Suggestions

close search

ArchiveEvent

Properties Methods 

Defines event objects for the archiveStarted and archiveStopped events. The Session object dispatches these events when an archive recording of the session starts and stops.

Properties

Name Type Description
id String The archive ID.
name String The name of the archive. You can assign an archive a name when you create it, using the OpenTok REST API or one of the OpenTok server SDKs.

Methods

Name Description
isDefaultPrevented() → {Boolean} Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false).
preventDefault() Prevents the default behavior associated with the event from taking place.

isDefaultPrevented() → {Boolean}

Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false). See preventDefault().
Returns:

preventDefault()

Prevents the default behavior associated with the event from taking place.

To see whether an event has a default behavior, check the cancelable property of the event object.

Call the preventDefault() method in the callback function for the event.

The following events have default behaviors: