Class Room

Namespace

LiveKit

public class Room

Inheritance

object

Room

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

ConnectionState

public ConnectionState ConnectionState { get; }

Property Value

ConnectionState

E2EEManager

public E2EEManager E2EEManager { get; }

Property Value

E2EEManager

IsConnected

public bool IsConnected { get; }

Property Value

bool

LocalParticipant

public LocalParticipant LocalParticipant { get; }

Property Value

LocalParticipant

Metadata

public string Metadata { get; }

Property Value

string

Name

public string Name { get; }

Property Value

string

NumParticipants

public uint NumParticipants { get; }

Property Value

uint

RemoteParticipants

public IReadOnlyDictionary<string, RemoteParticipant> RemoteParticipants { get; }

Property Value

IReadOnlyDictionary<string, RemoteParticipant>

Sid

public string Sid { get; }

Property Value

string

Methods

Connect(string, string, RoomOptions)

public ConnectInstruction Connect(string url, string token, RoomOptions options)

Parameters

url string

token string

options RoomOptions

Returns

ConnectInstruction

Disconnect()

public void Disconnect()

RegisterByteStreamHandler(string, ByteStreamHandler)

Registers a handler for incoming byte streams matching the given topic.

public void RegisterByteStreamHandler(string topic, ByteStreamHandler handler)

Parameters

topic string

Topic identifier that filters which streams will be handled. Only streams with a matching topic will trigger the handler.

handler ByteStreamHandler

Handler that is invoked whenever a remote participant opens a new stream with the matching topic. The handler receives a ByteStreamReader for consuming the stream data and the identity of the remote participant who initiated the stream.

RegisterTextStreamHandler(string, TextStreamHandler)

Registers a handler for incoming text streams matching the given topic.

public void RegisterTextStreamHandler(string topic, TextStreamHandler handler)

Parameters

topic string

Topic identifier that filters which streams will be handled. Only streams with a matching topic will trigger the handler.

handler TextStreamHandler

Handler that is invoked whenever a remote participant opens a new stream with the matching topic. The handler receives a TextStreamReader for consuming the stream data and the identity of the remote participant who initiated the stream.

UnregisterByteStreamHandler(string)

Unregisters a handler for incoming byte streams matching the given topic.

public void UnregisterByteStreamHandler(string topic)

Parameters

topic string

Topic identifier for which the handler should be unregistered.

UnregisterTextStreamHandler(string)

Unregisters a handler for incoming text streams matching the given topic.

public void UnregisterTextStreamHandler(string topic)

Parameters

topic string

Topic identifier for which the handler should be unregistered.

Events

ActiveSpeakersChanged

public event Room.SpeakersChangeDelegate ActiveSpeakersChanged

Event Type

Room.SpeakersChangeDelegate

Connected

public event Room.ConnectionDelegate Connected

Event Type

Room.ConnectionDelegate

ConnectionQualityChanged

public event Room.ConnectionQualityChangeDelegate ConnectionQualityChanged

Event Type

Room.ConnectionQualityChangeDelegate

ConnectionStateChanged

public event Room.ConnectionStateChangeDelegate ConnectionStateChanged

Event Type

Room.ConnectionStateChangeDelegate

DataReceived

public event Room.DataDelegate DataReceived

Event Type

Room.DataDelegate

DataTrackPublished

public event Room.DataTrackPublishedDelegate DataTrackPublished

Event Type

Room.DataTrackPublishedDelegate

DataTrackUnpublished

public event Room.DataTrackUnpublishedDelegate DataTrackUnpublished

Event Type

Room.DataTrackUnpublishedDelegate

Disconnected

public event Room.ConnectionDelegate Disconnected

Event Type

Room.ConnectionDelegate

E2EeStateChanged

public event Room.E2EeStateChangedDelegate E2EeStateChanged

Event Type

Room.E2EeStateChangedDelegate

LocalTrackPublished

public event Room.LocalPublishDelegate LocalTrackPublished

Event Type

Room.LocalPublishDelegate

LocalTrackUnpublished

public event Room.LocalPublishDelegate LocalTrackUnpublished

Event Type

Room.LocalPublishDelegate

ParticipantAttributesChanged

public event Room.ParticipantDelegate ParticipantAttributesChanged

Event Type

Room.ParticipantDelegate

ParticipantConnected

public event Room.ParticipantDelegate ParticipantConnected

Event Type

Room.ParticipantDelegate

ParticipantDisconnected

public event Room.ParticipantDelegate ParticipantDisconnected

Event Type

Room.ParticipantDelegate

ParticipantMetadataChanged

public event Room.ParticipantDelegate ParticipantMetadataChanged

Event Type

Room.ParticipantDelegate

ParticipantNameChanged

public event Room.ParticipantDelegate ParticipantNameChanged

Event Type

Room.ParticipantDelegate

Reconnected

public event Room.ConnectionDelegate Reconnected

Event Type

Room.ConnectionDelegate

Reconnecting

public event Room.ConnectionDelegate Reconnecting

Event Type

Room.ConnectionDelegate

RoomMetadataChanged

public event Room.MetaDelegate RoomMetadataChanged

Event Type

Room.MetaDelegate

SipDtmfReceived

public event Room.SipDtmfDelegate SipDtmfReceived

Event Type

Room.SipDtmfDelegate

TrackMuted

public event Room.MuteDelegate TrackMuted

Event Type

Room.MuteDelegate

TrackPublished

public event Room.PublishDelegate TrackPublished

Event Type

Room.PublishDelegate

TrackSubscribed

public event Room.SubscribeDelegate TrackSubscribed

Event Type

Room.SubscribeDelegate

TrackUnmuted

public event Room.MuteDelegate TrackUnmuted

Event Type

Room.MuteDelegate

TrackUnpublished

public event Room.PublishDelegate TrackUnpublished

Event Type

Room.PublishDelegate

TrackUnsubscribed

public event Room.SubscribeDelegate TrackUnsubscribed

Event Type

Room.SubscribeDelegate