Class RemoteDataTrack

Namespace

LiveKit

Data track published by a remote participant.

public sealed class RemoteDataTrack

Inheritance

object

RemoteDataTrack

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

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

IsPublished()

Whether or not the track is still published.

public bool IsPublished()

Returns

bool

true if the track is published; false otherwise.

SetPipelineOptions(RemoteDataTrackPipelineOptions)

Configures options for the pipeline handling incoming packets for this track.

public void SetPipelineOptions(RemoteDataTrackPipelineOptions options)

Parameters

options RemoteDataTrackPipelineOptions

The pipeline options to apply.

Remarks

These options apply to all current and future subscriptions of this track, and may be set at any time. New options take effect with the next received packet.

Subscribe()

Subscribes to the data track to receive frames using default options.

public DataTrackStream Subscribe()

Returns

DataTrackStream

A DataTrackStream for reading frames.

Remarks

Use the Subscribe(DataTrackSubscribeOptions) overload to configure subscription options.

Subscribe(DataTrackSubscribeOptions)

Subscribes to the data track to receive frames.

public DataTrackStream Subscribe(DataTrackSubscribeOptions options)

Parameters

options DataTrackSubscribeOptions

Options for the subscription, such as buffer size.

Returns

DataTrackStream

A DataTrackStream for reading frames.