@livekit/components-js-docs 0.0.2

package/generated-docs/core/pin_default_state.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PIN_DEFAULT_STATE variable
+
+**Signature:**
+
+```typescript
+PIN_DEFAULT_STATE: PinState;
+```

package/generated-docs/core/pinstate.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PinState type
+
+**Signature:**
+
+```typescript
+export type PinState = TrackReferenceOrPlaceholder[];
+```
+
+**References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

package/generated-docs/core/receivedchatmessage.from.md

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

package/generated-docs/core/receivedchatmessage.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ReceivedChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface ReceivedChatMessage extends ChatMessage
+```
+
+**Extends:** [ChatMessage](./core/chatmessage.md)
+
+## Properties
+
+| Property                                    | Type        | Description  |
+| ------------------------------------------- | ----------- | ------------ |
+| [from?](./core/receivedchatmessage.from.md) | Participant | _(Optional)_ |

package/generated-docs/core/receiveddatamessage.from.md

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

package/generated-docs/core/receiveddatamessage.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ReceivedDataMessage interface
+
+**Signature:**
+
+```typescript
+export interface ReceivedDataMessage<T extends string | undefined = string> extends BaseDataMessage<T>
+```
+
+**Extends:** [BaseDataMessage](./core/basedatamessage.md)<!-- -->&lt;T&gt;
+
+## Properties
+
+| Property                                    | Type        | Description  |
+| ------------------------------------------- | ----------- | ------------ |
+| [from?](./core/receiveddatamessage.from.md) | Participant | _(Optional)_ |

package/generated-docs/core/requireonlyone.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## RequireOnlyOne type
+
+**Signature:**
+
+```typescript
+export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
+  }[Keys];
+```

package/generated-docs/core/roomaudioplaybackallowedobservable.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomAudioPlaybackAllowedObservable (undefined)
+
+**Signature:**
+
+```typescript
+export declare function roomAudioPlaybackAllowedObservable(room: Room): Observable<{
+  canPlayAudio: boolean;
+}>;
+```

package/generated-docs/core/roomeventselector.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomEventSelector (undefined)
+
+**Signature:**
+
+```typescript
+export declare function roomEventSelector<T extends RoomEvent>(
+  room: Room,
+  event: T,
+): Observable<Parameters<RoomEventCallbacks[T]>>;
+```

package/generated-docs/core/roominfoobserver.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomInfoObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function roomInfoObserver(room: Room): Observable<{
+  name: string;
+  metadata: string | undefined;
+}>;
+```

package/generated-docs/core/roomobserver.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function roomObserver(room: Room): Observable<Room>;
+```

package/generated-docs/core/screenshareobserver.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# screenShareObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function screenShareObserver(room: Room): Observable<ScreenShareTrackMap>;
+```

package/generated-docs/core/screensharetrackmap.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ScreenShareTrackMap type
+
+**Signature:**
+
+```typescript
+export type ScreenShareTrackMap = Array<{
+  participant: Participant;
+  tracks: Array<TrackPublication>;
+}>;
+```

package/generated-docs/core/selectgridlayout.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# selectGridLayout (undefined)
+
+**Signature:**
+
+```typescript
+export declare function selectGridLayout(
+  layouts: GridLayoutDefinition[],
+  participantCount: number,
+  width: number,
+  height: number,
+): GridLayoutDefinition;
+```

package/generated-docs/core/sendmessage.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sendMessage (undefined)
+
+Publish data from the LocalParticipant.
+
+**Signature:**
+
+```typescript
+export declare function sendMessage(
+  localParticipant: LocalParticipant,
+  payload: Uint8Array,
+  topic?: string,
+  options?: DataSendOptions,
+): Promise<void>;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/setdifference.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setDifference (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setDifference<T>(setA: Set<T>, setB: Set<T>): Set<T>;
+```

package/generated-docs/core/setloglevel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setLogLevel (undefined)
+
+Set the log level for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
+
+**Signature:**
+
+```typescript
+export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/setmediadeviceoptions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## SetMediaDeviceOptions type
+
+**Signature:**
+
+```typescript
+export type SetMediaDeviceOptions = {
+  exact?: boolean;
+};
+```

package/generated-docs/core/setupchat.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChat (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupChat(room: Room): {
+  messageObservable: import('rxjs').Observable<ReceivedChatMessage[]>;
+  isSendingObservable: BehaviorSubject<boolean>;
+  send: (message: string) => Promise<void>;
+  destroy: () => void;
+};
+```

package/generated-docs/core/setupchattoggle.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChatToggle (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupChatToggle(): {
+  className: string;
+};
+```

package/generated-docs/core/setupclearpinbutton.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupClearPinButton (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupClearPinButton(): {
+  className: string;
+};
+```

package/generated-docs/core/setupconnectionqualityindicator.md

@@ -0,0 +1,70 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupConnectionQualityIndicator (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupConnectionQualityIndicator(participant: Participant): {
+  className:
+    | 'lk-rotate'
+    | 'lk-audio-conference'
+    | 'lk-audio-conference-stage'
+    | 'lk-audio-container'
+    | 'lk-button'
+    | 'lk-button-group'
+    | 'lk-button-group-container'
+    | 'lk-camera-off-note'
+    | 'lk-chat'
+    | 'lk-chat-entry'
+    | 'lk-chat-form'
+    | 'lk-chat-form-input'
+    | 'lk-chat-messages'
+    | 'lk-control-bar'
+    | 'lk-focus-layout-wrapper'
+    | 'lk-form-control'
+    | 'lk-grid-layout-wrapper'
+    | 'lk-join-button'
+    | 'lk-list'
+    | 'lk-message-body'
+    | 'lk-meta-data'
+    | 'lk-participant-name'
+    | 'lk-prejoin'
+    | 'lk-timestamp'
+    | 'lk-username-container'
+    | 'lk-video-conference'
+    | 'lk-video-conference-inner'
+    | 'lk-video-container'
+    | 'lk-audio-visualizer'
+    | 'lk-button-group-menu'
+    | 'lk-button-menu'
+    | 'lk-carousel'
+    | 'lk-chat-toggle'
+    | 'lk-connection-quality'
+    | 'lk-device-menu'
+    | 'lk-device-menu-heading'
+    | 'lk-disconnect-button'
+    | 'lk-focus-layout'
+    | 'lk-focus-toggle-button'
+    | 'lk-focused-participant'
+    | 'lk-grid-layout'
+    | 'lk-media-device-select'
+    | 'lk-pagination-control'
+    | 'lk-pagination-count'
+    | 'lk-pagination-indicator'
+    | 'lk-participant-media-audio'
+    | 'lk-participant-media-video'
+    | 'lk-participant-metadata'
+    | 'lk-participant-metadata-item'
+    | 'lk-participant-placeholder'
+    | 'lk-participant-tile'
+    | 'lk-pip-track'
+    | 'lk-room-container'
+    | 'lk-spinner'
+    | 'lk-start-audio-button'
+    | 'lk-toast'
+    | 'lk-track-muted-indicator-camera'
+    | 'lk-track-muted-indicator-microphone';
+  connectionQualityObserver: import('rxjs').Observable<import('livekit-client').ConnectionQuality>;
+};
+```

package/generated-docs/core/setupdatamessagehandler.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDataMessageHandler (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupDataMessageHandler<T extends string>(
+  room: Room,
+  topic?: T,
+  onMessage?: (msg: ReceivedDataMessage<T>) => void,
+): {
+  messageObservable: Observable<{
+    payload: Uint8Array;
+    topic: T;
+    from: import('livekit-client').RemoteParticipant | undefined;
+  }>;
+  isSendingObservable: Observable<boolean>;
+  send: (payload: Uint8Array, options?: DataSendOptions) => Promise<void>;
+};
+```

package/generated-docs/core/setupdeviceselector.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDeviceSelector (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupDeviceSelector(
+  kind: MediaDeviceKind,
+  room?: Room,
+  localTrack?: LocalAudioTrack | LocalVideoTrack,
+): {
+  className: string;
+  activeDeviceObservable: import('rxjs').Observable<string | undefined>;
+  setActiveMediaDevice: (id: string, options?: SetMediaDeviceOptions) => Promise<void>;
+};
+```

package/generated-docs/core/setupdisconnectbutton.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDisconnectButton (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupDisconnectButton(room: Room): {
+  className: string;
+  disconnect: (stopTracks?: boolean) => void;
+};
+```

package/generated-docs/core/setupfocustoggle.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupFocusToggle (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupFocusToggle(): {
+  className: string;
+};
+```

package/generated-docs/core/setuplivekitroom.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupLiveKitRoom (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupLiveKitRoom(): {
+  className: string;
+};
+```

package/generated-docs/core/setupmanualtoggle.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupManualToggle (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupManualToggle(): {
+  className: string;
+  toggle: (forceState?: boolean) => void;
+  enabledObserver: Observable<boolean>;
+  pendingObserver: Observable<boolean>;
+};
+```

package/generated-docs/core/setupmediatoggle.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupMediaToggle (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupMediaToggle<T extends ToggleSource>(
+  source: T,
+  room: Room,
+  options?: CaptureOptionsBySource<T>,
+): MediaToggleType<T>;
+```

package/generated-docs/core/setupmediatrack.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupMediaTrack (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupMediaTrack(trackIdentifier: TrackIdentifier): {
+  className: string;
+  trackObserver: import('rxjs').Observable<import('livekit-client').TrackPublication | undefined>;
+};
+```

package/generated-docs/core/setupparticipantname.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupParticipantName (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupParticipantName(participant: Participant): {
+  className: string;
+  infoObserver: import('rxjs').Observable<
+    | {
+        name: string | undefined;
+        identity: string;
+        metadata: string | undefined;
+      }
+    | {
+        name: string | undefined;
+        identity: string;
+        metadata: string | undefined;
+      }
+  >;
+};
+```

package/generated-docs/core/setupparticipanttile.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupParticipantTile (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupParticipantTile(): {
+  className: string;
+};
+```

package/generated-docs/core/setupstartaudio.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupStartAudio (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupStartAudio(): {
+  className: string;
+  roomAudioPlaybackAllowedObservable: typeof roomAudioPlaybackAllowedObservable;
+  handleStartAudioPlayback: (room: Room) => Promise<void>;
+};
+```

package/generated-docs/core/setuptrackmutedindicator.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupTrackMutedIndicator (undefined)
+
+**Signature:**
+
+```typescript
+export declare function setupTrackMutedIndicator(
+  participant: Participant,
+  source: Track.Source,
+): {
+  className: string;
+  mediaMutedObserver: import('rxjs').Observable<boolean>;
+};
+```

package/generated-docs/core/sortparticipants.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sortParticipants (undefined)
+
+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
+
+**Signature:**
+
+```typescript
+export declare function sortParticipants(participants: Participant[]): Participant[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/sorttrackreferences.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sortTrackReferences (undefined)
+
+Default sort for `TrackReferenceOrPlaceholder`<!-- -->, 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
+
+**Signature:**
+
+```typescript
+export declare function sortTrackReferences(
+  tracks: TrackReferenceOrPlaceholder[],
+): TrackReferenceOrPlaceholder[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/sourcesarray.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## SourcesArray type
+
+**Signature:**
+
+```typescript
+export type SourcesArray = Track.Source[] | TrackSourceWithOptions[];
+```
+
+**References:** [TrackSourceWithOptions](./core/tracksourcewithoptions.md)

package/generated-docs/core/supportsscreensharing.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# supportsScreenSharing (undefined)
+
+Returns `true` if the browser supports screen sharing.
+
+**Signature:**
+
+```typescript
+export declare function supportsScreenSharing(): boolean;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/togglesource.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ToggleSource type
+
+**Signature:**
+
+```typescript
+export type ToggleSource = Exclude<
+  Track.Source,
+  Track.Source.ScreenShareAudio | Track.Source.Unknown
+>;
+```

package/generated-docs/core/tokenize.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# tokenize (undefined)
+
+**Signature:**
+
+```typescript
+export declare function tokenize<T extends TokenizeGrammar>(
+  input: string,
+  grammar: T,
+): (
+  | string
+  | {
+      type: keyof T;
+      content: string;
+    }
+)[];
+```

package/generated-docs/core/tokenizegrammar.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TokenizeGrammar type
+
+**Signature:**
+
+```typescript
+export type TokenizeGrammar = {
+  [type: string]: RegExp;
+};
+```