public static class ArchiveProperties.Builder
extends java.lang.Object
ArchiveProperties
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ArchiveProperties |
build()
Builds the ArchiveProperties object.
|
ArchiveProperties.Builder |
hasAudio(boolean hasAudio)
Call this method to include an audio track (
true ) or not false ). |
ArchiveProperties.Builder |
hasVideo(boolean hasVideo)
Call this method to include an video track (
true ) or not false ). |
ArchiveProperties.Builder |
layout(ArchiveLayout layout)
Call this method to customize the layout for a composed archive
|
ArchiveProperties.Builder |
name(java.lang.String name)
Call this method to set a name to the archive.
|
ArchiveProperties.Builder |
outputMode(Archive.OutputMode outputMode)
Call this method to choose the output mode to be generated for this archive.
|
ArchiveProperties.Builder |
resolution(java.lang.String resolution)
Call this method to set the resolution of the archive.
|
public ArchiveProperties.Builder name(java.lang.String name)
name
- The name of the archive. You can use this name to identify the archive. It is a property
of the Archive object, and it is a property of archive-related events in the OpenTok JavaScript SDK.public ArchiveProperties.Builder resolution(java.lang.String resolution)
resolution
- The resolution of the archive, either "640x480" (SD, the default) or
"1280x720" (HD). This property only applies to composed archives. If you set this
and set the outputMode property to "individual", the call in the API method results in
an error.public ArchiveProperties.Builder hasAudio(boolean hasAudio)
true
) or not false
).hasAudio
- Whether the archive will include an audio track.public ArchiveProperties.Builder hasVideo(boolean hasVideo)
true
) or not false
).hasVideo
- Whether the archive will include an video track.public ArchiveProperties.Builder outputMode(Archive.OutputMode outputMode)
outputMode
- Set to a value defined in the Archive.OutputMode
enum.public ArchiveProperties.Builder layout(ArchiveLayout layout)
layout
- An object of type ArchiveLayout
.public ArchiveProperties build()