Class TextStreamWriter

Namespace

LiveKit

Writer for an outgoing text data stream.

public class TextStreamWriter : IDisposable

Inheritance

object

TextStreamWriter

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Properties

Info

public TextStreamInfo Info { get; }

Property Value

TextStreamInfo

Methods

Close(string)

Closes the stream.

public TextStreamWriter.CloseInstruction Close(string reason = "")

Parameters

reason string

A string specifying the reason for closure, if the stream is not being closed normally.

Returns

TextStreamWriter.CloseInstruction

A TextStreamWriter.CloseInstruction that completes when the close operation is complete or errors. Check CloseInstruction.Error to see if the operation was successful.

Dispose()

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

public void Dispose()

Write(string)

Writes text to the stream.

public TextStreamWriter.WriteInstruction Write(string text)

Parameters

text string

The text to write.

Returns

TextStreamWriter.WriteInstruction

A TextStreamWriter.WriteInstruction that completes when the write operation is complete or errors. Check WriteInstruction.Error to see if the operation was successful.