npm - @livekit/components-js-docs - Versions diffs - 0.1.2 → 0.1.4 - Mend

@livekit/components-js-docs 0.1.2 → 0.1.4

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.

Files changed (71) hide show

package/generated-docs/core/chatmessage.md CHANGED Viewed

@@ -15,6 +15,8 @@
 export interface ChatMessage
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                     | Type   | Description |

package/generated-docs/core/chatoptions.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+{
+  "title": "ChatOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# ChatOptions type
+**Signature:**
+```typescript
+export type ChatOptions = {
+  messageEncoder?: (message: ChatMessage) => Uint8Array;
+  messageDecoder?: (message: Uint8Array) => ReceivedChatMessage;
+  channelTopic?: string;
+};
+```
+**References:** [ChatMessage](./core/chatmessage.md)<!-- -->, [ReceivedChatMessage](./core/receivedchatmessage.md)
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/createmediadeviceobserver.md CHANGED Viewed

@@ -14,6 +14,7 @@
 ```typescript
 export declare function createMediaDeviceObserver(
   kind?: MediaDeviceKind,
+  onError?: (e: Error) => void,
   requestPermissions?: boolean
-): Observable<MediaDeviceInfo[]>;
+): Observable<void | MediaDeviceInfo[] | undefined>;
 ```

package/generated-docs/core/index.md CHANGED Viewed

@@ -20,6 +20,7 @@
 | [BaseDataMessage](./core/basedatamessage.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [CaptureOptionsBySource](./core/captureoptionsbysource.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ChatMessage](./core/chatmessage.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ChatOptions](./core/chatoptions.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [computeMenuPosition(button, menu)](./core/computemenuposition.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md)      |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -30,7 +31,7 @@
 | [createDataObserver(room)](./core/createdataobserver.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createDefaultGrammar](./core/createdefaultgrammar.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md)  |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createTrackObserver(participant, options)](./core/createtrackobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createUrlRegExp(options)](./core/createurlregexp.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [cssPrefix](./core/cssprefix.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -50,7 +51,6 @@
 | [isRemote(p)](./core/isremote.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isSourcesWithOptions(sources)](./core/issourceswithoptions.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isSourceWitOptions(source)](./core/issourcewitoptions.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isTrackReference(trackReference)](./core/istrackreference.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                 | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
 | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)                                  | Reads the user choices from local storage, or returns the default settings if none are found.                                                                                                                                                                                                                                                                                                               |
@@ -64,7 +64,6 @@
 | [observeParticipantMedia(participant)](./core/observeparticipantmedia.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [observeRoomEvents(room, events)](./core/observeroomevents.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [observeTrackEvents(track, events)](./core/observetrackevents.md)                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ParticipantClickEvent](./core/participantclickevent.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [participantEventSelector(participant, event)](./core/participanteventselector.md)                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ParticipantFilter](./core/participantfilter.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [participantInfoObserver(participant)](./core/participantinfoobserver.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -79,6 +78,7 @@
 | [roomEventSelector(room, event)](./core/roomeventselector.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomInfoObserver(room)](./core/roominfoobserver.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomObserver(room)](./core/roomobserver.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomVideoPlaybackAllowedObservable(room)](./core/roomvideoplaybackallowedobservable.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md)                               | Saves user choices to local storage.                                                                                                                                                                                                                                                                                                                                                                        |
 | [screenShareObserver(room)](./core/screenshareobserver.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ScreenShareTrackMap](./core/screensharetrackmap.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -102,6 +102,7 @@
 | [setupParticipantName(participant)](./core/setupparticipantname.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupParticipantTile()](./core/setupparticipanttile.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupStartAudio()](./core/setupstartaudio.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupStartVideo()](./core/setupstartvideo.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupTrackMutedIndicator(trackRef)](./core/setuptrackmutedindicator.md)                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [sortParticipants(participants)](./core/sortparticipants.md)                                         | Default sort for participants, it'll order participants by: 1. local participant 2. dominant speaker (speaker with the loudest audio level) 3. other speakers that are recently active 4. participants with video on 5. by joinedAt                                                                                                                                                                         |
 | [sortTrackReferences(tracks)](./core/sorttrackreferences.md)                                         | Default sort for <code>TrackReferenceOrPlaceholder</code>, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote screen_share track 3. local screen_share track 4. remote dominant speaker camera track (sorted by speaker with the loudest audio level) 5. other remote speakers that are recently active 6. remote unmuted camera tracks 7. remote tracks sorted by joinedAt |

package/generated-docs/core/pinstate.md CHANGED Viewed

@@ -16,3 +16,5 @@ export type PinState = TrackReferenceOrPlaceholder[];
 ```
 **References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/receivedchatmessage.md CHANGED Viewed

@@ -17,6 +17,8 @@ export interface ReceivedChatMessage extends ChatMessage
 **Extends:** [ChatMessage](./core/chatmessage.md)
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                    | Type        | Description  |

package/generated-docs/core/roomvideoplaybackallowedobservable.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+{
+  "title": "roomVideoPlaybackAllowedObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# roomVideoPlaybackAllowedObservable
+**Signature:**
+```typescript
+export declare function roomVideoPlaybackAllowedObservable(room: Room): Observable<{
+  canPlayVideo: boolean;
+}>;
+```

package/generated-docs/core/setupchat.md CHANGED Viewed

@@ -14,14 +14,10 @@
 ```typescript
 export declare function setupChat(
   room: Room,
-  options?: {
-    messageEncoder?: (message: ChatMessage) => Uint8Array;
-    messageDecoder?: (message: Uint8Array) => ReceivedChatMessage;
-  }
+  options?: ChatOptions
 ): {
   messageObservable: import("rxjs").Observable<ReceivedChatMessage[]>;
   isSendingObservable: BehaviorSubject<boolean>;
   send: (message: string) => Promise<void>;
-  destroy: () => void;
 };
 ```

package/generated-docs/core/setupstartvideo.md ADDED Viewed

@@ -0,0 +1,20 @@
+---
+{
+  "title": "setupStartVideo",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/startVideo.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# setupStartVideo
+**Signature:**
+```typescript
+export declare function setupStartVideo(): {
+  className: string;
+  roomVideoPlaybackAllowedObservable: typeof roomVideoPlaybackAllowedObservable;
+  handleStartVideoPlayback: (room: Room) => Promise<void>;
+};
+```

package/generated-docs/core/trackreference.md CHANGED Viewed

@@ -18,3 +18,5 @@ export type TrackReference = {
   source: Track.Source;
 };
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/trackreferenceorplaceholder.md CHANGED Viewed

@@ -16,3 +16,5 @@ export type TrackReferenceOrPlaceholder = TrackReference | TrackReferencePlaceho
 ```
 **References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md)
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/trackreferenceplaceholder.md CHANGED Viewed

@@ -18,3 +18,5 @@ export type TrackReferencePlaceholder = {
   source: Track.Source;
 };
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/widgetstate.md CHANGED Viewed

@@ -17,3 +17,5 @@ export type WidgetState = {
   unreadMessages: number;
 };
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiotrackprops.md CHANGED Viewed

@@ -21,13 +21,13 @@ export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElem
 ## Properties
-| Property                                                                               | Type                                       | Description                                                                                                              |
-| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
-| [muted?](./react/audiotrackprops.muted.md)                                             | boolean                                    | _(Optional)_ Mutes the audio track if set to <code>true</code>.                                                          |
-| [name?](./react/audiotrackprops.name.md)                                               | string                                     | _(Optional)_                                                                                                             |
-| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void           | _(Optional)_                                                                                                             |
-| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                                | _(Optional)_                                                                                                             |
-| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                           | _(Optional)_                                                                                                             |
-| [source?](./react/audiotrackprops.source.md)                                           | Track.Source                               | _(Optional)_                                                                                                             |
-| [trackRef?](./react/audiotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered.                                    |
-| [volume?](./react/audiotrackprops.volume.md)                                           | number                                     | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
+| Property                                                                               | Type                                        | Description                                                                                                              |
+| -------------------------------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| [muted?](./react/audiotrackprops.muted.md)                                             | boolean                                     | _(Optional)_ Mutes the audio track if set to <code>true</code>.                                                          |
+| [name?](./react/audiotrackprops.name.md)                                               | string                                      | _(Optional)_                                                                                                             |
+| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void            | _(Optional)_                                                                                                             |
+| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                                 | _(Optional)_                                                                                                             |
+| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                            | _(Optional)_                                                                                                             |
+| [source?](./react/audiotrackprops.source.md)                                           | Track.Source                                | _(Optional)_                                                                                                             |
+| [trackRef?](./react/audiotrackprops.trackref.md)                                       | [TrackReference](./react/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered.                                    |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                                      | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

package/generated-docs/react/audiovisualizerprops.md CHANGED Viewed

@@ -21,7 +21,7 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
 ## Properties
-| Property                                                    | Type                                                                 | Description  |
-| ----------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
-| [participant?](./react/audiovisualizerprops.participant.md) | Participant                                                          | _(Optional)_ |
-| [trackRef?](./react/audiovisualizerprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
+| Property                                                    | Type                                                                  | Description  |
+| ----------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [participant?](./react/audiovisualizerprops.participant.md) | Participant                                                           | _(Optional)_ |
+| [trackRef?](./react/audiovisualizerprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |

package/generated-docs/react/carousellayoutprops.md CHANGED Viewed

@@ -21,8 +21,8 @@ export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaEleme
 ## Properties
-| Property                                                   | Type                                                                             | Description                                                                                                                                         |
-| ---------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [children](./react/carousellayoutprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
-| [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal'                                                       | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
-| [tracks](./react/carousellayoutprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |
+| Property                                                   | Type                                                                              | Description                                                                                                                                         |
+| ---------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [children](./react/carousellayoutprops.children.md)        | React.ReactNode                                                                   |                                                                                                                                                     |
+| [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal'                                                        | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
+| [tracks](./react/carousellayoutprops.tracks.md)            | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |

package/generated-docs/react/chatentryprops.md CHANGED Viewed

@@ -23,9 +23,9 @@ export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
 ## Properties
-| Property                                                        | Type                                                 | Description                                                                                                    |
-| --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display.                                                                            |
-| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                              | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
-| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                              | _(Optional)_ Hide message timestamp.                                                                           |
-| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)      | _(Optional)_ An optional formatter for the message body.                                                       |
+| Property                                                        | Type                                                  | Description                                                                                                    |
+| --------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./react/receivedchatmessage.md) | The chat massage object to display.                                                                            |
+| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                               | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
+| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                               | _(Optional)_ Hide message timestamp.                                                                           |
+| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)       | _(Optional)_ An optional formatter for the message body.                                                       |

package/generated-docs/react/chatmessage.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+{
+  "title": "ChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# ChatMessage interface
+**Signature:**
+```typescript
+export interface ChatMessage
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Properties
+| Property                                      | Type   | Description |
+| --------------------------------------------- | ------ | ----------- |
+| [message](./react/chatmessage.message.md)     | string |             |
+| [timestamp](./react/chatmessage.timestamp.md) | number |             |

package/generated-docs/{core/participantclickevent.track.md → react/chatmessage.message.md} RENAMED Viewed

@@ -1,13 +1,13 @@
 ---
-{ "title": "ParticipantClickEvent.track property" }
+{ "title": "ChatMessage.message property" }
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# ParticipantClickEvent.track property
+# ChatMessage.message property
 **Signature:**
 ```typescript
-track?: TrackPublication;
+message: string;
 ```

package/generated-docs/react/{chatprops.messageencoder.md → chatmessage.timestamp.md} RENAMED Viewed

@@ -1,13 +1,13 @@
 ---
-{ "title": "ChatProps.messageEncoder property" }
+{ "title": "ChatMessage.timestamp property" }
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# ChatProps.messageEncoder property
+# ChatMessage.timestamp property
 **Signature:**
 ```typescript
-messageEncoder?: MessageEncoder;
+timestamp: number;
 ```

package/generated-docs/react/chatprops.md CHANGED Viewed

@@ -12,10 +12,10 @@
 **Signature:**
 ```typescript
-export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>
+export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>, ChatOptions
 ```
-**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, ChatOptions
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -23,6 +23,4 @@ export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>
 | Property                                                   | Type                                            | Description  |
 | ---------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [messageDecoder?](./react/chatprops.messagedecoder.md)     | [MessageDecoder](./core/messagedecoder.md)      | _(Optional)_ |
-| [messageEncoder?](./react/chatprops.messageencoder.md)     | [MessageEncoder](./core/messageencoder.md)      | _(Optional)_ |
 | [messageFormatter?](./react/chatprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

package/generated-docs/react/component/chat.md CHANGED Viewed

@@ -29,16 +29,6 @@ import { Chat } from "@livekit/components-react";
 ## Properties
-{% parameter name="messageDecoder" type="MessageDecoder" optional=true %}
-_(Optional)_
-{% /parameter %}
-{% parameter name="messageEncoder" type="MessageEncoder" optional=true %}
-_(Optional)_
-{% /parameter %}
 {% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
 _(Optional)_

package/generated-docs/react/component/livekitroom.md CHANGED Viewed

@@ -64,6 +64,11 @@ _(Optional)_
 {% /parameter %}
+{% parameter name="onEncryptionError" type="(error: Error) => void" optional=true %}
+_(Optional)_
+{% /parameter %}
 {% parameter name="onError" type="(error: Error) => void" optional=true %}
 _(Optional)_

package/generated-docs/react/component/mediadeviceselect.md CHANGED Viewed

@@ -57,6 +57,11 @@ _(Optional)_
 {% /parameter %}
+{% parameter name="onError" type="(e: Error) => void" optional=true %}
+_(Optional)_
+{% /parameter %}
 {% parameter name="requestPermissions" type="boolean" optional=true %}
 _(Optional)_ 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.

package/generated-docs/react/focuslayoutcontainerprops.md CHANGED Viewed

@@ -21,7 +21,7 @@ export interface FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
 ## Properties
-| Property                                                           | Type                                       | Description  |
-| ------------------------------------------------------------------ | ------------------------------------------ | ------------ |
-| [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md)     | [TrackReference](./core/trackreference.md) | _(Optional)_ |
-| [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt;                   | _(Optional)_ |
+| Property                                                           | Type                                        | Description  |
+| ------------------------------------------------------------------ | ------------------------------------------- | ------------ |
+| [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md)     | [TrackReference](./react/trackreference.md) | _(Optional)_ |
+| [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt;                    | _(Optional)_ |

package/generated-docs/react/focuslayoutprops.md CHANGED Viewed

@@ -21,8 +21,8 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
 ## Properties
-| Property                                                              | Type                                                                               | Description                                            |
-| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------ |
-| [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                           |
-| [track?](./react/focuslayoutprops.track.md)                           | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)               | _(Optional)_                                           |
-| [trackRef?](./react/focuslayoutprops.trackref.md)                     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)               | _(Optional)_ The track to display in the focus layout. |
+| Property                                                              | Type                                                                  | Description                                            |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------ |
+| [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: ParticipantClickEvent) =&gt; void                               | _(Optional)_                                           |
+| [track?](./react/focuslayoutprops.track.md)                           | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_                                           |
+| [trackRef?](./react/focuslayoutprops.trackref.md)                     | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track to display in the focus layout. |

package/generated-docs/react/focustoggleprops.md CHANGED Viewed

@@ -21,8 +21,8 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
 ## Properties
-| Property                                                | Type                                                                 | Description  |
-| ------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
-| [participant?](./react/focustoggleprops.participant.md) | Participant                                                          | _(Optional)_ |
-| [trackRef?](./react/focustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
-| [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source                                                         | _(Optional)_ |
+| Property                                                | Type                                                                  | Description  |
+| ------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [participant?](./react/focustoggleprops.participant.md) | Participant                                                           | _(Optional)_ |
+| [trackRef?](./react/focustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
+| [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source                                                          | _(Optional)_ |

package/generated-docs/react/gridlayoutprops.md CHANGED Viewed

@@ -21,7 +21,7 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
 ## Properties
-| Property                                        | Type                                                                             | Description |
-| ----------------------------------------------- | -------------------------------------------------------------------------------- | ----------- |
-| [children](./react/gridlayoutprops.children.md) | React.ReactNode                                                                  |             |
-| [tracks](./react/gridlayoutprops.tracks.md)     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |             |
+| Property                                        | Type                                                                              | Description |
+| ----------------------------------------------- | --------------------------------------------------------------------------------- | ----------- |
+| [children](./react/gridlayoutprops.children.md) | React.ReactNode                                                                   |             |
+| [tracks](./react/gridlayoutprops.tracks.md)     | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] |             |

package/generated-docs/react/hook/usechat.md CHANGED Viewed

@@ -25,10 +25,7 @@ It is possible to pass configurations for custom message encoding and decoding.
 ## Properties
-{% parameter name="options" type="{
-      messageEncoder?: MessageEncoder;
-      messageDecoder?: MessageDecoder;
-  }" optional=true %}
+{% parameter name="options" type="ChatOptions" optional=true %}
 {% /parameter %}
 ## Returns

package/generated-docs/react/hook/useisencrypted.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+{
+  "title": "useIsEncrypted",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useIsEncrypted.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# useIsEncrypted
+## Import
+```typescript
+import { useIsEncrypted } from "@livekit/components-react";
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Properties
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
+## Returns
+```typescript
+boolean;
+```

package/generated-docs/react/hook/uselivekitroom.md CHANGED Viewed

@@ -59,6 +59,9 @@ Define options how to connect to the LiveKit server.
 {% parameter name="onDisconnected" type="() => void" optional=true %}
 {% /parameter %}
+{% parameter name="onEncryptionError" type="(error: Error) => void" optional=true %}
+{% /parameter %}
 {% parameter name="onError" type="(error: Error) => void" optional=true %}
 {% /parameter %}

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

@@ -32,6 +32,11 @@ const { devices, activeDeviceId, setActiveMediaDevice } = useMediaDeviceSelect({
 {% parameter name="kind" type="MediaDeviceKind" optional=false %}
 {% /parameter %}
+{% parameter name="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="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.

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

@@ -0,0 +1,43 @@
+---
+{
+  "title": "useStartVideo",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartVideo.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# useStartVideo
+In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The `useStartVideo` hook returns an object with a boolean `canPlayVideo` flag that indicates whether video playback is allowed in the current context, as well as a `startVideo` function that can be called in a button `onClick` callback to start video playback in the current context.
+## Import
+```typescript
+import { useStartVideo } from "@livekit/components-react";
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Properties
+{% parameter name="props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% /parameter %}
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+## Returns
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayVideo: boolean;
+}
+```