UseRoomProps
Defined in: packages/react/src/hooks/connection/useRoom.ts:14
Properties
serverUrl
serverUrl: string | undefined;Defined in: packages/react/src/hooks/connection/useRoom.ts:16
URL to the media server. To simplify the implementation, undefined is also accepted as an intermediate value.
token
token: string | undefined;Defined in: packages/react/src/hooks/connection/useRoom.ts:18
A user-specific access token to authenticate to the room. To simplify the implementation, undefined is also accepted.
audio?
optional audio?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:20
Publish audio immediately after connecting to the room.
connect?
optional connect?: boolean;Defined in: packages/react/src/hooks/connection/useRoom.ts:22
If set to true a connection to the room is initiated.
connectOptions?
optional connectOptions?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:24
Define options for how to connect to the server.
onConnected?
optional onConnected?: () => void;Defined in: packages/react/src/hooks/connection/useRoom.ts:26
The props.onConnected property.
Returns
void
onDisconnected?
optional onDisconnected?: (reason?) => void;Defined in: packages/react/src/hooks/connection/useRoom.ts:28
The props.onDisconnected property.
Parameters
| Parameter | Type |
|---|---|
reason? | unknown |
Returns
void
onEncryptionError?
optional onEncryptionError?: (error) => void;Defined in: packages/react/src/hooks/connection/useRoom.ts:30
The props.onEncryptionError property.
Parameters
| Parameter | Type |
|---|---|
error | Error |
Returns
void
onError?
optional onError?: (error) => void;Defined in: packages/react/src/hooks/connection/useRoom.ts:32
The props.onError property.
Parameters
| Parameter | Type |
|---|---|
error | Error |
Returns
void
onMediaDeviceFailure?
optional onMediaDeviceFailure?: (failure?, kind?) => void;Defined in: packages/react/src/hooks/connection/useRoom.ts:34
The props.onMediaDeviceFailure property.
Parameters
| Parameter | Type |
|---|---|
failure? | unknown |
kind? | MediaDeviceKind |
Returns
void
options?
optional options?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:36
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.
room?
optional room?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:38
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?
optional screen?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:40
Publish screen share immediately after connecting to the room.
simulateParticipants?
optional simulateParticipants?: number;Defined in: packages/react/src/hooks/connection/useRoom.ts:42
The props.simulateParticipants property.
video?
optional video?: unknown;Defined in: packages/react/src/hooks/connection/useRoom.ts:44
Publish video immediately after connecting to the room.