Class TextStreamReader

Namespace

LiveKit

Reader for an incoming text data stream.

public sealed class TextStreamReader : IDisposable

Inheritance

object

TextStreamReader

Implements

IDisposable

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

public TextStreamInfo Info { get; }

Property Value

TextStreamInfo

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

ReadAll()

Reads all incoming chunks from the stream, concatenating them into a single value once the stream closes normally.

public TextStreamReader.ReadAllInstruction ReadAll()

Returns

TextStreamReader.ReadAllInstruction

A TextStreamReader.ReadAllInstruction that completes when the stream is complete or errors. Check ReadAllInstruction.IsError and access Text properties to handle the result.

Remarks

Calling this method consumes the stream reader.

ReadIncremental()

Reads incoming chunks from the stream incrementally.

public TextStreamReader.ReadIncrementalInstruction ReadIncremental()

Returns

TextStreamReader.ReadIncrementalInstruction

A TextStreamReader.ReadIncrementalInstruction that allows reading the stream incrementally.