StreamLink.NET  6.2.10-3513-c11dd52
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Properties | List of all members
Caplin.StreamLink.IConnectionStatusEvent Interface Reference

Provides information about a change in status of the connection to the Liberator. More...

Properties

Caplin.StreamLink.ConnectionState ConnectionState [get]
 Returns the new state of a connection the the Liberator. More...
 
string LiberatorUrl [get]
 Returns the URL of the Liberator connection that this status event has been raised for. More...
 
Caplin.StreamLink.LoginFailedReason LoginFailReason [get]
 Returns the reason for the login attempt failing. It only makes sense to obtain this value if the ConnectionState is LOGINFAILED. More...
 
string Username [get]
 Returns the username that will be used to log in to the Liberator. More...
 

Detailed Description

Provides information about a change in status of the connection to the Liberator.

The ConnectionStatusEvent is provided on a onConnectionStatusChange callback to a IConnectionListener.

Property Documentation

Caplin.StreamLink.ConnectionState Caplin.StreamLink.IConnectionStatusEvent.ConnectionState
get

Returns the new state of a connection the the Liberator.

The new connection state

string Caplin.StreamLink.IConnectionStatusEvent.LiberatorUrl
get

Returns the URL of the Liberator connection that this status event has been raised for.

The Liberator URL.

Caplin.StreamLink.LoginFailedReason Caplin.StreamLink.IConnectionStatusEvent.LoginFailReason
get

Returns the reason for the login attempt failing. It only makes sense to obtain this value if the ConnectionState is LOGINFAILED.

The reason (LoginFailedReason.NONE if not available).

string Caplin.StreamLink.IConnectionStatusEvent.Username
get

Returns the username that will be used to log in to the Liberator.

The username. This is only available when the ConnectionState is CredentialsRetrieved.


Generated on Thu Apr 27 2017 14:05:45 for StreamLink.NET