Class RoomDataStreamOptions

Namespace

LiveKit.Proto

Options controlling data stream behavior for the room.

public sealed class RoomDataStreamOptions : Google.Protobuf.IMessage<RoomDataStreamOptions>, Google.Protobuf.IBufferMessage

Inheritance

object

RoomDataStreamOptions

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

RoomDataStreamOptions()

public RoomDataStreamOptions()

RoomDataStreamOptions(RoomDataStreamOptions)

public RoomDataStreamOptions(RoomDataStreamOptions other)

Parameters

other RoomDataStreamOptions

Fields

MaxPayloadByteLengthFieldNumber

Field number for the "max_payload_byte_length" field.

public const int MaxPayloadByteLengthFieldNumber = 1

Field Value

int

UseLegacyClientImplementationFieldNumber

Field number for the "use_legacy_client_implementation" field.

public const int UseLegacyClientImplementationFieldNumber = 2

Field Value

int

Properties

Descriptor

public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasMaxPayloadByteLength

Gets whether the "max_payload_byte_length" field is set

public bool HasMaxPayloadByteLength { get; }

Property Value

bool

HasUseLegacyClientImplementation

Gets whether the "use_legacy_client_implementation" field is set

public bool HasUseLegacyClientImplementation { get; }

Property Value

bool

MaxPayloadByteLength

Maximum decompressed payload size in bytes accepted for a single incoming data stream. Streams exceeding this limit terminate with an error on the receiving side. Unset falls back to the SDK default.

public ulong MaxPayloadByteLength { get; set; }

Property Value

ulong

Parser

public static Google.Protobuf.MessageParser<RoomDataStreamOptions> Parser { get; }

Property Value

MessageParser<RoomDataStreamOptions>

UseLegacyClientImplementation

Temporary migration aid for SDKs that still implement data streams in their own client-side code on top of the FFI instead of using the FFI data stream API. When true, this client does not advertise data streams v2 support: ClientInfo.client_protocol is capped at 1 (DATA_STREAM_RPC), so remote clients will not use v2-only behavior toward this client. Defaults to false (v2 advertised). Will be removed once all FFI consumers migrate.

public bool UseLegacyClientImplementation { get; set; }

Property Value

bool

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearMaxPayloadByteLength()

Clears the value of the "max_payload_byte_length" field

public void ClearMaxPayloadByteLength()

ClearUseLegacyClientImplementation()

Clears the value of the "use_legacy_client_implementation" field

public void ClearUseLegacyClientImplementation()

Clone()

public RoomDataStreamOptions Clone()

Returns

RoomDataStreamOptions

Equals(RoomDataStreamOptions)

public bool Equals(RoomDataStreamOptions other)

Parameters

other RoomDataStreamOptions

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

public void MergeFrom(Google.Protobuf.CodedInputStream input)

Parameters

input CodedInputStream

MergeFrom(RoomDataStreamOptions)

public void MergeFrom(RoomDataStreamOptions other)

Parameters

other RoomDataStreamOptions

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream