@livekit/components-js-docs 0.1.0 → 0.1.2

package/generated-docs/core/setupmediatrack.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupMediaTrack",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaTrack.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupMediaTrack
@@ -7,6 +14,6 @@
 ```typescript
 export declare function setupMediaTrack(trackIdentifier: TrackIdentifier): {
   className: string;
-  trackObserver: import('rxjs').Observable<import('livekit-client').TrackPublication | undefined>;
+  trackObserver: import("rxjs").Observable<import("livekit-client").TrackPublication | undefined>;
 };
 ```

package/generated-docs/core/setupparticipantname.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupParticipantName",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantName.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupParticipantName
@@ -7,7 +14,7 @@
 ```typescript
 export declare function setupParticipantName(participant: Participant): {
   className: string;
-  infoObserver: import('rxjs').Observable<
+  infoObserver: import("rxjs").Observable<
     | {
         name: string | undefined;
         identity: string;

package/generated-docs/core/setupparticipanttile.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupParticipantTile",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantTile.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupParticipantTile

package/generated-docs/core/setupstartaudio.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupStartAudio",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/startAudio.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupStartAudio

package/generated-docs/core/setuptrackmutedindicator.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupTrackMutedIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/trackMutedIndicator.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupTrackMutedIndicator
@@ -7,6 +14,6 @@
 ```typescript
 export declare function setupTrackMutedIndicator(trackRef: TrackReferenceOrPlaceholder): {
   className: string;
-  mediaMutedObserver: import('rxjs').Observable<boolean>;
+  mediaMutedObserver: import("rxjs").Observable<boolean>;
 };
 ```

package/generated-docs/core/sortparticipants.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "sortParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/sort-participants.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # sortParticipants

package/generated-docs/core/sorttrackreferences.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "sortTrackReferences",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/sort-track-bundles.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # sortTrackReferences
@@ -8,7 +15,7 @@ Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants
 
 ```typescript
 export declare function sortTrackReferences(
-  tracks: TrackReferenceOrPlaceholder[],
+  tracks: TrackReferenceOrPlaceholder[]
 ): TrackReferenceOrPlaceholder[];
 ```
 

package/generated-docs/core/sourcesarray.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "SourcesArray type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## SourcesArray type
+# SourcesArray type
 
 **Signature:**
 

package/generated-docs/core/supportsscreensharing.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "supportsScreenSharing",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/featureDetection.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # supportsScreenSharing

package/generated-docs/core/togglesource.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ToggleSource type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaToggle.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ToggleSource type
+# ToggleSource type
 
 **Signature:**
 

package/generated-docs/core/tokenize.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "tokenize",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/tokenizer.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # tokenize
@@ -7,7 +14,7 @@
 ```typescript
 export declare function tokenize<T extends TokenizeGrammar>(
   input: string,
-  grammar: T,
+  grammar: T
 ): (
   | string
   | {

package/generated-docs/core/tokenizegrammar.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TokenizeGrammar type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/tokenizer.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TokenizeGrammar type
+# TokenizeGrammar type
 
 **Signature:**
 

package/generated-docs/core/trackidentifier.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackIdentifier type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackIdentifier type
+# TrackIdentifier type
 
 The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. `{source: Track.Source.Camera}` or `{name: "my-track"}` - TrackReference (participant and publication)
 

package/generated-docs/core/trackobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "trackObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # trackObservable

package/generated-docs/core/trackreference.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackReference type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackReference type
+# TrackReference type
 
 **Signature:**
 

package/generated-docs/core/trackreferencefilter.md

@@ -1,11 +1,18 @@
+---
+{
+  "title": "TrackReferenceFilter type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackReferenceFilter type
+# TrackReferenceFilter type
 
 **Signature:**
 
 ```typescript
-export type TrackReferenceFilter = Parameters<TrackReferenceOrPlaceholder[]['filter']>['0'];
+export type TrackReferenceFilter = Parameters<TrackReferenceOrPlaceholder[]["filter"]>["0"];
 ```
 
 **References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

package/generated-docs/core/trackreferenceid.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackReferenceId type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.utils.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackReferenceId type
+# TrackReferenceId type
 
 **Signature:**
 

package/generated-docs/core/trackreferenceorplaceholder.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackReferenceOrPlaceholder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackReferenceOrPlaceholder type
+# TrackReferenceOrPlaceholder type
 
 **Signature:**
 

package/generated-docs/core/trackreferenceplaceholder.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackReferencePlaceholder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackReferencePlaceholder type
+# TrackReferencePlaceholder type
 
 **Signature:**
 

package/generated-docs/core/trackreferencesobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "trackReferencesObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # trackReferencesObservable
@@ -8,7 +15,7 @@
 export declare function trackReferencesObservable(
   room: Room,
   sources: Track.Source[],
-  options: TrackReferencesObservableOptions,
+  options: TrackReferencesObservableOptions
 ): Observable<{
   trackReferences: TrackReference[];
   participants: Participant[];

package/generated-docs/core/tracksource.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackSource type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackSource type
+# TrackSource type
 
 **Signature:**
 
@@ -11,6 +18,6 @@ export type TrackSource<T extends Track.Source> = RequireAtLeastOne<
     name: string;
     participant: Participant;
   },
-  'name' | 'source'
+  "name" | "source"
 >;
 ```

package/generated-docs/core/tracksourcewithoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackSourceWithOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackSourceWithOptions type
+# TrackSourceWithOptions type
 
 **Signature:**
 

package/generated-docs/core/updatepages.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "updatePages",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/tile-array-update.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # updatePages
@@ -10,7 +17,7 @@ Divide the list of elements into pages and and check if pages need updating.
 export declare function updatePages<T extends UpdatableItem>(
   currentList: T[],
   nextList: T[],
-  maxItemsOnPage: number,
+  maxItemsOnPage: number
 ): T[];
 ```
 

package/generated-docs/core/videosource.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "VideoSource type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoSource type
+# VideoSource type
 
 **Signature:**
 

package/generated-docs/core/wasclickoutside.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "wasClickOutside",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/floating-menu.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # wasClickOutside

package/generated-docs/core/widget_default_state.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "WIDGET_DEFAULT_STATE variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## WIDGET_DEFAULT_STATE variable
+# WIDGET_DEFAULT_STATE variable
 
 **Signature:**
 

package/generated-docs/core/widgetstate.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "WidgetState type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## WidgetState type
+# WidgetState type
 
 **Signature:**
 

package/generated-docs/index.md

@@ -1,6 +1,10 @@
+---
+{ "title": "API Reference" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## API Reference
+# API Reference
 
 ## Packages
 

package/generated-docs/react/allowaudioplaybackprops.label.md

@@ -1,6 +1,10 @@
+---
+{ "title": "AllowAudioPlaybackProps.label property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AllowAudioPlaybackProps.label property
+# AllowAudioPlaybackProps.label property
 
 **Signature:**
 

package/generated-docs/react/allowaudioplaybackprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "AllowAudioPlaybackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/StartAudio.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AllowAudioPlaybackProps interface
+# AllowAudioPlaybackProps interface
 
 **Signature:**
 

package/generated-docs/react/audioconferenceprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "AudioConferenceProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/AudioConference.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioConferenceProps interface
+# AudioConferenceProps interface
 
 **Signature:**
 

package/generated-docs/react/audiotrackprops.md

@@ -1,25 +1,33 @@
+---
+{
+  "title": "AudioTrackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioTrack.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps interface
+# AudioTrackProps interface
 
 **Signature:**
 
 ```typescript
-export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement> extends React.HTMLAttributes<T>
+export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElement>
 ```
 
-**Extends:** React.HTMLAttributes&lt;T&gt;
+**Extends:** React.AudioHTMLAttributes&lt;HTMLAudioElement&gt;
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                                                               | Type                                       | Description                                                                           |
-| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- |
-| [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)_ by the default the range is between 0 and 1                              |
+| 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>. |

package/generated-docs/react/audiotrackprops.muted.md

@@ -0,0 +1,21 @@
+---
+{ "title": "AudioTrackProps.muted property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioTrackProps.muted property
+
+Mutes the audio track if set to `true`<!-- -->.
+
+**Signature:**
+
+```typescript
+muted?: boolean;
+```
+
+## Remarks
+
+If set to `true`<!-- -->, the server will stop sending audio track data to the client.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiotrackprops.name.md

@@ -1,10 +1,18 @@
+---
+{ "title": "AudioTrackProps.name property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps.name property
+# AudioTrackProps.name property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This property will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/audiotrackprops.onsubscriptionstatuschanged.md

@@ -1,6 +1,10 @@
+---
+{ "title": "AudioTrackProps.onSubscriptionStatusChanged property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps.onSubscriptionStatusChanged property
+# AudioTrackProps.onSubscriptionStatusChanged property
 
 **Signature:**
 

package/generated-docs/react/audiotrackprops.participant.md

@@ -1,10 +1,18 @@
+---
+{ "title": "AudioTrackProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps.participant property
+# AudioTrackProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This property will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**