Media stream base properties/methods. More...

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

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

void	addOnMaxSendBitrateChange (fm.liveswitch.IAction1< Integer > value)

fm.liveswitch.Error	changeDirection (fm.liveswitch.StreamDirection newDirection)
	Records the pending direction of this stream. More...

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

String	getCanonicalName ()
	Gets the canonical name. More...

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

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

fm.liveswitch.StreamDirection	getDirection ()

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

String	getInputContent ()
	Gets the input content descriptor. More...

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

String	getLabel ()
	Gets a label that identifies this class. More...

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

String	getLocalCanonicalName ()
	Gets the local canonical end-point identifier (CNAME) used by RTCP. More...

fm.liveswitch.StreamDirection	getLocalDirection ()
	Gets current direction indicated by the local description. More...

boolean	getLocalMuted ()
	Gets a value indicating whether the local stream is muted. More...

int	getMaxReceiveBitrate ()
	Gets the maximum bitrate that the connection receives in Kbps. More...

int	getMaxSendBitrate ()
	Gets the maximum bitrate that the upstream connection sends in Kbps. More...

boolean	getMuted ()
	Gets whether the stream is muted. More...

String	getOutputContent ()
	Gets the output content descriptor. More...

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

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

int	getRemoteBandwidth ()
	Gets the remote bandwidth in Kbps. More...

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

fm.liveswitch.StreamDirection	getRemoteDirection ()
	Gets current direction indicated by the remote description. More...

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

boolean	getRemoteMuted ()
	Gets a value indicating if remote is muted. More...

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...

	MediaStreamBase (fm.liveswitch.StreamType type)
	Initializes a new instance of the fm.liveswitch.MediaStreamBase class. More...

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

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

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

void	removeOnMaxSendBitrateChange (fm.liveswitch.IAction1< Integer > value)

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...

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

void	setLocalDirection (fm.liveswitch.StreamDirection value)
	Sets current direction indicated by the local description. More...

void	setLocalMuted (boolean value)
	Sets a value indicating whether the local stream is muted. More...

void	setMaxReceiveBitrate (int value)
	Sets the maximum bitrate that the connection receives in Kbps. More...

void	setMaxSendBitrate (int value)
	Sets the maximum bitrate that the upstream connection sends in Kbps. More...

void	setMuted (boolean value)
	Sets whether the stream is muted. More...

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

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

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

void	setRemoteMuted (boolean value)
	Sets a value indicating if remote is muted. More...

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

Public Member Functions inherited from fm.liveswitch.Stream
void	addOnDisabledChange (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the Disabled property changes state. More...

void	addOnDisabledChangeWithCaller (fm.liveswitch.IAction1< Object > 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	removeOnDisabledChangeWithCaller (fm.liveswitch.IAction1< Object > 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 changes. More...

void	addOnStateChange (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the connection state changes. More...

String	getConnectionId ()
	Gets the connection identifier. 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...

boolean	getLocalReceive ()
	Gets a value indicating whether the local peer supports receiving media on this stream. More...

boolean	getLocalSend ()
	Gets a value indicating whether the local peer on this stream supports sending media on this stream. More...

String	getMediaDescriptionId ()
	Gets the media description ID of this stream. More...

boolean	getRemoteReceive ()
	Gets a value indicating whether receiving media is supported by the remote 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...

boolean	getUseWssForMedia ()
	Gets a value indicating whether W. More...

void	removeOnDirectionChange (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the stream direction changes. More...

void	removeOnStateChange (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the connection state changes. More...

void	setExternalId (String value)
	Sets the external identifier. More...

void	setLocalReceive (boolean value)
	Sets a value indicating whether the local peer supports receiving media on this stream. More...

void	setLocalSend (boolean value)
	Sets a value indicating whether the local peer on this stream supports sending media on this stream. More...

void	setTag (String value)
	Sets optional data to associate with this instance. More...

void	setUseWssForMedia (boolean value)
	Sets a value indicating whether W. 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 all 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)
	Removes a property value from the local cache. More...

Protected Member Functions
void	extractCanonicalName (fm.liveswitch.sdp.MediaDescription mediaDescription, boolean isLocalDescription)
	Extracts Canonical Name from SDP and sets it to the appropreate Stream property. More...

fm.liveswitch.StreamDirection	getPendingLocalDirection ()
	Gets the pending local direction. More...

fm.liveswitch.sdp.MediaDescription	getRelatedMediaDescription ()
	Gets related SDP Media Description. More...

boolean	getRenegotiationPending ()
	Gets whether there exist changes that are pending SDP renegotiation. More...

abstract void	populateInfo (fm.liveswitch.MediaStreamInfo info)
	Populates the media stream info. More...

void	raiseLocalEncodingDisabled (fm.liveswitch.EncodingInfo encoding)
	Raises the OnLocalEncodingDisabled event. More...

void	raiseLocalEncodingEnabled (fm.liveswitch.EncodingInfo encoding)
	Raises the OnLocalEncodingEnabled event. More...

void	setInputContent (String value)
	Sets the input content descriptor. More...

void	setOutputContent (String value)
	Sets the output content descriptor. More...

void	setPendingLocalDirection (fm.liveswitch.StreamDirection value)
	Sets the pending local direction. More...

void	setRelatedMediaDescription (fm.liveswitch.sdp.MediaDescription value)
	Sets related SDP Media Description. More...

void	setRemoteBandwidth (int value)
	Sets the remote bandwidth in Kbps. More...

void	setRenegotiationPending (boolean value)
	Sets whether there exist changes that are pending SDP renegotiation. More...

Protected Member Functions inherited from fm.liveswitch.Stream
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...

fm.liveswitch.LogContext	getLogContext ()
	Gets the log context for this connection. 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

Media stream base properties/methods.

Constructor & Destructor Documentation

◆ MediaStreamBase()

fm.liveswitch.MediaStreamBase.MediaStreamBase ( fm.liveswitch.StreamType type )

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

Parameters

type The type.

Member Function Documentation

◆ addOnLocalEncodingDisabled()

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

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

◆ addOnLocalEncodingEnabled()

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

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

◆ addOnMaxSendBitrateChange()

void fm.liveswitch.MediaStreamBase.addOnMaxSendBitrateChange ( fm.liveswitch.IAction1< Integer > value )

◆ changeDirection()

fm.liveswitch.Error fm.liveswitch.MediaStreamBase.changeDirection ( fm.liveswitch.StreamDirection newDirection )

Records the pending direction of this stream.

The LocalDirection of this stream will be updated when the connection renegotiation commences.

Reimplemented from fm.liveswitch.StreamBase.

◆ extractCanonicalName()

void fm.liveswitch.MediaStreamBase.extractCanonicalName	(	fm.liveswitch.sdp.MediaDescription	mediaDescription,
		boolean	isLocalDescription
	)

protected

Extracts Canonical Name from SDP and sets it to the appropreate Stream property.

Parameters

mediaDescription	Media description to process.
isLocalDescription	Flag indicating if this description is local.

◆ getCachedLocalDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaStreamBase.getCachedLocalDirection ( )

Gets Cached Local Direction for this Media Stream.

Internal use.

◆ getCanonicalName()

String fm.liveswitch.MediaStreamBase.getCanonicalName ( )

Gets the canonical name.

Deprecated:: Use LocalCanonicalName instead.

◆ getCodecDisabled()

boolean fm.liveswitch.MediaStreamBase.getCodecDisabled ( String name )

Gets whether a codec is disabled.

Parameters

name	The codec name.

Returns: Whether the codec is disabled.

◆ getControlTransportInfo()

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

abstract

Gets control transport info.

◆ getDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaStreamBase.getDirection ( )

Returns: The Media Direction as a StreamDirection enumerator.

Reimplemented from fm.liveswitch.StreamBase.

◆ getInfo()

fm.liveswitch.MediaStreamInfo fm.liveswitch.MediaStreamBase.getInfo ( )

Gets the media stream info.

◆ getInputContent()

String fm.liveswitch.MediaStreamBase.getInputContent ( )

Gets the input content descriptor.

◆ getInputMuted()

abstract boolean fm.liveswitch.MediaStreamBase.getInputMuted ( )

abstract

Gets whether the input track is muted.

◆ getLabel()

String fm.liveswitch.MediaStreamBase.getLabel ( )

Gets a label that identifies this class.

Reimplemented from fm.liveswitch.StreamBase.

◆ getLocalBandwidth()

int fm.liveswitch.MediaStreamBase.getLocalBandwidth ( )

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.MediaStreamBase#getMaxReceiveBitrate to control inbound media bitrate once the session has been negotiated.

◆ getLocalCanonicalName()

String fm.liveswitch.MediaStreamBase.getLocalCanonicalName ( )

Gets the local canonical end-point identifier (CNAME) used by RTCP.

The CNAME is a unique identifier for endpoints across an application instance and can be used for third-party monitoring.

◆ getLocalDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaStreamBase.getLocalDirection ( )

Gets current direction indicated by the local description.

Reimplemented from fm.liveswitch.StreamBase.

◆ getLocalMuted()

boolean fm.liveswitch.MediaStreamBase.getLocalMuted ( )

Gets a value indicating whether the local stream is muted.

A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for fm.liveswitch.MediaStreamBase#getMuted.

◆ getMaxReceiveBitrate()

int fm.liveswitch.MediaStreamBase.getMaxReceiveBitrate ( )

Gets the maximum bitrate that the connection receives in Kbps.

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

◆ getMaxSendBitrate()

int fm.liveswitch.MediaStreamBase.getMaxSendBitrate ( )

Gets the maximum bitrate that the upstream connection sends in Kbps.

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

◆ getMuted()

boolean fm.liveswitch.MediaStreamBase.getMuted ( )

Gets whether the stream is muted.

A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
Alias for fm.liveswitch.MediaStreamBase#getInputMuted.

◆ getOutputContent()

String fm.liveswitch.MediaStreamBase.getOutputContent ( )

Gets the output content descriptor.

◆ getOutputMuted()

abstract boolean fm.liveswitch.MediaStreamBase.getOutputMuted ( )

abstract

Gets whether the output track is muted.

A muted stream does not show or play media, but the source is not disabled and its data continues to flow through the processing pipeline.

◆ getPendingLocalDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaStreamBase.getPendingLocalDirection ( )

protected

Gets the pending local direction.

◆ getPreferredCodecs()

String [] fm.liveswitch.MediaStreamBase.getPreferredCodecs ( )

Gets any preferred codecs, in order of preference.

◆ getRelatedMediaDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.MediaStreamBase.getRelatedMediaDescription ( )

protected

Gets related SDP Media Description.

◆ getRemoteBandwidth()

int fm.liveswitch.MediaStreamBase.getRemoteBandwidth ( )

Gets the remote bandwidth in Kbps.

This value is signalled in the remote session description received from the remote endpoint.
Use fm.liveswitch.MediaStreamBase#getMaxSendBitrate to control outbound media bitrate once the session has been negotiated.

◆ getRemoteCanonicalName()

String fm.liveswitch.MediaStreamBase.getRemoteCanonicalName ( )

Gets the remote canonical name.

◆ getRemoteDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaStreamBase.getRemoteDirection ( )

Gets current direction indicated by the remote description.

Reimplemented from fm.liveswitch.StreamBase.

◆ getRemoteEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.MediaStreamBase.getRemoteEncoding ( )

Gets the remote encoding.

◆ getRemoteMuted()

boolean fm.liveswitch.MediaStreamBase.getRemoteMuted ( )

Gets a value indicating if remote is muted.

◆ getRemoteRequestedDeactivation()

boolean fm.liveswitch.MediaStreamBase.getRemoteRequestedDeactivation ( )

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

◆ getRenegotiationPending()

boolean fm.liveswitch.MediaStreamBase.getRenegotiationPending ( )

protected

Gets whether there exist changes that are pending SDP renegotiation.

◆ getSimulcastMode()

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

abstract

Gets the simulcast mode.

◆ populateInfo()

abstract void fm.liveswitch.MediaStreamBase.populateInfo ( fm.liveswitch.MediaStreamInfo info )

abstractprotected

Populates the media stream info.

Parameters

info

◆ raiseBitrateRequest()

boolean fm.liveswitch.MediaStreamBase.raiseBitrateRequest ( fm.liveswitch.BitrateRequest bitrateRequest )

Raises a bitrate request to the local track.

Parameters

bitrateRequest The bitrate request.

◆ raiseLocalEncodingDisabled()

void fm.liveswitch.MediaStreamBase.raiseLocalEncodingDisabled ( fm.liveswitch.EncodingInfo encoding )

protected

Raises the OnLocalEncodingDisabled event.

Parameters

encoding The encoding.

◆ raiseLocalEncodingEnabled()

void fm.liveswitch.MediaStreamBase.raiseLocalEncodingEnabled ( fm.liveswitch.EncodingInfo encoding )

protected

Raises the OnLocalEncodingEnabled event.

Parameters

encoding The encoding.

◆ removeOnLocalEncodingDisabled()

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

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

◆ removeOnLocalEncodingEnabled()

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

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

◆ removeOnMaxSendBitrateChange()

void fm.liveswitch.MediaStreamBase.removeOnMaxSendBitrateChange ( fm.liveswitch.IAction1< Integer > value )

◆ setCodecDisabled()

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

Sets whether a codec is disabled.

Parameters

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

◆ setInputContent()

void fm.liveswitch.MediaStreamBase.setInputContent ( String value )

protected

Sets the input content descriptor.

◆ setInputMuted()

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

abstract

Sets whether the input track is muted.

◆ setLocalBandwidth()

void fm.liveswitch.MediaStreamBase.setLocalBandwidth ( int value )

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.MediaStreamBase#getMaxReceiveBitrate to control inbound media bitrate once the session has been negotiated.

◆ setLocalDirection()

void fm.liveswitch.MediaStreamBase.setLocalDirection ( fm.liveswitch.StreamDirection value )

Sets current direction indicated by the local description.

Reimplemented from fm.liveswitch.StreamBase.

◆ setLocalMuted()

void fm.liveswitch.MediaStreamBase.setLocalMuted ( boolean value )

Sets a value indicating whether the local stream is muted.

A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for fm.liveswitch.MediaStreamBase#getMuted.

◆ setMaxReceiveBitrate()

void fm.liveswitch.MediaStreamBase.setMaxReceiveBitrate ( int value )

Sets the maximum bitrate that the connection receives in Kbps.

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

◆ setMaxSendBitrate()

void fm.liveswitch.MediaStreamBase.setMaxSendBitrate ( int value )

Sets the maximum bitrate that the upstream connection sends in Kbps.

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

◆ setMuted()

void fm.liveswitch.MediaStreamBase.setMuted ( boolean value )

Sets whether the stream is muted.

A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
Alias for fm.liveswitch.MediaStreamBase#getInputMuted.

◆ setOutputContent()

void fm.liveswitch.MediaStreamBase.setOutputContent ( String value )

protected

Sets the output content descriptor.

◆ setOutputMuted()

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

abstract

Sets whether the output track is muted.

A muted stream does not show or play media, but the source is not disabled and its data continues to flow through the processing pipeline.

◆ setPendingLocalDirection()

void fm.liveswitch.MediaStreamBase.setPendingLocalDirection ( fm.liveswitch.StreamDirection value )

protected

Sets the pending local direction.

◆ setPreferredCodecs()

void fm.liveswitch.MediaStreamBase.setPreferredCodecs ( String[] value )

Sets any preferred codecs, in order of preference.

◆ setRelatedMediaDescription()

void fm.liveswitch.MediaStreamBase.setRelatedMediaDescription ( fm.liveswitch.sdp.MediaDescription value )

protected

Sets related SDP Media Description.

◆ setRemoteBandwidth()

void fm.liveswitch.MediaStreamBase.setRemoteBandwidth ( int value )

protected

Sets the remote bandwidth in Kbps.

This value is signalled in the remote session description received from the remote endpoint.
Use fm.liveswitch.MediaStreamBase#getMaxSendBitrate to control outbound media bitrate once the session has been negotiated.

◆ setRemoteEncoding()

void fm.liveswitch.MediaStreamBase.setRemoteEncoding ( fm.liveswitch.EncodingInfo value )

Sets the remote encoding.

◆ setRemoteMuted()

void fm.liveswitch.MediaStreamBase.setRemoteMuted ( boolean value )

Sets a value indicating if remote is muted.

◆ setRenegotiationPending()

void fm.liveswitch.MediaStreamBase.setRenegotiationPending ( boolean value )

protected

Sets whether there exist changes that are pending SDP renegotiation.

◆ setSimulcastMode()

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

abstract

Sets the simulcast mode.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MediaStreamBase()

Member Function Documentation

◆ addOnLocalEncodingDisabled()

◆ addOnLocalEncodingEnabled()

◆ addOnMaxSendBitrateChange()

◆ changeDirection()

◆ extractCanonicalName()

◆ getCachedLocalDirection()

◆ getCanonicalName()

◆ getCodecDisabled()

◆ getControlTransportInfo()

◆ getDirection()

◆ getInfo()

◆ getInputContent()

◆ getInputMuted()

◆ getLabel()

◆ getLocalBandwidth()

◆ getLocalCanonicalName()

◆ getLocalDirection()

◆ getLocalMuted()

◆ getMaxReceiveBitrate()

◆ getMaxSendBitrate()

◆ getMuted()

◆ getOutputContent()

◆ getOutputMuted()

◆ getPendingLocalDirection()

◆ getPreferredCodecs()

◆ getRelatedMediaDescription()

◆ getRemoteBandwidth()

◆ getRemoteCanonicalName()

◆ getRemoteDirection()

◆ getRemoteEncoding()

◆ getRemoteMuted()

◆ getRemoteRequestedDeactivation()

◆ getRenegotiationPending()

◆ getSimulcastMode()

◆ populateInfo()

◆ raiseBitrateRequest()

◆ raiseLocalEncodingDisabled()

◆ raiseLocalEncodingEnabled()

◆ removeOnLocalEncodingDisabled()

◆ removeOnLocalEncodingEnabled()

◆ removeOnMaxSendBitrateChange()

◆ setCodecDisabled()

◆ setInputContent()

◆ setInputMuted()

◆ setLocalBandwidth()

◆ setLocalDirection()

◆ setLocalMuted()

◆ setMaxReceiveBitrate()

◆ setMaxSendBitrate()

◆ setMuted()

◆ setOutputContent()

◆ setOutputMuted()

◆ setPendingLocalDirection()

◆ setPreferredCodecs()

◆ setRelatedMediaDescription()

◆ setRemoteBandwidth()

◆ setRemoteEncoding()

◆ setRemoteMuted()

◆ setRenegotiationPending()

◆ setSimulcastMode()