com.opentok

Class Archive

java.lang.Object

com.opentok.Archive

public class Archive
extends java.lang.Object

Represents an archive of an OpenTok session.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Archive.OutputMode Defines values used in the ArchiveProperties.Builder.outputMode(com.opentok.Archive.OutputMode) method and returned by the getOutputMode() method.
static class	Archive.Status Defines values returned by the getStatus() method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Archive()

Method Summary

Modifier and Type	Method and Description
long	getCreatedAt() The time at which the archive was created, in milliseconds since the Unix epoch.
int	getDuration() The duration of the archive, in milliseconds.
java.lang.String	getId() The archive ID.
java.lang.String	getName() The name of the archive.
Archive.OutputMode	getOutputMode() The output mode to be generated for this archive: composed or individual.
int	getPartnerId() The OpenTok API key associated with the archive.
java.lang.String	getPassword() The encrypted password if an archive storage was configured to use an encryption key
java.lang.String	getReason() For archives with the status Status.STOPPED or Status.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.
java.lang.String	getResolution() The resolution of the archive.
java.lang.String	getSessionId() The session ID of the OpenTok session associated with this archive.
int	getSize() The size of the MP4 file.
Archive.Status	getStatus() The status of the archive, as defined by the Archive.Status enum.
java.lang.String	getUrl() The download URL of the available MP4 file.
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).
static Archive	makeArchive()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Archive

protected Archive()

Method Detail

makeArchive

public static Archive makeArchive()

getCreatedAt

public long getCreatedAt()

The time at which the archive was created, in milliseconds since the Unix epoch.

getDuration

public int getDuration()

The duration of the archive, in milliseconds.

getId

public java.lang.String getId()

The archive ID.

getName

public java.lang.String getName()

The name of the archive.

getResolution

public java.lang.String getResolution()

The resolution of the archive.

getPartnerId

public int getPartnerId()

The OpenTok API key associated with the archive.

getReason

public java.lang.String getReason()

For archives with the status Status.STOPPED or Status.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.

getSessionId

public java.lang.String getSessionId()

The session ID of the OpenTok session associated with this archive.

getSize

public int getSize()

The size of the MP4 file. For archives that have not been generated, this value is set to 0.

getStatus

public Archive.Status getStatus()

The status of the archive, as defined by the Archive.Status enum.

getUrl

public java.lang.String getUrl()

The download URL of the available MP4 file. This is only set for an archive with the status set to Status.AVAILABLE; for other archives, (including archives with the status of Status.UPLOADED) this method returns null. The download URL is obfuscated, and the file is only available from the URL for 10 minutes. To generate a new URL, call the OpenTok.listArchives() or OpenTok.getArchive(String) method.

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).

getOutputMode

public Archive.OutputMode getOutputMode()

The output mode to be generated for this archive: composed or individual.

getPassword

public java.lang.String getPassword()

The encrypted password if an archive storage was configured to use an encryption key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object