Media stream interface. More...

Public Member Functions
abstract void	addOnDiscardBitrateNotification (fm.liveswitch.IAction1< fm.liveswitch.BitrateNotification > value)
	Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...

abstract void	addOnDiscardBitrateRequest (fm.liveswitch.IAction1< fm.liveswitch.BitrateRequest > value)
	Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More...

abstract void	addOnLocalEncodingDisabled (fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value)
	Adds a handler that is raised when a local encoding is disabled. More...

abstract void	addOnLocalEncodingEnabled (fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value)
	Adds a handler that is raised when a local encoding is enabled. More...

abstract fm.liveswitch.StreamDirection	getCachedLocalDirection ()
	Gets Cached Local Direction for this Media Stream. More...

abstract boolean	getCodecDisabled (String name)
	Gets whether a codec is disabled. More...

abstract fm.liveswitch.TransportInfo	getControlTransportInfo ()
	Gets the media stream control transport info. More...

abstract fm.liveswitch.MediaStreamInfo	getInfo ()
	Gets the media stream info. More...

abstract boolean	getInputMuted ()
	Gets whether the input track is muted. More...

abstract int	getLocalBandwidth ()
	Gets the local bandwidth, in kbps. More...

abstract String	getLocalCanonicalName ()
	Gets the local canonical name. More...

abstract int	getMaxReceiveBitrate ()
	Gets the maximum desired receive bitrate, in kbps. More...

abstract int	getMaxSendBitrate ()
	Gets the maximum desired send bitrate, in kbps. More...

abstract boolean	getOutputMuted ()
	Gets whether the output track is muted. More...

abstract String[]	getPreferredCodecs ()
	Gets any preferred codecs, in order of preference. More...

abstract int	getRemoteBandwidth ()
	Gets the remote bandwidth, in kbps. More...

abstract String	getRemoteCanonicalName ()
	Gets the remote canonical name. More...

abstract fm.liveswitch.EncodingInfo	getRemoteEncoding ()
	Gets the remote encoding. More...

abstract boolean	getRemoteMuted ()
	Gets a value that indicates if remote is muted. More...

abstract boolean	getRemoteRequestedDeactivation ()
	Gets Boolean value set when the server is currently requesting a 0 bitrate. More...

abstract fm.liveswitch.SimulcastMode	getSimulcastMode ()
	Gets the simulcast mode. More...

abstract boolean	raiseBitrateNotification (fm.liveswitch.BitrateNotification bitrateNotification)
	Raises a bitrate notification to the remote track. More...

abstract boolean	raiseBitrateRequest (fm.liveswitch.BitrateRequest bitrateRequest)
	Raises a bitrate request to the local track. More...

abstract void	removeOnDiscardBitrateNotification (fm.liveswitch.IAction1< fm.liveswitch.BitrateNotification > value)
	Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More...

abstract void	removeOnDiscardBitrateRequest (fm.liveswitch.IAction1< fm.liveswitch.BitrateRequest > value)
	Removes a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More...

abstract void	removeOnLocalEncodingDisabled (fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value)
	Removes a handler that is raised when a local encoding is disabled. More...

abstract void	removeOnLocalEncodingEnabled (fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value)
	Removes a handler that is raised when a local encoding is enabled. More...

abstract void	setCodecDisabled (String name, boolean disabled)
	Sets whether a codec is disabled. More...

abstract void	setInputMuted (boolean value)
	Sets whether the input track is muted. More...

abstract void	setLocalBandwidth (int value)
	Sets the local bandwidth, in kbps. More...

abstract void	setMaxReceiveBitrate (int value)
	Sets the maximum desired receive bitrate, in kbps. More...

abstract void	setMaxSendBitrate (int value)
	Sets the maximum desired send bitrate, in kbps. More...

abstract void	setOutputMuted (boolean value)
	Sets whether the output track is muted. More...

abstract void	setPreferredCodecs (String[] value)
	Sets any preferred codecs, in order of preference. More...

abstract void	setRemoteEncoding (fm.liveswitch.EncodingInfo value)
	Sets the remote encoding. More...

abstract void	setRemoteMuted (boolean value)
	Sets a value that indicates if remote is muted. More...

abstract void	setSimulcastMode (fm.liveswitch.SimulcastMode value)
	Sets the simulcast mode. More...

Public Member Functions inherited from fm.liveswitch.IStream
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

Media stream interface.

Member Function Documentation

◆ addOnDiscardBitrateNotification()

abstract void fm.liveswitch.IMediaStream.addOnDiscardBitrateNotification ( fm.liveswitch.IAction1< fm.liveswitch.BitrateNotification > value )

abstract

Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnDiscardBitrateRequest()

abstract void fm.liveswitch.IMediaStream.addOnDiscardBitrateRequest ( fm.liveswitch.IAction1< fm.liveswitch.BitrateRequest > value )

abstract

Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ addOnLocalEncodingDisabled()

abstract void fm.liveswitch.IMediaStream.addOnLocalEncodingDisabled ( fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value )

abstract

Adds a handler that is raised when a local encoding is disabled.

◆ addOnLocalEncodingEnabled()

abstract void fm.liveswitch.IMediaStream.addOnLocalEncodingEnabled ( fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value )

abstract

Adds a handler that is raised when a local encoding is enabled.

◆ getCachedLocalDirection()

abstract fm.liveswitch.StreamDirection fm.liveswitch.IMediaStream.getCachedLocalDirection ( )

abstract

Gets Cached Local Direction for this Media Stream.

Internal use.

◆ getCodecDisabled()

abstract boolean fm.liveswitch.IMediaStream.getCodecDisabled ( String name )

abstract

Gets whether a codec is disabled.

Parameters

name	The codec name.

Returns: Whether the codec is disabled.

◆ getControlTransportInfo()

abstract fm.liveswitch.TransportInfo fm.liveswitch.IMediaStream.getControlTransportInfo ( )

abstract

Gets the media stream control transport info.

◆ getInfo()

abstract fm.liveswitch.MediaStreamInfo fm.liveswitch.IMediaStream.getInfo ( )

abstract

Gets the media stream info.

◆ getInputMuted()

abstract boolean fm.liveswitch.IMediaStream.getInputMuted ( )

abstract

Gets whether the input track is muted.

◆ getLocalBandwidth()

abstract int fm.liveswitch.IMediaStream.getLocalBandwidth ( )

abstract

Gets the local bandwidth, in kbps.

This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use fm.liveswitch.IMediaStream#getMaxReceiveBitrate to control inbound media bitrate once the session has been negotiated.

◆ getLocalCanonicalName()

abstract String fm.liveswitch.IMediaStream.getLocalCanonicalName ( )

abstract

Gets the local canonical name.

◆ getMaxReceiveBitrate()

abstract int fm.liveswitch.IMediaStream.getMaxReceiveBitrate ( )

abstract

Gets the maximum desired receive bitrate, in kbps.

This value must be less than or equal to fm.liveswitch.IMediaStream#getLocalBandwidth.

◆ getMaxSendBitrate()

abstract int fm.liveswitch.IMediaStream.getMaxSendBitrate ( )

abstract

Gets the maximum desired send bitrate, in kbps.

This value must be less than or equal to fm.liveswitch.IMediaStream#getRemoteBandwidth.

◆ getOutputMuted()

abstract boolean fm.liveswitch.IMediaStream.getOutputMuted ( )

abstract

Gets whether the output track is muted.

◆ getPreferredCodecs()

abstract String [] fm.liveswitch.IMediaStream.getPreferredCodecs ( )

abstract

Gets any preferred codecs, in order of preference.

◆ getRemoteBandwidth()

abstract int fm.liveswitch.IMediaStream.getRemoteBandwidth ( )

abstract

Gets the remote bandwidth, in kbps.

This value is signalled in the remote session description received from the remote endpoint so we can limit our outbound media bitrate. Use fm.liveswitch.IMediaStream#getMaxSendBitrate to control outbound media bitrate once the session has been negotiated.

◆ getRemoteCanonicalName()

abstract String fm.liveswitch.IMediaStream.getRemoteCanonicalName ( )

abstract

Gets the remote canonical name.

◆ getRemoteEncoding()

abstract fm.liveswitch.EncodingInfo fm.liveswitch.IMediaStream.getRemoteEncoding ( )

abstract

Gets the remote encoding.

◆ getRemoteMuted()

abstract boolean fm.liveswitch.IMediaStream.getRemoteMuted ( )

abstract

Gets a value that indicates if remote is muted.

◆ getRemoteRequestedDeactivation()

abstract boolean fm.liveswitch.IMediaStream.getRemoteRequestedDeactivation ( )

abstract

Gets Boolean value set when the server is currently requesting a 0 bitrate.

This is to highlight the difference between when a stream is deactivated locally or by a control mechanism on the server. Internal Use

◆ getSimulcastMode()

abstract fm.liveswitch.SimulcastMode fm.liveswitch.IMediaStream.getSimulcastMode ( )

abstract

Gets the simulcast mode.

◆ raiseBitrateNotification()

abstract boolean fm.liveswitch.IMediaStream.raiseBitrateNotification ( fm.liveswitch.BitrateNotification bitrateNotification )

abstract

Raises a bitrate notification to the remote track.

Parameters

bitrateNotification The bitrate notification.

◆ raiseBitrateRequest()

abstract boolean fm.liveswitch.IMediaStream.raiseBitrateRequest ( fm.liveswitch.BitrateRequest bitrateRequest )

abstract

Raises a bitrate request to the local track.

Parameters

bitrateRequest The bitrate request.

◆ removeOnDiscardBitrateNotification()

abstract void fm.liveswitch.IMediaStream.removeOnDiscardBitrateNotification ( fm.liveswitch.IAction1< fm.liveswitch.BitrateNotification > value )

abstract

Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ removeOnDiscardBitrateRequest()

abstract void fm.liveswitch.IMediaStream.removeOnDiscardBitrateRequest ( fm.liveswitch.IAction1< fm.liveswitch.BitrateRequest > value )

abstract

Removes a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.

◆ removeOnLocalEncodingDisabled()

abstract void fm.liveswitch.IMediaStream.removeOnLocalEncodingDisabled ( fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value )

abstract

Removes a handler that is raised when a local encoding is disabled.

◆ removeOnLocalEncodingEnabled()

abstract void fm.liveswitch.IMediaStream.removeOnLocalEncodingEnabled ( fm.liveswitch.IAction1< fm.liveswitch.EncodingInfo > value )

abstract

Removes a handler that is raised when a local encoding is enabled.

◆ setCodecDisabled()

abstract void fm.liveswitch.IMediaStream.setCodecDisabled	(	String	name,
		boolean	disabled
	)

abstract

Sets whether a codec is disabled.

Parameters

name	The codec name.
disabled	Whether to disable the codec.

◆ setInputMuted()

abstract void fm.liveswitch.IMediaStream.setInputMuted ( boolean value )

abstract

Sets whether the input track is muted.

◆ setLocalBandwidth()

abstract void fm.liveswitch.IMediaStream.setLocalBandwidth ( int value )

abstract

Sets the local bandwidth, in kbps.

This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use fm.liveswitch.IMediaStream#getMaxReceiveBitrate to control inbound media bitrate once the session has been negotiated.

◆ setMaxReceiveBitrate()

abstract void fm.liveswitch.IMediaStream.setMaxReceiveBitrate ( int value )

abstract

Sets the maximum desired receive bitrate, in kbps.

This value must be less than or equal to fm.liveswitch.IMediaStream#getLocalBandwidth.

◆ setMaxSendBitrate()

abstract void fm.liveswitch.IMediaStream.setMaxSendBitrate ( int value )

abstract

Sets the maximum desired send bitrate, in kbps.

This value must be less than or equal to fm.liveswitch.IMediaStream#getRemoteBandwidth.

◆ setOutputMuted()

abstract void fm.liveswitch.IMediaStream.setOutputMuted ( boolean value )

abstract

Sets whether the output track is muted.

◆ setPreferredCodecs()

abstract void fm.liveswitch.IMediaStream.setPreferredCodecs ( String[] value )

abstract

Sets any preferred codecs, in order of preference.

◆ setRemoteEncoding()

abstract void fm.liveswitch.IMediaStream.setRemoteEncoding ( fm.liveswitch.EncodingInfo value )

abstract

Sets the remote encoding.

◆ setRemoteMuted()

abstract void fm.liveswitch.IMediaStream.setRemoteMuted ( boolean value )

abstract

Sets a value that indicates if remote is muted.

◆ setSimulcastMode()

abstract void fm.liveswitch.IMediaStream.setSimulcastMode ( fm.liveswitch.SimulcastMode value )

abstract

Sets the simulcast mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ addOnDiscardBitrateNotification()

◆ addOnDiscardBitrateRequest()

◆ addOnLocalEncodingDisabled()

◆ addOnLocalEncodingEnabled()

◆ getCachedLocalDirection()

◆ getCodecDisabled()

◆ getControlTransportInfo()

◆ getInfo()

◆ getInputMuted()

◆ getLocalBandwidth()

◆ getLocalCanonicalName()

◆ getMaxReceiveBitrate()

◆ getMaxSendBitrate()

◆ getOutputMuted()

◆ getPreferredCodecs()

◆ getRemoteBandwidth()

◆ getRemoteCanonicalName()

◆ getRemoteEncoding()

◆ getRemoteMuted()

◆ getRemoteRequestedDeactivation()

◆ getSimulcastMode()

◆ raiseBitrateNotification()

◆ raiseBitrateRequest()

◆ removeOnDiscardBitrateNotification()

◆ removeOnDiscardBitrateRequest()

◆ removeOnLocalEncodingDisabled()

◆ removeOnLocalEncodingEnabled()

◆ setCodecDisabled()

◆ setInputMuted()

◆ setLocalBandwidth()

◆ setMaxReceiveBitrate()

◆ setMaxSendBitrate()

◆ setOutputMuted()

◆ setPreferredCodecs()

◆ setRemoteEncoding()

◆ setRemoteMuted()

◆ setSimulcastMode()