Class StreamYieldInstruction

Namespace

LiveKit.Internal.Threading

public class StreamYieldInstruction : CustomYieldInstruction

Inheritance

object

StreamYieldInstruction

Derived

ReadIncrementalInstructionBase<TContent>

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Properties

IsCurrentReadDone

True once a chunk is ready for the current read (before Reset() is called for the next one). Public getter mirrors the sibling DataTrack.ReadFrameInstruction.IsCurrentReadDone; the setter stays internal because only the SDK's stream readers advance this state.

public bool IsCurrentReadDone { get; }

Property Value

bool

IsEos

True if the stream has reached the end.

public bool IsEos { get; protected set; }

Property Value

bool

keepWaiting

public override bool keepWaiting { get; }

Property Value

bool

Methods

GetAwaiter()

Returns an awaiter that completes when the next chunk is ready or the stream ends. Call Reset() between iterations to await the following chunk.

public StreamYieldInstructionAwaiter GetAwaiter()

Returns

StreamYieldInstructionAwaiter

Reset()

Resets the yield instruction for the next read.

public override void Reset()

Remarks

Calling this method after IsEos is true will throw an exception.