C# Class OpenTokApi.Core.OpenTok

Show file Open project: khalidabuhakmeh/OpenTokApi Class Usage Examples

Public Methods

Method	Description
CreateSession ( string location, object options = null ) : string	The create_session() method of the OpenTokSDK object to create a new OpenTok session and obtain a session ID.
GenerateToken ( string sessionId, object options = null ) : string	In order to authenticate a user connecting to a OpenTok session, a user must pass an authentication token along with the API key.
OpenTok ( ) : System
OpenTok ( string apiKey, string secret, string server, string tokenSentinel, string sdkVersion = "tbdotnet" ) : System

Private Methods

Method	Description
ByteToString ( byte buff ) : string
CleanupKey ( string key ) : string
CreateSessionId ( string uri, object>.Dictionary dict ) : XmlDocument
EncodeTo64 ( string data ) : string
SignString ( string message, string key ) : string
ValidateSettings ( ) : void

Method Details

CreateSession() public method

The create_session() method of the OpenTokSDK object to create a new OpenTok session and obtain a session ID.

public CreateSession ( string location, object options = null ) : string
location	string	n IP address that TokBox will use to situate the session in its global network. In general, you should not pass in a location hint; if no location hint is passed in, the session uses a media server based on the location of the first client connecting to the session. Pass a location hint in only if you know the general geographic region (and a representative IP address) and you think the first client connecting may not be in that region.
options	object	/// Optional. An object used to define peer-to-peer preferences for the session. /// /// - p2p_preference (p2p.preference) : "disabled" or "enabled" /// - multiplexer_switchType (multiplexer.switchType) /// - multiplexer_switchTimeout (multiplexer.switchTimeout) /// - multiplexer_numOuputStreams (multiplexer.numOutputStreams) /// - echoSuppression_enabled (echoSuppression.enabled) /// ///
return	string

GenerateToken() public method

In order to authenticate a user connecting to a OpenTok session, a user must pass an authentication token along with the API key.

public GenerateToken ( string sessionId, object options = null ) : string
sessionId	string	/// Optional. An object used to define preferences for the token. /// /// - role : "subscriber", "publisher", "moderator" /// - expire_time : DateTime for when the token should expire /// - connection_data : any metadata you want about the connection limited to 1000 characters ///
options	object
return	string

OpenTok() public method

public OpenTok ( ) : System
return	System

OpenTok() public method

public OpenTok ( string apiKey, string secret, string server, string tokenSentinel, string sdkVersion = "tbdotnet" ) : System
apiKey	string
secret	string
server	string
tokenSentinel	string
sdkVersion	string
return	System