MixedReality-WebRTC MixedReality-WebRTC
Search Results for

    Show / Hide Table of Contents

    Class RemoteVideoTrack

    Video track receiving video frames from the remote peer.

    Inheritance
    Object
    MediaTrack
    RemoteVideoTrack
    Implements
    IVideoSource
    Inherited Members
    MediaTrack.Transceiver
    MediaTrack.PeerConnection
    MediaTrack.Name
    Namespace: Microsoft.MixedReality.WebRTC
    Assembly: Microsoft.MixedReality.WebRTC.dll
    Syntax
    public class RemoteVideoTrack : MediaTrack, IVideoSource

    Properties

    | Improve this Doc View Source

    Enabled

    Enabled status of the track. If enabled, receives video frames from the remote peer as expected. If disabled, receives only black frames instead.

    Declaration
    public bool Enabled { get; }
    Property Value
    Type Description
    Boolean
    Remarks

    Reading the value of this property after the track has been disposed is valid, and returns false. The remote video track enabled status is controlled by the remote peer only.

    | Improve this Doc View Source

    FrameEncoding

    Video encoding indicating the kind of frames the source is producing.

    Declaration
    public VideoEncoding FrameEncoding { get; }
    Property Value
    Type Description
    VideoEncoding
    | Improve this Doc View Source

    NativeHandle

    Retrieves an unsafe handle to video track. Currently for internal use by the Unity NativeVideoRenderer component.

    Declaration
    public IntPtr NativeHandle { get; }
    Property Value
    Type Description
    IntPtr

    Methods

    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    MediaTrack.ToString()

    Events

    | Improve this Doc View Source

    Argb32VideoFrameReady

    Event that occurs when a new video frame is available from the source, either because the source produced it locally (VideoTrackSource, LocalVideoTrack) or because it received it from the remote peer (RemoteVideoTrack).

    Declaration
    public event Argb32VideoFrameDelegate Argb32VideoFrameReady
    Event Type
    Type Description
    Argb32VideoFrameDelegate
    Remarks

    The event delivers to the handlers an ARGB32-encoded video frame.

    This event is invoked on the WebRTC worker thread. Handlers can be added/removed safely while the event is invoked, but access to any resource used by its handlers must be synchronized manually. Note that a handler might be invoked (at most once) after it has been removed from the event.

    | Improve this Doc View Source

    I420AVideoFrameReady

    Event that occurs when a new video frame is available from the source, either because the source produced it locally (VideoTrackSource, LocalVideoTrack) or because it received it from the remote peer (RemoteVideoTrack).

    Declaration
    public event I420AVideoFrameDelegate I420AVideoFrameReady
    Event Type
    Type Description
    I420AVideoFrameDelegate
    Remarks

    The event delivers to the handlers an I420-encoded video frame.

    This event is invoked on the WebRTC worker thread. Handlers can be added/removed safely while the event is invoked, but access to any resource used by its handlers must be synchronized manually. Note that a handler might be invoked (at most once) after it has been removed from the event.

    Implements

    IVideoSource
    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • Enabled
      • FrameEncoding
      • NativeHandle
    • Methods
      • ToString()
    • Events
      • Argb32VideoFrameReady
      • I420AVideoFrameReady
    • Implements
    Back to top Generated by DocFX