OpenTok.Session.Builder Class Reference

Used to create a Session instance. More...

Public Member Functions
	Builder (Context context, string apiKey, string sessionId)
	Creates a new Builder instance. More...
Session	Build ()
	Creates a Session object. More...

Properties
bool	ConnectionEventsSuppressed = false [get, set]
	Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false. More...
bool	SinglePeerConnection = false [get, set]
	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. More...
bool	IpWhitelist = false [get, set]
	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. More...
Uri	ProxyUrl [get, set]
	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. More...
IceConfig	IceConfig [get, set]
	This property is used by the configurable TURN feature. More...
Context	Context [get, set]
	The Content object used to manage resources for the Session. More...
string	ApiKey [get, set]
	Your OpenTok API key. See your Vonage Video API account page. More...
string	SessionId [get, set]
	The OpenTok 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. More...

Detailed Description

Used to create a Session instance.

Instantiate a Builder instance by calling the Builder() constructor. Then (optionally), set properties of the Builder object. Then call the Build() method to create a Session object.

Constructor & Destructor Documentation

Builder()

OpenTok.Session.Builder.Builder	(	Context	context,
		string	apiKey,
		string	sessionId
	)

Creates a new Builder instance.

Parameters

context	The Content object used to manage resources for the Session.
apiKey	Your OpenTok API key. See your Vonage Video API account page.
sessionId	The OpenTok 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.

Member Function Documentation

Build()

Session OpenTok.Session.Builder.Build

(

)

Creates a Session object.

Returns

Property Documentation

ApiKey

string OpenTok.Session.Builder.ApiKey

getset

Your OpenTok API key. See your Vonage Video API account page.

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.

ConnectionEventsSuppressed

bool OpenTok.Session.Builder.ConnectionEventsSuppressed = false

getset

Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false.

Context

Context OpenTok.Session.Builder.Context

getset

The Content object used to manage resources for the Session.

IceConfig

IceConfig OpenTok.Session.Builder.IceConfig

getset

This property is used by the configurable TURN feature.

IpWhitelist

bool OpenTok.Session.Builder.IpWhitelist = false

getset

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

Uri OpenTok.Session.Builder.ProxyUrl

getset

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.

SessionId

string OpenTok.Session.Builder.SessionId

getset

The OpenTok 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.

SinglePeerConnection

bool OpenTok.Session.Builder.SinglePeerConnection = false

getset

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.

---

The documentation for this class was generated from the following file:

• /Users/jswartz_1/src/native-sdk-src/project/windows/OpenTok/src/Session.cs