@livekit/components-js-docs 0.1.57 → 0.1.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -72,7 +72,7 @@ _(Optional)_
|
|
|
72
72
|
|
|
73
73
|
{% /parameter %}
|
|
74
74
|
|
|
75
|
-
{% parameter name="onMediaDeviceFailure" type="(failure?: MediaDeviceFailure) => void" optional=true %}
|
|
75
|
+
{% parameter name="onMediaDeviceFailure" type="(failure?: MediaDeviceFailure, kind?: MediaDeviceKind) => void" optional=true %}
|
|
76
76
|
_(Optional)_
|
|
77
77
|
|
|
78
78
|
{% /parameter %}
|
|
@@ -63,7 +63,7 @@ Define options how to connect to the LiveKit server.
|
|
|
63
63
|
{% parameter name="props.onError" type="(error: Error) => void" optional=true %}
|
|
64
64
|
{% /parameter %}
|
|
65
65
|
|
|
66
|
-
{% parameter name="props.onMediaDeviceFailure" type="(failure?: MediaDeviceFailure) => void" optional=true %}
|
|
66
|
+
{% parameter name="props.onMediaDeviceFailure" type="(failure?: MediaDeviceFailure, kind?: MediaDeviceKind) => void" optional=true %}
|
|
67
67
|
{% /parameter %}
|
|
68
68
|
|
|
69
69
|
{% parameter name="props.options" type="RoomOptions" optional=true %}
|
|
@@ -19,20 +19,20 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
|
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
|
-
| Property | Type
|
|
23
|
-
| ------------------------------------------------------------------------- |
|
|
24
|
-
| [audio?](./react/livekitroomprops.audio.md) | AudioCaptureOptions \| boolean
|
|
25
|
-
| [connect?](./react/livekitroomprops.connect.md) | boolean
|
|
26
|
-
| [connectOptions?](./react/livekitroomprops.connectoptions.md) | RoomConnectOptions
|
|
27
|
-
| [onConnected?](./react/livekitroomprops.onconnected.md) | () => void
|
|
28
|
-
| [onDisconnected?](./react/livekitroomprops.ondisconnected.md) | (reason?: DisconnectReason) => void
|
|
29
|
-
| [onEncryptionError?](./react/livekitroomprops.onencryptionerror.md) | (error: Error) => void
|
|
30
|
-
| [onError?](./react/livekitroomprops.onerror.md) | (error: Error) => void
|
|
31
|
-
| [onMediaDeviceFailure?](./react/livekitroomprops.onmediadevicefailure.md) | (failure?: MediaDeviceFailure) => void | _(Optional)_ |
|
|
32
|
-
| [options?](./react/livekitroomprops.options.md) | RoomOptions
|
|
33
|
-
| [room?](./react/livekitroomprops.room.md) | Room
|
|
34
|
-
| [screen?](./react/livekitroomprops.screen.md) | ScreenShareCaptureOptions \| boolean
|
|
35
|
-
| [serverUrl](./react/livekitroomprops.serverurl.md) | string \| undefined
|
|
36
|
-
| [simulateParticipants?](./react/livekitroomprops.simulateparticipants.md) | number \| undefined
|
|
37
|
-
| [token](./react/livekitroomprops.token.md) | string \| undefined
|
|
38
|
-
| [video?](./react/livekitroomprops.video.md) | VideoCaptureOptions \| boolean
|
|
22
|
+
| Property | Type | Description |
|
|
23
|
+
| ------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
24
|
+
| [audio?](./react/livekitroomprops.audio.md) | AudioCaptureOptions \| boolean | _(Optional)_ Publish audio immediately after connecting to your LiveKit room. |
|
|
25
|
+
| [connect?](./react/livekitroomprops.connect.md) | boolean | _(Optional)_ If set to true a connection to LiveKit room is initiated. |
|
|
26
|
+
| [connectOptions?](./react/livekitroomprops.connectoptions.md) | RoomConnectOptions | _(Optional)_ Define options how to connect to the LiveKit server. |
|
|
27
|
+
| [onConnected?](./react/livekitroomprops.onconnected.md) | () => void | _(Optional)_ |
|
|
28
|
+
| [onDisconnected?](./react/livekitroomprops.ondisconnected.md) | (reason?: DisconnectReason) => void | _(Optional)_ |
|
|
29
|
+
| [onEncryptionError?](./react/livekitroomprops.onencryptionerror.md) | (error: Error) => void | _(Optional)_ |
|
|
30
|
+
| [onError?](./react/livekitroomprops.onerror.md) | (error: Error) => void | _(Optional)_ |
|
|
31
|
+
| [onMediaDeviceFailure?](./react/livekitroomprops.onmediadevicefailure.md) | (failure?: MediaDeviceFailure, kind?: MediaDeviceKind) => void | _(Optional)_ |
|
|
32
|
+
| [options?](./react/livekitroomprops.options.md) | RoomOptions | _(Optional)_ 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. |
|
|
33
|
+
| [room?](./react/livekitroomprops.room.md) | Room | _(Optional)_ Optional room instance. By passing your own room instance you overwrite the <code>options</code> parameter, make sure to set the options directly on the room instance itself. |
|
|
34
|
+
| [screen?](./react/livekitroomprops.screen.md) | ScreenShareCaptureOptions \| boolean | _(Optional)_ Publish screen share immediately after connecting to your LiveKit room. |
|
|
35
|
+
| [serverUrl](./react/livekitroomprops.serverurl.md) | string \| undefined | URL to the LiveKit server. For example: <code>wss://<domain>.livekit.cloud</code> To simplify the implementation, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string url can the connection be established. |
|
|
36
|
+
| [simulateParticipants?](./react/livekitroomprops.simulateparticipants.md) | number \| undefined | _(Optional)_ |
|
|
37
|
+
| [token](./react/livekitroomprops.token.md) | string \| undefined | 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, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string token can the connection be established. |
|
|
38
|
+
| [video?](./react/livekitroomprops.video.md) | VideoCaptureOptions \| boolean | _(Optional)_ Publish video immediately after connecting to your LiveKit room. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@livekit/components-js-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.58",
|
|
4
4
|
"description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"directory": "/docs/beta-docs"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@livekit/components-react": "2.9.
|
|
11
|
+
"@livekit/components-react": "2.9.5"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|