fm.liveswitch.MediaTrackBase Class Referenceabstract

Media track base properties/methods. More...

Public Member Functions

abstract void addOnDestroyed (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the track is destroyed. More...
 
abstract void addOnMuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the track is muted. More...
 
abstract void addOnStarted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the track is started. More...
 
abstract void addOnStopped (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the track is stopped. More...
 
abstract void addOnUnmuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the track is unmuted. More...
 
abstract fm.liveswitch.Future< Object > changeSinkOutput (fm.liveswitch.SinkOutput sinkOutput)
 Changes the sink output while the media track is active. More...
 
abstract fm.liveswitch.Future< Object > changeSourceInput (fm.liveswitch.SourceInput sourceInput)
 Changes the source input while the media track is active. More...
 
abstract boolean destroy ()
 Destroys this media track. More...
 
abstract boolean getMuted ()
 Gets a value indicating whether this track is muted. More...
 
abstract fm.liveswitch.SinkOutput getSinkOutput ()
 Gets the current sink output. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.SinkOutput[]> getSinkOutputs ()
 Gets the available sink outputs. More...
 
abstract fm.liveswitch.SourceInput getSourceInput ()
 Gets the current source input. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.SourceInput[]> getSourceInputs ()
 Gets the available source inputs. More...
 
abstract void removeOnDestroyed (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the track is destroyed. More...
 
abstract void removeOnMuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the track is muted. More...
 
abstract void removeOnStarted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the track is started. More...
 
abstract void removeOnStopped (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the track is stopped. More...
 
abstract void removeOnUnmuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the track is unmuted. More...
 
abstract void setMuted (boolean value)
 Sets a value indicating whether this track is muted. More...
 
abstract void setSinkOutput (fm.liveswitch.SinkOutput value)
 Sets the current sink output. More...
 
abstract void setSourceInput (fm.liveswitch.SourceInput value)
 Sets the current source input. 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

 MediaTrackBase ()
 
- 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 track base properties/methods.

Constructor & Destructor Documentation

◆ MediaTrackBase()

fm.liveswitch.MediaTrackBase.MediaTrackBase ( )
protected

Member Function Documentation

◆ addOnDestroyed()

abstract void fm.liveswitch.MediaTrackBase.addOnDestroyed ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the track is destroyed.

Implements fm.liveswitch.IMediaTrack.

◆ addOnMuted()

abstract void fm.liveswitch.MediaTrackBase.addOnMuted ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the track is muted.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ addOnStarted()

abstract void fm.liveswitch.MediaTrackBase.addOnStarted ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the track is started.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ addOnStopped()

abstract void fm.liveswitch.MediaTrackBase.addOnStopped ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the track is stopped.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ addOnUnmuted()

abstract void fm.liveswitch.MediaTrackBase.addOnUnmuted ( fm.liveswitch.IAction0  value)
abstract

Adds a handler that is raised when the track is unmuted.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ changeSinkOutput()

abstract fm.liveswitch.Future<Object> fm.liveswitch.MediaTrackBase.changeSinkOutput ( fm.liveswitch.SinkOutput  sinkOutput)
abstract

Changes the sink output while the media track is active.

Parameters
sinkOutputThe sink output.

Implements fm.liveswitch.IMediaTrack.

◆ changeSourceInput()

abstract fm.liveswitch.Future<Object> fm.liveswitch.MediaTrackBase.changeSourceInput ( fm.liveswitch.SourceInput  sourceInput)
abstract

Changes the source input while the media track is active.

Parameters
sourceInputThe source input.

Implements fm.liveswitch.IMediaTrack.

◆ destroy()

abstract boolean fm.liveswitch.MediaTrackBase.destroy ( )
abstract

Destroys this media track.

Implements fm.liveswitch.IMediaTrack.

◆ getMuted()

abstract boolean fm.liveswitch.MediaTrackBase.getMuted ( )
abstract

Gets a value indicating whether this track is muted.

Implements fm.liveswitch.IMediaTrack.

◆ getSinkOutput()

abstract fm.liveswitch.SinkOutput fm.liveswitch.MediaTrackBase.getSinkOutput ( )
abstract

Gets the current sink output.

Implements fm.liveswitch.IMediaTrack.

◆ getSinkOutputs()

abstract fm.liveswitch.Future<fm.liveswitch.SinkOutput[]> fm.liveswitch.MediaTrackBase.getSinkOutputs ( )
abstract

Gets the available sink outputs.

Returns
A future with an array of sink outputs.

Implements fm.liveswitch.IMediaTrack.

◆ getSourceInput()

abstract fm.liveswitch.SourceInput fm.liveswitch.MediaTrackBase.getSourceInput ( )
abstract

Gets the current source input.

Implements fm.liveswitch.IMediaTrack.

◆ getSourceInputs()

abstract fm.liveswitch.Future<fm.liveswitch.SourceInput[]> fm.liveswitch.MediaTrackBase.getSourceInputs ( )
abstract

Gets the available source inputs.

Returns
A future with an array of source inputs.

Implements fm.liveswitch.IMediaTrack.

◆ removeOnDestroyed()

abstract void fm.liveswitch.MediaTrackBase.removeOnDestroyed ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the track is destroyed.

Implements fm.liveswitch.IMediaTrack.

◆ removeOnMuted()

abstract void fm.liveswitch.MediaTrackBase.removeOnMuted ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the track is muted.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ removeOnStarted()

abstract void fm.liveswitch.MediaTrackBase.removeOnStarted ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the track is started.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ removeOnStopped()

abstract void fm.liveswitch.MediaTrackBase.removeOnStopped ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the track is stopped.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ removeOnUnmuted()

abstract void fm.liveswitch.MediaTrackBase.removeOnUnmuted ( fm.liveswitch.IAction0  value)
abstract

Removes a handler that is raised when the track is unmuted.

Only applicable for local media tracks.

Implements fm.liveswitch.IMediaTrack.

◆ setMuted()

abstract void fm.liveswitch.MediaTrackBase.setMuted ( boolean  value)
abstract

Sets a value indicating whether this track is muted.

Implements fm.liveswitch.IMediaTrack.

◆ setSinkOutput()

abstract void fm.liveswitch.MediaTrackBase.setSinkOutput ( fm.liveswitch.SinkOutput  value)
abstract

Sets the current sink output.

Implements fm.liveswitch.IMediaTrack.

◆ setSourceInput()

abstract void fm.liveswitch.MediaTrackBase.setSourceInput ( fm.liveswitch.SourceInput  value)
abstract

Sets the current source input.

Implements fm.liveswitch.IMediaTrack.