fm.liveswitch.LocalMedia Class Reference

A collection of local audio/video tracks. More...

Public Member Functions

void addOnAudioMuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio source is muted. More...
 
void addOnAudioStarted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the first audio track is started. More...
 
void addOnAudioStopped (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the first audio track is stopped. More...
 
void addOnAudioUnmuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio source is unmuted. More...
 
void addOnVideoMuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video source is muted. More...
 
void addOnVideoStarted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the first video track is started. More...
 
void addOnVideoStopped (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the first video track is stopped. More...
 
void addOnVideoUnmuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video source is unmuted. More...
 
fm.liveswitch.Future< Object > changeAudioSourceInput (fm.liveswitch.SourceInput audioSourceInput)
 Changes the audio source input of the audio track while the media is active. More...
 
fm.liveswitch.Future< Object > changeVideoSourceInput (fm.liveswitch.SourceInput videoSourceInput)
 Changes the video source input of the video track while the media is active. More...
 
fm.liveswitch.AudioSource getAudioSource ()
 Gets the audio source. More...
 
fm.liveswitch.SourceInput getAudioSourceInput ()
 Gets the current audio source input of the audio track. More...
 
fm.liveswitch.Future< fm.liveswitch.SourceInput[]> getAudioSourceInputs ()
 Gets a list of the names and IDs of currently available audio devices. More...
 
fm.liveswitch.AudioSource[] getAudioSources ()
 Gets the audio sources. More...
 
fm.liveswitch.MediaSourceBase[] getMediaSources ()
 Gets the audio/video sources. More...
 
fm.liveswitch.VideoSource getVideoSource ()
 Gets the video source. More...
 
fm.liveswitch.SourceInput getVideoSourceInput ()
 Gets the current video source input of the video track. More...
 
fm.liveswitch.Future< fm.liveswitch.SourceInput[]> getVideoSourceInputs ()
 Gets a list of the names and IDs of currently available video devices. More...
 
fm.liveswitch.VideoSource[] getVideoSources ()
 Gets the video sources. More...
 
 LocalMedia ()
 
void removeOnAudioMuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio source is muted. More...
 
void removeOnAudioStarted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the first audio track is started. More...
 
void removeOnAudioStopped (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the first audio track is stopped. More...
 
void removeOnAudioUnmuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio source is unmuted. More...
 
void removeOnVideoMuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video source is muted. More...
 
void removeOnVideoStarted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the first video track is started. More...
 
void removeOnVideoStopped (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the first video track is stopped. More...
 
void removeOnVideoUnmuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video source is unmuted. More...
 
void setAudioSourceInput (fm.liveswitch.SourceInput value)
 Sets the current audio source input of the audio track. More...
 
void setVideoSourceInput (fm.liveswitch.SourceInput value)
 Sets the current video source input of the video track. More...
 
- Public Member Functions inherited from fm.liveswitch.Media< TAudioTrack extends fm.liveswitch.AudioTrack, TVideoTrack extends fm.liveswitch.VideoTrack >
void addOnAudioDestroyed (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is destroyed. More...
 
void addOnAudioLevel (fm.liveswitch.IAction1< Double > value)
 Adds a handler that is raised periodically when the audio's level is calculated. More...
 
void addOnVideoDestroyed (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is destroyed. More...
 
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...
 
void addOnVideoSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Adds a handler that is raised whenever the video's frame size changes. More...
 
void destroy ()
 Destroys all non-persistent internal objects encapsulated by the Media class. More...
 
int getAudioLevelInterval ()
 Gets the interval in milliseconds between fm.liveswitch.Media#addOnAudioLevel events. More...
 
TAudioTrack[] getAudioTracks ()
 Gets all audio tracks from this media. More...
 
boolean getIsRecordingAudio ()
 Gets whether audio is being recorded locally. More...
 
boolean getIsRecordingVideo ()
 Gets whether video is being recorded locally. More...
 
fm.liveswitch.Size getVideoSize ()
 Gets the size of the video track. More...
 
TVideoTrack[] getVideoTracks ()
 Gets all video tracks from this media. More...
 
fm.liveswitch.Future< fm.liveswitch.VideoBuffergrabVideoFrame ()
 Gets the next frame from the video track once it is rendered. More...
 
 Media ()
 Initializes a new instance of the fm.liveswitch.Media class. More...
 
void removeOnAudioDestroyed (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is destroyed. More...
 
void removeOnAudioLevel (fm.liveswitch.IAction1< Double > value)
 Removes a handler that is raised periodically when the audio's level is calculated. More...
 
void removeOnVideoDestroyed (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is destroyed. More...
 
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...
 
void removeOnVideoSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Removes a handler that is raised whenever the video's frame size changes. More...
 
void setAudioLevelInterval (int value)
 Sets the interval in milliseconds between fm.liveswitch.Media#addOnAudioLevel events. More...
 
- Public Member Functions inherited from fm.liveswitch.MediaBase< TAudioTrack, TVideoTrack >
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...
 
double getAudioGain ()
 Gets the gain (input amplification) of the audio track. More...
 
abstract int getAudioLevelInterval ()
 Gets the interval in milliseconds between fm.liveswitch.MediaBase#addOnAudioLevel events. More...
 
boolean getAudioMuted ()
 Gets a value indicating whether the audio is muted. More...
 
TIAudioTrack getAudioTrack ()
 Gets the audio track from this media. More...
 
abstract TIAudioTrack[] getAudioTracks ()
 Gets all audio tracks from this media. More...
 
double getAudioVolume ()
 Gets the audio volume on the audio track. More...
 
String getId ()
 Gets the unique identifier of this media. More...
 
boolean getVideoMuted ()
 Gets a value indicating whether the video track is muted. More...
 
abstract fm.liveswitch.Size getVideoSize ()
 Gets the size of the last processed video frame, if known. More...
 
TIVideoTrack getVideoTrack ()
 Gets the video track from this media. More...
 
abstract TIVideoTrack[] getVideoTracks ()
 Gets all video tracks from this media. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.VideoBuffergrabVideoFrame ()
 Gets the next raw video frame. More...
 
 MediaBase ()
 Initializes a new instance of the fm.liveswitch.MediaBase class. 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...
 
void setAudioGain (double value)
 Sets the gain (input amplification) of the audio track. More...
 
abstract void setAudioLevelInterval (int value)
 Sets the interval in milliseconds between fm.liveswitch.MediaBase#addOnAudioLevel events. More...
 
void setAudioMuted (boolean value)
 Sets a value indicating whether the audio is muted. More...
 
void setAudioVolume (double value)
 Sets the audio volume on the audio track. More...
 
void setId (String value)
 Sets the unique identifier of this media. More...
 
void setVideoMuted (boolean value)
 Sets a value indicating whether the video track is muted. More...
 
- Public Member Functions inherited from fm.liveswitch.ILocalMedia< fm.liveswitch.LocalMedia, fm.liveswitch.AudioTrack, fm.liveswitch.VideoTrack >
abstract void addOnAudioMuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is muted. More...
 
abstract void addOnAudioStarted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is started. More...
 
abstract void addOnAudioStopped (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is stopped. More...
 
abstract void addOnAudioUnmuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the audio track is unmuted. More...
 
abstract void addOnVideoMuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is muted. More...
 
abstract void addOnVideoStarted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is started. More...
 
abstract void addOnVideoStopped (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is stopped. More...
 
abstract void addOnVideoUnmuted (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the video track is unmuted. More...
 
abstract fm.liveswitch.Future< Object > changeAudioSourceInput (fm.liveswitch.SourceInput audioSourceInput)
 Changes the audio source input of the first audio track while the media is active. More...
 
abstract fm.liveswitch.Future< Object > changeVideoSourceInput (fm.liveswitch.SourceInput videoSourceInput)
 Changes the video source input of the first video track while the media is active. More...
 
abstract fm.liveswitch.AudioEncodingConfig getAudioEncoding ()
 Gets the first (primary) local audio encoding. More...
 
abstract fm.liveswitch.AudioEncodingConfig[] getAudioEncodings ()
 Gets the local audio encodings. More...
 
abstract boolean getAudioSimulcastDisabled ()
 Gets whether audio simulcast is disabled. More...
 
abstract int getAudioSimulcastEncodingCount ()
 Gets the number of audio simulcast encodings. More...
 
abstract int getAudioSimulcastPreferredBitrate ()
 Gets the preferred audio simulcast bitrate, in kbps. More...
 
abstract fm.liveswitch.SourceInput getAudioSourceInput ()
 Gets the current audio source input of the first audio track. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.SourceInput[]> getAudioSourceInputs ()
 Gets the available audio source inputs of the first audio track. More...
 
abstract fm.liveswitch.LocalMediaState getState ()
 Gets the current state. More...
 
abstract fm.liveswitch.VideoEncodingConfig getVideoEncoding ()
 Gets the first (primary) local video encoding. More...
 
abstract fm.liveswitch.VideoEncodingConfig[] getVideoEncodings ()
 Gets the local video encodings. More...
 
abstract double getVideoSimulcastBitsPerPixel ()
 Gets the desired video simulcast bits-per-pixel (bpp). More...
 
abstract fm.liveswitch.VideoDegradationPreference getVideoSimulcastDegradationPreference ()
 Gets the video simulcast degradation preference. More...
 
abstract boolean getVideoSimulcastDisabled ()
 Gets whether video simulcast is disabled. More...
 
abstract int getVideoSimulcastEncodingCount ()
 Gets the number of video simulcast encodings. More...
 
abstract int getVideoSimulcastPreferredBitrate ()
 Gets the preferred video simulcast bitrate, in kbps. More...
 
abstract fm.liveswitch.SourceInput getVideoSourceInput ()
 Gets the current video source input of the first video track. More...
 
abstract fm.liveswitch.Future< fm.liveswitch.SourceInput[]> getVideoSourceInputs ()
 Gets the available video source inputs of the first video track. More...
 
abstract void removeOnAudioMuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is muted. More...
 
abstract void removeOnAudioStarted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is started. More...
 
abstract void removeOnAudioStopped (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is stopped. More...
 
abstract void removeOnAudioUnmuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the audio track is unmuted. More...
 
abstract void removeOnVideoMuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is muted. More...
 
abstract void removeOnVideoStarted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is started. More...
 
abstract void removeOnVideoStopped (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is stopped. More...
 
abstract void removeOnVideoUnmuted (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the video track is unmuted. More...
 
abstract void setAudioEncodings (fm.liveswitch.AudioEncodingConfig[] value)
 Sets the local audio encodings. More...
 
abstract void setAudioSimulcastDisabled (boolean value)
 Sets whether audio simulcast is disabled. More...
 
abstract void setAudioSimulcastEncodingCount (int value)
 Sets the number of audio simulcast encodings. More...
 
abstract void setAudioSimulcastPreferredBitrate (int value)
 Sets the preferred audio simulcast bitrate, in kbps. More...
 
abstract void setAudioSourceInput (fm.liveswitch.SourceInput value)
 Sets the current audio source input of the first audio track. More...
 
abstract void setVideoEncodings (fm.liveswitch.VideoEncodingConfig[] value)
 Sets the local video encodings. More...
 
abstract void setVideoSimulcastBitsPerPixel (double value)
 Sets the desired video simulcast bits-per-pixel (bpp). More...
 
abstract void setVideoSimulcastDegradationPreference (fm.liveswitch.VideoDegradationPreference value)
 Sets the video simulcast degradation preference. More...
 
abstract void setVideoSimulcastDisabled (boolean value)
 Sets whether video simulcast is disabled. More...
 
abstract void setVideoSimulcastEncodingCount (int value)
 Sets the number of video simulcast encodings. More...
 
abstract void setVideoSimulcastPreferredBitrate (int value)
 Sets the preferred video simulcast bitrate, in kbps. More...
 
abstract void setVideoSourceInput (fm.liveswitch.SourceInput value)
 Sets the current video source input of the first video track. More...
 
abstract fm.liveswitch.Future< TLocalMedia > start ()
 Starts the media track sources. More...
 
abstract fm.liveswitch.Future< TLocalMedia > stop ()
 Stops the media track sources. More...
 
- Public Member Functions inherited from fm.liveswitch.IMedia< fm.liveswitch.AudioTrack, fm.liveswitch.VideoTrack >
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...
 

Protected Member Functions

void addAudioTrack (fm.liveswitch.AudioTrack audioTrack)
 Adds the audio track. More...
 
void addVideoTrack (fm.liveswitch.VideoTrack videoTrack)
 Adds the video track. More...
 
fm.liveswitch.AudioTrack[] arrayFromAudioTracks (java.util.ArrayList< fm.liveswitch.AudioTrack > tracks)
 Creates an array of tracks from a list of audio tracks. More...
 
fm.liveswitch.VideoTrack[] arrayFromVideoTracks (java.util.ArrayList< fm.liveswitch.VideoTrack > tracks)
 Creates an array of tracks from a list of video tracks. More...
 
java.util.ArrayList< fm.liveswitch.AudioTrackcreateAudioTrackCollection ()
 Creates an audio track collection. More...
 
java.util.ArrayList< fm.liveswitch.VideoTrackcreateVideoTrackCollection ()
 Creates a video track collection. More...
 
fm.liveswitch.AudioEncodingConfig[] doGetAudioEncodings ()
 Gets the array of local audio encoding configurations. More...
 
fm.liveswitch.VideoEncodingConfig[] doGetVideoEncodings ()
 Gets the local video encodings. More...
 
void doSetAudioEncodings (fm.liveswitch.AudioEncodingConfig[] encodings)
 Sets the local audio encodings. More...
 
void doSetVideoEncodings (fm.liveswitch.VideoEncodingConfig[] encodings)
 Sets the local video encodings. More...
 
fm.liveswitch.Future< fm.liveswitch.LocalMediadoStart ()
 Starts the local media. More...
 
fm.liveswitch.Future< fm.liveswitch.LocalMediadoStop ()
 Stops the local media. More...
 
boolean removeAudioTrack (fm.liveswitch.AudioTrack audioTrack)
 Removes the audio track. More...
 
boolean removeVideoTrack (fm.liveswitch.VideoTrack videoTrack)
 Removes the video track. More...
 
- Protected Member Functions inherited from fm.liveswitch.Media< TAudioTrack extends fm.liveswitch.AudioTrack, TVideoTrack extends fm.liveswitch.VideoTrack >
void addAudioTrack (TAudioTrack audioTrack)
 Adds an audio track. More...
 
void addVideoTrack (TVideoTrack videoTrack)
 Adds a video track. More...
 
abstract TAudioTrack[] arrayFromAudioTracks (java.util.ArrayList< TAudioTrack > tracks)
 Creates an array of tracks from a list of audio tracks. More...
 
abstract TVideoTrack[] arrayFromVideoTracks (java.util.ArrayList< TVideoTrack > tracks)
 Creates an array of tracks from a list of video tracks. More...
 
boolean removeAudioTrack (TAudioTrack audioTrack)
 Removes an audio track. More...
 
boolean removeVideoTrack (TVideoTrack videoTrack)
 Removes a video track. More...
 
void setIsRecordingAudio (boolean value)
 Sets whether audio is being recorded locally. More...
 
void setIsRecordingVideo (boolean value)
 Sets whether video is being recorded locally. More...
 

Detailed Description

A collection of local audio/video tracks.

Constructor & Destructor Documentation

◆ LocalMedia()

fm.liveswitch.LocalMedia.LocalMedia ( )

Member Function Documentation

◆ addAudioTrack()

void fm.liveswitch.LocalMedia.addAudioTrack ( fm.liveswitch.AudioTrack  audioTrack)
protected

Adds the audio track.

Parameters
audioTrackThe audio track.

◆ addOnAudioMuted()

void fm.liveswitch.LocalMedia.addOnAudioMuted ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the audio source is muted.

◆ addOnAudioStarted()

void fm.liveswitch.LocalMedia.addOnAudioStarted ( fm.liveswitch.IAction0  value)

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

◆ addOnAudioStopped()

void fm.liveswitch.LocalMedia.addOnAudioStopped ( fm.liveswitch.IAction0  value)

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

◆ addOnAudioUnmuted()

void fm.liveswitch.LocalMedia.addOnAudioUnmuted ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the audio source is unmuted.

◆ addOnVideoMuted()

void fm.liveswitch.LocalMedia.addOnVideoMuted ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the video source is muted.

◆ addOnVideoStarted()

void fm.liveswitch.LocalMedia.addOnVideoStarted ( fm.liveswitch.IAction0  value)

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

◆ addOnVideoStopped()

void fm.liveswitch.LocalMedia.addOnVideoStopped ( fm.liveswitch.IAction0  value)

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

◆ addOnVideoUnmuted()

void fm.liveswitch.LocalMedia.addOnVideoUnmuted ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the video source is unmuted.

◆ addVideoTrack()

void fm.liveswitch.LocalMedia.addVideoTrack ( fm.liveswitch.VideoTrack  videoTrack)
protected

Adds the video track.

Parameters
videoTrackThe video track.

◆ arrayFromAudioTracks()

fm.liveswitch.AudioTrack [] fm.liveswitch.LocalMedia.arrayFromAudioTracks ( java.util.ArrayList< fm.liveswitch.AudioTrack tracks)
protected

Creates an array of tracks from a list of audio tracks.

Parameters
tracksThe list of tracks.

◆ arrayFromVideoTracks()

fm.liveswitch.VideoTrack [] fm.liveswitch.LocalMedia.arrayFromVideoTracks ( java.util.ArrayList< fm.liveswitch.VideoTrack tracks)
protected

Creates an array of tracks from a list of video tracks.

Parameters
tracksThe list of tracks.

◆ changeAudioSourceInput()

fm.liveswitch.Future<Object> fm.liveswitch.LocalMedia.changeAudioSourceInput ( fm.liveswitch.SourceInput  audioSourceInput)

Changes the audio source input of the audio track while the media is active.

If there are multiple audio tracks in a custom media stack, this method calls into the first audio track.
For example, this method can be used to change the audio source's input on a laptop from the device microphone to a USB headset.

Parameters
audioSourceInputThe audio source input.

◆ changeVideoSourceInput()

fm.liveswitch.Future<Object> fm.liveswitch.LocalMedia.changeVideoSourceInput ( fm.liveswitch.SourceInput  videoSourceInput)

Changes the video source input of the video track while the media is active.

If there are multiple video tracks in a custom media stack, this method calls into the first video track.
For example, this method can be used to change the video source’s input on a mobile device from a front to a back camera.

Parameters
videoSourceInputThe video source input.

◆ createAudioTrackCollection()

java.util.ArrayList<fm.liveswitch.AudioTrack> fm.liveswitch.LocalMedia.createAudioTrackCollection ( )
protected

◆ createVideoTrackCollection()

java.util.ArrayList<fm.liveswitch.VideoTrack> fm.liveswitch.LocalMedia.createVideoTrackCollection ( )
protected

◆ doGetAudioEncodings()

fm.liveswitch.AudioEncodingConfig [] fm.liveswitch.LocalMedia.doGetAudioEncodings ( )
protected

Gets the array of local audio encoding configurations.

Returns
The local audio encodings.

Reimplemented in fm.liveswitch.RtcLocalMedia< TView >.

◆ doGetVideoEncodings()

fm.liveswitch.VideoEncodingConfig [] fm.liveswitch.LocalMedia.doGetVideoEncodings ( )
protected

Gets the local video encodings.

Returns
The local video encodings.

Reimplemented in fm.liveswitch.RtcLocalMedia< TView >.

◆ doSetAudioEncodings()

void fm.liveswitch.LocalMedia.doSetAudioEncodings ( fm.liveswitch.AudioEncodingConfig[]  encodings)
protected

Sets the local audio encodings.

Parameters
encodingsThe local audio encodings.

Reimplemented in fm.liveswitch.RtcLocalMedia< TView >.

◆ doSetVideoEncodings()

void fm.liveswitch.LocalMedia.doSetVideoEncodings ( fm.liveswitch.VideoEncodingConfig[]  encodings)
protected

Sets the local video encodings.

Parameters
encodingsThe local video encodings.

Reimplemented in fm.liveswitch.RtcLocalMedia< TView >.

◆ doStart()

fm.liveswitch.Future<fm.liveswitch.LocalMedia> fm.liveswitch.LocalMedia.doStart ( )
protected

Starts the local media.

◆ doStop()

fm.liveswitch.Future<fm.liveswitch.LocalMedia> fm.liveswitch.LocalMedia.doStop ( )
protected

Stops the local media.

◆ getAudioSource()

fm.liveswitch.AudioSource fm.liveswitch.LocalMedia.getAudioSource ( )

Gets the audio source.

◆ getAudioSourceInput()

fm.liveswitch.SourceInput fm.liveswitch.LocalMedia.getAudioSourceInput ( )

Gets the current audio source input of the audio track.


If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
The audio source input can only be set before the media has started. If the audio source input is not set, then the default input device is used.
If you want to change the input after the media has started, call ChangeAudioSourceInput instead. ChangeAudioSourceInput stops the current audio input and switch to the new input.

◆ getAudioSourceInputs()

fm.liveswitch.Future<fm.liveswitch.SourceInput[]> fm.liveswitch.LocalMedia.getAudioSourceInputs ( )

Gets a list of the names and IDs of currently available audio devices.


Returns
A future with an array of audio source inputs.

◆ getAudioSources()

fm.liveswitch.AudioSource [] fm.liveswitch.LocalMedia.getAudioSources ( )

Gets the audio sources.

◆ getMediaSources()

fm.liveswitch.MediaSourceBase [] fm.liveswitch.LocalMedia.getMediaSources ( )

Gets the audio/video sources.

◆ getVideoSource()

fm.liveswitch.VideoSource fm.liveswitch.LocalMedia.getVideoSource ( )

Gets the video source.

◆ getVideoSourceInput()

fm.liveswitch.SourceInput fm.liveswitch.LocalMedia.getVideoSourceInput ( )

Gets the current video source input of the video track.


If there are multiple video tracks in a custom media stack, this property is bound to the first video track.
The video source input can only be set before the media has started. If the video source input is not set, then the default input device is used.
If you want to change the input after the media has started, call ChangeVideoSourceInput instead. ChangeVideoSourceInput stops the current audio input and switch to the new input.

◆ getVideoSourceInputs()

fm.liveswitch.Future<fm.liveswitch.SourceInput[]> fm.liveswitch.LocalMedia.getVideoSourceInputs ( )

Gets a list of the names and IDs of currently available video devices.


Returns
A future with an array of video source inputs.

◆ getVideoSources()

fm.liveswitch.VideoSource [] fm.liveswitch.LocalMedia.getVideoSources ( )

Gets the video sources.

◆ removeAudioTrack()

boolean fm.liveswitch.LocalMedia.removeAudioTrack ( fm.liveswitch.AudioTrack  audioTrack)
protected

Removes the audio track.

Parameters
audioTrackThe audio track.

◆ removeOnAudioMuted()

void fm.liveswitch.LocalMedia.removeOnAudioMuted ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the audio source is muted.

◆ removeOnAudioStarted()

void fm.liveswitch.LocalMedia.removeOnAudioStarted ( fm.liveswitch.IAction0  value)

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

◆ removeOnAudioStopped()

void fm.liveswitch.LocalMedia.removeOnAudioStopped ( fm.liveswitch.IAction0  value)

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

◆ removeOnAudioUnmuted()

void fm.liveswitch.LocalMedia.removeOnAudioUnmuted ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the audio source is unmuted.

◆ removeOnVideoMuted()

void fm.liveswitch.LocalMedia.removeOnVideoMuted ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the video source is muted.

◆ removeOnVideoStarted()

void fm.liveswitch.LocalMedia.removeOnVideoStarted ( fm.liveswitch.IAction0  value)

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

◆ removeOnVideoStopped()

void fm.liveswitch.LocalMedia.removeOnVideoStopped ( fm.liveswitch.IAction0  value)

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

◆ removeOnVideoUnmuted()

void fm.liveswitch.LocalMedia.removeOnVideoUnmuted ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the video source is unmuted.

◆ removeVideoTrack()

boolean fm.liveswitch.LocalMedia.removeVideoTrack ( fm.liveswitch.VideoTrack  videoTrack)
protected

Removes the video track.

Parameters
videoTrackThe video track.

◆ setAudioSourceInput()

void fm.liveswitch.LocalMedia.setAudioSourceInput ( fm.liveswitch.SourceInput  value)

Sets the current audio source input of the audio track.


If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
The audio source input can only be set before the media has started. If the audio source input is not set, then the default input device is used.
If you want to change the input after the media has started, call ChangeAudioSourceInput instead. ChangeAudioSourceInput stops the current audio input and switch to the new input.

◆ setVideoSourceInput()

void fm.liveswitch.LocalMedia.setVideoSourceInput ( fm.liveswitch.SourceInput  value)

Sets the current video source input of the video track.


If there are multiple video tracks in a custom media stack, this property is bound to the first video track.
The video source input can only be set before the media has started. If the video source input is not set, then the default input device is used.
If you want to change the input after the media has started, call ChangeVideoSourceInput instead. ChangeVideoSourceInput stops the current audio input and switch to the new input.