Interface LiveKitRoomProps

Hierarchy

  • LiveKitRoomProps

Properties

audio?: boolean | AudioCaptureOptions

Publish audio immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html

connect?: boolean

If set to true a connection to LiveKit room is initiated.

Default Value

false

connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomConnectOptions.html

featureFlags?: FeatureFlags
onConnected?: (() => void)

Type declaration

    • (): void
    • Returns void

onDisconnected?: (() => void)

Type declaration

    • (): void
    • Returns void

onEncryptionError?: ((error: Error) => void)

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onError?: ((error: Error) => void)

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onMediaDeviceFailure?: ((failure?: MediaDeviceFailure) => void)

Type declaration

    • (failure?: MediaDeviceFailure): void
    • Parameters

      • Optional failure: MediaDeviceFailure

      Returns void

options?: RoomOptions

Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html

room?: Room

Optional room instance. By passing your own room instance you overwrite the options parameter, make sure to set the options directly on the room instance itself.

screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/ScreenShareCaptureOptions.html

serverUrl: undefined | string

URL to the LiveKit server. For example: wss://<domain>.livekit.cloud To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string url can the connection be established.

simulateParticipants?: number
token: undefined | string

A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string token can the connection be established.

See

https://docs.livekit.io/cloud/project-management/keys-and-tokens/#generating-access-tokens

video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html

Generated using TypeDoc