npm - @livekit/components-js-docs - Versions diffs - 0.0.4 → 0.1.0 - Mend

@livekit/components-js-docs 0.0.4 → 0.1.0

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 (166) hide show

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

@@ -11,6 +11,8 @@ export type LocalUserChoices = {
   audioEnabled: boolean;
   videoDeviceId: string;
   audioDeviceId: string;
+  e2ee: boolean;
+  sharedPassphrase: string;
 };
 ```

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

	@@ -1 +1 @@
1	- {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"~~carouselview~~.md","title":"~~CarouselView~~"},{"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":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"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":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"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":"usedatachannel_1.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":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"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":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"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":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
1	+ {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"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":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"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":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"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":"usedatachannel_1.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":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useismuted_1.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"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":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"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":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrack.md","title":"useTrack"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackmutedindicator_1.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}

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

@@ -14,10 +14,11 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
 ## Properties
-| Property                                                                              | Type                                                                                 | Description  |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------ |
-| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_ |
-| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_ |
-| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
-| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_ |
+| Property                                                                              | Type                                                                                 | Description                                  |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- |
+| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_                                 |
+| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                 |
+| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_                                 |
+| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_                                 |
+| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_                                 |
+| [trackRef?](./react/participanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                 | _(Optional)_ The track reference to display. |

package/generated-docs/react/participanttileprops.participant.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## ParticipantTileProps.participant property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 participant?: Participant;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.publication.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## ParticipantTileProps.publication property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 publication?: TrackPublication;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.source.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## ParticipantTileProps.source property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 source?: Track.Source;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.trackref.md ADDED Viewed

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## ParticipantTileProps.trackRef property
+The track reference to display.
+**Signature:**
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -14,14 +14,15 @@ 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](./react/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](./react/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](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
-| [userLabel?](./react/prejoinprops.userlabel.md)   | string                                                                          | _(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](./react/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](./react/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](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
+| [showE2EEOptions?](./react/prejoinprops.showe2eeoptions.md) | boolean                                                                         | _(Optional)_                                                                                                                               |
+| [userLabel?](./react/prejoinprops.userlabel.md)             | string                                                                          | _(Optional)_                                                                                                                               |

package/generated-docs/react/prejoinprops.showe2eeoptions.md ADDED Viewed

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## PreJoinProps.showE2EEOptions property
+**Signature:**
+```typescript
+showE2EEOptions?: boolean;
+```

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

@@ -2,6 +2,10 @@
 ## TrackContext variable
+> Warning: This API is now obsolete.
+>
+> `TrackContext` has been to `TrackRefContext`<!-- -->, use this as a drop in replacement.
 **Signature:**
 ```typescript

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

@@ -14,8 +14,9 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
 ## Properties
-| Property                                                        | Type                             | Description  |
-| --------------------------------------------------------------- | -------------------------------- | ------------ |
-| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                      | _(Optional)_ |
-| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
-| [source](./react/trackmutedindicatorprops.source.md)            | Track.Source                     |              |
+| Property                                                        | Type                                                                 | Description  |
+| --------------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
+| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                                                          | _(Optional)_ |
+| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted'                                     | _(Optional)_ |
+| [source?](./react/trackmutedindicatorprops.source.md)           | Track.Source                                                         | _(Optional)_ |
+| [trackRef?](./react/trackmutedindicatorprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |

package/generated-docs/react/trackmutedindicatorprops.participant.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## TrackMutedIndicatorProps.participant property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 participant?: Participant;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.source.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## TrackMutedIndicatorProps.source property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
-source: Track.Source;
+source?: Track.Source;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.trackref.md ADDED Viewed

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## TrackMutedIndicatorProps.trackRef property
+**Signature:**
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## TrackRefContext variable
+This context provides a `TrackReferenceOrPlaceholder` to all child components.
+**Signature:**
+```typescript
+TrackRefContext: React.Context<TrackReferenceOrPlaceholder | undefined>;
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -12,8 +12,9 @@ export interface UseFocusToggleProps
 ## Properties
-| Property                                                   | Type                                                | Description  |
-| ---------------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                         | _(Optional)_ |
-| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
-| [trackSource](./react/usefocustoggleprops.tracksource.md)  | Track.Source                                        |              |
+| Property                                                   | Type                                                                 | Description  |
+| ---------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
+| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                                          | _(Optional)_ |
+| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;                  |              |
+| [trackRef?](./react/usefocustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
+| [trackSource?](./react/usefocustoggleprops.tracksource.md) | Track.Source                                                         | _(Optional)_ |

package/generated-docs/react/usefocustoggleprops.participant.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseFocusToggleProps.participant property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 participant?: Participant;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usefocustoggleprops.trackref.md ADDED Viewed

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## UseFocusToggleProps.trackRef property
+**Signature:**
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```

package/generated-docs/react/usefocustoggleprops.tracksource.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseFocusToggleProps.trackSource property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
-trackSource: Track.Source;
+trackSource?: Track.Source;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -2,13 +2,21 @@
 ## UseParticipantInfoOptions interface
+The `useParticipantInfo` hook returns the identity, name, and metadata of a given participant. It requires a `Participant` object passed as property or via the `ParticipantContext`<!-- -->.
 **Signature:**
 ```typescript
 export interface UseParticipantInfoOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+```tsx
+const { identity, name, metadata } = useParticipantInfo({ participant });
+```
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

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

@@ -2,13 +2,21 @@
 ## UseParticipantPermissionsOptions interface
+The `useParticipantPermissions` hook returns the permissions of a given participant.
 **Signature:**
 ```typescript
 export interface UseParticipantPermissionsOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+```tsx
+const permissions = useParticipantPermissions({ participant });
+```
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

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

@@ -14,11 +14,12 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
 ## Properties
-| Property                                                                                 | Type                                                                                 | Description  |
-| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------ |
-| [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_ |
-| [htmlProps](./react/useparticipanttileprops.htmlprops.md)                                | React.HTMLAttributes&lt;T&gt;                                                        |              |
-| [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant](./react/useparticipanttileprops.participant.md)                            | Participant                                                                          |              |
-| [publication?](./react/useparticipanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
-| [source](./react/useparticipanttileprops.source.md)                                      | Track.Source                                                                         |              |
+| Property                                                                                 | Type                                                                                 | Description                                  |
+| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- |
+| [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_                                 |
+| [htmlProps](./react/useparticipanttileprops.htmlprops.md)                                | React.HTMLAttributes&lt;T&gt;                                                        |                                              |
+| [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                 |
+| [participant?](./react/useparticipanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_                                 |
+| [publication?](./react/useparticipanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_                                 |
+| [source?](./react/useparticipanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_                                 |
+| [trackRef?](./react/useparticipanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                 | _(Optional)_ The track reference to display. |

package/generated-docs/react/useparticipanttileprops.participant.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseParticipantTileProps.participant property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
-participant: Participant;
+participant?: Participant;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.publication.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseParticipantTileProps.publication property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 publication?: TrackPublication;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.source.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseParticipantTileProps.source property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
-source: Track.Source;
+source?: Track.Source;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.trackref.md ADDED Viewed

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## UseParticipantTileProps.trackRef property
+The track reference to display.
+**Signature:**
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -12,6 +12,6 @@ export interface UseRemoteParticipantOptions
 ## Properties
-| Property                                                             | Type                 | Description  |
-| -------------------------------------------------------------------- | -------------------- | ------------ |
-| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ |
+| Property                                                             | Type                 | Description                                                                                                                                                                                                                                                      |
+| -------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what <code>ParticipantEvents</code> the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date. |

package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md CHANGED Viewed

@@ -2,8 +2,12 @@
 ## UseRemoteParticipantOptions.updateOnlyOn property
+To optimize performance, you can use the `updateOnlyOn` property to decide on what `ParticipantEvents` the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date.
 **Signature:**
 ```typescript
 updateOnlyOn?: ParticipantEvent[];
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -2,13 +2,25 @@
 ## UseRoomInfoOptions interface
+The `useRoomInfo` hook returns the name and metadata of the given `Room`<!-- -->.
 **Signature:**
 ```typescript
 export interface UseRoomInfoOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Remarks
+Needs to be called inside a `RoomContext` or by passing a `Room` instance.
+## Usage
+```tsx
+const { name, metadata } = useRoomInfo();
+```
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/usetrackmutedindicatoroptions.participant.md CHANGED Viewed

@@ -2,8 +2,14 @@
 ## UseTrackMutedIndicatorOptions.participant property
+> Warning: This API is now obsolete.
+>
+> This parameter will be removed in a future version use `trackRef` instead.
 **Signature:**
 ```typescript
 participant?: Participant;
 ```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usetrackoptions.element.md ADDED Viewed

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## UseTrackOptions.element property
+**Signature:**
+```typescript
+element?: React.RefObject<HTMLMediaElement>;
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## UseTrackOptions interface
+**Signature:**
+```typescript
+export interface UseTrackOptions
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Properties
+| Property                                       | Type                                                             | Description  |
+| ---------------------------------------------- | ---------------------------------------------------------------- | ------------ |
+| [element?](./react/usetrackoptions.element.md) | React.RefObject&lt;HTMLMediaElement&gt;                          | _(Optional)_ |
+| [props?](./react/usetrackoptions.props.md)     | React.HTMLAttributes&lt;HTMLVideoElement \| HTMLAudioElement&gt; | _(Optional)_ |

package/generated-docs/react/usetrackoptions.props.md ADDED Viewed

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+## UseTrackOptions.props property
+**Signature:**
+```typescript
+props?: React.HTMLAttributes<HTMLVideoElement | HTMLAudioElement>;
+```

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

@@ -16,6 +16,6 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
 | Property                                                                      | Type                                            | Description  |
 | ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./react/messagedecoder.md)     | _(Optional)_ |
-| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./react/messageencoder.md)     | _(Optional)_ |
+| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./core/messagedecoder.md)      | _(Optional)_ |
+| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./core/messageencoder.md)      | _(Optional)_ |
 | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

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

@@ -14,12 +14,13 @@ export interface VideoTrackProps extends React.HTMLAttributes<HTMLVideoElement>
 ## Properties
-| Property                                                                               | Type                                                                               | Description  |
-| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------ |
-| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                                                            | _(Optional)_ |
-| [name?](./react/videotrackprops.name.md)                                               | string                                                                             | _(Optional)_ |
-| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void                                                   | _(Optional)_ |
-| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant?](./react/videotrackprops.participant.md)                                 | Participant                                                                        | _(Optional)_ |
-| [publication?](./react/videotrackprops.publication.md)                                 | TrackPublication                                                                   | _(Optional)_ |
-| [source](./react/videotrackprops.source.md)                                            | Track.Source                                                                       |              |
+| Property                                                                               | Type                                                                               | Description                                              |
+| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------- |
+| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                                                            | _(Optional)_                                             |
+| [name?](./react/videotrackprops.name.md)                                               | string                                                                             | _(Optional)_                                             |
+| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void                                                   | _(Optional)_                                             |
+| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                             |
+| [participant?](./react/videotrackprops.participant.md)                                 | Participant                                                                        | _(Optional)_                                             |
+| [publication?](./react/videotrackprops.publication.md)                                 | TrackPublication                                                                   | _(Optional)_                                             |
+| [source?](./react/videotrackprops.source.md)                                           | Track.Source                                                                       | _(Optional)_                                             |
+| [trackRef?](./react/videotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md)                                         | _(Optional)_ The track reference of the track to render. |