Represents a request to send audio from a Vonage Video API session to a WebSocket.
More...
|
| const string | MissingSessionId = "SessionId needs to be provided." |
| | Indicates SessionId needs to be provided. More...
|
| const string | MissingToken = "Token needs to be provided." |
| | Indicates Token needs to be provided. More...
|
| const string | InvalidUrl = "Url length should be between 15 and 2048." |
| | Indicates Url length should be between 15 and 2048. More...
|
Represents a request to send audio from a Vonage Video API session to a WebSocket.
◆ AudioConnectorStartRequest()
| OpenTokSDK.AudioConnectorStartRequest.AudioConnectorStartRequest |
( |
string |
sessionId, |
|
|
string |
token, |
|
|
WebSocket |
socket |
|
) |
| |
Creates a new instance of ConnectRequest.
- Parameters
-
| sessionId | The Vonage Video API session ID that includes the OpenTok streams you want to include in the WebSocket stream. |
| token | The OpenTok token to be used for the Audio Connector connection to the Vonage Video API session. You can add token data to identify that the connection is the Audio Connector endpoint or for other identifying data. (The OpenTok client libraries include properties for inspecting the connection data for a client connected to a session.) See the Token Creation developer guide. |
| socket | Options for configuring the connect call for WebSocket. |
◆ ToDataDictionary()
| Dictionary<string, object> OpenTokSDK.AudioConnectorStartRequest.ToDataDictionary |
( |
| ) |
|
Converts request to dictionary.
- Returns
- Dictionary containing instance values.
◆ InvalidUrl
| const string OpenTokSDK.AudioConnectorStartRequest.InvalidUrl = "Url length should be between 15 and 2048." |
Indicates Url length should be between 15 and 2048.
◆ MissingSessionId
| const string OpenTokSDK.AudioConnectorStartRequest.MissingSessionId = "SessionId needs to be provided." |
Indicates SessionId needs to be provided.
◆ MissingToken
| const string OpenTokSDK.AudioConnectorStartRequest.MissingToken = "Token needs to be provided." |
Indicates Token needs to be provided.
◆ SessionId
| string OpenTokSDK.AudioConnectorStartRequest.SessionId |
|
The ID of a session (generated with the same APIKEY as specified in the URL) where the streams will be gathered from.
◆ Socket
| WebSocket OpenTokSDK.AudioConnectorStartRequest.Socket |
|
Options for configuring the connect call for WebSocket.
◆ Token
| string OpenTokSDK.AudioConnectorStartRequest.Token |
|
A valid OpenTok token with a Subscriber role.
