Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ConnectionState

name

ConnectionState

Index

Enumeration members

CONNECTED

CONNECTED: = "CONNECTED"

A network connection has been established to the Liberator. StreamLink will now attempt to log in to the Liberator session.

CONNECTING

CONNECTING: = "CONNECTING"

A connection attempt is in progress. If the connection attempt is successful, a CONNECTED state will be raised, if the connection fails, the FAILED event will be raised.

CREDENTIALSRETRIEVALFAILED

CREDENTIALSRETRIEVALFAILED: = "CREDENTIALSRETRIEVALFAILED"

StreamLink has failed to retrieve the credentials.

CREDENTIALSRETRIEVED

CREDENTIALSRETRIEVED: = "CREDENTIALSRETRIEVED"

StreamLink has successfully retrieved the credentials.

DISCONNECTED

DISCONNECTED: = "DISCONNECTED"

Disconnected from the Liberator. When this state is raised by the StreamLink library all subscriptions have removed. StreamLink will not perform any activity until you call connect() on the StreamLink object.

EJECTED

EJECTED: = "EJECTED"

The client has been ejected from the Liberator. StreamLink will not perform any more connection attempts and will switch to the DISCONNECTED state.

FAILED

FAILED: = "FAILED"

A connection attempt has failed. StreamLink will attempt to connect to a Liberator on the configured server list.

LOGGEDIN

LOGGEDIN: = "LOGGEDIN"

The client is now logged into the Liberator. In this state it is possible for StreamLink applications to receive subscription updates and receive responses to commands.

LOGINFAILED

LOGINFAILED: = "LOGINFAILED"

The client could not login to the Liberator. StreamLink will not perform any more connection attempts and will switch to the DISCONNECTED state.

LOST

LOST: = "LOST"

The connection to the Liberator has been lost. StreamLink will attempt to connect and establish a new session with a configured Liberator.

PAUSED

PAUSED: = "PAUSED"

The connection has been paused by the application. This state is a direct result of the application causing StreamLink.pause. StreamLink is held in a "frozen" state pending a call to StreamLink.resume.

RECONNECTED

RECONNECTED: = "RECONNECTED"

The Liberator session has been reconnected. This should be treated as an informational event, StreamLink will switch to the LOGGEDIN state to simplify implementation of your application (see the traffic light example above).

RETRIEVINGCREDENTIALS

RETRIEVINGCREDENTIALS: = "RETRIEVINGCREDENTIALS"

StreamLink is attempting to obtain a set of credentials to log in to the server.

UNREACHABLE

UNREACHABLE: = "UNREACHABLE"

A connection to the Liberator is not possible due to no network being available.

Generated using TypeDoc