OpenTok

• hasAudio — Whether the composed archive should include the stream's audio (true, the default) or not (false).
• hasVideo — Whether the composed archive should include the stream's video (true, the default) or not (false).

• error — An error object (if the call to the method fails).

• hasAudio — Whether the broadcast should include the stream's audio (true, the default) or not (false).
• hasVideo — Whether the broadcast should include the stream's video (true, the default) or not (false).

• location (String) — An IP address that the OpenTok servers will use to situate the session in the global OpenTok network. If you do not set a location hint, the OpenTok servers will be based on the first client connecting to the session.
• e2ee (Boolean) — Determines whether to enable `end-to-end encryption for the OpenTok session. Set to "true" or "false".
• mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router ("routed") or not ("relayed"). By default, the setting is "relayed".

  With the mediaMode parameter set to "relayed", the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams.

  The OpenTok Media Router provides the following benefits:

• archiveMode (String) — Whether the session is automatically archived ("always") or not ("manual"). By default, the setting is "manual", and you must call the StartArchive() method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set the mediaMode parameter to "routed".
• archiveName (String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, _.
• archiveResolution (Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080".
• The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When the mediaMode parameter is set to "relayed", each client must send a separate audio-video stream to each client subscribing to it.)
• The OpenTok Media Router can improve the quality of the user experience through audio fallback and video recovery. With these features, if a client's connectivity degrades to a degree that it does not support video for a stream it's subscribing to, the video is dropped on that client (without affecting other clients), and the client receives audio only. If the client's connectivity improves, the video returns.
• The OpenTok Media Router supports the archiving feature, which lets you record, save, and retrieve OpenTok sessions.

• error — On failiure, this parameter is set to an Error object. Check the error message for details. On success, this is set to null.
• session — On sucess, this parameter is set to a Session object. The sessionId property of this object is session ID of the session. On error, this parameter is not set.

• headers (Object) — Custom headers to be added to the SIP INVITE request iniated from OpenTok to the third-party SIP platform.
• auth (Object) — The credentials to be used for HTTP Digest authentication in case this is required by the third-party SIP platform.
  • "username" -- The username to be used in the SIP INVITE.
  • "password" -- The password to be used in the SIP INVITE.
• secure (Boolean) — Whether the SIP media streams should be transmitted encrypted or not.
• from (String) — The number or string that will be sent to the final SIP number as the caller. It must be a string in the form of from@example.com, where from can be a string or a number. If from is set to a number (for example, "14155550101@example.com"), it will show up as the incoming number on PSTN phones. If from is undefined or set to a string (for example, "joe@example.com"), +00000000 will show up as the incoming number on PSTN phones.
• video (Boolean) — A Boolean flag that indicates whether the SIP call will include video (true) or not (false, the default). With video included, the SIP client's video is included in the OpenTok stream that is sent to the OpenTok session. The SIP client will receive a dynamic composed video stream of the published streams in the OpenTok session. This is a beta feature.
• observeForceMute (optional) Whether the SIP end point observes force mute action by other clients like moderators (true) or not (false, the default). See Muting the audio of streams in a session.

• error — An error object (if the call to the method fails).

• excudedStreamIds (Array of strings) — An array of stream IDs to exlude from being muted. This is optional. If you do not set this property, all arrays in the session will be muted.

• role (String) — The role for the token. Each role defines a set of permissions granted to the token:
  • 'subscriber' — A subscriber can only subscribe to streams.
  • 'publisher' — A publisher can publish streams, subscribe to streams, and signal. (This is the default value if you do not specify a role.)
  • 'publisheronly' — A publisheronly can publish streams, but cannot subscribe to streams.
  • 'moderator' — In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams. See the Moderation developer guide.
• expireTime (Number) — The expiration time for the token, in seconds since the UNIX epoch. The maximum expiration time is 30 days after the creation time. If a fractional number is specified, then it is rounded down to the nearest whole number. The default expiration time of 24 hours after the token creation time.
• data (String) — A string containing connection metadata describing the end-user.For example, you can pass the user ID, name, or other data describing the end-user. The length of the string is limited to 1000 characters. This data cannot be updated once it is set.
• initialLayoutClassList (Array) — An array of class names (strings) to be used as the initial layout classes for streams published by the client. Layout classes are used in customizing the layout of videos in live streaming broadcasts and composed archives.

• error — An error object (if the call to the method fails).
• archive — The Archive object.

• error — An error object (if the call to the method fails).
• render — The Render object.

• error — An error object (if the call to the method fails). This is set to null if there is no error. Calling this method results in an error if you pass in an invalid stream ID or an invalid session ID.
• stream — The Stream object. This object includes properties defining the stream. This is undefined if there is an error.

• count — The maximum number of archives to return. The default number of archives returned is 50 (or fewer, if there are fewer than 50 archives). The method returns a maximum of 1000 archives.
• offset — The offset for the first archive to list (starting with the first archive recorded as offset 0). 1 is the offset of the archive that started prior to the most recent archive. This property is optional; the default is 0.
• sessionId — Specify the ID of a session in order to retrieve archives specifically for that session. This property is optional. When no session ID is specified, then the method will return archives from any session created with your API key.

If you don't pass in an options argument, the method returns up to 1000 archives starting with the first archive recorded.

• error — An error object (if the call to the method fails).
• archives — An array of Archive objects.

• count — The maximum number of broadcasts to return. The default number of broadcasts returned is 50 (or fewer, if there are fewer than 50 broadcasts). The method returns a maximum of 1000 broadcasts.
• offset — The offset for the first broadcast to list (starting with the first broadcast recorded as offset 0). 1 is the offset of the broadcast that started prior to the most recent broadcast. This property is optional; the default is 0.
• sessionId — Specify the ID of a session in order to retrieve broadcasts specifically for that session. This property is optional. When no session ID is specified, then the method will return broadcasts from any session created with your API key.

If you don't pass in an options argument, the method returns up to 1000 broadcasts starting with the first broadcast recorded.

• error — An error object (if the call to the method fails).
• broadcasts — An array of Broadcast objects.

• count — The maximum number of renders to return. The default number of renders returned is 50 (or fewer, if there are fewer than 50 renders). The method returns a maximum of 1000 renders.
• offset — The offset for the first render to list (starting with the first render recorded as offset 0). 1 is the offset of the render that started prior to the most recent render. This property is optional; the default is 0.
• sessionId — Specify the ID of a session in order to retrieve renders specifically for that session. This property is optional. When no session ID is specified, then the method will return renders from any session created with your API key.

If you don't pass in an options argument, the method returns up to 1000 renders, starting with the first render recorded.

• error — An error object (if the call to the method fails).
• renders — An array of Render objects.

• error — An error object (if the call to the method fails). This is set to null if there is no error. Calling this method results in an error if you pass in an invalid session ID.
• streams — An array of Stream objects. Each Stream object includes properties defining the stream. This is undefined if there is an error.

• error — An error object (if the call to the method fails). This is set to null if there is no error.

const classListArray = [
  { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] },
  { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] },
  { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] }
];

• data — The data to send. The limit to the length of data string is 8kB. Do not set the data string to null or undefined.
• type — The type of the signal. Clients can use the type to filter signals. The maximum length of the type string is 128 characters.

• name (String) — the name of the archive, which you can use to identify the archive. The name is set as a property of the Archive object, and it is a property of archive-related events in the OpenTok client libraries.
• hasAudio (Boolean) — Whether the archive will include an audio track (true) or not (false). The default value is true (an audio track is included). If you set both hasAudio and hasVideo to false, the call to the startArchive() method results in an error.
• hasVideo (Boolean) — Whether the archive will include a video track (true) or (not false). The default value is true (a video track is included). If you set both hasAudio and hasVideo to false, the call to the startArchive() method results in an error.
• outputMode (String) — Whether all streams in the archive are recorded to a single file ("composed", the default) or to individual files ("individual").
• layout (Object) — An object defining the initial layout options for a composed archive. This object has three properties: type, stylesheet, and screenshareType, which are each strings. Set type to "bestFit", "pip", "verticalPresentation", "horizontalPresentation", or "custom". Set the stylesheet property if type is set to "custom", and set it to the stylesheet defining the custom layout. For example, set the layout object to { type: "pip" } to set the initial layout of the archive to picture-in-picture. Set the screenshareType property to the layout type to use when there is a screen-sharing stream in the session (This property is optional.) Note if you set the screenshareType property, you must set the type property to "bestFit" and leave the stylesheet property unset. For details, see Customizing the video layout for composed archives.
• resolution (String) — For a composed archive, set this to the resolution of the archive. Valid values are "1280x720" or "640x480" (the default).
• streamMode (optional) — The stream mode for the archive. This can be set to one of the the following:
  • "auto" — Streams included in the archive are selected automatically (the default).
  • "manual" — Specify streams to be included based on calls to the OpenTok.addArchiveStream() and OpenTok.removeArchiveStream() methods.
• multiArchiveTag (String) — Set this to support recording multiple archives for the same session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this option when manually starting an archive that is automatically archived. Note that the multiArchiveTag value is not included in the response for the methods to list archives and retrieve archive information. If you do not specify a unique multiArchiveTag you can only record one archive at a time for a given session.

• error — An error object (if the call to the method fails).
• archive — The Archive object. This object includes properties defining the archive, including the archive ID.

{
   outputs: {
     hls: {
       dvr: false,
       lowLatency: false,
     },
     rtmp: [{
       id: "foo",
       serverUrl: "rtmp://myfooserver/myfooapp",
       streamName: "myfoostream"
     },
     {
       id: "bar",
       serverUrl: "rtmp://mybarserver/mybarapp",
       streamName: "mybarstream"
     }]
   },
   maxDuration: 5400,
   resolution: "640x480",
   layout: {
     type: "custom",
     stylesheet: "the layout stylesheet (only used with type == custom)",
     screenshareType: "the layout type to use when there is a screen-sharing stream (optional)"
   },
   streamMode: "manual"
 }

The options object includes the following properties:

• outputs (required) — This object defines the types of broadcast streams you want to start. You can include HLS, RTMP, or both as broadcast streams. If you include RTMP streaming, you can specify up to five target RTMP streams (or just one).

  For HLS, include a single hls property in the outputs object. This object includes the following optional properties:

  • dvr (Boolean) — Whether to enable DVR functionality — rewinding, pausing, and resuming — in players that support it (true), or not (false, the default). With DVR enabled, the HLS URL will include a ?DVR query string appended to the end.
  • lowLatency (Boolean) — Whether to enable low-latency mode for the HLS stream. Some HLS players do not support low-latency mode. This feature is incompatible with DVR mode HLS broadcasts.
  The HLS URL is returned in the broadcastUrls as the hls property in the Broadcast object passed into the callback methods of the OpenTok#getBroadcast and OpenTok#listBroadcast methods.

  For each RTMP stream, specify serverUrl (the RTMP server URL), streamName (the stream name, such as the YouTube Live stream name or the Facebook stream key), and (optionally) id (a unique ID for the stream). If you specify an ID, it will be included as the id property of the Broadcast object passed into the callback methods of the startBroadcast() method and the OpenTok.getBroadcast() method. OpenTok streams the session to each RTMP URL you specify. Note that OpenTok live streaming supports RTMP and RTMPS.

• maxDuration (optional) — The maximum duration for the broadcast, in seconds. The broadcast will automatically stop when the maximum duration is reached. You can set the maximum duration to a value from 60 (60 seconds) to 36000 (10 hours). The default maximum duration is 4 hours (14,400 seconds).
• resolution (optional) — The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD).
layout (optional) — Specify this to assign the initial layout type for the broadcast. This object has three properties: type, stylesheet, and screenshareType, which are each strings. Valid values for the type property are "bestFit" (best fit), "custom" (custom), "horizontalPresentation" (horizontal presentation), "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)). If you specify a "custom" layout type, set the stylesheet property of the layout object to the stylesheet. (For other layout types, do not set a stylesheet property.) If you do not specify an initial layout type, the broadcast stream uses the Best Fit layout type. Set the screenshareType property to the layout type to use when there is a screen-sharing stream in the session. (This property is optional.) Note if you set the screenshareType property, you must set the type property to "bestFit" and leave the stylesheet property unset. For more information, see Configuring video layout for OpenTok live streaming broadcasts.
• streamMode (optional) — The stream mode for the broadcast. This can be set to one of the the following:
  • "auto" — Streams included in the broadcast are selected automatically (the default).
  • "manual" — Specify streams to be included based on calls to the OpenTok.addBroadcastStream() and OpenTok.removeBroadcastStream() methods.
• multiBroadcastTag (optional) — Set this to support multiple broadcasts for the same session simultaneously. Set this to a unique string for each simultaneous broadcast of an ongoing session. Note that the multiBroadcastTag value is not included in the response for the methods to list live streaming broadcasts and get information about a live streaming broadcast.

• sessionId (String) — The ID of a session (generated with the same `APIKEY`as specified in the URL) which you wish to start rendering into
• token (String) — A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream.
• url (String) — A publically reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
• properties (Object) — Initial configuration of Publisher properties for the composed output stream.
• maxDuration (Number) — The maximum time allowed for the Render, in seconds. After this time, the Render will be stopped automatically, if it is still running.
• resolution (String) — Resolution of the display area for the composition.

• error — An error object (if the call to the method fails).
• render — The Render object. This object includes properties defining the render, including the render ID.

• error — An error object (if the call to the method fails).
• archive — The Archive object.

• error — An error object (if the call to the method fails).
• render — The Render object.

• streams (Array) — An array of stream IDs for the OpenTok streams you want to include in the WebSocket stream. If you omit this property, all streams in the session will be included.
• headers (Object) — An object of key-value pairs of headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.

• id -- A unique ID identifying the Audio Streamer WebSocket connection.
• connectionId -- The OpenTok connection ID for the Audio Streamer WebSocket connection in the OpenTok session.