Support for OpenTok 1.0 Archiving is no longer being offered, but the API remains accessible. We now offer a new and improved Archiving support for OpenTok 2.0. Learn more
This class defines an event object dispatched when an archive is created, closed, or loaded; when an archive recording starts or stops; or when an archive starts or stops playing back. The following events are defined by the ArchiveEvent class:
archiveCreated See Session.createArchive().
archiveClosed See Session.closeArchive().
archiveLoaded See Session.loadArchive().
archiveSaved See Recorder.saveArchive().
playbackStarted See Archive.startPlayback().
playbackStopped See Archive.stopPlayback().
sessionRecordingStarted See Session.startRecording().
sessionRecordingStopped See Session.stopRecording().
The ArchiveEvent object has the following properties:
archives (Array[Archive]) An array of Archive objects. Currently, this array contains one element: the Archive object related to the event:
archiveClosedevent, this Archive object corresponds to the archive that was closed.
archiveCreatedevent, this Archive object corresponds to the created archive.
archiveLoadedevent, this Archive object corresponds to the archive that was loaded.
archiveSavedevent, this Archive object corresponds to the archive that was saved.
playbackStartedevent, this Archive object corresponds to the archive that starts playing back.
playbackStoppedevent, this Archive object corresponds to the archive that stops playing back.
sessionRecordingStartedevent this Archive object corresponds to the archive that is being recorded to.
sessionRecordingStoppedevent this Archive object corresponds to the archive in which recording stopped.
target (Object) The object that dispatched the event.
type (String) The type of event. There are the following types of ArchiveEvent event:
"archiveCreated" An archive has been created.
"archiveLoaded" An archive has been loaded.
"archiveSaved" An archive has been saved.
"playbackStarted" The archive has started playing back.
"playbackStopped" The archive has stopped playing back.
"sessionRecordingStarted" A per-session recording has started.
"sessionRecordingStopped" A per-session recording has stopped.