@livekit/components-js-docs 0.1.6 → 0.1.8
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/chatmessage.id.md +13 -0
- package/generated-docs/core/chatmessage.md +1 -0
- package/generated-docs/core/chatoptions.md +1 -0
- package/generated-docs/core/datatopic.md +1 -0
- package/generated-docs/core/index.md +1 -0
- package/generated-docs/core/receivedchatmessage.edittimestamp.md +13 -0
- package/generated-docs/core/receivedchatmessage.md +4 -3
- package/generated-docs/core/setlogextension.md +23 -0
- package/generated-docs/core/setupchat.md +2 -1
- package/generated-docs/core/setupdatamessagehandler.md +1 -1
- package/generated-docs/core/setupmanualtoggle.md +1 -1
- package/generated-docs/react/audiovisualizerprops.md +4 -4
- package/generated-docs/react/audiovisualizerprops.trackref.md +1 -1
- package/generated-docs/react/chatmessage.id.md +13 -0
- package/generated-docs/react/chatmessage.md +1 -0
- package/generated-docs/react/component/audiovisualizer.md +1 -1
- package/generated-docs/react/hook/usechat.md +4 -3
- package/generated-docs/react/hook/usetracktoggle.md +8 -5
- package/generated-docs/react/index.md +86 -82
- package/generated-docs/react/multibandtrackvolumeoptions.analyseroptions.md +13 -0
- package/generated-docs/react/multibandtrackvolumeoptions.bands.md +13 -0
- package/generated-docs/react/multibandtrackvolumeoptions.hipass.md +17 -0
- package/generated-docs/react/multibandtrackvolumeoptions.lopass.md +17 -0
- package/generated-docs/react/multibandtrackvolumeoptions.md +30 -0
- package/generated-docs/react/multibandtrackvolumeoptions.updateinterval.md +17 -0
- package/generated-docs/react/receivedchatmessage.edittimestamp.md +13 -0
- package/generated-docs/react/receivedchatmessage.md +4 -3
- package/generated-docs/react/setlogextension.md +23 -0
- package/generated-docs/react/usemultibandtrackvolume.md +20 -0
- package/generated-docs/react/usetrackvolume.md +23 -0
- package/package.json +2 -2
|
@@ -21,5 +21,6 @@ export interface ChatMessage
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description |
|
|
23
23
|
| -------------------------------------------- | ------ | ----------- |
|
|
24
|
+
| [id](./core/chatmessage.id.md) | string | |
|
|
24
25
|
| [message](./core/chatmessage.message.md) | string | |
|
|
25
26
|
| [timestamp](./core/chatmessage.timestamp.md) | number | |
|
|
@@ -85,6 +85,7 @@
|
|
|
85
85
|
| [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
|
|
86
86
|
| [sendMessage(localParticipant, payload, topic, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
|
|
87
87
|
| [setDifference(setA, setB)](./core/setdifference.md) | |
|
|
88
|
+
| [setLogExtension(extension, options)](./core/setlogextension.md) | Set the log extension for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log extension, use the <code>liveKitClientLogExtension</code> prop on the <code>options</code> object. |
|
|
88
89
|
| [setLogLevel(level, options)](./core/setloglevel.md) | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object. |
|
|
89
90
|
| [SetMediaDeviceOptions](./core/setmediadeviceoptions.md) | |
|
|
90
91
|
| [setupChat(room, options)](./core/setupchat.md) | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "ReceivedChatMessage.editTimestamp property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# ReceivedChatMessage.editTimestamp property
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
editTimestamp?: number;
|
|
13
|
+
```
|
|
@@ -21,6 +21,7 @@ export interface ReceivedChatMessage extends ChatMessage
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property
|
|
25
|
-
|
|
|
26
|
-
| [
|
|
24
|
+
| Property | Type | Description |
|
|
25
|
+
| ------------------------------------------------------------- | ----------- | ------------ |
|
|
26
|
+
| [editTimestamp?](./core/receivedchatmessage.edittimestamp.md) | number | _(Optional)_ |
|
|
27
|
+
| [from?](./core/receivedchatmessage.from.md) | Participant | _(Optional)_ |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "setLogExtension",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# setLogExtension
|
|
11
|
+
|
|
12
|
+
Set the log extension for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log extension, use the `liveKitClientLogExtension` prop on the `options` object.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
export declare function setLogExtension(
|
|
18
|
+
extension: LogExtension,
|
|
19
|
+
options?: SetLogExtensionOptions
|
|
20
|
+
): void;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -18,6 +18,7 @@ export declare function setupChat(
|
|
|
18
18
|
): {
|
|
19
19
|
messageObservable: import("rxjs").Observable<ReceivedChatMessage[]>;
|
|
20
20
|
isSendingObservable: BehaviorSubject<boolean>;
|
|
21
|
-
send: (message: string) => Promise<
|
|
21
|
+
send: (message: string) => Promise<ChatMessage>;
|
|
22
|
+
update: (message: string, messageId: string) => Promise<ChatMessage>;
|
|
22
23
|
};
|
|
23
24
|
```
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
```typescript
|
|
15
15
|
export declare function setupManualToggle(): {
|
|
16
16
|
className: string;
|
|
17
|
-
toggle: (forceState?: boolean) => void
|
|
17
|
+
toggle: (forceState?: boolean) => Promise<void>;
|
|
18
18
|
enabledObserver: Observable<boolean>;
|
|
19
19
|
pendingObserver: Observable<boolean>;
|
|
20
20
|
};
|
|
@@ -21,7 +21,7 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type
|
|
25
|
-
| ----------------------------------------------------------- |
|
|
26
|
-
| [participant?](./react/audiovisualizerprops.participant.md) | Participant
|
|
27
|
-
| [trackRef?](./react/audiovisualizerprops.trackref.md) | [
|
|
24
|
+
| Property | Type | Description |
|
|
25
|
+
| ----------------------------------------------------------- | ------------------------------------------- | ------------ |
|
|
26
|
+
| [participant?](./react/audiovisualizerprops.participant.md) | Participant | _(Optional)_ |
|
|
27
|
+
| [trackRef?](./react/audiovisualizerprops.trackref.md) | [TrackReference](./react/trackreference.md) | _(Optional)_ |
|
|
@@ -21,5 +21,6 @@ export interface ChatMessage
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description |
|
|
23
23
|
| --------------------------------------------- | ------ | ----------- |
|
|
24
|
+
| [id](./react/chatmessage.id.md) | string | |
|
|
24
25
|
| [message](./react/chatmessage.message.md) | string | |
|
|
25
26
|
| [timestamp](./react/chatmessage.timestamp.md) | number | |
|
|
@@ -31,7 +31,7 @@ Requires a `TrackReferenceOrPlaceholder` to be provided either as a property or
|
|
|
31
31
|
|
|
32
32
|
## Properties
|
|
33
33
|
|
|
34
|
-
{% parameter name="trackRef" type="
|
|
34
|
+
{% parameter name="trackRef" type="TrackReference" optional=true %}
|
|
35
35
|
_(Optional)_
|
|
36
36
|
|
|
37
37
|
{% /parameter %}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
# useChat
|
|
11
11
|
|
|
12
|
-
The `useChat` hook provides chat functionality for a LiveKit room. It returns a simple `send` function to send chat messages and an array of `chatMessages` to hold received messages.
|
|
12
|
+
The `useChat` hook provides chat functionality for a LiveKit room. It returns a simple `send` function to send chat messages and an array of `chatMessages` to hold received messages. It also returns a `update` function that allows you to implement message-edit functionality.
|
|
13
13
|
|
|
14
14
|
## Import
|
|
15
15
|
|
|
@@ -19,7 +19,7 @@ import { useChat } from "@livekit/components-react";
|
|
|
19
19
|
|
|
20
20
|
## Remarks
|
|
21
21
|
|
|
22
|
-
It is possible to pass configurations for custom message encoding and decoding.
|
|
22
|
+
It is possible to pass configurations for custom message encoding and decoding and non-default topics on which to send the messages.
|
|
23
23
|
|
|
24
24
|
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
25
25
|
|
|
@@ -32,7 +32,8 @@ It is possible to pass configurations for custom message encoding and decoding.
|
|
|
32
32
|
|
|
33
33
|
```typescript
|
|
34
34
|
{
|
|
35
|
-
send: ((message: string) => Promise<
|
|
35
|
+
send: ((message: string) => Promise<import("@livekit/components-core").ChatMessage>) | undefined;
|
|
36
|
+
update: ((message: string, messageId: string) => Promise<import("@livekit/components-core").ChatMessage>) | undefined;
|
|
36
37
|
chatMessages: ReceivedChatMessage[];
|
|
37
38
|
isSending: boolean;
|
|
38
39
|
}
|
|
@@ -30,10 +30,13 @@ return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
|
|
|
30
30
|
|
|
31
31
|
```typescript
|
|
32
32
|
{
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
33
|
+
toggle: (
|
|
34
|
+
forceState?: boolean | undefined,
|
|
35
|
+
captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined
|
|
36
|
+
) => Promise<void>;
|
|
37
|
+
enabled: boolean;
|
|
38
|
+
pending: boolean;
|
|
39
|
+
track: import("livekit-client").LocalTrackPublication | undefined;
|
|
40
|
+
buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
|
|
38
41
|
}
|
|
39
42
|
```
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
| Hook | Description |
|
|
58
58
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
59
59
|
| [useAudioPlayback(room)](./react/hook/useaudioplayback.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</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. |
|
|
60
|
-
| [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. It returns a simple <code>send</code> function to send chat messages and an array of <code>chatMessages</code> to hold received messages.
|
|
60
|
+
| [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. It returns a simple <code>send</code> function to send chat messages and an array of <code>chatMessages</code> to hold received messages. It also returns a <code>update</code> function that allows you to implement message-edit functionality. |
|
|
61
61
|
| [useChatToggle({ props })](./react/hook/usechattoggle.md) | The <code>useChatToggle</code> hook provides state and functions for toggling the chat window. |
|
|
62
62
|
| [useClearPinButton(props)](./react/hook/useclearpinbutton.md) | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton()](./react/component/clearpinbutton.md) or your custom implementation of it component. It adds the <code>onClick</code> handler to signal the <code>LayoutContext</code> that the tile in focus should be cleared. |
|
|
63
63
|
| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md) | The <code>useConnectionQualityIndicator</code> hook provides props for the <code>ConnectionQualityIndicator</code> or your custom implementation of it component. |
|
|
@@ -124,84 +124,88 @@
|
|
|
124
124
|
|
|
125
125
|
## Others
|
|
126
126
|
|
|
127
|
-
| Other | Description
|
|
128
|
-
| --------------------------------------------------------------------------------- |
|
|
129
|
-
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) |
|
|
130
|
-
| [AudioConferenceProps](./react/audioconferenceprops.md) |
|
|
131
|
-
| [AudioTrackProps](./react/audiotrackprops.md) |
|
|
132
|
-
| [AudioVisualizerProps](./react/audiovisualizerprops.md) |
|
|
133
|
-
| [CarouselLayoutProps](./react/carousellayoutprops.md) |
|
|
134
|
-
| [CarouselView](./react/carouselview.md) |
|
|
135
|
-
| [ChatEntryProps](./react/chatentryprops.md) | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:
|
|
136
|
-
| [ChatMessage](./react/chatmessage.md) |
|
|
137
|
-
| [ChatProps](./react/chatprops.md) |
|
|
138
|
-
| [ChatToggleProps](./react/chattoggleprops.md) |
|
|
139
|
-
| [ClearPinButtonProps](./react/clearpinbuttonprops.md) |
|
|
140
|
-
| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) |
|
|
141
|
-
| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) |
|
|
142
|
-
| [ConnectionStateToastProps](./react/connectionstatetoastprops.md) |
|
|
143
|
-
| [ConnectionStatusProps](./react/connectionstatusprops.md) |
|
|
144
|
-
| [ControlBarControls](./react/controlbarcontrols.md) |
|
|
145
|
-
| [ControlBarProps](./react/controlbarprops.md) |
|
|
146
|
-
| [DisconnectButtonProps](./react/disconnectbuttonprops.md) |
|
|
147
|
-
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) |
|
|
148
|
-
| [FocusLayoutProps](./react/focuslayoutprops.md) |
|
|
149
|
-
| [FocusToggleProps](./react/focustoggleprops.md) |
|
|
150
|
-
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) |
|
|
151
|
-
| [GridLayoutProps](./react/gridlayoutprops.md) |
|
|
152
|
-
| [LayoutContext](./react/layoutcontext.md) |
|
|
153
|
-
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) |
|
|
154
|
-
| [LayoutContextType](./react/layoutcontexttype.md) |
|
|
155
|
-
| [LiveKitRoomProps](./react/livekitroomprops.md) |
|
|
156
|
-
| [LocalUserChoices](./react/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username.
|
|
157
|
-
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) |
|
|
158
|
-
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) |
|
|
159
|
-
| [MessageDecoder](./react/messagedecoder.md) |
|
|
160
|
-
| [MessageEncoder](./react/messageencoder.md) |
|
|
161
|
-
| [MessageFormatter](./react/messageformatter.md) |
|
|
162
|
-
| [
|
|
163
|
-
| [
|
|
164
|
-
| [
|
|
165
|
-
| [
|
|
166
|
-
| [
|
|
167
|
-
| [
|
|
168
|
-
| [
|
|
169
|
-
| [
|
|
170
|
-
| [
|
|
171
|
-
| [
|
|
172
|
-
| [
|
|
173
|
-
| [
|
|
174
|
-
| [
|
|
175
|
-
| [
|
|
176
|
-
| [
|
|
177
|
-
| [
|
|
178
|
-
| [
|
|
179
|
-
| [
|
|
180
|
-
| [
|
|
181
|
-
| [
|
|
182
|
-
| [
|
|
183
|
-
| [
|
|
184
|
-
| [
|
|
185
|
-
| [
|
|
186
|
-
| [
|
|
187
|
-
| [
|
|
188
|
-
| [
|
|
189
|
-
| [
|
|
190
|
-
| [
|
|
191
|
-
| [
|
|
192
|
-
| [
|
|
193
|
-
| [
|
|
194
|
-
| [
|
|
195
|
-
| [
|
|
196
|
-
| [
|
|
197
|
-
| [
|
|
198
|
-
| [
|
|
199
|
-
| [
|
|
200
|
-
| [
|
|
201
|
-
| [
|
|
202
|
-
| [
|
|
203
|
-
| [
|
|
204
|
-
| [
|
|
205
|
-
| [
|
|
206
|
-
| [
|
|
207
|
-
| [
|
|
127
|
+
| Other | Description |
|
|
128
|
+
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
129
|
+
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
|
|
130
|
+
| [AudioConferenceProps](./react/audioconferenceprops.md) | |
|
|
131
|
+
| [AudioTrackProps](./react/audiotrackprops.md) | |
|
|
132
|
+
| [AudioVisualizerProps](./react/audiovisualizerprops.md) | |
|
|
133
|
+
| [CarouselLayoutProps](./react/carousellayoutprops.md) | |
|
|
134
|
+
| [CarouselView](./react/carouselview.md) | |
|
|
135
|
+
| [ChatEntryProps](./react/chatentryprops.md) | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component: |
|
|
136
|
+
| [ChatMessage](./react/chatmessage.md) | |
|
|
137
|
+
| [ChatProps](./react/chatprops.md) | |
|
|
138
|
+
| [ChatToggleProps](./react/chattoggleprops.md) | |
|
|
139
|
+
| [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
|
|
140
|
+
| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | |
|
|
141
|
+
| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) | |
|
|
142
|
+
| [ConnectionStateToastProps](./react/connectionstatetoastprops.md) | |
|
|
143
|
+
| [ConnectionStatusProps](./react/connectionstatusprops.md) | |
|
|
144
|
+
| [ControlBarControls](./react/controlbarcontrols.md) | |
|
|
145
|
+
| [ControlBarProps](./react/controlbarprops.md) | |
|
|
146
|
+
| [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
|
|
147
|
+
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
|
|
148
|
+
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
149
|
+
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
150
|
+
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
|
|
151
|
+
| [GridLayoutProps](./react/gridlayoutprops.md) | |
|
|
152
|
+
| [LayoutContext](./react/layoutcontext.md) | |
|
|
153
|
+
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
|
|
154
|
+
| [LayoutContextType](./react/layoutcontexttype.md) | |
|
|
155
|
+
| [LiveKitRoomProps](./react/livekitroomprops.md) | |
|
|
156
|
+
| [LocalUserChoices](./react/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
|
|
157
|
+
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
|
|
158
|
+
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
|
|
159
|
+
| [MessageDecoder](./react/messagedecoder.md) | |
|
|
160
|
+
| [MessageEncoder](./react/messageencoder.md) | |
|
|
161
|
+
| [MessageFormatter](./react/messageformatter.md) | |
|
|
162
|
+
| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
|
|
163
|
+
| [ParticipantContext](./react/participantcontext.md) | |
|
|
164
|
+
| [ParticipantLoopProps](./react/participantloopprops.md) | |
|
|
165
|
+
| [ParticipantNameProps](./react/participantnameprops.md) | |
|
|
166
|
+
| [ParticipantTileProps](./react/participanttileprops.md) | |
|
|
167
|
+
| [PinState](./react/pinstate.md) | |
|
|
168
|
+
| [PreJoinProps](./react/prejoinprops.md) | Props for the PreJoin component. |
|
|
169
|
+
| [ReceivedChatMessage](./react/receivedchatmessage.md) | |
|
|
170
|
+
| [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
|
|
171
|
+
| [RoomContext](./react/roomcontext.md) | |
|
|
172
|
+
| [RoomNameProps](./react/roomnameprops.md) | |
|
|
173
|
+
| [setLogExtension(extension, options)](./react/setlogextension.md) | Set the log extension for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log extension, use the <code>liveKitClientLogExtension</code> prop on the <code>options</code> object. |
|
|
174
|
+
| [setLogLevel(level, options)](./react/setloglevel.md) | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object. |
|
|
175
|
+
| [TrackContext](./react/trackcontext.md) | |
|
|
176
|
+
| [TrackLoopProps](./react/trackloopprops.md) | |
|
|
177
|
+
| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
|
|
178
|
+
| [TrackRefContext](./react/trackrefcontext.md) | This context provides a <code>TrackReferenceOrPlaceholder</code> to all child components. |
|
|
179
|
+
| [TrackReference](./react/trackreference.md) | |
|
|
180
|
+
| [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | |
|
|
181
|
+
| [TrackToggleProps](./react/tracktoggleprops.md) | |
|
|
182
|
+
| [UseChatToggleProps](./react/usechattoggleprops.md) | |
|
|
183
|
+
| [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
|
|
184
|
+
| [UseIsMutedOptions](./react/useismutedoptions.md) | |
|
|
185
|
+
| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
|
|
186
|
+
| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
|
|
187
|
+
| [UseMediaTrackOptions](./react/usemediatrackoptions.md) | |
|
|
188
|
+
| [useMultibandTrackVolume](./react/usemultibandtrackvolume.md) | Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API. |
|
|
189
|
+
| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | The <code>useParticipantInfo</code> hook returns the identity, name, and metadata of a given participant. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>. |
|
|
190
|
+
| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
|
|
191
|
+
| [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
|
|
192
|
+
| [UseParticipantTileProps](./react/useparticipanttileprops.md) | |
|
|
193
|
+
| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md) | Options for the <code>usePersistentDeviceSettings</code> hook. |
|
|
194
|
+
| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | |
|
|
195
|
+
| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | |
|
|
196
|
+
| [UserInfo](./react/userinfo.md) | |
|
|
197
|
+
| [UseRoomInfoOptions](./react/useroominfooptions.md) | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>. |
|
|
198
|
+
| [UseStartAudioProps](./react/usestartaudioprops.md) | |
|
|
199
|
+
| [UseStartVideoProps](./react/usestartvideoprops.md) | |
|
|
200
|
+
| [UseSwipeOptions](./react/useswipeoptions.md) | |
|
|
201
|
+
| [UseTokenOptions](./react/usetokenoptions.md) | |
|
|
202
|
+
| [UseTrackMutedIndicatorOptions](./react/usetrackmutedindicatoroptions.md) | |
|
|
203
|
+
| [UseTrackOptions](./react/usetrackoptions.md) | |
|
|
204
|
+
| [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
|
|
205
|
+
| [UseTracksOptions](./react/usetracksoptions.md) | |
|
|
206
|
+
| [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
|
|
207
|
+
| [useTrackVolume](./react/usetrackvolume.md) | Hook for tracking the volume of an audio track using the Web Audio API. |
|
|
208
|
+
| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
|
|
209
|
+
| [VideoConferenceProps](./react/videoconferenceprops.md) | |
|
|
210
|
+
| [VideoTrackProps](./react/videotrackprops.md) | |
|
|
211
|
+
| [WidgetState](./react/widgetstate.md) | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MultiBandTrackVolumeOptions.analyserOptions property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# MultiBandTrackVolumeOptions.analyserOptions property
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
analyserOptions?: AnalyserOptions;
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MultiBandTrackVolumeOptions.bands property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# MultiBandTrackVolumeOptions.bands property
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
bands?: number;
|
|
13
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MultiBandTrackVolumeOptions.hiPass property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# MultiBandTrackVolumeOptions.hiPass property
|
|
8
|
+
|
|
9
|
+
cut off of frequency bins on the higher end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
|
|
10
|
+
|
|
11
|
+
**Signature:**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
hiPass?: number;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MultiBandTrackVolumeOptions.loPass property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# MultiBandTrackVolumeOptions.loPass property
|
|
8
|
+
|
|
9
|
+
cut off of frequency bins on the lower end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
|
|
10
|
+
|
|
11
|
+
**Signature:**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
loPass?: number;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "MultiBandTrackVolumeOptions interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# MultiBandTrackVolumeOptions interface
|
|
11
|
+
|
|
12
|
+
Interface for configuring options for the useMultibandTrackVolume hook.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
export interface MultiBandTrackVolumeOptions
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Type | Description |
|
|
25
|
+
| -------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| [analyserOptions?](./react/multibandtrackvolumeoptions.analyseroptions.md) | AnalyserOptions | _(Optional)_ |
|
|
27
|
+
| [bands?](./react/multibandtrackvolumeoptions.bands.md) | number | _(Optional)_ |
|
|
28
|
+
| [hiPass?](./react/multibandtrackvolumeoptions.hipass.md) | number | _(Optional)_ cut off of frequency bins on the higher end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize, |
|
|
29
|
+
| [loPass?](./react/multibandtrackvolumeoptions.lopass.md) | number | _(Optional)_ cut off of frequency bins on the lower end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize, |
|
|
30
|
+
| [updateInterval?](./react/multibandtrackvolumeoptions.updateinterval.md) | number | _(Optional)_ update should run every x ms |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MultiBandTrackVolumeOptions.updateInterval property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# MultiBandTrackVolumeOptions.updateInterval property
|
|
8
|
+
|
|
9
|
+
update should run every x ms
|
|
10
|
+
|
|
11
|
+
**Signature:**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
updateInterval?: number;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "ReceivedChatMessage.editTimestamp property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# ReceivedChatMessage.editTimestamp property
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
editTimestamp?: number;
|
|
13
|
+
```
|
|
@@ -21,6 +21,7 @@ export interface ReceivedChatMessage extends ChatMessage
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property
|
|
25
|
-
|
|
|
26
|
-
| [
|
|
24
|
+
| Property | Type | Description |
|
|
25
|
+
| -------------------------------------------------------------- | ----------- | ------------ |
|
|
26
|
+
| [editTimestamp?](./react/receivedchatmessage.edittimestamp.md) | number | _(Optional)_ |
|
|
27
|
+
| [from?](./react/receivedchatmessage.from.md) | Participant | _(Optional)_ |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "setLogExtension",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/logger.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# setLogExtension
|
|
11
|
+
|
|
12
|
+
Set the log extension for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log extension, use the `liveKitClientLogExtension` prop on the `options` object.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
export declare function setLogExtension(
|
|
18
|
+
extension: LogExtension,
|
|
19
|
+
options?: SetLogExtensionOptions
|
|
20
|
+
): void;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useMultibandTrackVolume variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# useMultibandTrackVolume variable
|
|
11
|
+
|
|
12
|
+
Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
useMultibandTrackVolume: (trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder, options?: MultiBandTrackVolumeOptions) => number[]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useTrackVolume variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# useTrackVolume variable
|
|
11
|
+
|
|
12
|
+
Hook for tracking the volume of an audio track using the Web Audio API.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
useTrackVolume: (
|
|
18
|
+
trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReference,
|
|
19
|
+
options?: AudioAnalyserOptions
|
|
20
|
+
) => number;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
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.8",
|
|
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": "1.5.
|
|
11
|
+
"@livekit/components-react": "1.5.3"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|