session.h

This file includes the type definition for an OpenTok session along with several function declarations useful when dealing with a session.

Data structures: otc_session_capabilities, otc_custom_ice_config, otc_signal_options, otc_session_callbacks

Includes: capabilities.h, config.h, publisher.h, subscriber.h, stream.h

#define ENCRYPTION_SECRET_MINIMUM_LENGTH

#define ENCRYPTION_SECRET_MINIMUM_LENGTH 8

#define ENCRYPTION_SECRET_MAXIMUM_LENGTH

#define ENCRYPTION_SECRET_MAXIMUM_LENGTH 256

typedef otc_session

OpenTok session type definition.

typedef struct otc_session otc_session;

typedef otc_session_settings

OpenTok session settings type definition.

typedef struct otc_session_settings otc_session_settings;

enum otc_session_error_code

Error code enumeration for OpenTok sessions.

This enumeration represents several error codes associated with a session.

Functions

otc_session_new(apikey, session_id, callbacks) → {otc_session *}

Creates a new otc_session struct instance. Pass this into the otc_session_connect function to connect to the OpenTok session.

See also otc_session_new_with_settings for initializing a otc_session struct with advanced options.

Important: If you are using the Video API with a Vonage application (instead of an OpenTok project), pass in the application ID (not an OpenTok API key) for this parameter.

Parameters:

Returns:

The otc_session struct, representing the OpenTok session.

otc_session_settings_new() → {otc_session_settings *}

Creates a new otc_session_settings instance, used to set up advanced session settings. Call the following functions to configure these settings before calling the otc_session_new_with_settings function to create a session with these settings:

• otc_session_settings_set_connection_events_suppressed — Suppress connection events.
• otc_session_settings_set_custom_ice_config &mdash Use custom TURN servers.
• otc_session_settings_set_proxy_url — Configure the IP proxy feature.
• otc_session_settings_set_ip_whitelist — Enable the IP whitelist feature.
• otc_session_settings_set_single_peer_connection — Enable the Single Peer Connection feature.
• otc_session_settings_set_session_migration — Enable the Session Migration feature.

Returns:

otc_session_settings *

otc_session_settings_set_connection_events_suppressed(settings, suppress) → {otc_status}

Prevent connection events, to support large interactive video sessions. This prevents otc_session_callbacks.on_connection_created and otc_session_callbacks.on_connection_dropped callback functions from being invoked when other clients connect to or disconnect from the session. (Also, the OpenTok server does not send these events to the client.) For more information, see Suppressing connection events in the OpenTok developer guides.

Parameters:

Returns:

otc_status

otc_session_settings_set_custom_ice_config(settings, custom_ice_config) → {otc_status}

Enables custom ICE sever configuration. This is part of the configurable TURN feature.

Parameters:

Returns:

otc_status

otc_session_settings_set_proxy_url(settings, proxy_url) → {otc_status}

Sets the IP proxy URL. See the IP Proxy developer guide.

Parameters:

Returns:

otc_status

otc_session_settings_set_ip_whitelist(settings, ip_whitelist) → {otc_status}

Pass in OTC_TRUE to have the client use the IP address white list. This feature is available as an add-on feature.

Parameters:

Returns:

otc_status

otc_session_settings_set_single_peer_connection(settings, enable) → {otc_status}

Single Peer Connection (SPC) is a feature that encapsulates all subscriber connections to a single peer connection. The benefits of enabling SPC include reduced OS resource consumption, improved rate control, and, in case of mobile native devices, support for larger sessions.

SPC is disabled by default. When disabled, the session will use Multiple Peer Connection (MPC), where a separate peer connection is established between each endpoint.

Parameters:

Returns:

otc_status Returns the status of the operation.

otc_session_settings_set_session_migration(settings, enable) → {otc_status}

Enables the session migration feature, allowing the client to remain connected during server rotation. The default value is false (session migration is not enabled). For more information, see Server Rotation and Session Migration.

Parameters:

Returns:

otc_status Returns the status of the operation.

otc_session_settings_delete(settings) → {otc_status}

Deletes an otc_session_settings instance.

Parameters:

Returns:

otc_status

otc_session_new_with_settings(apikey, session_id, callbacks, settings) → {otc_session *}

Creates a new OpenTok session with advanced settings. These include settings for suppressing connection events, custom TURN servers, the IP proxy feature, and the IP whitelist feature.

Parameters:

See: : - otc_session_new.

Returns:

The struct, representing the OpenTok session.

otc_session_delete(session) → {otc_status}

Releases resources associated with the session. No callbacks in otc_session_callbacks will be invoked as a result of invoking this method (or afterwards).

Parameters:

Returns:

otc_status

otc_session_connect(session, token) → {otc_status}

Connects the client to an OpenTok session.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_disconnect(session) → {otc_status}

Disconnects the client from this session. All of the client's subscribers and publishers will also be will be disconnected from the session. As a best practice, before calling this function, call the otc_session_unpublish function for all publishers and wait for the otc_publisher_callbacks#on_stream_destroyed callback. This ensures the complete removal of publishers, especially if network connectivity issues prevent removal due to the reconnection feature, which may keep publisher streams alive for potential reconnection.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_publish(session, publisher) → {otc_status}

Starts a publisher streaming to the session.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_unpublish(session, publisher) → {otc_status}

Causes a publisher from a session (causing its stream to stop).

Parameters:

Returns:

Return value indicating either error or success.

otc_session_subscribe(session, subscriber) → {otc_status}

Starts subscribing to (receiving a stream for) a subscriber's audio-video stream in this session.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_unsubscribe(session, subscriber) → {otc_status}

Stops subscribing to (receiving a stream for) a specified subscriber in the session.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_send_signal(session, type, signal) → {otc_status}

Sends a signal to all clients connected to the session. See otc_session_send_signal_with_options, otc_session_send_signal_to_connection, and otc_session_send_signal_to_connection_with_options. Also see the Signaling overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_force_mute_all(session, excluded_streams_ids, excluded_streams_len) → {otc_status}

Forces all publishers in the session (except for those publishing excluded streams) to mute audio.

Also, any streams that are published after the call to the otc_session_force_mute_all function are published with audio muted. You can remove the mute state of a session by calling the otc_session_disable_force_mute function. After you call the otc_session_disable_force_mute function, new streams published to the session will no longer have audio muted.

Calling this function causes the otc_session_callback.on_mute_forced() callback function to be called in each client connected to the session, with the active property of the otc_on_mute_forced_info struct passed into the function set to OTC_TRUE. Also, the otc_publisher_callbacks.on_publisher_mute_forced() callback function is called in each client publishing a muted stream.

Call the otc_session_get_capabilities function to see if the client can call this function successfully. This is reserved for clients that have connected with a token that has been assigned the moderator role (see the (see the Token creation overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_disable_force_mute(session) → {otc_status}

Disables the active mute state of the session. After you call this method, new streams published to the session will no longer have audio muted.

After you call the otc_session_force_mute_all() function (or a moderator in another client makes a call to mute all streams), any streams published after the moderation call are published with audio muted. Call the otc_session_disable_force_mute function to remove the mute state of a session (so that new published streams are not automatically muted).

Calling this function causes the otc_session_callback.on_mute_forced() callback function to be called in each client connected to the session, with the active property of the otc_on_mute_forced_info struct passed into the function set to OTC_FALSE.

Call the otc_session_get_capabilities function to see if the client can call this function successfully. This is reserved for clients that have connected with a token that has been assigned the moderator role (see the Token creation overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_force_mute_stream(session, stream_id_to_mute) → {otc_status}

Forces the publisher of a specified stream to mute its audio.

Calling this function causes the otc_publisher_callbacks.on_publisher_mute_forced() callback function to be called in the client publishing the muted stream.

Call the otc_session_get_capabilities function to see if the client can call this function successfully. This is reserved for clients that have connected with a token that has been assigned the moderator role (see the (see the Token creation overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_force_disconnect(session, connection) → {otc_status}

Forces a client to disconnect from the session.

While you can use this function to terminate your own connection, calling otc_session_disconnect is simpler. An error is returned if the client's role does not include permissions required to force other users to disconnect. You define a client's role when you create the user token. When a connection is terminated using this function, otc_session_callbacks#on_connection_dropped and otc_publisher_callbacks#on_stream_destroyed callbacks are dispatched in the same way as they would be if the connection had terminated itself using otc_session_disconnect.

Parameters:

Returns:

An error in the event of an error otherwise OTC_SUCCESS

otc_session_send_signal_to_connection(session, type, signal, connection) → {otc_status}

Sends a signal to a specific client connected to the session. See otc_session_send_signal_to_connection_with_options, otc_session_send_signal, and otc_session_send_signal_with_options. Also see the Signaling overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_send_signal_with_options(session, type, signal, signal_options) → {otc_status}

Sends a signal to all clients connected to the session, with specified options. See otc_session_send_signal, otc_session_send_signal_to_connection, and otc_session_send_signal_to_connection_with_options. Also see the Signaling overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_send_signal_to_connection_with_options(session, type, signal, connection, signal_options) → {otc_status}

Sends a signal to a specific client, with specified options. See otc_session_send_signal, otc_session_send_signal_to_connection, and otc_session_send_signal_with_options. Also see the Signaling overview.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_report_issue(session, issue_description, issue_id) → {otc_status}

Report that your app experienced an issue. You can use the issue ID with the Inspector tool or when discussing an issue with the Vonage Video API support team.

Parameters:

Returns:

Return value indicating either error or success.

otc_session_get_id(session) → {char *}

Gets the unique session ID for this session.

Parameters:

Returns:

char *

otc_session_get_connection(session) → {otc_connection *}

Gets the connection object associated with this session.

Parameters:

Returns:

The otc_connection instance.

otc_session_get_capabilities(session) → {struct otc_session_capabilities}

Gets the capabilities of the client connecxted to the session. All otc_session_capabilities members are undefined until otc_session_callbacks.on_connected has been called.

Parameters:

Returns:

The otc_session_capabilities instance.

otc_session_get_user_data(session) → {void *}

Gets the user data associated with the session. See otc_session_callbacks.user_data.

Parameters:

Returns:

A pointer to the user data.

otc_session_set_encryption_secret(session, secret) → {otc_status}

See the End-to-end encryption developer guide.

The session must have been configured as end-to-end encrypted using the server SDK. Whether end-to-end encryption is enabled is only known once the session configuration has been received from the server.

If the session is already known not to be end-to-end encrypted when this function is called, it returns OTC_SESSION_ENCRYPTION_NOT_ENABLED synchronously. In that case any existing publishers and subscribers also receive the corresponding error through their error callbacks and are dropped.

If whether end-to-end encryption is enabled is not yet known (for example, when the secret is set before the session connects), this function succeeds. If the session later turns out not to be end-to-end encrypted, the OTC_SESSION_ENCRYPTION_NOT_ENABLED error is returned synchronously from the subsequent otc_session_publish or otc_session_subscribe call (reported as OTC_PUBLISHER_ENCRYPTION_NOT_ENABLED / OTC_SUBSCRIBER_ENCRYPTION_NOT_ENABLED respectively).

Passing NULL or an empty string as the secret resets (clears) the previously set encryption secret. Resetting the secret is always allowed, even on a session that is known not to be end-to-end encrypted.

Any other secret must be between ENCRYPTION_SECRET_MINIMUM_LENGTH and ENCRYPTION_SECRET_MAXIMUM_LENGTH bytes long when UTF-8 encoded; otherwise OTC_SESSION_INVALID_ENCRYPTION_SECRET is returned.

A new secret takes effect for the publishers and subscribers that are already running, as well as for those created afterwards. Resetting the secret, however, only takes effect for publishers and subscribers created afterwards: those that are already running keep encrypting and decrypting with the previous secret until they are recreated.

Parameters:

Returns:

Return value indicating either error or success. Returns OTC_SESSION_INVALID_ENCRYPTION_SECRET if the secret is neither a reset (NULL or empty) nor of a valid length, and OTC_SESSION_ENCRYPTION_NOT_ENABLED if a non-empty secret is set on a session that is already known not to be end-to-end encrypted.