Represents a connection between a client and an Vonage Video API session. More...
Inherits IDisposable.
| Public Member Functions | |
| void | Dispose () |
| Disposes of the Connection object's resources. | |
| override bool | Equals (object obj) |
| override int | GetHashCode () |
| Protected Member Functions | |
| virtual void | Dispose (bool disposing) |
| Properties | |
| string | Id [get] |
| The unique ID for this connection. | |
| string | Data [get] |
| A string containing metadata describing the connection. You can add this connection data when you create a token. | |
| DateTime | CreationTime [get] |
| Returns the time at which the connection was created on the Vonage Video API server. |
Detailed Description
Represents a connection between a client and an Vonage Video API session.
The Session.Connection property is set to a Connection object that represents the local user's connection. The Stream.Connection property is set to a Connection object that represents the stream publisher's connection. To initialize a session, call the
OpenTok.Session.Session(Context, string, string, bool, Uri, bool, Uri, IceConfig) constructor, which returns the Session object. Then call the Session.Connect(string) method to connect to the session. When the connection to the session is made, the Session object sends the Session.Connected event.
When streams connect to a session, the Session object sends the Session.StreamReceived event. Compare the connection property of a Stream object with the connection property of the Session object to determine if a stream is published by your client or another.
See also : Session.StreamReceived, Session.Connected
Member Function Documentation
Dispose()
Parameters : | | | | --- | --- | | disposing | |
Equals()
| override bool OpenTok.Connection.Equals | ( | object | obj | ) |
Parameters : | | | | --- | --- | | obj | |
Returns
GetHashCode()
| override int OpenTok.Connection.GetHashCode | ( | ) |
Returns