Class RemoteDataTrack

Namespace

LiveKit.Rtc

Assembly

LivekitRtc.dll

A data track published by a remote participant. Delivered by DataTrackPublished; call Subscribe(uint?) to receive its frames.

public class RemoteDataTrack : IDisposable

Inheritance

object

RemoteDataTrack

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Info

Information about the data track.

public DataTrackInfo Info { get; }

Property Value

DataTrackInfo

PublisherIdentity

Identity of the participant who published the track.

public string PublisherIdentity { get; }

Property Value

string

Methods

Dispose()

Releases the native handle of the track. The streams returned by Subscribe(uint?) are disposed separately.

public void Dispose()

IsPublished()

Whether the track is still published.

public bool IsPublished()

Returns

bool

True while the publisher keeps the track published.

SetPipelineOptions(uint?)

Configures how incoming packets are reassembled into frames for this track. The options apply to all current and future subscriptions and take effect with the next packet.

public void SetPipelineOptions(uint? maxPartialFrames = null)

Parameters

maxPartialFrames uint?

Maximum number of partial frames tracked concurrently (default 1). Higher values tolerate more reordering for high-frequency senders at the cost of buffering. Zero is clamped to one; null keeps the current value.

Subscribe(uint?)

Subscribes to the track. The returned stream yields the frames as they arrive; dispose it to unsubscribe.

public DataTrackStream Subscribe(uint? bufferSize = null)

Parameters

bufferSize uint?

Maximum number of received frames buffered internally. Null keeps the SDK default. Zero is not valid and is clamped to one.

Returns

DataTrackStream

The stream of frames; dispose it to unsubscribe.