@livekit/components-js-docs 0.1.48 → 0.1.49
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/chatoptions.md +0 -2
- package/generated-docs/core/dedupesegments.md +0 -2
- package/generated-docs/core/gettrackreferenceid.md +0 -2
- package/generated-docs/core/gettrackreferencesource.md +0 -2
- package/generated-docs/core/gridlayoutdefinition.md +0 -2
- package/generated-docs/core/islocal.md +1 -1
- package/generated-docs/core/ismobilebrowser.md +0 -2
- package/generated-docs/core/isparticipanttrackreferencepinned.md +0 -2
- package/generated-docs/core/isremote.md +1 -1
- package/generated-docs/core/istrackreferencepinned.md +0 -2
- package/generated-docs/core/loaduserchoices.md +6 -2
- package/generated-docs/core/localuserchoices.md +0 -2
- package/generated-docs/core/messagedecoder.md +0 -2
- package/generated-docs/core/messageencoder.md +0 -2
- package/generated-docs/core/participantidentifier.md +5 -3
- package/generated-docs/core/pinstate.md +0 -2
- package/generated-docs/core/receivedchatmessage.md +0 -2
- package/generated-docs/core/saveuserchoices.md +6 -2
- package/generated-docs/core/sendmessage.md +0 -2
- package/generated-docs/core/setlogextension.md +0 -2
- package/generated-docs/core/setloglevel.md +0 -2
- package/generated-docs/core/sortparticipants.md +0 -2
- package/generated-docs/core/sorttrackreferences.md +0 -2
- package/generated-docs/core/supportsscreensharing.md +0 -2
- package/generated-docs/core/trackreference.md +0 -2
- package/generated-docs/core/trackreferenceorplaceholder.md +0 -2
- package/generated-docs/core/trackreferenceplaceholder.md +0 -2
- package/generated-docs/core/updatepages.md +0 -2
- package/generated-docs/core/widgetstate.md +0 -2
- package/generated-docs/react/agentstate.md +5 -3
- package/generated-docs/react/allowaudioplaybackprops.md +0 -2
- package/generated-docs/react/allowmediaplaybackprops.md +0 -2
- package/generated-docs/react/audioconferenceprops.md +0 -2
- package/generated-docs/react/audiotrackprops.md +0 -2
- package/generated-docs/react/audiotrackprops.muted.md +6 -2
- package/generated-docs/react/audiotrackprops.trackref.md +0 -2
- package/generated-docs/react/audiotrackprops.volume.md +0 -2
- package/generated-docs/react/audiovisualizerprops.md +0 -2
- package/generated-docs/react/audiowaveformoptions.barcount.md +6 -0
- package/generated-docs/react/audiowaveformoptions.md +6 -2
- package/generated-docs/react/audiowaveformoptions.updateinterval.md +6 -0
- package/generated-docs/react/audiowaveformoptions.volmultiplier.md +6 -0
- package/generated-docs/react/barvisualizeroptions.md +5 -3
- package/generated-docs/react/barvisualizerprops.barcount.md +5 -3
- package/generated-docs/react/barvisualizerprops.children.md +5 -3
- package/generated-docs/react/barvisualizerprops.md +5 -3
- package/generated-docs/react/barvisualizerprops.options.md +5 -1
- package/generated-docs/react/barvisualizerprops.state.md +5 -3
- package/generated-docs/react/barvisualizerprops.trackref.md +5 -1
- package/generated-docs/react/carousellayoutprops.md +0 -2
- package/generated-docs/react/carousellayoutprops.orientation.md +0 -2
- package/generated-docs/react/chatentryprops.entry.md +0 -2
- package/generated-docs/react/chatentryprops.hidename.md +0 -2
- package/generated-docs/react/chatentryprops.hidetimestamp.md +0 -2
- package/generated-docs/react/chatentryprops.md +0 -2
- package/generated-docs/react/chatentryprops.messageformatter.md +0 -2
- package/generated-docs/react/chatprops.md +0 -2
- package/generated-docs/react/chattoggleprops.md +0 -2
- package/generated-docs/react/clearpinbuttonprops.md +0 -2
- package/generated-docs/react/component/audioconference.md +0 -2
- package/generated-docs/react/component/audiotrack.md +0 -2
- package/generated-docs/react/component/audiovisualizer.md +0 -2
- package/generated-docs/react/component/barvisualizer.md +5 -3
- package/generated-docs/react/component/carousellayout.md +0 -2
- package/generated-docs/react/component/chat.md +0 -2
- package/generated-docs/react/component/chatentry.md +0 -2
- package/generated-docs/react/component/chattoggle.md +0 -2
- package/generated-docs/react/component/clearpinbutton.md +0 -2
- package/generated-docs/react/component/connectionqualityindicator.md +0 -2
- package/generated-docs/react/component/connectionstate.md +0 -2
- package/generated-docs/react/component/connectionstatetoast.md +0 -2
- package/generated-docs/react/component/controlbar.md +0 -2
- package/generated-docs/react/component/disconnectbutton.md +0 -2
- package/generated-docs/react/component/focuslayout.md +0 -2
- package/generated-docs/react/component/focuslayoutcontainer.md +0 -2
- package/generated-docs/react/component/focustoggle.md +0 -2
- package/generated-docs/react/component/gridlayout.md +0 -2
- package/generated-docs/react/component/layoutcontext.md +0 -2
- package/generated-docs/react/component/layoutcontextprovider.md +6 -2
- package/generated-docs/react/component/livekitroom.md +0 -2
- package/generated-docs/react/component/mediadevicemenu.md +0 -2
- package/generated-docs/react/component/mediadeviceselect.md +0 -2
- package/generated-docs/react/component/participantaudiotile.md +0 -2
- package/generated-docs/react/component/participantcontext.md +0 -2
- package/generated-docs/react/component/participantcontextifneeded.md +0 -2
- package/generated-docs/react/component/participantloop.md +0 -2
- package/generated-docs/react/component/participantname.md +0 -2
- package/generated-docs/react/component/participanttile.md +6 -6
- package/generated-docs/react/component/prejoin.md +0 -2
- package/generated-docs/react/component/roomaudiorenderer.md +0 -2
- package/generated-docs/react/component/roomcontext.md +0 -2
- package/generated-docs/react/component/roomname.md +0 -2
- package/generated-docs/react/component/startaudio.md +0 -2
- package/generated-docs/react/component/startmediabutton.md +0 -2
- package/generated-docs/react/component/toast.md +0 -2
- package/generated-docs/react/component/trackloop.md +0 -2
- package/generated-docs/react/component/trackmutedindicator.md +0 -2
- package/generated-docs/react/component/trackrefcontext.md +0 -2
- package/generated-docs/react/component/tracktoggle.md +0 -2
- package/generated-docs/react/component/videoconference.md +0 -2
- package/generated-docs/react/component/videotrack.md +0 -2
- package/generated-docs/react/component/voiceassistantcontrolbar.md +5 -3
- package/generated-docs/react/connectionqualityindicatoroptions.md +0 -2
- package/generated-docs/react/connectionqualityindicatorprops.md +0 -2
- package/generated-docs/react/connectionstatetoastprops.md +0 -2
- package/generated-docs/react/connectionstatusprops.md +0 -2
- package/generated-docs/react/connectionstatusprops.room.md +0 -2
- package/generated-docs/react/controlbarcontrols.md +0 -2
- package/generated-docs/react/controlbarprops.md +0 -2
- package/generated-docs/react/controlbarprops.saveuserchoices.md +6 -2
- package/generated-docs/react/disconnectbuttonprops.md +0 -2
- package/generated-docs/react/focuslayoutcontainerprops.md +0 -2
- package/generated-docs/react/focuslayoutprops.md +0 -2
- package/generated-docs/react/focuslayoutprops.trackref.md +0 -2
- package/generated-docs/react/focustoggleprops.md +0 -2
- package/generated-docs/react/formatchatmessagelinks.md +0 -2
- package/generated-docs/react/gridlayoutdefinition.md +0 -2
- package/generated-docs/react/gridlayoutprops.md +0 -2
- package/generated-docs/react/hook/useaudioplayback.md +6 -2
- package/generated-docs/react/hook/useaudiowaveform.md +13 -3
- package/generated-docs/react/hook/usechat.md +0 -7
- package/generated-docs/react/hook/usechattoggle.md +1 -3
- package/generated-docs/react/hook/useclearpinbutton.md +0 -2
- package/generated-docs/react/hook/useconnectionqualityindicator.md +1 -3
- package/generated-docs/react/hook/useconnectionstate.md +0 -2
- package/generated-docs/react/hook/usecreatelayoutcontext.md +0 -2
- package/generated-docs/react/hook/usedatachannel.md +0 -2
- package/generated-docs/react/hook/usedatachannel_1.md +0 -2
- package/generated-docs/react/hook/usedisconnectbutton.md +1 -3
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +0 -2
- package/generated-docs/react/hook/useensurelayoutcontext.md +0 -2
- package/generated-docs/react/hook/useensureparticipant.md +0 -2
- package/generated-docs/react/hook/useensureroom.md +0 -2
- package/generated-docs/react/hook/useensuretrackref.md +0 -2
- package/generated-docs/react/hook/usefacingmode.md +6 -2
- package/generated-docs/react/hook/usefocustoggle.md +2 -4
- package/generated-docs/react/hook/usegridlayout.md +0 -2
- package/generated-docs/react/hook/useisencrypted.md +7 -3
- package/generated-docs/react/hook/useismuted.md +9 -1
- package/generated-docs/react/hook/useisrecording.md +0 -2
- package/generated-docs/react/hook/useisspeaking.md +0 -2
- package/generated-docs/react/hook/usekrispnoisefilter.md +64 -0
- package/generated-docs/react/hook/uselayoutcontext.md +0 -2
- package/generated-docs/react/hook/uselivekitroom.md +15 -17
- package/generated-docs/react/hook/uselocalparticipant.md +3 -3
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +0 -2
- package/generated-docs/react/hook/usemaybelayoutcontext.md +0 -2
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +0 -2
- package/generated-docs/react/hook/usemayberoomcontext.md +0 -2
- package/generated-docs/react/hook/usemaybetrackrefcontext.md +0 -2
- package/generated-docs/react/hook/usemediadevices.md +0 -2
- package/generated-docs/react/hook/usemediadeviceselect.md +5 -7
- package/generated-docs/react/hook/usemultibandtrackvolume.md +25 -3
- package/generated-docs/react/hook/usepagination.md +6 -2
- package/generated-docs/react/hook/useparticipantattribute.md +1 -3
- package/generated-docs/react/hook/useparticipantattributes.md +1 -3
- package/generated-docs/react/hook/useparticipantcontext.md +0 -2
- package/generated-docs/react/hook/useparticipantinfo.md +1 -3
- package/generated-docs/react/hook/useparticipantpermissions.md +1 -3
- package/generated-docs/react/hook/useparticipants.md +8 -3
- package/generated-docs/react/hook/useparticipanttile.md +4 -6
- package/generated-docs/react/hook/useparticipanttracks.md +0 -2
- package/generated-docs/react/hook/usepersistentuserchoices.md +19 -3
- package/generated-docs/react/hook/usepinnedtracks.md +0 -2
- package/generated-docs/react/hook/usepreviewdevice.md +0 -2
- package/generated-docs/react/hook/usepreviewtracks.md +6 -5
- package/generated-docs/react/hook/useremoteparticipant.md +3 -3
- package/generated-docs/react/hook/useremoteparticipant_1.md +3 -3
- package/generated-docs/react/hook/useremoteparticipants.md +8 -3
- package/generated-docs/react/hook/useroomcontext.md +0 -2
- package/generated-docs/react/hook/useroominfo.md +1 -3
- package/generated-docs/react/hook/usesortedparticipants.md +0 -2
- package/generated-docs/react/hook/usespeakingparticipants.md +0 -2
- package/generated-docs/react/hook/usestartaudio.md +8 -4
- package/generated-docs/react/hook/usestartvideo.md +8 -4
- package/generated-docs/react/hook/useswipe.md +6 -5
- package/generated-docs/react/hook/usetoken.md +1 -3
- package/generated-docs/react/hook/usetrackbyname.md +0 -2
- package/generated-docs/react/hook/usetrackmutedindicator.md +0 -2
- package/generated-docs/react/hook/usetrackrefcontext.md +0 -2
- package/generated-docs/react/hook/usetracks.md +4 -7
- package/generated-docs/react/hook/usetracktoggle.md +0 -2
- package/generated-docs/react/hook/usetracktranscription.md +16 -3
- package/generated-docs/react/hook/usetrackvolume.md +6 -5
- package/generated-docs/react/hook/usevisualstableupdate.md +3 -3
- package/generated-docs/react/hook/usevoiceassistant.md +5 -3
- package/generated-docs/react/index.md +2 -0
- package/generated-docs/react/layoutcontextproviderprops.md +6 -2
- package/generated-docs/react/layoutcontextproviderprops.onpinchange.md +6 -0
- package/generated-docs/react/layoutcontextproviderprops.onwidgetchange.md +6 -0
- package/generated-docs/react/layoutcontextproviderprops.value.md +6 -0
- package/generated-docs/react/layoutcontexttype.md +0 -2
- package/generated-docs/react/livekitroomprops.audio.md +0 -2
- package/generated-docs/react/livekitroomprops.connect.md +0 -2
- package/generated-docs/react/livekitroomprops.connectoptions.md +0 -2
- package/generated-docs/react/livekitroomprops.md +0 -2
- package/generated-docs/react/livekitroomprops.options.md +0 -2
- package/generated-docs/react/livekitroomprops.room.md +0 -2
- package/generated-docs/react/livekitroomprops.screen.md +0 -2
- package/generated-docs/react/livekitroomprops.serverurl.md +0 -2
- package/generated-docs/react/livekitroomprops.token.md +0 -2
- package/generated-docs/react/livekitroomprops.video.md +0 -2
- package/generated-docs/react/localuserchoices.md +0 -2
- package/generated-docs/react/mediadevicemenuprops.md +0 -2
- package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +0 -2
- package/generated-docs/react/mediadeviceselectprops.exactmatch.md +0 -2
- package/generated-docs/react/mediadeviceselectprops.md +0 -2
- package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +0 -2
- package/generated-docs/react/messagedecoder.md +0 -2
- package/generated-docs/react/messageencoder.md +0 -2
- package/generated-docs/react/messageformatter.md +0 -2
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/multibandtrackvolumeoptions.analyseroptions.md +6 -0
- package/generated-docs/react/multibandtrackvolumeoptions.bands.md +6 -0
- package/generated-docs/react/multibandtrackvolumeoptions.hipass.md +6 -2
- package/generated-docs/react/multibandtrackvolumeoptions.lopass.md +6 -2
- package/generated-docs/react/multibandtrackvolumeoptions.md +6 -2
- package/generated-docs/react/multibandtrackvolumeoptions.updateinterval.md +6 -2
- package/generated-docs/react/participantidentifier.md +5 -3
- package/generated-docs/react/participantloopprops.children.md +0 -2
- package/generated-docs/react/participantloopprops.md +0 -2
- package/generated-docs/react/participantloopprops.participants.md +0 -2
- package/generated-docs/react/participantnameprops.md +0 -2
- package/generated-docs/react/participanttileprops.md +0 -2
- package/generated-docs/react/participanttileprops.trackref.md +0 -2
- package/generated-docs/react/pinstate.md +0 -2
- package/generated-docs/react/prejoinprops.debug.md +0 -2
- package/generated-docs/react/prejoinprops.defaults.md +0 -2
- package/generated-docs/react/prejoinprops.md +0 -2
- package/generated-docs/react/prejoinprops.onsubmit.md +0 -2
- package/generated-docs/react/prejoinprops.onvalidate.md +0 -2
- package/generated-docs/react/prejoinprops.persistuserchoices.md +6 -2
- package/generated-docs/react/receivedchatmessage.md +0 -2
- package/generated-docs/react/roomaudiorendererprops.md +0 -2
- package/generated-docs/react/roomaudiorendererprops.muted.md +6 -2
- package/generated-docs/react/roomaudiorendererprops.volume.md +0 -2
- package/generated-docs/react/roomnameprops.md +0 -2
- package/generated-docs/react/setlogextension.md +0 -2
- package/generated-docs/react/setloglevel.md +0 -2
- package/generated-docs/react/trackloopprops.children.md +0 -2
- package/generated-docs/react/trackloopprops.md +0 -2
- package/generated-docs/react/trackloopprops.tracks.md +0 -2
- package/generated-docs/react/trackmutedindicatorprops.md +0 -2
- package/generated-docs/react/trackreference.md +0 -2
- package/generated-docs/react/trackreferenceorplaceholder.md +0 -2
- package/generated-docs/react/tracktoggleprops.md +0 -2
- package/generated-docs/react/tracktoggleprops.onchange.md +0 -2
- package/generated-docs/react/tracktranscriptionoptions.buffersize.md +6 -2
- package/generated-docs/react/tracktranscriptionoptions.md +6 -2
- package/generated-docs/react/tracktranscriptionoptions.ontranscription.md +6 -2
- package/generated-docs/react/usechattoggleprops.md +0 -2
- package/generated-docs/react/usefocustoggleprops.md +0 -2
- package/generated-docs/react/useisencryptedoptions.md +6 -2
- package/generated-docs/react/useisencryptedoptions.room.md +6 -0
- package/generated-docs/react/useismutedoptions.md +0 -2
- package/generated-docs/react/usekrispnoisefilteroptions.md +28 -0
- package/generated-docs/react/usekrispnoisefilteroptions.trackref.md +21 -0
- package/generated-docs/react/uselocalparticipantoptions.md +0 -2
- package/generated-docs/react/uselocalparticipantoptions.room.md +0 -2
- package/generated-docs/react/usemediadeviceselectprops.md +0 -2
- package/generated-docs/react/usemediadeviceselectprops.onerror.md +0 -2
- package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +0 -2
- package/generated-docs/react/useparticipantattributesoptions.md +0 -2
- package/generated-docs/react/useparticipantinfooptions.md +0 -2
- package/generated-docs/react/useparticipantpermissionsoptions.md +0 -2
- package/generated-docs/react/useparticipantsoptions.md +0 -2
- package/generated-docs/react/useparticipantsoptions.room.md +0 -2
- package/generated-docs/react/useparticipantsoptions.updateonlyon.md +0 -2
- package/generated-docs/react/useparticipanttileprops.md +0 -2
- package/generated-docs/react/useparticipanttileprops.trackref.md +0 -2
- package/generated-docs/react/usepersistentuserchoicesoptions.defaults.md +6 -2
- package/generated-docs/react/usepersistentuserchoicesoptions.md +6 -2
- package/generated-docs/react/usepersistentuserchoicesoptions.preventload.md +6 -2
- package/generated-docs/react/usepersistentuserchoicesoptions.preventsave.md +6 -2
- package/generated-docs/react/useremoteparticipantoptions.md +0 -2
- package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md +0 -2
- package/generated-docs/react/useremoteparticipantsoptions.md +0 -2
- package/generated-docs/react/useremoteparticipantsoptions.room.md +0 -2
- package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +0 -2
- package/generated-docs/react/userinfo.md +0 -2
- package/generated-docs/react/useroominfooptions.md +0 -2
- package/generated-docs/react/usestartaudioprops.md +6 -2
- package/generated-docs/react/usestartaudioprops.props.md +6 -0
- package/generated-docs/react/usestartaudioprops.room.md +6 -0
- package/generated-docs/react/usestartvideoprops.md +6 -2
- package/generated-docs/react/usestartvideoprops.props.md +6 -0
- package/generated-docs/react/usestartvideoprops.room.md +6 -0
- package/generated-docs/react/useswipeoptions.md +6 -2
- package/generated-docs/react/usetokenoptions.md +0 -2
- package/generated-docs/react/usetrackshookreturntype.md +0 -2
- package/generated-docs/react/usetracksoptions.md +0 -2
- package/generated-docs/react/usetracktoggleprops.md +0 -2
- package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +0 -2
- package/generated-docs/react/usevisualstableupdateoptions.md +0 -2
- package/generated-docs/react/videoconferenceprops.md +0 -2
- package/generated-docs/react/videoconferenceprops.settingscomponent.md +6 -2
- package/generated-docs/react/videotrackprops.md +0 -2
- package/generated-docs/react/videotrackprops.trackref.md +0 -2
- package/generated-docs/react/voiceassistant.agent.md +5 -1
- package/generated-docs/react/voiceassistant.agentattributes.md +5 -1
- package/generated-docs/react/voiceassistant.agenttranscriptions.md +5 -1
- package/generated-docs/react/voiceassistant.audiotrack.md +5 -1
- package/generated-docs/react/voiceassistant.md +5 -3
- package/generated-docs/react/voiceassistant.state.md +5 -1
- package/generated-docs/react/voiceassistantcontrolbarcontrols.md +5 -3
- package/generated-docs/react/voiceassistantcontrolbarprops.controls.md +5 -1
- package/generated-docs/react/voiceassistantcontrolbarprops.md +5 -3
- package/generated-docs/react/voiceassistantcontrolbarprops.ondeviceerror.md +5 -1
- package/generated-docs/react/voiceassistantcontrolbarprops.saveuserchoices.md +5 -3
- package/generated-docs/react/widgetstate.md +0 -2
- package/package.json +2 -2
|
@@ -6,10 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
# VideoConferenceProps.SettingsComponent property
|
|
8
8
|
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is experimental and may change or be removed based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
9
15
|
**Signature:**
|
|
10
16
|
|
|
11
17
|
```typescript
|
|
12
18
|
SettingsComponent?: React.ComponentType;
|
|
13
19
|
```
|
|
14
|
-
|
|
15
|
-
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -17,8 +17,6 @@ export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElem
|
|
|
17
17
|
|
|
18
18
|
**Extends:** React.VideoHTMLAttributes<HTMLVideoElement>
|
|
19
19
|
|
|
20
|
-
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
21
|
-
|
|
22
20
|
## Properties
|
|
23
21
|
|
|
24
22
|
| Property | Type | Description |
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistant.agent property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistant.agentAttributes property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistant.agentTranscriptions property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistant.audioTrack property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -9,7 +9,11 @@
|
|
|
9
9
|
|
|
10
10
|
# VoiceAssistant interface
|
|
11
11
|
|
|
12
|
-
|
|
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 %}
|
|
13
17
|
|
|
14
18
|
**Signature:**
|
|
15
19
|
|
|
@@ -17,8 +21,6 @@
|
|
|
17
21
|
export interface VoiceAssistant
|
|
18
22
|
```
|
|
19
23
|
|
|
20
|
-
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
21
|
-
|
|
22
24
|
## Properties
|
|
23
25
|
|
|
24
26
|
| Property | Type | Description |
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistant.state property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -9,7 +9,11 @@
|
|
|
9
9
|
|
|
10
10
|
# VoiceAssistantControlBarControls type
|
|
11
11
|
|
|
12
|
-
|
|
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 %}
|
|
13
17
|
|
|
14
18
|
**Signature:**
|
|
15
19
|
|
|
@@ -19,5 +23,3 @@ export type VoiceAssistantControlBarControls = {
|
|
|
19
23
|
leave?: boolean;
|
|
20
24
|
};
|
|
21
25
|
```
|
|
22
|
-
|
|
23
|
-
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistantControlBarProps.controls property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -9,7 +9,11 @@
|
|
|
9
9
|
|
|
10
10
|
# VoiceAssistantControlBarProps interface
|
|
11
11
|
|
|
12
|
-
|
|
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 %}
|
|
13
17
|
|
|
14
18
|
**Signature:**
|
|
15
19
|
|
|
@@ -19,8 +23,6 @@ export interface VoiceAssistantControlBarProps extends React.HTMLAttributes<HTML
|
|
|
19
23
|
|
|
20
24
|
**Extends:** React.HTMLAttributes<HTMLDivElement>
|
|
21
25
|
|
|
22
|
-
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
23
|
-
|
|
24
26
|
## Properties
|
|
25
27
|
|
|
26
28
|
| Property | Type | Description |
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistantControlBarProps.onDeviceError property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
**Signature:**
|
|
12
16
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# VoiceAssistantControlBarProps.saveUserChoices property
|
|
8
8
|
|
|
9
|
-
|
|
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 %}
|
|
10
14
|
|
|
11
15
|
If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
|
|
12
16
|
|
|
@@ -15,5 +19,3 @@ If `true`<!-- -->, the user's device choices will be persisted. This will enable
|
|
|
15
19
|
```typescript
|
|
16
20
|
saveUserChoices?: boolean;
|
|
17
21
|
```
|
|
18
|
-
|
|
19
|
-
{% 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.49",
|
|
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.11"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|