Search Results for

    Show / Hide Table of Contents

    Class Room

    Inheritance
    System.Object
    JSRef
    JSObject
    JSEventEmitter<RoomEvent>
    Room
    Implements
    System.IDisposable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: LiveKit
    Assembly: cs.temp.dll.dll
    Syntax
    public class Room : JSEventEmitter<RoomEvent>, IDisposable

    Constructors

    Room(Nullable<RoomOptions>)

    Declaration
    public Room(RoomOptions? options = null)
    Parameters
    Type Name Description
    System.Nullable<RoomOptions> options

    Properties

    ActiveSpeakers

    Declaration
    public JSArray<Participant> ActiveSpeakers { get; }
    Property Value
    Type Description
    JSArray<Participant>

    CanPlaybackAudio

    Declaration
    public bool CanPlaybackAudio { get; }
    Property Value
    Type Description
    System.Boolean

    IsClosed

    Declaration
    public bool IsClosed { get; }
    Property Value
    Type Description
    System.Boolean

    LocalParticipant

    Declaration
    public LocalParticipant LocalParticipant { get; }
    Property Value
    Type Description
    LocalParticipant

    Metadata

    Declaration
    public string Metadata { get; }
    Property Value
    Type Description
    System.String

    Name

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    System.String

    RemoteParticipants

    Declaration
    public JSMap<string, RemoteParticipant> RemoteParticipants { get; }
    Property Value
    Type Description
    JSMap<System.String, RemoteParticipant>

    RoomOptions

    Declaration
    public RoomOptions RoomOptions { get; }
    Property Value
    Type Description
    RoomOptions

    State

    Declaration
    public ConnectionState State { get; }
    Property Value
    Type Description
    ConnectionState

    Methods

    Connect(String, String, Nullable<RoomConnectOptions>)

    Declaration
    public ConnectOperation Connect(string url, string token, RoomConnectOptions? options = null)
    Parameters
    Type Name Description
    System.String url
    System.String token
    System.Nullable<RoomConnectOptions> options
    Returns
    Type Description
    ConnectOperation

    Disconnect(Boolean)

    Declaration
    public void Disconnect(bool stopTracks = true)
    Parameters
    Type Name Description
    System.Boolean stopTracks

    Dispose()

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    LiveKit.JSEventEmitter<LiveKit.RoomEvent>.Dispose(System.Boolean)

    GetLocalDevices(Nullable<MediaDeviceKind>, Nullable<Boolean>)

    Declaration
    public static JSPromise<JSArray<MediaDeviceInfo>> GetLocalDevices(MediaDeviceKind? kind = null, bool? requestPermissions = null)
    Parameters
    Type Name Description
    System.Nullable<MediaDeviceKind> kind
    System.Nullable<System.Boolean> requestPermissions
    Returns
    Type Description
    JSPromise<JSArray<MediaDeviceInfo>>

    GetParticipantByIdentity(String)

    Declaration
    public Participant GetParticipantByIdentity(string identity)
    Parameters
    Type Name Description
    System.String identity
    Returns
    Type Description
    Participant

    GetSid()

    Declaration
    public JSPromise<JSObject> GetSid()
    Returns
    Type Description
    JSPromise<JSObject>

    StartAudio()

    Declaration
    public JSPromise StartAudio()
    Returns
    Type Description
    JSPromise

    SwitchActiveDevice(MediaDeviceKind, String)

    Declaration
    public JSPromise SwitchActiveDevice(MediaDeviceKind kind, string deviceId)
    Parameters
    Type Name Description
    MediaDeviceKind kind
    System.String deviceId
    Returns
    Type Description
    JSPromise

    Events

    ActiveSpeakersChanged

    Declaration
    public event Room.ActiveSpeakersChangedDelegate ActiveSpeakersChanged
    Event Type
    Type Description
    Room.ActiveSpeakersChangedDelegate

    AttributesChanged

    Declaration
    public event Room.AttributesChangedDelegate AttributesChanged
    Event Type
    Type Description
    Room.AttributesChangedDelegate

    AudioPlaybackChanged

    Declaration
    public event Room.AudioPlaybackChangedDelegate AudioPlaybackChanged
    Event Type
    Type Description
    Room.AudioPlaybackChangedDelegate

    ConnectionQualityChanged

    Declaration
    public event Room.ConnectionQualityChangedDelegate ConnectionQualityChanged
    Event Type
    Type Description
    Room.ConnectionQualityChangedDelegate

    DataReceived

    Declaration
    public event Room.DataReceivedDelegate DataReceived
    Event Type
    Type Description
    Room.DataReceivedDelegate

    Disconnected

    Declaration
    public event Room.DisconnectedDelegate Disconnected
    Event Type
    Type Description
    Room.DisconnectedDelegate

    LocalTrackPublished

    Declaration
    public event Room.LocalTrackPublishedDelegate LocalTrackPublished
    Event Type
    Type Description
    Room.LocalTrackPublishedDelegate

    LocalTrackUnpublished

    Declaration
    public event Room.LocalTrackUnpublishedDelegate LocalTrackUnpublished
    Event Type
    Type Description
    Room.LocalTrackUnpublishedDelegate

    MediaDevicesChanged

    Declaration
    public event Room.MediaDevicesChangedDelegate MediaDevicesChanged
    Event Type
    Type Description
    Room.MediaDevicesChangedDelegate

    MediaDevicesError

    Declaration
    public event Room.MediaDevicesErrorDelegate MediaDevicesError
    Event Type
    Type Description
    Room.MediaDevicesErrorDelegate

    ParticipantConnected

    Declaration
    public event Room.ParticipantConnectedDelegate ParticipantConnected
    Event Type
    Type Description
    Room.ParticipantConnectedDelegate

    ParticipantDisconnected

    Declaration
    public event Room.ParticipantDisconnectedDelegate ParticipantDisconnected
    Event Type
    Type Description
    Room.ParticipantDisconnectedDelegate

    ParticipantMetadataChanged

    Declaration
    public event Room.ParticipantMetadataChangedDelegate ParticipantMetadataChanged
    Event Type
    Type Description
    Room.ParticipantMetadataChangedDelegate

    Reconnected

    Declaration
    public event Room.ReconnectedDelegate Reconnected
    Event Type
    Type Description
    Room.ReconnectedDelegate

    Reconnecting

    Declaration
    public event Room.ReconnectingDelegate Reconnecting
    Event Type
    Type Description
    Room.ReconnectingDelegate

    RoomMetadataChanged

    Declaration
    public event Room.RoomMetadataChangedDelegate RoomMetadataChanged
    Event Type
    Type Description
    Room.RoomMetadataChangedDelegate

    TrackMuted

    Declaration
    public event Room.TrackMutedDelegate TrackMuted
    Event Type
    Type Description
    Room.TrackMutedDelegate

    TrackPublished

    Declaration
    public event Room.TrackPublishedDelegate TrackPublished
    Event Type
    Type Description
    Room.TrackPublishedDelegate

    TrackStreamStateChanged

    Declaration
    public event Room.TrackStreamStateChangedDelegate TrackStreamStateChanged
    Event Type
    Type Description
    Room.TrackStreamStateChangedDelegate

    TrackSubscribed

    Declaration
    public event Room.TrackSubscribedDelegate TrackSubscribed
    Event Type
    Type Description
    Room.TrackSubscribedDelegate

    TrackSubscriptionFailed

    Declaration
    public event Room.TrackSubscriptionFailedDelegate TrackSubscriptionFailed
    Event Type
    Type Description
    Room.TrackSubscriptionFailedDelegate

    TrackSubscriptionPermissionChanged

    Declaration
    public event Room.TrackSubscriptionPermissionChangedDelegate TrackSubscriptionPermissionChanged
    Event Type
    Type Description
    Room.TrackSubscriptionPermissionChangedDelegate

    TrackUnmuted

    Declaration
    public event Room.TrackUnmutedDelegate TrackUnmuted
    Event Type
    Type Description
    Room.TrackUnmutedDelegate

    TrackUnpublished

    Declaration
    public event Room.TrackUnpublishedDelegate TrackUnpublished
    Event Type
    Type Description
    Room.TrackUnpublishedDelegate

    TrackUnsubscribed

    Declaration
    public event Room.TrackUnsubscribedDelegate TrackUnsubscribed
    Event Type
    Type Description
    Room.TrackUnsubscribedDelegate

    Implements

    System.IDisposable
    In This Article
    Back to top LiveKit Client SDK for Unity WebGL