fm.liveswitch.IStream Interface Reference

Stream interface. More...

Public Member Functions

abstract void addOnDirectionChange (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the signalling state changes. More...
 
abstract 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...
 
abstract fm.liveswitch.StreamDirection getDirection ()
 Gets the current direction. More...
 
abstract String getExternalId ()
 Gets the external identifier. More...
 
abstract String getId ()
 Gets the identifier. 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...
 
abstract boolean getLocalReceive ()
 Gets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
abstract boolean getLocalSend ()
 Gets a value indicating whether sending media is supported by the local peer on this stream. More...
 
abstract String getMediaDescriptionId ()
 Gets the media description identifier. More...
 
abstract fm.liveswitch.StreamDirection getRemoteDirection ()
 Gets the current direction indicated by the remote description. More...
 
abstract boolean getRemoteReceive ()
 Gets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
abstract boolean getRemoteSend ()
 Gets a value indicating whether sending media is supported by the remote peer on this stream. More...
 
abstract fm.liveswitch.StreamState getState ()
 Gets the current state. More...
 
abstract String getTag ()
 Gets optional data to associate with this instance. More...
 
abstract fm.liveswitch.TransportInfo getTransportInfo ()
 Gets the stream transport info. More...
 
abstract fm.liveswitch.StreamType getType ()
 Gets the type. More...
 
abstract void removeOnDirectionChange (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the signalling state changes. More...
 
abstract void removeOnStateChange (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the stream state changes. More...
 
abstract 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...
 
abstract void setLocalReceive (boolean value)
 Sets a value indicating whether receiving media is supported by the local peer on this stream. More...
 
abstract void setLocalSend (boolean value)
 Sets a value indicating whether sending media is supported by the local peer on this stream. More...
 
abstract void setTag (String value)
 Sets optional data to associate with this instance. More...
 

Detailed Description

Stream interface.

Member Function Documentation

◆ addOnDirectionChange()

abstract void fm.liveswitch.IStream.addOnDirectionChange ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the signalling state changes.

Implemented in fm.liveswitch.StreamBase.

◆ addOnStateChange()

abstract void fm.liveswitch.IStream.addOnStateChange ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the stream state changes.

Implemented in fm.liveswitch.StreamBase.

◆ changeDirection()

abstract fm.liveswitch.Error fm.liveswitch.IStream.changeDirection ( fm.liveswitch.StreamDirection  newDirection)
abstract

Changes this stream's direction.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ getDirection()

abstract fm.liveswitch.StreamDirection fm.liveswitch.IStream.getDirection ( )
abstract

Gets the current direction.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ getExternalId()

abstract String fm.liveswitch.IStream.getExternalId ( )
abstract

Gets the external identifier.

Implemented in fm.liveswitch.StreamBase.

◆ getId()

abstract String fm.liveswitch.IStream.getId ( )
abstract

Gets the identifier.

Implemented in fm.liveswitch.StreamBase.

◆ getLabel()

abstract String fm.liveswitch.IStream.getLabel ( )
abstract

Gets a label that identifies this class.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ getLocalDirection()

abstract fm.liveswitch.StreamDirection fm.liveswitch.IStream.getLocalDirection ( )
abstract

Gets current direction indicated by the local description.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ getLocalReceive()

abstract boolean fm.liveswitch.IStream.getLocalReceive ( )
abstract

Gets a value indicating whether receiving media is supported by the local peer on this stream.

Implemented in fm.liveswitch.StreamBase.

◆ getLocalSend()

abstract boolean fm.liveswitch.IStream.getLocalSend ( )
abstract

Gets a value indicating whether sending media is supported by the local peer on this stream.

Implemented in fm.liveswitch.StreamBase.

◆ getMediaDescriptionId()

abstract String fm.liveswitch.IStream.getMediaDescriptionId ( )
abstract

Gets the media description identifier.

Implemented in fm.liveswitch.StreamBase.

◆ getRemoteDirection()

abstract fm.liveswitch.StreamDirection fm.liveswitch.IStream.getRemoteDirection ( )
abstract

Gets the current direction indicated by the remote description.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ getRemoteReceive()

abstract boolean fm.liveswitch.IStream.getRemoteReceive ( )
abstract

Gets a value indicating whether receiving media is supported by the local peer on this stream.

Returns false if the remote stream direction has not been received.

Implemented in fm.liveswitch.StreamBase.

◆ getRemoteSend()

abstract boolean fm.liveswitch.IStream.getRemoteSend ( )
abstract

Gets a value indicating whether sending media is supported by the remote peer on this stream.

Returns false if the remote stream direction has not been received.

Implemented in fm.liveswitch.StreamBase.

◆ getState()

abstract fm.liveswitch.StreamState fm.liveswitch.IStream.getState ( )
abstract

Gets the current state.

Implemented in fm.liveswitch.StreamBase.

◆ getTag()

abstract String fm.liveswitch.IStream.getTag ( )
abstract

Gets optional data to associate with this instance.

Implemented in fm.liveswitch.StreamBase.

◆ getTransportInfo()

abstract fm.liveswitch.TransportInfo fm.liveswitch.IStream.getTransportInfo ( )
abstract

Gets the stream transport info.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.DataStream.

◆ getType()

abstract fm.liveswitch.StreamType fm.liveswitch.IStream.getType ( )
abstract

Gets the type.

Implemented in fm.liveswitch.StreamBase.

◆ removeOnDirectionChange()

abstract void fm.liveswitch.IStream.removeOnDirectionChange ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the signalling state changes.

Implemented in fm.liveswitch.StreamBase.

◆ removeOnStateChange()

abstract void fm.liveswitch.IStream.removeOnStateChange ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the stream state changes.

Implemented in fm.liveswitch.StreamBase.

◆ setExternalId()

abstract void fm.liveswitch.IStream.setExternalId ( String  value)
abstract

Sets the external identifier.

Implemented in fm.liveswitch.StreamBase.

◆ setLocalDirection()

abstract void fm.liveswitch.IStream.setLocalDirection ( fm.liveswitch.StreamDirection  value)
abstract

Sets current direction indicated by the local description.

Implemented in fm.liveswitch.StreamBase, and fm.liveswitch.MediaStreamBase.

◆ setLocalReceive()

abstract void fm.liveswitch.IStream.setLocalReceive ( boolean  value)
abstract

Sets a value indicating whether receiving media is supported by the local peer on this stream.

Implemented in fm.liveswitch.StreamBase.

◆ setLocalSend()

abstract void fm.liveswitch.IStream.setLocalSend ( boolean  value)
abstract

Sets a value indicating whether sending media is supported by the local peer on this stream.

Implemented in fm.liveswitch.StreamBase.

◆ setTag()

abstract void fm.liveswitch.IStream.setTag ( String  value)
abstract

Sets optional data to associate with this instance.

Implemented in fm.liveswitch.StreamBase.