Search Results for

    Show / Hide Table of Contents

    Interface IMediaStream

    Media stream interface.

    Inherited Members
    IStream.Id
    IStream.ExternalId
    IStream.MediaDescriptionId
    IStream.Type
    IStream.Tag
    IStream.Direction
    IStream.LocalDirection
    IStream.RemoteDirection
    IStream.ChangeDirection(StreamDirection)
    IStream.Label
    IStream.OnDirectionChange
    IStream.LocalSend
    IStream.LocalReceive
    IStream.RemoteSend
    IStream.RemoteReceive
    IStream.State
    IStream.OnStateChange
    IStream.TransportInfo
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public interface IMediaStream : IStream

    Properties

    CachedLocalDirection

    Gets Cached Local Direction for this Media Stream. Internal use.

    Declaration
    StreamDirection CachedLocalDirection { get; }
    Property Value
    Type Description
    StreamDirection

    ControlTransportInfo

    Gets the media stream control transport info.

    Declaration
    TransportInfo ControlTransportInfo { get; }
    Property Value
    Type Description
    TransportInfo

    Info

    Gets the media stream info.

    Declaration
    MediaStreamInfo Info { get; }
    Property Value
    Type Description
    MediaStreamInfo

    InputMuted

    Gets or sets whether the input track is muted.

    Declaration
    bool InputMuted { get; set; }
    Property Value
    Type Description
    System.Boolean

    LocalBandwidth

    Gets or sets the local bandwidth, in kbps. This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use MaxReceiveBitrate to control inbound media bitrate once the session has been negotiated.

    Declaration
    int LocalBandwidth { get; set; }
    Property Value
    Type Description
    System.Int32

    LocalCanonicalName

    Gets the local canonical name.

    Declaration
    string LocalCanonicalName { get; }
    Property Value
    Type Description
    System.String

    MaxReceiveBitrate

    Gets or sets the maximum desired receive bitrate, in kbps. This value must be less than or equal to LocalBandwidth.

    Declaration
    int MaxReceiveBitrate { get; set; }
    Property Value
    Type Description
    System.Int32

    MaxSendBitrate

    Gets or sets the maximum desired send bitrate, in kbps. This value must be less than or equal to RemoteBandwidth.

    Declaration
    int MaxSendBitrate { get; set; }
    Property Value
    Type Description
    System.Int32

    OutputMuted

    Gets or sets whether the output track is muted.

    Declaration
    bool OutputMuted { get; set; }
    Property Value
    Type Description
    System.Boolean

    PreferredCodecs

    Gets or sets any preferred codecs, in order of preference.

    Declaration
    string[] PreferredCodecs { get; set; }
    Property Value
    Type Description
    System.String[]

    RemoteBandwidth

    Gets the remote bandwidth, in kbps. This value is signalled in the remote session description received from the remote endpoint so we can limit our outbound media bitrate. Use MaxSendBitrate to control outbound media bitrate once the session has been negotiated.

    Declaration
    int RemoteBandwidth { get; }
    Property Value
    Type Description
    System.Int32

    RemoteCanonicalName

    Gets the remote canonical name.

    Declaration
    string RemoteCanonicalName { get; }
    Property Value
    Type Description
    System.String

    RemoteEncoding

    Gets or sets the remote encoding.

    Declaration
    EncodingInfo RemoteEncoding { get; set; }
    Property Value
    Type Description
    EncodingInfo

    RemoteMuted

    Gets or sets a value that indicates if remote is muted.

    Declaration
    bool RemoteMuted { get; set; }
    Property Value
    Type Description
    System.Boolean

    RemoteRequestedDeactivation

    Gets Boolean value set when the server is currently requesting a 0 bitrate. This is to highlight the difference between when a stream is deactivated locally or by a control mechanism on the server. Internal Use

    Declaration
    bool RemoteRequestedDeactivation { get; }
    Property Value
    Type Description
    System.Boolean

    SimulcastMode

    Gets or sets the simulcast mode.

    Declaration
    SimulcastMode SimulcastMode { get; set; }
    Property Value
    Type Description
    SimulcastMode

    Methods

    GetCodecDisabled(String)

    Gets whether a codec is disabled.

    Declaration
    bool GetCodecDisabled(string name)
    Parameters
    Type Name Description
    System.String name

    The codec name.

    Returns
    Type Description
    System.Boolean

    Whether the codec is disabled.

    RaiseBitrateNotification(BitrateNotification)

    Raises a bitrate notification to the remote track.

    Declaration
    bool RaiseBitrateNotification(BitrateNotification bitrateNotification)
    Parameters
    Type Name Description
    BitrateNotification bitrateNotification

    The bitrate notification.

    Returns
    Type Description
    System.Boolean

    RaiseBitrateRequest(BitrateRequest)

    Raises a bitrate request to the local track.

    Declaration
    bool RaiseBitrateRequest(BitrateRequest bitrateRequest)
    Parameters
    Type Name Description
    BitrateRequest bitrateRequest

    The bitrate request.

    Returns
    Type Description
    System.Boolean

    SetCodecDisabled(String, Boolean)

    Sets whether a codec is disabled.

    Declaration
    void SetCodecDisabled(string name, bool disabled)
    Parameters
    Type Name Description
    System.String name

    The codec name.

    System.Boolean disabled

    Whether to disable the codec.

    Events

    OnDiscardBitrateNotification

    Raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.

    Declaration
    event Action1<BitrateNotification> OnDiscardBitrateNotification
    Event Type
    Type Description
    Action1<BitrateNotification>

    OnDiscardBitrateRequest

    Raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.

    Declaration
    event Action1<BitrateRequest> OnDiscardBitrateRequest
    Event Type
    Type Description
    Action1<BitrateRequest>

    OnLocalEncodingDisabled

    Raised when a local encoding is disabled.

    Declaration
    event Action1<EncodingInfo> OnLocalEncodingDisabled
    Event Type
    Type Description
    Action1<EncodingInfo>

    OnLocalEncodingEnabled

    Raised when a local encoding is enabled.

    Declaration
    event Action1<EncodingInfo> OnLocalEncodingEnabled
    Event Type
    Type Description
    Action1<EncodingInfo>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0