com.opentok.ArchiveProperties
public class ArchiveProperties extends Object
Defines values for the properties parameter of the
OpenTok.startArchive(String sessionId, ArchiveProperties properties) method.
See Also:
: - OpenTok.createSession(com.opentok.SessionProperties properties)
Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
static class
ArchiveProperties.Builder
Used to create an ArchiveProperties object.
Method Summary
All MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
String
getMultiArchiveTag()
Returns the multiArchiveTag, if present.
boolean
hasAudio()
Whether the archive has an audio track (true) or not (false).
boolean
hasVideo()
Whether the archive has a video track (true) or not (false).
ArchiveLayout
layout()
Returns the custom layout of the archive (composed archives only).
Integer
maxBitrate()
Gets the maximum bitrate (bps) for the archive if specified.
String
name()
Returns the name of the archive, which you can use to identify the archive.
Archive.OutputMode
outputMode()
The output mode of the archive.
String
resolution()
Returns the resolution of the archive.
Archive.StreamMode
streamMode()
The stream mode of the archive.
Map<String,Collection<String>>
toMap()
Returns the archive properties as a Map.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method Details
name
public String name()
Returns the name of the archive, which you can use to identify the archive.
resolution
public String resolution()
Returns the resolution of the archive.
getMultiArchiveTag
public String getMultiArchiveTag()
Returns the multiArchiveTag, if present.
hasVideo
public boolean hasVideo()
Whether the archive has a video track (true) or not (false).
hasAudio
public boolean hasAudio()
Whether the archive has an audio track (true) or not (false).
maxBitrate
public Integer maxBitrate()
Gets the maximum bitrate (bps) for the archive if specified.
Returns:
: The maximum bitrate (in bits per second) for the archiving, or null if unspecified (the default).
Since: : 4.15.0
outputMode
public Archive.OutputMode outputMode()
The output mode of the archive.
streamMode
public Archive.StreamMode streamMode()
The stream mode of the archive.
layout
public ArchiveLayout layout()
Returns the custom layout of the archive (composed archives only).
toMap
public Map<String,Collection<String>> toMap()
Returns the archive properties as a Map.