ArchiveEvent class

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:

ArchiveEvent properties

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:

  • For the archiveClosed event, this Archive object corresponds to the archive that was closed.
  • For the archiveCreated event, this Archive object corresponds to the created archive.
  • For the archiveLoaded event, this Archive object corresponds to the archive that was loaded.
  • For the archiveSaved event, this Archive object corresponds to the archive that was saved.
  • For the playbackStarted event, this Archive object corresponds to the archive that starts playing back.
  • For the playbackStopped event, this Archive object corresponds to the archive that stops playing back.
  • For the sessionRecordingStarted event this Archive object corresponds to the archive that is being recorded to.
  • For the sessionRecordingStopped event 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.

IRC Live Chat

Have a quick question? Chat with TokBox Support on IRC. Join chat