@livekit/components-js-docs 0.1.74 → 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/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/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