fm.liveswitch.Stream Class Referenceabstract

A peer-to-peer stream. More...

Public Member Functions

void addOnDisabledChange (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the Disabled property changes state. More...
 
boolean getDeactivated ()
 Gets a value indicating whether this stream is deactivated. More...
 
boolean getDisabled ()
 Gets a value indicating whether this stream is disabled. More...
 
fm.liveswitch.EncryptionMode getEncryptionMode ()
 Gets the encryption mode. More...
 
fm.liveswitch.EncryptionMode[] getEncryptionModes ()
 Gets the encryption modes. More...
 
fm.liveswitch.EncryptionPolicy getEncryptionPolicy ()
 Gets a value indicating Encryption Policy. More...
 
int getIndex ()
 Gets the index. More...
 
fm.liveswitch.IceParameters getLocalIceParameters ()
 Gets the local ICE parameters. More...
 
fm.liveswitch.IceParameters getRemoteIceParameters ()
 Gets the remote ICE parameters. More...
 
fm.liveswitch.SdesPolicy getSdesPolicy ()
 Gets Sdes policy for stream. More...
 
boolean getUseDtls ()
 Gets a value indicating whether DTLS encryption is in use for this stream. More...
 
boolean getUseSdes ()
 Gets a value indicating whether SDES encryption is in use for this stream. More...
 
void removeOnDisabledChange (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the Disabled property changes state. More...
 
void setDeactivated (boolean value)
 Sets a value indicating whether this stream is deactivated. More...
 
void setDisabled (boolean value)
 Sets a value indicating whether this stream is disabled. More...
 
void setEncryptionMode (fm.liveswitch.EncryptionMode value)
 Sets the encryption mode. More...
 
void setEncryptionModes (fm.liveswitch.EncryptionMode[] value)
 Sets the encryption modes. More...
 
void setEncryptionPolicy (fm.liveswitch.EncryptionPolicy value)
 Sets a value indicating Encryption Policy. More...
 
void setSdesPolicy (fm.liveswitch.SdesPolicy value)
 Sets Sdes policy for stream. More...
 
void setUseDtls (boolean value)
 Sets a value indicating whether DTLS encryption is in use for this stream. More...
 
void setUseSdes (boolean value)
 Sets a value indicating whether SDES encryption is in use for this stream. More...
 
 Stream (fm.liveswitch.StreamType type)
 Initializes a new instance of the fm.liveswitch.Stream class. More...
 
- Public Member Functions inherited from fm.liveswitch.StreamBase
void addOnDirectionChange (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the stream direction change has occurred. More...
 
void addOnStateChange (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the stream state changes. More...
 
abstract fm.liveswitch.Error changeDirection (fm.liveswitch.StreamDirection newDirection)
 Changes this stream's direction. More...
 
String getConnectionId ()
 Gets the connection identifier. More...
 
abstract fm.liveswitch.StreamDirection getDirection ()
 Gets the current direction. More...
 
String getExternalId ()
 Gets the external identifier. More...
 
String getId ()
 Gets the identifier. More...
 
boolean getIsTerminated ()
 Gets a value indicating whether the stream is currently closed or failed. More...
 
boolean getIsTerminating ()
 Gets a value indicating whether the stream is currently closing or failing. More...
 
boolean getIsTerminatingOrTerminated ()
 Gets a value indicating whether the stream is currently closing, failing, closed, or failed. More...
 
abstract String getLabel ()
 Gets a label that identifies this class. More...
 
abstract fm.liveswitch.StreamDirection getLocalDirection ()
 Gets current direction indicated by the local description. More...
 
boolean getLocalReceive ()
 Gets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
boolean getLocalSend ()
 Gets a value indicating whether sending media is supported by the local peer on this stream. More...
 
String getMediaDescriptionId ()
 Gets the media description identifier. More...
 
abstract fm.liveswitch.StreamDirection getRemoteDirection ()
 Gets current direction indicated by the remote description. More...
 
boolean getRemoteReceive ()
 Gets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
boolean getRemoteSend ()
 Gets a value indicating whether sending media is supported by the remote peer on this stream. More...
 
fm.liveswitch.StreamState getState ()
 Gets the state of the stream. More...
 
String getTag ()
 Gets optional data to associate with this instance. More...
 
abstract fm.liveswitch.TransportInfo getTransportInfo ()
 Gets the stream transport info. More...
 
fm.liveswitch.StreamType getType ()
 Gets the type. More...
 
void removeOnDirectionChange (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the stream direction change has occurred. More...
 
void removeOnStateChange (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the stream state changes. More...
 
void setExternalId (String value)
 Sets the external identifier. More...
 
abstract void setLocalDirection (fm.liveswitch.StreamDirection value)
 Sets current direction indicated by the local description. More...
 
void setLocalReceive (boolean value)
 Sets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
void setLocalSend (boolean value)
 Sets a value indicating whether sending media is supported by the local peer on this stream. More...
 
void setTag (String value)
 Sets optional data to associate with this instance. More...
 
 StreamBase (fm.liveswitch.StreamType type)
 Initializes a new instance of the fm.liveswitch.StreamBase class. More...
 
String toString ()
 Returns a string that represents this instance. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets the dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Unsets a property value in the local cache. More...
 

Protected Member Functions

void processBundledStateChanged (boolean bundled)
 Processes bundled state change of this stream. More...
 
void processCachedSettings ()
 Evaluate cached settings and set them. More...
 
void raiseDisabledChange ()
 Raises the OnDisabledChange event. More...
 
- Protected Member Functions inherited from fm.liveswitch.StreamBase
long getConnectedTimestamp ()
 Gets the ManagedStopwatch.GetTimestamp() value representing the ticks that passed when this stream's connection state changed to connected. More...
 
void processStateChange ()
 Processes a state change. More...
 
void processStateLockChange ()
 Processes a state lock change. More...
 
void processUpdateToMediaStreamIdentification (String oldValue)
 Process update to the MediaDescription Identificiation. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

A peer-to-peer stream.

Constructor & Destructor Documentation

◆ Stream()

fm.liveswitch.Stream.Stream ( fm.liveswitch.StreamType  type)

Initializes a new instance of the fm.liveswitch.Stream class.

Parameters
typeThe type.

Member Function Documentation

◆ addOnDisabledChange()

void fm.liveswitch.Stream.addOnDisabledChange ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the Disabled property changes state.

◆ getDeactivated()

boolean fm.liveswitch.Stream.getDeactivated ( )

Gets a value indicating whether this stream is deactivated.

A stream is deactivated if its direction is unset or inactive.

◆ getDisabled()

boolean fm.liveswitch.Stream.getDisabled ( )

Gets a value indicating whether this stream is disabled.

A stream is disabled if session negotiation failed or if the underlying transport could not be started.

◆ getEncryptionMode()

fm.liveswitch.EncryptionMode fm.liveswitch.Stream.getEncryptionMode ( )

Gets the encryption mode.

◆ getEncryptionModes()

fm.liveswitch.EncryptionMode [] fm.liveswitch.Stream.getEncryptionModes ( )

Gets the encryption modes.

◆ getEncryptionPolicy()

fm.liveswitch.EncryptionPolicy fm.liveswitch.Stream.getEncryptionPolicy ( )

Gets a value indicating Encryption Policy.

◆ getIndex()

int fm.liveswitch.Stream.getIndex ( )

Gets the index.

◆ getLocalIceParameters()

fm.liveswitch.IceParameters fm.liveswitch.Stream.getLocalIceParameters ( )

Gets the local ICE parameters.

◆ getRemoteIceParameters()

fm.liveswitch.IceParameters fm.liveswitch.Stream.getRemoteIceParameters ( )

Gets the remote ICE parameters.

◆ getSdesPolicy()

fm.liveswitch.SdesPolicy fm.liveswitch.Stream.getSdesPolicy ( )

Gets Sdes policy for stream.

◆ getUseDtls()

boolean fm.liveswitch.Stream.getUseDtls ( )

Gets a value indicating whether DTLS encryption is in use for this stream.

◆ getUseSdes()

boolean fm.liveswitch.Stream.getUseSdes ( )

Gets a value indicating whether SDES encryption is in use for this stream.

Reimplemented in fm.liveswitch.DataStream.

◆ processBundledStateChanged()

void fm.liveswitch.Stream.processBundledStateChanged ( boolean  bundled)
protected

Processes bundled state change of this stream.

Parameters
bundled

Reimplemented in fm.liveswitch.DataStream.

◆ processCachedSettings()

void fm.liveswitch.Stream.processCachedSettings ( )
protected

Evaluate cached settings and set them.

Reimplemented in fm.liveswitch.DataStream.

◆ raiseDisabledChange()

void fm.liveswitch.Stream.raiseDisabledChange ( )
protected

Raises the OnDisabledChange event.

◆ removeOnDisabledChange()

void fm.liveswitch.Stream.removeOnDisabledChange ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the Disabled property changes state.

◆ setDeactivated()

void fm.liveswitch.Stream.setDeactivated ( boolean  value)

Sets a value indicating whether this stream is deactivated.

A stream is deactivated if its direction is unset or inactive.

◆ setDisabled()

void fm.liveswitch.Stream.setDisabled ( boolean  value)

Sets a value indicating whether this stream is disabled.

A stream is disabled if session negotiation failed or if the underlying transport could not be started.

◆ setEncryptionMode()

void fm.liveswitch.Stream.setEncryptionMode ( fm.liveswitch.EncryptionMode  value)

Sets the encryption mode.

◆ setEncryptionModes()

void fm.liveswitch.Stream.setEncryptionModes ( fm.liveswitch.EncryptionMode[]  value)

Sets the encryption modes.

◆ setEncryptionPolicy()

void fm.liveswitch.Stream.setEncryptionPolicy ( fm.liveswitch.EncryptionPolicy  value)

Sets a value indicating Encryption Policy.

◆ setSdesPolicy()

void fm.liveswitch.Stream.setSdesPolicy ( fm.liveswitch.SdesPolicy  value)

Sets Sdes policy for stream.

◆ setUseDtls()

void fm.liveswitch.Stream.setUseDtls ( boolean  value)

Sets a value indicating whether DTLS encryption is in use for this stream.

◆ setUseSdes()

void fm.liveswitch.Stream.setUseSdes ( boolean  value)

Sets a value indicating whether SDES encryption is in use for this stream.

Reimplemented in fm.liveswitch.DataStream.