fm.liveswitch.IMediaTrack Interface Reference

Media track interface. 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...
 

Detailed Description

Media track interface.

Member Function Documentation

◆ addOnDestroyed()

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

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

Implemented in fm.liveswitch.MediaTrackBase.

◆ addOnMuted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ addOnStarted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ addOnStopped()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ addOnUnmuted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ changeSinkOutput()

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

Changes the sink output while the media track is active.

Parameters
sinkOutputThe sink output.

Implemented in fm.liveswitch.MediaTrackBase.

◆ changeSourceInput()

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

Changes the source input while the media track is active.

Parameters
sourceInputThe source input.

Implemented in fm.liveswitch.MediaTrackBase.

◆ destroy()

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

Destroys this media track.

Implemented in fm.liveswitch.MediaTrackBase.

◆ getMuted()

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

Gets a value indicating whether this track is muted.

Implemented in fm.liveswitch.MediaTrackBase.

◆ getSinkOutput()

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

Gets the current sink output.

Implemented in fm.liveswitch.MediaTrackBase.

◆ getSinkOutputs()

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

Gets the available sink outputs.

Returns
A future with an array of sink outputs.

Implemented in fm.liveswitch.MediaTrackBase.

◆ getSourceInput()

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

Gets the current source input.

Implemented in fm.liveswitch.MediaTrackBase.

◆ getSourceInputs()

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

Gets the available source inputs.

Returns
A future with an array of source inputs.

Implemented in fm.liveswitch.MediaTrackBase.

◆ removeOnDestroyed()

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

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

Implemented in fm.liveswitch.MediaTrackBase.

◆ removeOnMuted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ removeOnStarted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ removeOnStopped()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ removeOnUnmuted()

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

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

Only applicable for local media tracks.

Implemented in fm.liveswitch.MediaTrackBase.

◆ setMuted()

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

Sets a value indicating whether this track is muted.

Implemented in fm.liveswitch.MediaTrackBase.

◆ setSinkOutput()

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

Sets the current sink output.

Implemented in fm.liveswitch.MediaTrackBase.

◆ setSourceInput()

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

Sets the current source input.

Implemented in fm.liveswitch.MediaTrackBase.