@livekit/components-js-docs 0.1.57 → 0.1.59
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/datatopic.md +1 -0
- package/generated-docs/react/component/livekitroom.md +1 -1
- package/generated-docs/react/hook/uselivekitroom.md +1 -1
- package/generated-docs/react/hook/usetracktranscription.md +1 -1
- package/generated-docs/react/hook/usetranscriptions.md +45 -0
- package/generated-docs/react/index.md +2 -0
- package/generated-docs/react/livekitroomprops.md +17 -17
- package/generated-docs/react/livekitroomprops.onmediadevicefailure.md +1 -1
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/usetranscriptionsoptions.md +29 -0
- package/generated-docs/react/usetranscriptionsoptions.participantidentities.md +19 -0
- package/generated-docs/react/usetranscriptionsoptions.tracksids.md +19 -0
- package/package.json +2 -2
|
@@ -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 %}
|
|
@@ -38,7 +38,7 @@ optional callback for retrieving newly incoming transcriptions only
|
|
|
38
38
|
|
|
39
39
|
## Returns
|
|
40
40
|
|
|
41
|
-
An object consisting of `segments` with maximum length of opts.
|
|
41
|
+
An object consisting of `segments` with maximum length of opts.bufferSize
|
|
42
42
|
|
|
43
43
|
```typescript
|
|
44
44
|
{
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useTranscriptions",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTranscriptions.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# useTranscriptions
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
useTranscriptions is a hook that returns the transcriptions for the given participant identities and track sids, if no options are provided, it will return all transcriptions
|
|
19
|
+
|
|
20
|
+
## Import
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { useTranscriptions } from "@livekit/components-react";
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
const transcriptions = useTranscriptions();
|
|
30
|
+
return <div>{transcriptions.map((transcription) => transcription.text)}</div>;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Properties
|
|
34
|
+
|
|
35
|
+
{% parameter name="opts.participantIdentities" type="string[]" optional=true %}
|
|
36
|
+
{% /parameter %}
|
|
37
|
+
|
|
38
|
+
{% parameter name="opts.trackSids" type="string[]" optional=true %}
|
|
39
|
+
{% /parameter %}
|
|
40
|
+
|
|
41
|
+
## Returns
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import('../../packages/core/dist/index.d.ts').TextStreamData[]
|
|
45
|
+
```
|
|
@@ -130,6 +130,7 @@
|
|
|
130
130
|
| [useTrackToggle({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, ...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. |
|
|
131
131
|
| [useTrackTranscription(trackRef, options)](./react/hook/usetracktranscription.md) | |
|
|
132
132
|
| [useTrackVolume(trackOrTrackReference, options)](./react/hook/usetrackvolume.md) | Hook for tracking the volume of an audio track using the Web Audio API. |
|
|
133
|
+
| [useTranscriptions(opts)](./react/hook/usetranscriptions.md) | **_(BETA)_** useTranscriptions is a hook that returns the transcriptions for the given participant identities and track sids, if no options are provided, it will return all transcriptions |
|
|
133
134
|
| [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. |
|
|
134
135
|
| [useVoiceAssistant()](./react/hook/usevoiceassistant.md) | **_(BETA)_** This hook looks for the first agent-participant in the room. |
|
|
135
136
|
|
|
@@ -204,6 +205,7 @@
|
|
|
204
205
|
| [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
|
|
205
206
|
| [UseTracksOptions](./react/usetracksoptions.md) | |
|
|
206
207
|
| [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
|
|
208
|
+
| [UseTranscriptionsOptions](./react/usetranscriptionsoptions.md) | **_(BETA)_** |
|
|
207
209
|
| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
|
|
208
210
|
| [VideoConferenceProps](./react/videoconferenceprops.md) | |
|
|
209
211
|
| [VideoTrackProps](./react/videotrackprops.md) | |
|
|
@@ -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. |
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"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":"layoutcontext.md","title":"LayoutContext"},{"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":"participantcontext.md","title":"ParticipantContext"},{"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":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"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":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"usetextstream.md","title":"useTextStream"},{"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":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"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":"layoutcontext.md","title":"LayoutContext"},{"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":"participantcontext.md","title":"ParticipantContext"},{"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":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"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":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"usetextstream.md","title":"useTextStream"},{"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":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "UseTranscriptionsOptions interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTranscriptions.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# UseTranscriptionsOptions interface
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
**Signature:**
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
export interface UseTranscriptionsOptions
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
| Property | Type | Description |
|
|
27
|
+
| ----------------------------------------------------------------------------------- | ---------- | ------------------------- |
|
|
28
|
+
| [participantIdentities?](./react/usetranscriptionsoptions.participantidentities.md) | string\[\] | **_(BETA)_** _(Optional)_ |
|
|
29
|
+
| [trackSids?](./react/usetranscriptionsoptions.tracksids.md) | string\[\] | **_(BETA)_** _(Optional)_ |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "UseTranscriptionsOptions.participantIdentities property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# UseTranscriptionsOptions.participantIdentities property
|
|
8
|
+
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
15
|
+
**Signature:**
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
participantIdentities?: string[];
|
|
19
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "UseTranscriptionsOptions.trackSids property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# UseTranscriptionsOptions.trackSids property
|
|
8
|
+
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
15
|
+
**Signature:**
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
trackSids?: string[];
|
|
19
|
+
```
|
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.59",
|
|
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.6"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|