Search Results for

    Show / Hide Table of Contents

    Class MediaTrackBase

    Media track base properties/methods.

    Inheritance
    System.Object
    Serializable
    Dynamic
    MediaTrackBase
    MediaTrack<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat>
    Implements
    IMediaTrack
    Inherited Members
    Dynamic.DynamicProperties
    Dynamic.GetDynamicValue(String)
    Dynamic.SetDynamicValue(String, Object)
    Dynamic.UnsetDynamicValue(String)
    Serializable.IsDirty
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public abstract class MediaTrackBase : Dynamic, IMediaTrack

    Properties

    Muted

    Gets or sets a value indicating whether this track is muted.

    Declaration
    public abstract bool Muted { get; set; }
    Property Value
    Type Description
    System.Boolean

    SinkOutput

    Gets or sets the current sink output.

    Declaration
    public abstract SinkOutput SinkOutput { get; set; }
    Property Value
    Type Description
    SinkOutput

    SourceInput

    Gets or sets the current source input.

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

    Methods

    ChangeSinkOutput(SinkOutput)

    Changes the sink output while the media track is active.

    Declaration
    public abstract Future<object> ChangeSinkOutput(SinkOutput sinkOutput)
    Parameters
    Type Name Description
    SinkOutput sinkOutput

    The sink output.

    Returns
    Type Description
    Future<System.Object>

    ChangeSourceInput(SourceInput)

    Changes the source input while the media track is active.

    Declaration
    public abstract Future<object> ChangeSourceInput(SourceInput sourceInput)
    Parameters
    Type Name Description
    SourceInput sourceInput

    The source input.

    Returns
    Type Description
    Future<System.Object>

    Destroy()

    Destroys this media track.

    Declaration
    public abstract bool Destroy()
    Returns
    Type Description
    System.Boolean

    GetSinkOutputs()

    Gets the available sink outputs.

    Declaration
    public abstract Future<SinkOutput[]> GetSinkOutputs()
    Returns
    Type Description
    Future<SinkOutput[]>

    A future with an array of sink outputs.

    GetSourceInputs()

    Gets the available source inputs.

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

    A future with an array of source inputs.

    Events

    OnDestroyed

    Raised when the track is destroyed.

    Declaration
    public abstract event Action0 OnDestroyed
    Event Type
    Type Description
    Action0

    OnMuted

    Raised when the track is muted. Only applicable for local media tracks.

    Declaration
    public abstract event Action0 OnMuted
    Event Type
    Type Description
    Action0

    OnStarted

    Raised when the track is started. Only applicable for local media tracks.

    Declaration
    public abstract event Action0 OnStarted
    Event Type
    Type Description
    Action0

    OnStopped

    Raised when the track is stopped. Only applicable for local media tracks.

    Declaration
    public abstract event Action0 OnStopped
    Event Type
    Type Description
    Action0

    OnUnmuted

    Raised when the track is unmuted. Only applicable for local media tracks.

    Declaration
    public abstract event Action0 OnUnmuted
    Event Type
    Type Description
    Action0

    Implements

    IMediaTrack
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0