Search Results for

    Show / Hide Table of Contents

    Class LocalMedia

    A collection of local audio/video tracks.

    Inheritance
    System.Object
    Serializable
    Dynamic
    MediaBase<AudioTrack, VideoTrack>
    Media<AudioTrack, VideoTrack>
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>
    LocalMedia
    RtcLocalMedia<TView>
    Implements
    ILocalMedia<LocalMedia, AudioTrack, VideoTrack>
    IMedia<AudioTrack, VideoTrack>
    Inherited Members
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.State
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioEncoding
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioEncodings
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoEncoding
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoEncodings
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoGetAudioEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoSetAudioEncodings(AudioEncodingConfig[])
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoGetVideoEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoSetVideoEncodings(VideoEncodingConfig[])
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockAudioEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings(VideoType)
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.LockVideoEncodings(VideoType, Int32, Int32, Double)
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastDisabled
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastEncodingCount
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AudioSimulcastPreferredBitrate
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastDisabled
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastEncodingCount
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastPreferredBitrate
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastBitsPerPixel
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.VideoSimulcastDegradationPreference
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DefaultVideoBitsPerPixel
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.Start()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoStart()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.Stop()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.DoStop()
    LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>.AbortStart(Promise<LocalMedia>, Exception)
    Media<AudioTrack, VideoTrack>.AudioLevelInterval
    Media<AudioTrack, VideoTrack>.AudioTracks
    Media<AudioTrack, VideoTrack>.VideoTracks
    Media<AudioTrack, VideoTrack>.OnAudioLevel
    Media<AudioTrack, VideoTrack>.OnVideoSize
    Media<AudioTrack, VideoTrack>.OnVideoSizeChange
    Media<AudioTrack, VideoTrack>.OnAudioDestroyed
    Media<AudioTrack, VideoTrack>.OnVideoDestroyed
    Media<AudioTrack, VideoTrack>.AddAudioTrack(AudioTrack)
    Media<AudioTrack, VideoTrack>.RemoveAudioTrack(AudioTrack)
    Media<AudioTrack, VideoTrack>.AddVideoTrack(VideoTrack)
    Media<AudioTrack, VideoTrack>.RemoveVideoTrack(VideoTrack)
    Media<AudioTrack, VideoTrack>.IsRecordingAudio
    Media<AudioTrack, VideoTrack>.IsRecordingVideo
    Media<AudioTrack, VideoTrack>.VideoSize
    Media<AudioTrack, VideoTrack>.GrabVideoFrame()
    Media<AudioTrack, VideoTrack>.Destroy()
    Media<AudioTrack, VideoTrack>.CreateAudioTrackCollection()
    Media<AudioTrack, VideoTrack>.CreateVideoTrackCollection()
    Media<AudioTrack, VideoTrack>.ArrayFromAudioTracks(List<AudioTrack>)
    Media<AudioTrack, VideoTrack>.ArrayFromVideoTracks(List<VideoTrack>)
    MediaBase<AudioTrack, VideoTrack>.Id
    MediaBase<AudioTrack, VideoTrack>.AudioTrack
    MediaBase<AudioTrack, VideoTrack>.VideoTrack
    MediaBase<AudioTrack, VideoTrack>.AudioGain
    MediaBase<AudioTrack, VideoTrack>.AudioVolume
    MediaBase<AudioTrack, VideoTrack>.AudioMuted
    MediaBase<AudioTrack, VideoTrack>.VideoMuted
    Dynamic.DynamicProperties
    Dynamic.GetDynamicValue(String)
    Dynamic.SetDynamicValue(String, Object)
    Dynamic.UnsetDynamicValue(String)
    Serializable.IsDirty
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public class LocalMedia : LocalMediaBase<LocalMedia, AudioTrack, VideoTrack>, ILocalMedia<LocalMedia, AudioTrack, VideoTrack>, IMedia<AudioTrack, VideoTrack>

    Properties

    AudioSource

    Gets the audio source.

    Declaration
    public AudioSource AudioSource { get; }
    Property Value
    Type Description
    AudioSource

    AudioSourceInput

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

    Declaration
    public SourceInput AudioSourceInput { get; set; }
    Property Value
    Type Description
    SourceInput

    AudioSources

    Gets the audio sources.

    Declaration
    public AudioSource[] AudioSources { get; }
    Property Value
    Type Description
    AudioSource[]

    MediaSources

    Gets the audio/video sources.

    Declaration
    public MediaSourceBase[] MediaSources { get; }
    Property Value
    Type Description
    MediaSourceBase[]

    VideoSource

    Gets the video source.

    Declaration
    public VideoSource VideoSource { get; }
    Property Value
    Type Description
    VideoSource

    VideoSourceInput

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

    Declaration
    public SourceInput VideoSourceInput { get; set; }
    Property Value
    Type Description
    SourceInput

    VideoSources

    Gets the video sources.

    Declaration
    public VideoSource[] VideoSources { get; }
    Property Value
    Type Description
    VideoSource[]

    Methods

    AddAudioTrack(AudioTrack)

    Adds the audio track.

    Declaration
    protected override void AddAudioTrack(AudioTrack audioTrack)
    Parameters
    Type Name Description
    AudioTrack audioTrack

    The audio track.

    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.AddAudioTrack(FM.LiveSwitch.AudioTrack)

    AddVideoTrack(VideoTrack)

    Adds the video track.

    Declaration
    protected override void AddVideoTrack(VideoTrack videoTrack)
    Parameters
    Type Name Description
    VideoTrack videoTrack

    The video track.

    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.AddVideoTrack(FM.LiveSwitch.VideoTrack)

    ArrayFromAudioTracks(List<AudioTrack>)

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

    Declaration
    protected override AudioTrack[] ArrayFromAudioTracks(List<AudioTrack> tracks)
    Parameters
    Type Name Description
    List<AudioTrack> tracks

    The list of tracks.

    Returns
    Type Description
    AudioTrack[]
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.ArrayFromAudioTracks(List<FM.LiveSwitch.AudioTrack>)

    ArrayFromVideoTracks(List<VideoTrack>)

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

    Declaration
    protected override VideoTrack[] ArrayFromVideoTracks(List<VideoTrack> tracks)
    Parameters
    Type Name Description
    List<VideoTrack> tracks

    The list of tracks.

    Returns
    Type Description
    VideoTrack[]
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.ArrayFromVideoTracks(List<FM.LiveSwitch.VideoTrack>)

    ChangeAudioSourceInput(SourceInput)

    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.

    Declaration
    public Future<object> ChangeAudioSourceInput(SourceInput audioSourceInput)
    Parameters
    Type Name Description
    SourceInput audioSourceInput

    The audio source input.

    Returns
    Type Description
    Future<System.Object>

    ChangeVideoSourceInput(SourceInput)

    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.

    Declaration
    public Future<object> ChangeVideoSourceInput(SourceInput videoSourceInput)
    Parameters
    Type Name Description
    SourceInput videoSourceInput

    The video source input.

    Returns
    Type Description
    Future<System.Object>

    CreateAudioTrackCollection()

    Creates an audio track collection.

    Declaration
    protected override List<AudioTrack> CreateAudioTrackCollection()
    Returns
    Type Description
    List<AudioTrack>
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.CreateAudioTrackCollection()

    CreateVideoTrackCollection()

    Creates a video track collection.

    Declaration
    protected override List<VideoTrack> CreateVideoTrackCollection()
    Returns
    Type Description
    List<VideoTrack>
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.CreateVideoTrackCollection()

    DoGetAudioEncodings()

    Gets the array of local audio encoding configurations.

    Declaration
    protected override AudioEncodingConfig[] DoGetAudioEncodings()
    Returns
    Type Description
    AudioEncodingConfig[]

    The local audio encodings.

    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoGetAudioEncodings()

    DoGetVideoEncodings()

    Gets the local video encodings.

    Declaration
    protected override VideoEncodingConfig[] DoGetVideoEncodings()
    Returns
    Type Description
    VideoEncodingConfig[]

    The local video encodings.

    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoGetVideoEncodings()

    DoSetAudioEncodings(AudioEncodingConfig[])

    Sets the local audio encodings.

    Declaration
    protected override void DoSetAudioEncodings(AudioEncodingConfig[] encodings)
    Parameters
    Type Name Description
    AudioEncodingConfig[] encodings

    The local audio encodings.

    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoSetAudioEncodings(FM.LiveSwitch.AudioEncodingConfig[])

    DoSetVideoEncodings(VideoEncodingConfig[])

    Sets the local video encodings.

    Declaration
    protected override void DoSetVideoEncodings(VideoEncodingConfig[] encodings)
    Parameters
    Type Name Description
    VideoEncodingConfig[] encodings

    The local video encodings.

    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoSetVideoEncodings(FM.LiveSwitch.VideoEncodingConfig[])

    DoStart()

    Starts the local media.

    Declaration
    protected override Future<LocalMedia> DoStart()
    Returns
    Type Description
    Future<LocalMedia>
    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoStart()

    DoStop()

    Stops the local media.

    Declaration
    protected override Future<LocalMedia> DoStop()
    Returns
    Type Description
    Future<LocalMedia>
    Overrides
    FM.LiveSwitch.LocalMediaBase<FM.LiveSwitch.LocalMedia, FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.DoStop()

    GetAudioSourceInputs()

    Gets a list of the names and IDs of currently available audio devices.
    A common requirement when working with LiveSwitch is to present a list of available media devices for the user to select from. Additionally, you might want to store the selected devices for retrieval. For example, to select the device again if the user leaves and returns.

    Declaration
    public Future<SourceInput[]> GetAudioSourceInputs()
    Returns
    Type Description
    Future<SourceInput[]>

    A future with an array of audio source inputs.

    GetVideoSourceInputs()

    Gets a list of the names and IDs of currently available video devices.
    A common requirement when working with LiveSwitch is to present a list of available media devices for the user to select from. Additionally, you might want to store the selected devices for retrieval. For example, to select the device again if the user leaves and returns.

    Declaration
    public Future<SourceInput[]> GetVideoSourceInputs()
    Returns
    Type Description
    Future<SourceInput[]>

    A future with an array of video source inputs.

    RemoveAudioTrack(AudioTrack)

    Removes the audio track.

    Declaration
    protected override bool RemoveAudioTrack(AudioTrack audioTrack)
    Parameters
    Type Name Description
    AudioTrack audioTrack

    The audio track.

    Returns
    Type Description
    System.Boolean
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.RemoveAudioTrack(FM.LiveSwitch.AudioTrack)

    RemoveVideoTrack(VideoTrack)

    Removes the video track.

    Declaration
    protected override bool RemoveVideoTrack(VideoTrack videoTrack)
    Parameters
    Type Name Description
    VideoTrack videoTrack

    The video track.

    Returns
    Type Description
    System.Boolean
    Overrides
    FM.LiveSwitch.Media<FM.LiveSwitch.AudioTrack, FM.LiveSwitch.VideoTrack>.RemoveVideoTrack(FM.LiveSwitch.VideoTrack)

    Events

    OnAudioMuted

    Raised when the audio source is muted.

    Declaration
    public event Action0 OnAudioMuted
    Event Type
    Type Description
    Action0

    OnAudioStarted

    Raised when the first audio track is started.

    Declaration
    public event Action0 OnAudioStarted
    Event Type
    Type Description
    Action0

    OnAudioStopped

    Raised when the first audio track is stopped.

    Declaration
    public event Action0 OnAudioStopped
    Event Type
    Type Description
    Action0

    OnAudioUnmuted

    Raised when the audio source is unmuted.

    Declaration
    public event Action0 OnAudioUnmuted
    Event Type
    Type Description
    Action0

    OnVideoMuted

    Raised when the video source is muted.

    Declaration
    public event Action0 OnVideoMuted
    Event Type
    Type Description
    Action0

    OnVideoStarted

    Raised when the first video track is started.

    Declaration
    public event Action0 OnVideoStarted
    Event Type
    Type Description
    Action0

    OnVideoStopped

    Raised when the first video track is stopped.

    Declaration
    public event Action0 OnVideoStopped
    Event Type
    Type Description
    Action0

    OnVideoUnmuted

    Raised when the video source is unmuted.

    Declaration
    public event Action0 OnVideoUnmuted
    Event Type
    Type Description
    Action0

    Implements

    ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack>
    IMedia<TIAudioTrack, TIVideoTrack>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0