@livekit/components-js-docs 0.1.46 → 0.1.48
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.
- package/generated-docs/core/messagedecoder.md +1 -3
- package/generated-docs/core/messageencoder.md +1 -3
- package/generated-docs/react/audiovisualizerprops.md +1 -3
- package/generated-docs/react/component/audiovisualizer.md +1 -3
- package/generated-docs/react/component/livekitroom.md +1 -1
- package/generated-docs/react/component/prejoin.md +5 -0
- package/generated-docs/react/hook/uselivekitroom.md +1 -1
- package/generated-docs/react/hook/usespeakingparticipants.md +1 -1
- package/generated-docs/react/index.md +10 -10
- package/generated-docs/react/livekitroomprops.md +1 -1
- package/generated-docs/react/livekitroomprops.ondisconnected.md +1 -1
- package/generated-docs/react/messagedecoder.md +1 -3
- package/generated-docs/react/messageencoder.md +1 -3
- package/generated-docs/react/prejoinprops.md +1 -0
- package/generated-docs/react/prejoinprops.videoprocessor.md +13 -0
- package/package.json +2 -2
|
@@ -11,9 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
{% callout type="caution" variation="normal" %}
|
|
13
13
|
|
|
14
|
-
This API is deprecated:
|
|
15
|
-
|
|
16
|
-
the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
14
|
+
This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
17
15
|
|
|
18
16
|
{% /callout %}
|
|
19
17
|
|
|
@@ -11,9 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
{% callout type="caution" variation="normal" %}
|
|
13
13
|
|
|
14
|
-
This API is deprecated:
|
|
15
|
-
|
|
16
|
-
the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
14
|
+
This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
17
15
|
|
|
18
16
|
{% /callout %}
|
|
19
17
|
|
|
@@ -56,7 +56,7 @@ Define options how to connect to the LiveKit server.
|
|
|
56
56
|
{% parameter name="onConnected" type="() => void" optional=true %}
|
|
57
57
|
{% /parameter %}
|
|
58
58
|
|
|
59
|
-
{% parameter name="onDisconnected" type="() => void" optional=true %}
|
|
59
|
+
{% parameter name="onDisconnected" type="(reason?: DisconnectReason) => void" optional=true %}
|
|
60
60
|
{% /parameter %}
|
|
61
61
|
|
|
62
62
|
{% parameter name="onEncryptionError" type="(error: Error) => void" optional=true %}
|
|
@@ -49,15 +49,15 @@
|
|
|
49
49
|
|
|
50
50
|
## Prefabs
|
|
51
51
|
|
|
52
|
-
| Prefab
|
|
53
|
-
|
|
|
54
|
-
| [AudioConference({ ...props })](./react/component/audioconference.md)
|
|
55
|
-
| [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md)
|
|
56
|
-
| [ControlBar({ variation, controls, saveUserChoices, onDeviceError, ...props })](./react/component/controlbar.md)
|
|
57
|
-
| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)
|
|
58
|
-
| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
|
|
59
|
-
| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, ...props })](./react/component/videoconference.md)
|
|
60
|
-
| [VoiceAssistantControlBar({ controls, saveUserChoices, onDeviceError, ...props })](./react/component/voiceassistantcontrolbar.md)
|
|
52
|
+
| Prefab | Description |
|
|
53
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
54
|
+
| [AudioConference({ ...props })](./react/component/audioconference.md) | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view. |
|
|
55
|
+
| [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md) | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message. |
|
|
56
|
+
| [ControlBar({ variation, controls, saveUserChoices, onDeviceError, ...props })](./react/component/controlbar.md) | The <code>ControlBar</code> prefab gives the user the basic user interface to control their media devices (camera, microphone and screen share), open the <code>Chat</code> and leave the room. |
|
|
57
|
+
| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md) | The <code>MediaDeviceMenu</code> component is a button that opens a menu that lists all media devices and allows the user to select them. |
|
|
58
|
+
| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, videoProcessor, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
|
|
59
|
+
| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, ...props })](./react/component/videoconference.md) | The <code>VideoConference</code> ready-made component is your drop-in solution for a classic video conferencing application. It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers of participants, basic non-persistent chat, screen sharing, and more. |
|
|
60
|
+
| [VoiceAssistantControlBar({ controls, saveUserChoices, onDeviceError, ...props })](./react/component/voiceassistantcontrolbar.md) | **_(BETA)_** |
|
|
61
61
|
|
|
62
62
|
## Hooks
|
|
63
63
|
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
| [useRoomContext()](./react/hook/useroomcontext.md) | Ensures that a room is provided via context. If no room is provided, an error is thrown. |
|
|
117
117
|
| [useRoomInfo(options)](./react/hook/useroominfo.md) | |
|
|
118
118
|
| [useSortedParticipants(participants)](./react/hook/usesortedparticipants.md) | The <code>useSortedParticipants</code> hook returns the participants sorted by importance. |
|
|
119
|
-
| [useSpeakingParticipants()](./react/hook/usespeakingparticipants.md) | The <code>useSpeakingParticipants</code> hook returns
|
|
119
|
+
| [useSpeakingParticipants()](./react/hook/usespeakingparticipants.md) | The <code>useSpeakingParticipants</code> hook returns only the active speakers of all participants. |
|
|
120
120
|
| [useStartAudio({ room, props })](./react/hook/usestartaudio.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useStatAudio</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context. |
|
|
121
121
|
| [useStartVideo({ room, props })](./react/hook/usestartvideo.md) | In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The <code>useStartVideo</code> hook returns an object with a boolean <code>canPlayVideo</code> flag that indicates whether video playback is allowed in the current context, as well as a <code>startVideo</code> function that can be called in a button <code>onClick</code> callback to start video playback in the current context. |
|
|
122
122
|
| [useSwipe(element, options)](./react/hook/useswipe.md) | Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes. |
|
|
@@ -27,7 +27,7 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
|
|
|
27
27
|
| [connect?](./react/livekitroomprops.connect.md) | boolean | _(Optional)_ If set to true a connection to LiveKit room is initiated. |
|
|
28
28
|
| [connectOptions?](./react/livekitroomprops.connectoptions.md) | RoomConnectOptions | _(Optional)_ Define options how to connect to the LiveKit server. |
|
|
29
29
|
| [onConnected?](./react/livekitroomprops.onconnected.md) | () => void | _(Optional)_ |
|
|
30
|
-
| [onDisconnected?](./react/livekitroomprops.ondisconnected.md) | () => void
|
|
30
|
+
| [onDisconnected?](./react/livekitroomprops.ondisconnected.md) | (reason?: DisconnectReason) => void | _(Optional)_ |
|
|
31
31
|
| [onEncryptionError?](./react/livekitroomprops.onencryptionerror.md) | (error: Error) => void | _(Optional)_ |
|
|
32
32
|
| [onError?](./react/livekitroomprops.onerror.md) | (error: Error) => void | _(Optional)_ |
|
|
33
33
|
| [onMediaDeviceFailure?](./react/livekitroomprops.onmediadevicefailure.md) | (failure?: MediaDeviceFailure) => void | _(Optional)_ |
|
|
@@ -11,9 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
{% callout type="caution" variation="normal" %}
|
|
13
13
|
|
|
14
|
-
This API is deprecated:
|
|
15
|
-
|
|
16
|
-
the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
14
|
+
This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
17
15
|
|
|
18
16
|
{% /callout %}
|
|
19
17
|
|
|
@@ -11,9 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
{% callout type="caution" variation="normal" %}
|
|
13
13
|
|
|
14
|
-
This API is deprecated:
|
|
15
|
-
|
|
16
|
-
the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
14
|
+
This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
|
|
17
15
|
|
|
18
16
|
{% /callout %}
|
|
19
17
|
|
|
@@ -35,3 +35,4 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
|
|
|
35
35
|
| [onValidate?](./react/prejoinprops.onvalidate.md) | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) => boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
|
|
36
36
|
| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean | _(Optional)_ If true, user choices are persisted across sessions. |
|
|
37
37
|
| [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
|
|
38
|
+
| [videoProcessor?](./react/prejoinprops.videoprocessor.md) | TrackProcessor<Track.Kind.Video> | _(Optional)_ |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "PreJoinProps.videoProcessor property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# PreJoinProps.videoProcessor property
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
videoProcessor?: TrackProcessor<Track.Kind.Video>;
|
|
13
|
+
```
|
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.48",
|
|
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.6.
|
|
11
|
+
"@livekit/components-react": "2.6.10"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|