Represents a request to send audio from a Vonage Video API session to a WebSocket. More...
| Public Member Functions | |
| AudioConnectorStartRequest (string sessionId, string token, WebSocket socket) | |
| Creates a new instance of ConnectRequest. More... | |
| Dictionary< string, object > | ToDataDictionary () |
| Converts request to dictionary. More... |
| Public Attributes | |
| 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... |
| Properties | |
| string | SessionId [get] |
The ID of a session (generated with the same APIKEY as specified in the URL) where the streams will be gathered from. More... | |
| string | Token [get] |
| A valid OpenTok token with a Subscriber role. More... | |
| WebSocket | Socket [get] |
| Options for configuring the connect call for WebSocket. More... |
Detailed Description
Represents a request to send audio from a Vonage Video API session to a WebSocket.
Constructor & Destructor Documentation
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. |
Member Function Documentation
ToDataDictionary()
| Dictionary<string, object> OpenTokSDK.AudioConnectorStartRequest.ToDataDictionary | ( | ) |
Converts request to dictionary.
Returns : Dictionary containing instance values.
Member Data Documentation
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.
Property Documentation
SessionId
The ID of a session (generated with the same APIKEY as specified in the URL) where the streams will be gathered from.
Socket
Options for configuring the connect call for WebSocket.
Token
A valid OpenTok token with a Subscriber role.