Package com.opentok
Class ArchiveProperties
- java.lang.Object
-
- com.opentok.ArchiveProperties
-
public class ArchiveProperties extends java.lang.Object
Defines values for theproperties
parameter of theOpenTok.startArchive(String sessionId, ArchiveProperties properties)
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ArchiveProperties.Builder
Used to create an ArchiveProperties object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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).java.lang.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.java.lang.String
resolution()
Returns the resolution of the archive.Archive.StreamMode
streamMode()
The stream mode of the archive.java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>
toMap()
Returns the archive properties as a Map.
-
-
-
Method Detail
-
name
public java.lang.String name()
Returns the name of the archive, which you can use to identify the archive.
-
resolution
public java.lang.String resolution()
Returns the resolution of the archive.
-
getMultiArchiveTag
public java.lang.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
).
-
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 java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> toMap()
Returns the archive properties as a Map.
-
-