|
Vonage Video API Windows SDK
|
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 | SessionMigration = false [get, set] |
| Enables the session migration feature, allowing the client to remain connected during server rotation. The default value is 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] |
| Defines the TURN servers to be used by the client in the OpenTok session. See the configurable TURN servers 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... | |
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.
| OpenTok.Session.Builder.Builder | ( | Context | context, |
| string | apiKey, | ||
| string | sessionId | ||
| ) |
Creates a new Builder instance.
| 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. |
|
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.
|
getset |
Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false.
|
getset |
The Content object used to manage resources for the Session.
|
getset |
Defines the TURN servers to be used by the client in the OpenTok session. See the configurable TURN servers
|
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.
|
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.
|
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.
|
getset |
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.
This is a beta feature.
|
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.
1.8.15