@livekit/components-js-docs 0.1.73 → 0.1.76

package/generated-docs/react/meta-data.json

@@ -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":"sessionprovider.md","title":"SessionProvider"},{"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":"useagent.md","title":"useAgent"},{"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":"useensuresession.md","title":"useEnsureSession"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useevents.md","title":"useEvents"},{"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":"usemaybesessioncontext.md","title":"useMaybeSessionContext"},{"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":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesession.md","title":"useSession"},{"filename":"usesessioncontext.md","title":"useSessionContext"},{"filename":"usesessionmessages.md","title":"useSessionMessages"},{"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"}]}
+{"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":"sessionprovider.md","title":"SessionProvider"},{"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":"useagent.md","title":"useAgent"},{"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":"useensuresession.md","title":"useEnsureSession"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useevents.md","title":"useEvents"},{"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":"usemaybesessioncontext.md","title":"useMaybeSessionContext"},{"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":"userpc.md","title":"useRpc"},{"filename":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesession.md","title":"useSession"},{"filename":"usesessioncontext.md","title":"useSessionContext"},{"filename":"usesessionmessages.md","title":"useSessionMessages"},{"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"}]}

package/generated-docs/react/prejoinprops.md

@@ -21,16 +21,16 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 
 ## Properties
 
-| Property                                                          | Type                                                                           | Description                                                                                                                                |
-| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [camLabel?](./react/prejoinprops.camlabel.md)                     | string                                                                         | _(Optional)_                                                                                                                               |
-| [debug?](./react/prejoinprops.debug.md)                           | boolean                                                                        | _(Optional)_ Display a debug window for your convenience.                                                                                  |
-| [defaults?](./react/prejoinprops.defaults.md)                     | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
-| [joinLabel?](./react/prejoinprops.joinlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                               |
-| [micLabel?](./react/prejoinprops.miclabel.md)                     | string                                                                         | _(Optional)_                                                                                                                               |
-| [onError?](./react/prejoinprops.onerror.md)                       | (error: Error) =&gt; void                                                      | _(Optional)_                                                                                                                               |
-| [onSubmit?](./react/prejoinprops.onsubmit.md)                     | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
-| [onValidate?](./react/prejoinprops.onvalidate.md)                 | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
-| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                                                        | _(Optional)_ If true, user choices are persisted across sessions.                                                                          |
-| [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                               |
-| [videoProcessor?](./react/prejoinprops.videoprocessor.md)         | TrackProcessor&lt;Track.Kind.Video&gt;                                         | _(Optional)_                                                                                                                               |
+| Property                                                          | Type                                                                           | Description                                                                                                                                  |
+| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| [camLabel?](./react/prejoinprops.camlabel.md)                     | string                                                                         | _(Optional)_                                                                                                                                 |
+| [debug?](./react/prejoinprops.debug.md)                           | boolean                                                                        | _(Optional)_ Display a debug window for your convenience.                                                                                    |
+| [defaults?](./react/prejoinprops.defaults.md)                     | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                     |
+| [joinLabel?](./react/prejoinprops.joinlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                                 |
+| [micLabel?](./react/prejoinprops.miclabel.md)                     | string                                                                         | _(Optional)_                                                                                                                                 |
+| [onError?](./react/prejoinprops.onerror.md)                       | (error: Error) =&gt; void                                                      | _(Optional)_                                                                                                                                 |
+| [onSubmit?](./react/prejoinprops.onsubmit.md)                     | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                         |
+| [onValidate?](./react/prejoinprops.onvalidate.md)                 | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are passed to the onSubmit callback. |
+| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                                                        | _(Optional)_ If true, user choices are persisted across sessions.                                                                            |
+| [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                                 |
+| [videoProcessor?](./react/prejoinprops.videoprocessor.md)         | TrackProcessor&lt;Track.Kind.Video&gt;                                         | _(Optional)_                                                                                                                                 |

package/generated-docs/react/prejoinprops.onvalidate.md

@@ -6,7 +6,7 @@
 
 # PreJoinProps.onValidate property
 
-Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+Provide your custom validation function. Only if validation is successful the user choices are passed to the onSubmit callback.
 
 **Signature:**
 

package/generated-docs/react/rpccallparams.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "RpcCallParams type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRpc.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RpcCallParams type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Base RPC call parameters with an arbitrary payload type (used when the payload will be serialized by a serializer).
+
+**Signature:**
+
+```typescript
+export type RpcCallParams<Payload> = Omit<PerformRpcParams, "payload"> & {
+  payload: Payload;
+};
+```

package/generated-docs/react/rpchandler.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "RpcHandler type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRpc.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RpcHandler type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type RpcHandler<Input = any, Output = any> = (
+  payload: Input,
+  data: RpcInvocationData
+) => Promise<Output>;
+```

package/generated-docs/react/rpcperformfn.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "RpcPerformFn type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRpc.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RpcPerformFn type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type RpcPerformFn = {
+  <Output = string, Input = unknown>(
+    params: RpcCallParams<Input>,
+    serializer: Serializer<Output, Input>
+  ): Promise<Output>;
+  (params: PerformRpcParams): Promise<string>;
+};
+```
+
+**References:** [RpcCallParams](./react/rpccallparams.md)

package/generated-docs/react/userpcoptions.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "UseRpcOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRpc.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRpcOptions type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Options for [useRpc()](./react/hook/userpc.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export type UseRpcOptions<S extends Serializer<any, any> = Serializer<any, any>> = {
+  fromIdentity?: string;
+  serializer?: S;
+};
+```

package/generated-docs/react/userpcreturn.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "UseRpcReturn type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRpc.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRpcReturn type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type UseRpcReturn = {
+  perform: RpcPerformFn;
+};
+```
+
+**References:** [RpcPerformFn](./react/rpcperformfn.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.73",
+  "version": "0.1.76",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.9.20"
+    "@livekit/components-react": "2.9.23"
   },
   "author": "",
   "license": "Apache-2.0",