com.opentok

Class ArchiveProperties.Builder

java.lang.Object

com.opentok.ArchiveProperties.Builder

Enclosing class:

ArchiveProperties

public static class ArchiveProperties.Builder
extends java.lang.Object

Use this class to create a ArchiveProperties object.

See Also:

ArchiveProperties

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

public ArchiveProperties.Builder name(java.lang.String name)

Call this method to set a name to the archive.

Parameters:

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.

Returns:

The ArchiveProperties.Builder object with the name setting.

resolution

public ArchiveProperties.Builder resolution(java.lang.String resolution)

Call this method to set the resolution of the archive.

Parameters:

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.

Returns:

The ArchiveProperties.Builder object with the resolution setting.

hasAudio

public ArchiveProperties.Builder hasAudio(boolean hasAudio)

Call this method to include an audio track (true) or not false).

Parameters:

hasAudio - Whether the archive will include an audio track.

Returns:

The ArchiveProperties.Builder object with the hasAudio setting.

hasVideo

public ArchiveProperties.Builder hasVideo(boolean hasVideo)

Call this method to include an video track (true) or not false).

Parameters:

hasVideo - Whether the archive will include an video track.

Returns:

The ArchiveProperties.Builder object with the hasVideo setting.

outputMode

public ArchiveProperties.Builder outputMode(Archive.OutputMode outputMode)

Call this method to choose the output mode to be generated for this archive.

Parameters:

outputMode - Set to a value defined in the Archive.OutputMode enum.

Returns:

The ArchiveProperties.Builder object with the output mode setting.

layout

public ArchiveProperties.Builder layout(ArchiveLayout layout)

Call this method to customize the layout for a composed archive

Parameters:

layout - An object of type ArchiveLayout .

Returns:

The ArchiveProperties.Builder object with the output mode setting.

build

public ArchiveProperties build()

Builds the ArchiveProperties object.

Returns:

The ArchiveProperties object.