fm.liveswitch.StreamState Enum Reference

The state of a stream. More...

Public Member Functions

 StreamState (int value)
 
int getAssignedValue ()
 

Static Public Member Functions

 [static initializer]
 
static StreamState getByAssignedValue (int value)
 

Public Attributes

 New =(1)
 Indicates that the stream is new and has not been started. More...
 
 Initializing =(2)
 Indicates that the stream is being initialized but no connecting attempts have been made. More...
 
 Connecting =(3)
 Indicates that the stream is currently connecting. More...
 
 Connected =(4)
 Indicates that the stream is currently connected. More...
 
 Failing =(5)
 Indicates that the stream has encountered an error and is cleaning up. More...
 
 Failed =(6)
 Indicates that the stream has encountered an error and has cleaned up. More...
 
 Closing =(7)
 Indicates that the stream has been instructed to close and is cleaning up. More...
 
 Closed =(8)
 Indicates that the stream has been instructed to close and has cleaned up. More...
 

Detailed Description

The state of a stream.

Constructor & Destructor Documentation

◆ StreamState()

fm.liveswitch.StreamState.StreamState ( int  value)

Member Function Documentation

◆ [static initializer]()

fm.liveswitch.StreamState.[static initializer]
static

◆ getAssignedValue()

int fm.liveswitch.StreamState.getAssignedValue ( )

◆ getByAssignedValue()

static StreamState fm.liveswitch.StreamState.getByAssignedValue ( int  value)
static

Member Data Documentation

◆ Closed

fm.liveswitch.StreamState.Closed =(8)

Indicates that the stream has been instructed to close and has cleaned up.

◆ Closing

fm.liveswitch.StreamState.Closing =(7)

Indicates that the stream has been instructed to close and is cleaning up.

◆ Connected

fm.liveswitch.StreamState.Connected =(4)

Indicates that the stream is currently connected.

◆ Connecting

fm.liveswitch.StreamState.Connecting =(3)

Indicates that the stream is currently connecting.

◆ Failed

fm.liveswitch.StreamState.Failed =(6)

Indicates that the stream has encountered an error and has cleaned up.

◆ Failing

fm.liveswitch.StreamState.Failing =(5)

Indicates that the stream has encountered an error and is cleaning up.

◆ Initializing

fm.liveswitch.StreamState.Initializing =(2)

Indicates that the stream is being initialized but no connecting attempts have been made.

◆ New

fm.liveswitch.StreamState.New =(1)

Indicates that the stream is new and has not been started.