Optional
audioOptional
connectIf set to true a connection to LiveKit room is initiated.
false
Optional
connectDefine options how to connect to the LiveKit server.
https://docs.livekit.io/client-sdk-js/interfaces/RoomConnectOptions.html
Optional
Experimental
featureOptional
onOptional
onOptional
onOptional
onOptional
onOptional
failure: MediaDeviceFailureOptional
optionsOptions 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.
https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html
Optional
roomOptional 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.
Optional
screenPublish screen share immediately after connecting to your LiveKit room.
false
https://docs.livekit.io/client-sdk-js/interfaces/ScreenShareCaptureOptions.html
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.
Optional
simulateA 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.
https://docs.livekit.io/cloud/project-management/keys-and-tokens/#generating-access-tokens
Optional
videoPublish video immediately after connecting to your LiveKit room.
false
https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html
Generated using TypeDoc
Publish audio immediately after connecting to your LiveKit room.
Default Value
false
See
https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html