OpenTok.Session

Creates a Session instance.

Parameters

context	The Content object used to manage resources for the Session.
apiKey	Your Vonage Video API key. See the your Vonage Video API account page.
sessionId	The Vonage Video API session ID this instance should connect to. For test purposes, you can generate test session by logging into your Vonage Video API account. Use the OpenTok server SDKs to generate session IDs in your shipping application.
connectionEventsSuppressed	Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false.
apiUrl	This parameter is deprecated. (Its value is ignored.)
ipWhitelist	Set this to true if the allowed IP list feature is enabled for your project. (This is available as an add-on feature. The default value is false.
proxyUrl	Set this to the URL of the IP proxy server. This is available as an add-on feature. See the OpenTok pricing page and the IP proxy developer guide.
iceConfig	This parameter is used by the configurable TURN feature.

.

See also

Connect(string), Connected

Connects to the Vonage Video API session provided in the Session constructor, using the provided authentication token.

When the session connects, the Session object sends the Connected event.

If the session fails to connect, the Session object sends the Error event.

Parameters

token

The token for the user. See Token Creation Overview.

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 ForceMuteAll method (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 DisableForceMute() method to remove the mute state of a session (so that new published streams are not automatically muted).

Calling this method causes the Session object in each client connected to the session to send the MuteForced event, with the IsActive property of the MuteForcedEventArgs object to be set to false.

Check the CanForceMute property of the Session.Capabilities object to see if you 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).

See Muting the audio of streams in a session.

See also

Capabilities, ForceMuteAll, MuteForced

Disconnects from this session. All Subscriber and Publisher instances will be disconnected.

As a best practice, before calling this method, call the Unpublish(Publisher) method for all publishers and wait for the Publisher.StreamDestroyed event. 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.

When the session disconnects, the Session sends the Disconnected event.

Disposes of the Session object's resources.

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 ForceMuteAll() method are published with audio muted. You can remove the mute state of a session by calling the DisableForceMute() method. After you call the DisableForceMute() method, new streams published to the session will no longer have audio muted.

Calling this method causes the Session object in each client connected to the session to send the MuteForced event, with the IsActive property of the MuteForcedEventArgs object to be set to true.

Check the CanForceMute property of the Session.Capabilities object to see if you 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).

See Muting the audio of streams in a session.

Parameters

excludedStreams

Streams to be excluded from the mute request. Set this to null (or do not set this parameter) to mute all streams in the session (including those published by the local client).

See also

Capabilities, ForceMuteStream, DisableForceMute(), Session.MuteForced, Publisher.MuteForced

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

Check the CanForceMute property of the Session.Capabilities object to see if you 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).

See Muting the audio of streams in a session.

Parameters

stream

The stream to be muted.

See also

Capabilities, ForceMuteAll, Publisher.MuteForced

Starts a Publisher streaming to the session.

Parameters

publisher

The Publisher that you want to stream to the session.

Sends a signal to all clients in the session.

Parameters

type	The type of the signal. The type is set in the SignalEventArgs.Type argument of the Signal event listener.
data	The data to send. The limit to the size of data is 8kB. The type is set in the SignalEventArgs.Data argument of the Signal event listener.
connection
retryAfterReconnect

Sets the end-to-end encryption secret used by all publishers and subscribers.

See the End-to-end encryption developer guide.

Parameters

secret

Value of the encryption secret.

Start receiving and rendering audio-video stream data for the specified subscriber.

Parameters

subscriber

The subscriber bound to the stream to be received.

Disconnects the Publisher from the session.

Parameters

publisher

The Publisher to unpublish.

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

Parameters

subscriber

The Subcriber you want to stop subscribing to.

Whether the client can only subscribe to streams, or both publish and subscribe to streams, based on the role assigned to the token used to connect to the session.

Returns the Connection corresponding to this client's connection to this Session.

Called when an archive of the session starts recording. In response to this method, you may want to add a user interface notification (such as an icon in the Publisher view) that indicates the session is being recorded.

Called when an archive of the session stops being recorded. In response to this method, you may want to remove a user interface notification (such as an icon in the Publisher view) the session recording has stopped.

Sent when the client connects to the Vonage Video API session.

Sent when another client connects to the session.

The ConnectionEventArgs.Connection object represents the client's connection to the session. Note that this method is invoked when other clients connect to the session. When your own client client connects, the Session sends the Connected event.

Sent when another client leaves the session.

The ConnectionEventArgs.Connection object represents the client's previous connection to the session. Note that this method is called when other clients leave the session. When your own client client disconnects, the Session object sends the Connected event.

Sent when the client disconnects from the Vonage Video API session.

Sent when something goes wrong when connecting or connected to the session.

This event is sent if the attempt to connect to the session fails. It is also sent if the connection to the session drops due to an error after a successful connection, and in this case the event is sent just before the Disconnected event is sent.

Called when a moderator forces clients publishing streams to the session to mute audio (the IsActive property of the MuteForcedEventArgs object is set to true), or when a moderator disables the mute audio state in the session (the IsActive property of the MuteForcedEventArgs object is set to false).

Sent when the local client has lost its connection to an Vonage Video API session and is trying to reconnect. This results from a loss in network connectivity.

If the client can reconnect to the session, the Session object sends the ReconnectionSuccess event. Otherwise, if the client cannot reconnect, the Session object sends the Disconnected event.

In response to this method being called, you may want to provide a user interface notification, to let the user know that the app is trying to reconnect to the session and that audio-video streams are temporarily disconnected.

See also

ReconnectionSuccess, Disconnected

Invoked when the local client has reconnected to the Vonage Video API session after its network connection was lost temporarily.

When the connection is lost, the Session object sends the Session.ReconnectionStart event, prior to sending the Session.ReconnectionSuccess event. If the client cannot reconnect to the session, the Session object sends the Session.Disconnected event.

Any existing publishers and subscribers are automatically reconnected when the client reconnects and this method is called.

By default, any signals initiated by the local client using the SendSignal(string, string, Connection, bool) method are sent when the client reconnects. To prevent any signals initiated while disconnected from being sent, set the retryAfterReconnect parameter of the SendSignal method to false. (All signals sent by other clients while your client was disconnected are received upon reconnecting.)

See also

ReconnectionStart

Called when a signal is received in the session.

Called when the video dimensions of a stream in the session change. The StreamEventArgs.Stream object represents a snapshot of stream at the time of the callback.

Sent when another client stops publishing a stream to this Vonage Video API session.

The StreamEventArgs.Stream object represents a snapshot of stream at the time of the callback. It can be used to identify a corresponding Subscriber (if there is one).

Called when a stream in the session changes between having audio and not having audio. The StreamEventArgs.Stream object represents a snapshot of stream at the time of the callback.

Called when a stream in the session changes between having captions and not having captions.

Called when a stream in the session changes between having video and not having video. The StreamEventArgs.Stream object represents a snapshot of stream at the time of the callback.

Sent when a there is a new stream published by another client in this Vonage Video API session.

The StreamEventArgs.Stream object represents a snapshot of stream at the time of the callback. Create a Subscriber and call the Subscribe(Subscriber) method to subscribe to the stream.