fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack > Interface Template Reference

Media interface. More...

Public Member Functions

abstract void addOnAudioDestroyed (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is destroyed. More...
 
abstract void addOnAudioLevel (fm.liveswitch.IAction1< Double > value)
 Adds a handler that is raised periodically when the audio's level is calculated. More...
 
abstract void addOnVideoDestroyed (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is destroyed. More...
 
abstract void addOnVideoSize (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Adds a handler that is raised whenever the video's frame size is known, once per frame. More...
 
abstract void addOnVideoSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Adds a handler that is raised whenever the video's frame size changes. More...
 
abstract void destroy ()
 Destroys this media stack. More...
 
abstract double getAudioGain ()
 Gets a value indicating the audio gain (input amplification). More...
 
abstract int getAudioLevelInterval ()
 Gets the interval in milliseconds between fm.liveswitch.IMedia#addOnAudioLevel events. More...
 
abstract boolean getAudioMuted ()
 Gets a value indicating whether the audio is muted. More...
 
abstract TIAudioTrack getAudioTrack ()
 Gets the audio track. More...
 
abstract TIAudioTrack[] getAudioTracks ()
 Gets the audio tracks. More...
 
abstract double getAudioVolume ()
 Gets a value indicating the audio volume (output resistance). More...
 
abstract String getId ()
 Gets the identifier. More...
 
abstract boolean getVideoMuted ()
 Gets a value indicating whether the video is muted. More...
 
abstract fm.liveswitch.Size getVideoSize ()
 Gets the size of the last processed video frame, if known. More...
 
abstract TIVideoTrack getVideoTrack ()
 Gets the video track. More...
 
abstract TIVideoTrack[] getVideoTracks ()
 Gets the video tracks. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.VideoBuffergrabVideoFrame ()
 Gets the next raw video frame. More...
 
abstract void removeOnAudioDestroyed (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is destroyed. More...
 
abstract void removeOnAudioLevel (fm.liveswitch.IAction1< Double > value)
 Removes a handler that is raised periodically when the audio's level is calculated. More...
 
abstract void removeOnVideoDestroyed (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is destroyed. More...
 
abstract void removeOnVideoSize (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Removes a handler that is raised whenever the video's frame size is known, once per frame. More...
 
abstract void removeOnVideoSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Removes a handler that is raised whenever the video's frame size changes. More...
 
abstract void setAudioGain (double value)
 Sets a value indicating the audio gain (input amplification). More...
 
abstract void setAudioLevelInterval (int value)
 Sets the interval in milliseconds between fm.liveswitch.IMedia#addOnAudioLevel events. More...
 
abstract void setAudioMuted (boolean value)
 Sets a value indicating whether the audio is muted. More...
 
abstract void setAudioVolume (double value)
 Sets a value indicating the audio volume (output resistance). More...
 
abstract void setId (String value)
 Sets the identifier. More...
 
abstract void setVideoMuted (boolean value)
 Sets a value indicating whether the video is muted. More...
 

Detailed Description

Media interface.

Member Function Documentation

◆ addOnAudioDestroyed()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.addOnAudioDestroyed ( fm.liveswitch.IAction0  value)
abstract

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

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

◆ addOnAudioLevel()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.addOnAudioLevel ( fm.liveswitch.IAction1< Double >  value)
abstract

Adds a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

◆ addOnVideoDestroyed()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.addOnVideoDestroyed ( fm.liveswitch.IAction0  value)
abstract

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

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ addOnVideoSize()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.addOnVideoSize ( fm.liveswitch.IAction1< fm.liveswitch.Size value)
abstract

Adds a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ addOnVideoSizeChange()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.addOnVideoSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)
abstract

Adds a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ destroy()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.destroy ( )
abstract

Destroys this media stack.

◆ getAudioGain()

abstract double fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioGain ( )
abstract

Gets a value indicating the audio gain (input amplification).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ getAudioLevelInterval()

abstract int fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioLevelInterval ( )
abstract

Gets the interval in milliseconds between fm.liveswitch.IMedia#addOnAudioLevel events.

◆ getAudioMuted()

abstract boolean fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioMuted ( )
abstract

Gets a value indicating whether the audio is muted.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ getAudioTrack()

abstract TIAudioTrack fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioTrack ( )
abstract

Gets the audio track.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ getAudioTracks()

abstract TIAudioTrack [] fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioTracks ( )
abstract

Gets the audio tracks.

◆ getAudioVolume()

abstract double fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getAudioVolume ( )
abstract

Gets a value indicating the audio volume (output resistance).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ getId()

abstract String fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getId ( )
abstract

Gets the identifier.

◆ getVideoMuted()

abstract boolean fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getVideoMuted ( )
abstract

Gets a value indicating whether the video is muted.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

◆ getVideoSize()

abstract fm.liveswitch.Size fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getVideoSize ( )
abstract

Gets the size of the last processed video frame, if known.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

◆ getVideoTrack()

abstract TIVideoTrack fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getVideoTrack ( )
abstract

Gets the video track.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

◆ getVideoTracks()

abstract TIVideoTrack [] fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.getVideoTracks ( )
abstract

Gets the video tracks.

◆ grabVideoFrame()

abstract fm.liveswitch.Future<fm.liveswitch.VideoBuffer> fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.grabVideoFrame ( )
abstract

Gets the next raw video frame.

If there are multiple video tracks in a custom media stack, this method calls into the first video track.

Returns
A future video buffer.

◆ removeOnAudioDestroyed()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.removeOnAudioDestroyed ( fm.liveswitch.IAction0  value)
abstract

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

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

◆ removeOnAudioLevel()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.removeOnAudioLevel ( fm.liveswitch.IAction1< Double >  value)
abstract

Removes a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

◆ removeOnVideoDestroyed()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.removeOnVideoDestroyed ( fm.liveswitch.IAction0  value)
abstract

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

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ removeOnVideoSize()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.removeOnVideoSize ( fm.liveswitch.IAction1< fm.liveswitch.Size value)
abstract

Removes a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ removeOnVideoSizeChange()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.removeOnVideoSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)
abstract

Removes a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

◆ setAudioGain()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setAudioGain ( double  value)
abstract

Sets a value indicating the audio gain (input amplification).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ setAudioLevelInterval()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setAudioLevelInterval ( int  value)
abstract

Sets the interval in milliseconds between fm.liveswitch.IMedia#addOnAudioLevel events.

◆ setAudioMuted()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setAudioMuted ( boolean  value)
abstract

Sets a value indicating whether the audio is muted.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ setAudioVolume()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setAudioVolume ( double  value)
abstract

Sets a value indicating the audio volume (output resistance).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

◆ setId()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setId ( String  value)
abstract

Sets the identifier.

◆ setVideoMuted()

abstract void fm.liveswitch.IMedia< TIAudioTrack extends fm.liveswitch.IAudioTrack, TIVideoTrack extends fm.liveswitch.IVideoTrack >.setVideoMuted ( boolean  value)
abstract

Sets a value indicating whether the video is muted.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.