@livekit/components-js-docs 0.1.12 → 0.1.13
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/attachifsubscribed.md +2 -2
- package/generated-docs/core/createdefaultgrammar.md +2 -2
- package/generated-docs/core/index.md +2 -2
- package/generated-docs/core/participantpermissionobserver.md +1 -3
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +1 -1
- package/generated-docs/react/hook/usemultibandtrackvolume.md +34 -0
- package/generated-docs/react/hook/useparticipantpermissions.md +1 -1
- package/generated-docs/react/hook/usetrackvolume.md +34 -0
- package/generated-docs/react/index.md +2 -2
- package/generated-docs/react/meta-data.json +1 -1
- package/package.json +2 -2
- package/generated-docs/react/usemultibandtrackvolume.md +0 -20
- package/generated-docs/react/usetrackvolume.md +0 -23
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
{
|
|
3
|
-
"title": "attachIfSubscribed
|
|
3
|
+
"title": "attachIfSubscribed",
|
|
4
4
|
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/utils.ts"
|
|
5
5
|
}
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
9
|
|
|
10
|
-
# attachIfSubscribed
|
|
10
|
+
# attachIfSubscribed
|
|
11
11
|
|
|
12
12
|
**Signature:**
|
|
13
13
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
{
|
|
3
|
-
"title": "createDefaultGrammar
|
|
3
|
+
"title": "createDefaultGrammar",
|
|
4
4
|
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/tokenizer.ts"
|
|
5
5
|
}
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
9
|
|
|
10
|
-
# createDefaultGrammar
|
|
10
|
+
# createDefaultGrammar
|
|
11
11
|
|
|
12
12
|
**Signature:**
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| [allParticipantRoomEvents](./core/allparticipantroomevents.md) | |
|
|
16
16
|
| [allRemoteParticipantEvents](./core/allremoteparticipantevents.md) | |
|
|
17
17
|
| [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md) | |
|
|
18
|
-
| [attachIfSubscribed](./core/attachifsubscribed.md)
|
|
18
|
+
| [attachIfSubscribed(publication, element)](./core/attachifsubscribed.md) | |
|
|
19
19
|
| [AudioSource](./core/audiosource.md) | |
|
|
20
20
|
| [BaseDataMessage](./core/basedatamessage.md) | |
|
|
21
21
|
| [CaptureOptionsBySource](./core/captureoptionsbysource.md) | |
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
| [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md) | |
|
|
30
30
|
| [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md) | |
|
|
31
31
|
| [createDataObserver(room)](./core/createdataobserver.md) | |
|
|
32
|
-
| [createDefaultGrammar](./core/createdefaultgrammar.md)
|
|
32
|
+
| [createDefaultGrammar()](./core/createdefaultgrammar.md) | |
|
|
33
33
|
| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
|
|
34
34
|
| [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md) | |
|
|
35
35
|
| [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
|
|
@@ -14,7 +14,5 @@
|
|
|
14
14
|
```typescript
|
|
15
15
|
export declare function participantPermissionObserver(
|
|
16
16
|
participant: Participant
|
|
17
|
-
): Observable<
|
|
18
|
-
import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined
|
|
19
|
-
>;
|
|
17
|
+
): Observable<ParticipantPermission | undefined>;
|
|
20
18
|
```
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useMultibandTrackVolume",
|
|
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
|
|
11
|
+
|
|
12
|
+
Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.
|
|
13
|
+
|
|
14
|
+
## Import
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { useMultibandTrackVolume } from "@livekit/components-react";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
{% parameter name="options" type="MultiBandTrackVolumeOptions" optional=true %}
|
|
25
|
+
{% /parameter %}
|
|
26
|
+
|
|
27
|
+
{% parameter name="trackOrTrackReference" type="LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder" optional=true %}
|
|
28
|
+
{% /parameter %}
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
number[]
|
|
34
|
+
```
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useTrackVolume",
|
|
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
|
|
11
|
+
|
|
12
|
+
Hook for tracking the volume of an audio track using the Web Audio API.
|
|
13
|
+
|
|
14
|
+
## Import
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { useTrackVolume } from "@livekit/components-react";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
{% parameter name="options" type="AudioAnalyserOptions" optional=true %}
|
|
25
|
+
{% /parameter %}
|
|
26
|
+
|
|
27
|
+
{% parameter name="trackOrTrackReference" type="LocalAudioTrack | RemoteAudioTrack | TrackReference" optional=true %}
|
|
28
|
+
{% /parameter %}
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
number;
|
|
34
|
+
```
|
|
@@ -87,6 +87,7 @@
|
|
|
87
87
|
| [useMaybeTrackRefContext()](./react/hook/usemaybetrackrefcontext.md) | Returns a track reference from the <code>TrackRefContext</code> if it exists, otherwise <code>undefined</code>. |
|
|
88
88
|
| [useMediaDevices({ kind, onError, })](./react/hook/usemediadevices.md) | The <code>useMediaDevices</code> hook returns the list of media devices of a given kind. |
|
|
89
89
|
| [useMediaDeviceSelect({ kind, room, track, requestPermissions, onError, })](./react/hook/usemediadeviceselect.md) | The <code>useMediaDeviceSelect</code> hook is used to implement the <code>MediaDeviceSelect</code> component and returns o.a. the list of devices of a given kind (audioinput or videoinput), the currently active device and a function to set the the active device. |
|
|
90
|
+
| [useMultibandTrackVolume(trackOrTrackReference, options)](./react/hook/usemultibandtrackvolume.md) | Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API. |
|
|
90
91
|
| [usePagination(itemPerPage, trackReferences)](./react/hook/usepagination.md) | The <code>usePagination</code> hook implements simple pagination logic for use with arrays. |
|
|
91
92
|
| [useParticipantContext()](./react/hook/useparticipantcontext.md) | Ensures that a participant is provided via context. If not inside a <code>ParticipantContext</code>, an error is thrown. |
|
|
92
93
|
| [useParticipantInfo(props)](./react/hook/useparticipantinfo.md) | |
|
|
@@ -113,6 +114,7 @@
|
|
|
113
114
|
| [useTrackRefContext()](./react/hook/usetrackrefcontext.md) | Ensures that a track reference is provided via context. If not inside a <code>TrackRefContext</code>, an error is thrown. |
|
|
114
115
|
| [useTracks(sources, options)](./react/hook/usetracks.md) | The <code>useTracks</code> hook returns an array of <code>TrackReference</code> or <code>TrackReferenceOrPlaceholder</code> depending on the provided <code>sources</code> property. If only subscribed tracks are desired, set the <code>onlySubscribed</code> property to <code>true</code>. |
|
|
115
116
|
| [useTrackToggle({ source, onChange, initialState, captureOptions, ...rest })](./react/hook/usetracktoggle.md) | The <code>useTrackToggle</code> hook is used to implement the <code>TrackToggle</code> component and returns state and functionality of the given track. |
|
|
117
|
+
| [useTrackVolume(trackOrTrackReference, options)](./react/hook/usetrackvolume.md) | Hook for tracking the volume of an audio track using the Web Audio API. |
|
|
116
118
|
| [useVisualStableUpdate(trackReferences, maxItemsOnPage, options)](./react/hook/usevisualstableupdate.md) | The <code>useVisualStableUpdate</code> hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible. |
|
|
117
119
|
|
|
118
120
|
## Others
|
|
@@ -175,7 +177,6 @@
|
|
|
175
177
|
| [UseIsMutedOptions](./react/useismutedoptions.md) | |
|
|
176
178
|
| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
|
|
177
179
|
| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
|
|
178
|
-
| [useMultibandTrackVolume](./react/usemultibandtrackvolume.md) | Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API. |
|
|
179
180
|
| [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>. |
|
|
180
181
|
| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
|
|
181
182
|
| [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
|
|
@@ -192,7 +193,6 @@
|
|
|
192
193
|
| [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
|
|
193
194
|
| [UseTracksOptions](./react/usetracksoptions.md) | |
|
|
194
195
|
| [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
|
|
195
|
-
| [useTrackVolume](./react/usetrackvolume.md) | Hook for tracking the volume of an audio track using the Web Audio API. |
|
|
196
196
|
| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
|
|
197
197
|
| [VideoConferenceProps](./react/videoconferenceprops.md) | |
|
|
198
198
|
| [VideoTrackProps](./react/videotrackprops.md) | |
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
|
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.13",
|
|
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.0.
|
|
11
|
+
"@livekit/components-react": "2.0.4"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|
|
@@ -1,20 +0,0 @@
|
|
|
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} /%}
|
|
@@ -1,23 +0,0 @@
|
|
|
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} /%}
|