close search

Add Messaging, Voice, and Authentication to your apps with Nexmo APIs

Visit Nexmo


An object representing an OpenTok live streaming broadcast.

Do not call the new() constructor. To start a live streaming broadcast, call the OpenTok.startBroadcast() method.

Name Type Description
createdAt Number The time at which the archive was created, in milliseconds since the UNIX epoch.


Name Description
stop(callback) Stops the live streaming broadcast.


Stops the live streaming broadcast.

Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.

Name Type Description
callback function The function to call upon completing the operation. Two arguments are passed to the function:
  • error — An error object (if the call to the method fails).
  • broadcast — The Broadcast object.