\OpenTokOpenTok

The session ID corresponding to the session to which the user will connect.

This array defines options for the token. This array includes the following keys, all of which are optional:

• 'role' (string) — One of the constants defined in the Role class. The default role is publisher.
• 'expireTime' (int) — The timestamp for when the token expires, in milliseconds since the Unix epoch. The default expiration time is 24 hours after the token creation time. The maximum expiration time is 30 days 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.

(Optional) This array defines options for the session. The array includes the following keys (all of which are optional):

• 'archiveMode' (ArchiveMode) — Whether the session is automatically archived (ArchiveMode::ALWAYS) or not (ArchiveMode::MANUAL). By default, the setting is ArchiveMode.MANUAL, and you must call the OpenTok->startArchive() method to start archiving. To archive the session (either automatically or not), you must set the mediaMode key to MediaMode::ROUTED.
• 'location' (String) — An IP address that the OpenTok servers will use to situate the session in its global network. If you do not set a location hint, the OpenTok servers will be based on the first client connecting to the session.
• 'mediaMode' (MediaMode) — Whether the session will transmit streams using the OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, the mediaMode property is set to MediaMode.RELAYED.

  With the mediaMode parameter set to MediaMode.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:

  • The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When the mediaMode parameter is set to MediaMode.ROUTED, 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 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.

The session ID of the OpenTok session to archive.

(Optional) This array defines options for the archive. The array includes the following keys (all of which are optional):

• 'name' (String) — The name of the archive. You can use this name to identify the archive. It is a property of the Archive object, and it is a property of archive-related events in the OpenTok client SDKs.
• 'hasVideo' (Boolean) — Whether the archive will record video (true, the default) or not (false). If you set both hasAudio and hasVideo to false, the call to the startArchive() method results in an error.
• 'hasAudio' (Boolean) — Whether the archive will record audio (true, the default) or not (false). If you set both hasAudio and hasVideo to false, the call to the startArchive() method results in an error.
• 'outputMode' (OutputMode) — Whether all streams in the archive are recorded to a single file (OutputMode::COMPOSED, the default) or to individual files (OutputMode::INDIVIDUAL).

The archive ID of the archive you want to stop recording.

The archive ID.

The archive ID of the archive you want to delete.

Optional. The index offset of the first archive. 0 is offset of the most recently started archive. 1 is the offset of the archive that started prior to the most recent archive. If you do not specify an offset, 0 is used.

Optional. The number of archives to be returned. The maximum number of archives returned is 1000.

Optional. The OpenTok session Id for which you want to retrieve Archives for. If no session Id is specified, the method will return archives from all sessions created with the API key.

The OpenTok archive ID.

The session ID of the session the streams belong to.

The connectionId of the connection in a session.

The OpenTok session ID that the client is connected to.

The connection ID of the connection in the session.

The session ID of the session to be broadcast.

(Optional) An array with options for the broadcast. This array has the following properties:

• layout (Layout) — (Optional) An object defining the initial layout type of the broadcast. If you do not specify an initial layout type, the broadcast stream uses the Best Fit layout type. For more information, see Configuring Video Layout for the OpenTok live streaming feature.

The ID of the broadcast.

The ID of the broadcast.

The ID of the broadcast.

An object defining the layout type for the broadcast.

The session ID of the session the stream belongs to.

The stream ID.

An array containing one property: $layoutClassList. This property is an array of class names (strings) to apply to the stream. Set $layoutClassList to an empty array to clear the layout class list for a stream. For example, this code sets the stream to use two classes:

$streamProperties = array(
  '$layoutClassList' => array('bottom', 'right')
);
$opentok->updateStream($sessionId, $streamId, $streamProperties);

The session ID for the OpenTok session containing the stream.

The stream ID.

The session ID.

The ID of the OpenTok session that the participant being called will join.

The OpenTok token to be used for the participant being called. You can add token data to identify that the participant is on a SIP endpoint or for other identifying data, such as phone numbers. Generate a token using the OpenTok->generateToken() or Session->generateToken() method.

The SIP URI to be used as destination of the SIP Call initiated from OpenTok to the Third Party SIP Platform.

If the URI contains a transport=tlsheader, the negotiation between Vonage and the SIP endpoint will be done securely. Note that this will only apply to the negotiation itself, and not to the transmission of audio. To have audio transmission be encrypted, see the "secure" property of the options parameter.

This is an example of secure call negotiation: "sip:access@thirparty.com;transport=tls".

This is an example of insecure call negotiation: "sip:access@thirparty.com".

This array defines options for the token. It includes the following keys, all of which are optional:

• 'headers' (array) — Headers​: Custom Headers to be added to the SIP INVITE request initiated from OpenTok to the Third Party SIP Platform.
• 'auth' (array) — Auth​: Username and Password to be used in the SIP INVITE request for HTTP Digest authentication in case this is required by the Third Party SIP Platform.
  • 'username' (string) — The username to be used in the the SIP INVITE​ request for HTTP digest authentication (if one is required).
  • 'password' (string) — The password to be used in the the SIP INVITE​ request for HTTP digest authentication.
• 'secure' (Boolean) — Indicates whether the media must be transmitted encrypted (true, the default) or not (false).
• '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.

The OpenTok session ID where the signal will be sent.

This array defines the payload for the signal. This array includes the following keys, of which type is optional:

• 'data' (string) — The data string for the signal. You can send a maximum of 8kB.
• 'type' (string) — (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '_', and '~'.

An optional parameter used to send the signal to a specific connection in a session.