Class MediaStreamTrack

    Definition

    Namespace:
    Tizen.Multimedia.Remoting
    Assembly:
    Tizen.Multimedia.Remoting.dll

    Provides the ability to control audio or video track from peer.

    public sealed class MediaStreamTrack
    Inheritance
    object
    MediaStreamTrack

    Properties

    View Source

    Display

    Gets or sets the display to show video data from peer.

    Declaration
    public Display Display { get; set; }
    Property Value
    Type Description
    Display

    A Display that specifies the display.

    Remarks

    If user set video source with SendRecv, Display must be set.
    If not, the received video will fill entire screen.
    If remote track, Display must be set in TrackAdded event.
    The display is created with MediaView.

    Exceptions
    Type Condition
    System.NotSupportedException

    The required feature is not supported.

    System.ObjectDisposedException

    The WebRTC has already been disposed of.

    System.ArgumentException

    The value has already been assigned to another WebRTC.

    System.InvalidOperationException

    The WebRTC is not called in TrackAdded event. -or-
    This MediaStreamTrack is not Video.

    View Source

    DisplayMode

    Gets or sets the display mode.

    Declaration
    public WebRTCDisplayMode DisplayMode { get; set; }
    Property Value
    Type Description
    WebRTCDisplayMode

    A WebRTCDisplayMode that specifies the display mode.

    Remarks

    This property is meaningful only in overlay or EVAS surface display type.

    Exceptions
    Type Condition
    System.NotSupportedException

    The required feature is not supported.

    System.ArgumentException

    Display mode type is incorrect.

    System.InvalidOperationException

    Display is not set.

    View Source

    DisplayVisible

    Gets or sets the display visibility.

    Declaration
    public bool DisplayVisible { get; set; }
    Property Value
    Type Description
    bool

    true if WebRTC display is visible, otherwise false.

    Remarks

    This property is meaningful only in overlay or EVAS surface display type.

    Exceptions
    Type Condition
    System.NotSupportedException

    The required feature is not supported.

    System.InvalidOperationException

    Display is not set.

    View Source

    Mute

    Gets or sets the mute status of the audio track.

    Declaration
    public bool Mute { get; set; }
    Property Value
    Type Description
    bool

    true if audio is muted, otherwise false. The default value is false.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The WebRTC has already been disposed.

    System.InvalidOperationException

    This MediaStreamTrack is not Audio.

    View Source

    Type

    Gets the type of media stream track.

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

    MediaType

    Methods

    View Source

    ApplyAudioStreamPolicy(AudioStreamPolicy)

    Applies the audio stream policy to remote track.

    Declaration
    public void ApplyAudioStreamPolicy(AudioStreamPolicy policy)
    Parameters
    Type Name Description
    AudioStreamPolicy policy

    The AudioStreamPolicy to apply.

    Remarks

    This must be called in TrackAdded event.

    WebRTC does not support all AudioStreamType.
    Supported types are Media, Voip, MediaExternalOnly.

    Exceptions
    Type Condition
    System.ArgumentNullException

    policy is null.

    System.InvalidOperationException

    AudioFrameEncoded was set.
    -or-
    This method was not called in TrackAdded event. -or-
    This MediaStreamTrack is not Audio.

    System.NotSupportedException

    AudioStreamType of policy is not supported on the current platform.

    System.ObjectDisposedException

    The WebRTC has already been disposed.
    -or-
    policy has already been disposed.

    See Also
    AudioStreamPolicy
    TrackAdded
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX