Class RoomConfiguration

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class RoomConfiguration : IMessage<RoomConfiguration>, IEquatable<RoomConfiguration>, IDeepCloneable<RoomConfiguration>, IBufferMessage, IMessage

Inheritance

object

RoomConfiguration

Implements

IMessage<RoomConfiguration>

IEquatable<RoomConfiguration>

IDeepCloneable<RoomConfiguration>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RoomConfiguration()

public RoomConfiguration()

RoomConfiguration(RoomConfiguration)

public RoomConfiguration(RoomConfiguration other)

Parameters

other RoomConfiguration

Fields

AgentsFieldNumber

Field number for the "agents" field.

public const int AgentsFieldNumber = 10

Field Value

int

DepartureTimeoutFieldNumber

Field number for the "departure_timeout" field.

public const int DepartureTimeoutFieldNumber = 3

Field Value

int

EgressFieldNumber

Field number for the "egress" field.

public const int EgressFieldNumber = 5

Field Value

int

EmptyTimeoutFieldNumber

Field number for the "empty_timeout" field.

public const int EmptyTimeoutFieldNumber = 2

Field Value

int

MaxParticipantsFieldNumber

Field number for the "max_participants" field.

public const int MaxParticipantsFieldNumber = 4

Field Value

int

MaxPlayoutDelayFieldNumber

Field number for the "max_playout_delay" field.

public const int MaxPlayoutDelayFieldNumber = 8

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 11

Field Value

int

MinPlayoutDelayFieldNumber

Field number for the "min_playout_delay" field.

public const int MinPlayoutDelayFieldNumber = 7

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

SyncStreamsFieldNumber

Field number for the "sync_streams" field.

public const int SyncStreamsFieldNumber = 9

Field Value

int

TagsFieldNumber

Field number for the "tags" field.

public const int TagsFieldNumber = 12

Field Value

int

Properties

Agents

Define agents that should be dispatched to this room

public RepeatedField<RoomAgentDispatch> Agents { get; }

Property Value

RepeatedField<RoomAgentDispatch>

DepartureTimeout

number of seconds to keep the room open after everyone leaves

public uint DepartureTimeout { get; set; }

Property Value

uint

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Egress

egress

public RoomEgress Egress { get; set; }

Property Value

RoomEgress

EmptyTimeout

number of seconds to keep the room open if no one joins

public uint EmptyTimeout { get; set; }

Property Value

uint

MaxParticipants

limit number of participants that can be in a room, excluding Egress and Ingress participants

public uint MaxParticipants { get; set; }

Property Value

uint

MaxPlayoutDelay

public uint MaxPlayoutDelay { get; set; }

Property Value

uint

Metadata

metadata of room

public string Metadata { get; set; }

Property Value

string

MinPlayoutDelay

playout delay of subscriber

public uint MinPlayoutDelay { get; set; }

Property Value

uint

Name

Used as ID, must be unique

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<RoomConfiguration> Parser { get; }

Property Value

MessageParser<RoomConfiguration>

SyncStreams

improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

public bool SyncStreams { get; set; }

Property Value

bool

Tags

Tags to attach to the room

public MapField<string, string> Tags { get; }

Property Value

MapField<string, string>

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public RoomConfiguration Clone()

Returns

RoomConfiguration

A deep clone of this object.

Equals(RoomConfiguration)

public bool Equals(RoomConfiguration other)

Parameters

other RoomConfiguration

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(RoomConfiguration)

Merges the given message into this one.

public void MergeFrom(RoomConfiguration other)

Parameters

other RoomConfiguration

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.