docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RTCRtpReceiver

    Represents a receiver for RTP streams.

    Inheritance
    object
    RefCountedObject
    RTCRtpReceiver
    Implements
    IDisposable
    Inherited Members
    RefCountedObject.disposed
    Namespace: Unity.WebRTC
    Assembly: Unity.WebRTC.dll
    Syntax
    public class RTCRtpReceiver : RefCountedObject, IDisposable

    Properties

    Streams

    Gets the media streams associated with the receiver.

    Declaration
    public IEnumerable<MediaStream> Streams { get; }
    Property Value
    Type Description
    IEnumerable<MediaStream>

    Track

    Gets the media stream track associated with the receiver.

    Declaration
    public MediaStreamTrack Track { get; }
    Property Value
    Type Description
    MediaStreamTrack

    Transform

    Gets or sets the RTP transform for the receiver.

    Declaration
    public RTCRtpTransform Transform { get; set; }
    Property Value
    Type Description
    RTCRtpTransform

    Methods

    Dispose()

    Releases resources used by the object.

    Declaration
    public override void Dispose()
    Overrides
    RefCountedObject.Dispose()

    ~RTCRtpReceiver()

    Finalizer for RTCRtpReceiver.

    Declaration
    protected ~RTCRtpReceiver()

    GetCapabilities(TrackKind)

    Gets the capabilities of the RTP receiver.

    Declaration
    public static RTCRtpCapabilities GetCapabilities(TrackKind kind)
    Parameters
    Type Name Description
    TrackKind kind

    The type of media track (audio or video).

    Returns
    Type Description
    RTCRtpCapabilities

    Capabilities supported by the receiver.

    GetContributingSources()

    Gets the contributing sources for the receiver.

    Declaration
    public RTCRtpContributingSource[] GetContributingSources()
    Returns
    Type Description
    RTCRtpContributingSource[]

    Returns an array of contributing sources.

    GetStats()

    Gets the statistics report for the receiver.

    Declaration
    public RTCStatsReportAsyncOperation GetStats()
    Returns
    Type Description
    RTCStatsReportAsyncOperation

    Returns an asynchronous operation for retrieving receiver statistics.

    GetSynchronizationSources()

    Gets the synchronization sources for the receiver.

    Declaration
    public RTCRtpContributingSource[] GetSynchronizationSources()
    Returns
    Type Description
    RTCRtpContributingSource[]

    Returns an array of synchronization sources.

    Implements

    IDisposable
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)