Class RoomOptions

Namespace

LiveKit.Proto

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

Inheritance

object

RoomOptions

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

RoomOptions()

public RoomOptions()

RoomOptions(RoomOptions)

public RoomOptions(RoomOptions other)

Parameters

other RoomOptions

Fields

AdaptiveStreamFieldNumber

Field number for the "adaptive_stream" field.

public const int AdaptiveStreamFieldNumber = 2

Field Value

int

AutoSubscribeFieldNumber

Field number for the "auto_subscribe" field.

public const int AutoSubscribeFieldNumber = 1

Field Value

int

ConnectTimeoutMsFieldNumber

Field number for the "connect_timeout_ms" field.

public const int ConnectTimeoutMsFieldNumber = 9

Field Value

int

DynacastFieldNumber

Field number for the "dynacast" field.

public const int DynacastFieldNumber = 3

Field Value

int

E2EeFieldNumber

Field number for the "e2ee" field.

public const int E2EeFieldNumber = 4

Field Value

int

EncryptionFieldNumber

Field number for the "encryption" field.

public const int EncryptionFieldNumber = 7

Field Value

int

JoinRetriesFieldNumber

Field number for the "join_retries" field.

public const int JoinRetriesFieldNumber = 6

Field Value

int

RtcConfigFieldNumber

Field number for the "rtc_config" field.

public const int RtcConfigFieldNumber = 5

Field Value

int

SinglePeerConnectionFieldNumber

Field number for the "single_peer_connection" field.

public const int SinglePeerConnectionFieldNumber = 8

Field Value

int

Properties

AdaptiveStream

public bool AdaptiveStream { get; set; }

Property Value

bool

AutoSubscribe

public bool AutoSubscribe { get; set; }

Property Value

bool

ConnectTimeoutMs

timeout in milliseconds for each signal connection attempt (default: 5000)

public ulong ConnectTimeoutMs { get; set; }

Property Value

ulong

Descriptor

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

Property Value

MessageDescriptor

Dynacast

public bool Dynacast { get; set; }

Property Value

bool

E2Ee

[Obsolete]
public E2eeOptions E2Ee { get; set; }

Property Value

E2eeOptions

Encryption

public E2eeOptions Encryption { get; set; }

Property Value

E2eeOptions

HasAdaptiveStream

Gets whether the "adaptive_stream" field is set

public bool HasAdaptiveStream { get; }

Property Value

bool

HasAutoSubscribe

Gets whether the "auto_subscribe" field is set

public bool HasAutoSubscribe { get; }

Property Value

bool

HasConnectTimeoutMs

Gets whether the "connect_timeout_ms" field is set

public bool HasConnectTimeoutMs { get; }

Property Value

bool

HasDynacast

Gets whether the "dynacast" field is set

public bool HasDynacast { get; }

Property Value

bool

HasJoinRetries

Gets whether the "join_retries" field is set

public bool HasJoinRetries { get; }

Property Value

bool

HasSinglePeerConnection

Gets whether the "single_peer_connection" field is set

public bool HasSinglePeerConnection { get; }

Property Value

bool

JoinRetries

public uint JoinRetries { get; set; }

Property Value

uint

Parser

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

Property Value

MessageParser<RoomOptions>

RtcConfig

allow to setup a custom RtcConfiguration

public RtcConfig RtcConfig { get; set; }

Property Value

RtcConfig

SinglePeerConnection

use single peer connection for both publish/subscribe (default: false)

public bool SinglePeerConnection { get; set; }

Property Value

bool

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearAdaptiveStream()

Clears the value of the "adaptive_stream" field

public void ClearAdaptiveStream()

ClearAutoSubscribe()

Clears the value of the "auto_subscribe" field

public void ClearAutoSubscribe()

ClearConnectTimeoutMs()

Clears the value of the "connect_timeout_ms" field

public void ClearConnectTimeoutMs()

ClearDynacast()

Clears the value of the "dynacast" field

public void ClearDynacast()

ClearJoinRetries()

Clears the value of the "join_retries" field

public void ClearJoinRetries()

ClearSinglePeerConnection()

Clears the value of the "single_peer_connection" field

public void ClearSinglePeerConnection()

Clone()

public RoomOptions Clone()

Returns

RoomOptions

Equals(RoomOptions)

public bool Equals(RoomOptions other)

Parameters

other RoomOptions

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(RoomOptions)

public void MergeFrom(RoomOptions other)

Parameters

other RoomOptions

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream