@livekit/components-js-docs 0.1.73 → 0.1.76

package/generated-docs/core/participantbyidentifierobserver.md

@@ -14,7 +14,7 @@
 ```typescript
 export declare function participantByIdentifierObserver(
   room: Room,
-  { kind, identity }: ParticipantIdentifier,
+  input: ParticipantIdentifier,
   options?: ConnectedParticipantObserverOptions
 ): Observable<RemoteParticipant | undefined>;
 ```

package/generated-docs/core/setupdatamessagehandler.md

@@ -18,7 +18,7 @@ export declare function setupDataMessageHandler<T extends string>(
   onMessage?: (msg: ReceivedDataMessage<T>) => void
 ): {
   messageObservable: Observable<{
-    payload: Uint8Array<ArrayBufferLike>;
+    payload: Uint8Array<ArrayBuffer>;
     topic: T;
     from: import("livekit-client").RemoteParticipant | undefined;
   }>;

package/generated-docs/react/component/chattoggle.md

@@ -25,6 +25,6 @@ For the component to have any effect it has to live inside a `LayoutContext` con
 
 ```tsx
 <LiveKitRoom>
-  <ToggleChat />
+  <ChatToggle />
 </LiveKitRoom>
 ```

package/generated-docs/react/component/controlbar.md

@@ -19,7 +19,7 @@ import { ControlBar } from "@livekit/components-react";
 
 ## Remarks
 
-This component is build with other LiveKit components like `TrackToggle`<!-- -->, `DeviceSelectorButton`<!-- -->, `DisconnectButton` and `StartAudio`<!-- -->.
+This component is built with other LiveKit components like `TrackToggle`<!-- -->, `DeviceSelectorButton`<!-- -->, `DisconnectButton` and `StartAudio`<!-- -->.
 
 ## Usage
 

package/generated-docs/react/component/prejoin.md

@@ -9,7 +9,7 @@
 
 # PreJoin
 
-The `PreJoin` prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the `LiveKitRoom` so that the user enters the room with the correct media devices.
+The `PreJoin` prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera and microphone). On submit the user decisions are returned, which can then be passed on to the `LiveKitRoom` so that the user enters the room with the correct media devices.
 
 ## Import
 
@@ -65,7 +65,7 @@ _(Optional)_ This function is called with the `LocalUserChoices` if validation i
 {% /parameter %}
 
 {% parameter name="onValidate" type="(values: LocalUserChoices) => boolean" optional=true %}
-_(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+_(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are passed to the onSubmit callback.
 
 {% /parameter %}
 

package/generated-docs/react/hook/usechattoggle.md

@@ -23,7 +23,7 @@ Depends on the `LayoutContext` to work properly.
 
 ## Properties
 
-{% parameter name="{ props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
 ## Returns

package/generated-docs/react/hook/usefocustoggle.md

@@ -26,10 +26,10 @@ return <button {...mergedProps}>{inFocus ? "Unfocus" : "Focus"}</button>;
 
 ## Properties
 
-{% parameter name="{ trackRef, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, props }.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="input.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 {% /parameter %}
 
 ## Returns

package/generated-docs/react/hook/usemediadevices.md

@@ -26,7 +26,7 @@ const audioDevices = useMediaDevices({ kind: "audioinput" });
 
 ## Properties
 
-{% parameter name="{ kind, onError, }" type="{
+{% parameter name="input" type="{
       kind: MediaDeviceKind;
       onError?: (e: Error) => void;
   }" optional=false %}

package/generated-docs/react/hook/usemediadeviceselect.md

@@ -27,23 +27,23 @@ const { devices, activeDeviceId, setActiveMediaDevice } = useMediaDeviceSelect({
 
 ## Properties
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.kind" type="MediaDeviceKind" optional=false %}
+{% parameter name="input.kind" type="MediaDeviceKind" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.onError" type="(e: Error) => void" optional=true %}
+{% parameter name="input.onError" type="(e: Error) => void" optional=true %}
 this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the `requestPermissions` option is set to `true`<!-- -->. Most commonly this will emit a MediaDeviceError
 
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.requestPermissions" type="boolean" optional=true %}
+{% parameter name="input.requestPermissions" type="boolean" optional=true %}
 this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
 
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
+{% parameter name="input.track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
 {% /parameter %}
 
 ## Returns

package/generated-docs/react/hook/useparticipanttile.md

@@ -23,16 +23,16 @@ The returned props include many data attributes that are useful for CSS styling
 
 ## Properties
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.htmlProps" type="React.HTMLAttributes<T>" optional=false %}
+{% parameter name="input.htmlProps" type="React.HTMLAttributes<T>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.disableSpeakingIndicator" type="boolean" optional=true %}
+{% parameter name="input.disableSpeakingIndicator" type="boolean" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
+{% parameter name="input.onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="input.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 The track reference to display.
 
 {% /parameter %}

package/generated-docs/react/hook/userpc.md

@@ -0,0 +1,56 @@
+---
+{
+  "title": "useRpc",
+  "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. -->
+
+# useRpc
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Hook for declarative RPC method registration and outbound RPC calls.
+
+Registers a handler for an incoming RPC method and returns a `performRpc` function for outbound calls. The handler is registered on mount and unregistered on unmount. Handler identity does not matter (captured by ref), so inline functions work without `useCallback`<!-- -->.
+
+## Import
+
+```typescript
+import { useRpc } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const { performRpc } = useRpc(
+  session,
+  "getUserLocation",
+  async (payload: { highAccuracy: boolean }) => {
+    const pos = await getPosition(payload.highAccuracy);
+    return { lat: pos.coords.latitude, lng: pos.coords.longitude };
+  }
+);
+```
+
+## Properties
+
+{% parameter name="handler" type="RpcHandler<SerializerInput<S>, SerializerOutput<S>>" optional=false %}
+{% /parameter %}
+
+{% parameter name="methodName" type="string" optional=false %}
+{% /parameter %}
+
+{% parameter name="session" type="UseSessionReturn" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseRpcReturn;
+```

package/generated-docs/react/hook/usestartaudio.md

@@ -25,10 +25,10 @@ import { useStartAudio } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="{ room, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ room, props }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns

package/generated-docs/react/hook/usestartvideo.md

@@ -25,10 +25,10 @@ import { useStartVideo } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="{ room, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ room, props }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns

package/generated-docs/react/hook/usetracktoggle.md

@@ -26,7 +26,7 @@ return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
 
 ## Properties
 
-{% parameter name="{ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns