@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/core/log.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "log",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# log
+
+**Signature:**
+
+```typescript
+log: loglevel.Logger;
+```

package/generated-docs/core/mediatoggletype.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "MediaToggleType 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. -->
+
+# MediaToggleType type
+
+**Signature:**
+
+```typescript
+export type MediaToggleType<T extends ToggleSource> = {
+  pendingObserver: Observable<boolean>;
+  toggle: (
+    forceState?: boolean,
+    captureOptions?: CaptureOptionsBySource<T>
+  ) => Promise<boolean | undefined>;
+  className: string;
+  enabledObserver: Observable<boolean>;
+};
+```
+
+**References:** [ToggleSource](./core/togglesource.md)<!-- -->, [CaptureOptionsBySource](./core/captureoptionsbysource.md)

package/generated-docs/core/messagedecoder.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "MessageDecoder 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. -->
+
+# MessageDecoder type
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type MessageDecoder = (message: Uint8Array) => LegacyReceivedChatMessage;
+```
+
+**References:** [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)

package/generated-docs/core/messageencoder.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "MessageEncoder 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. -->
+
+# MessageEncoder type
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type MessageEncoder = (message: LegacyChatMessage) => Uint8Array;
+```
+
+**References:** [LegacyChatMessage](./core/legacychatmessage.md)

package/generated-docs/core/mutedobserver.md

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

package/generated-docs/core/observeparticipantevents.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "observeParticipantEvents",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# observeParticipantEvents
+
+**Signature:**
+
+```typescript
+export declare function observeParticipantEvents<T extends Participant>(
+  participant: T,
+  ...events: ParticipantEvent[]
+): Observable<T>;
+```

package/generated-docs/core/observeparticipantmedia.md

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

package/generated-docs/core/observeroomevents.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "observeRoomEvents",
+  "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. -->
+
+# observeRoomEvents
+
+**Signature:**
+
+```typescript
+export declare function observeRoomEvents(room: Room, ...events: RoomEvent[]): Observable<Room>;
+```

package/generated-docs/core/observetrackevents.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "observeTrackEvents",
+  "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. -->
+
+# observeTrackEvents
+
+**Signature:**
+
+```typescript
+export declare function observeTrackEvents(
+  track: TrackPublication,
+  ...events: TrackEvent[]
+): Observable<TrackPublication>;
+```

package/generated-docs/core/participantattributesobserver.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "participantAttributesObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# participantAttributesObserver
+
+**Signature:**
+
+```typescript
+export declare function participantAttributesObserver(participant: Participant): Observable<{
+  changed: Readonly<Record<string, string>>;
+  attributes: Readonly<Record<string, string>>;
+}>;
+```

package/generated-docs/core/participantbyidentifierobserver.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "participantByIdentifierObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# participantByIdentifierObserver
+
+**Signature:**
+
+```typescript
+export declare function participantByIdentifierObserver(
+  room: Room,
+  { kind, identity }: ParticipantIdentifier,
+  options?: ConnectedParticipantObserverOptions
+): Observable<RemoteParticipant | undefined>;
+```

package/generated-docs/core/participanteventselector.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "participantEventSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# participantEventSelector
+
+**Signature:**
+
+```typescript
+export declare function participantEventSelector<T extends ParticipantEvent>(
+  participant: Participant,
+  event: T
+): Observable<Parameters<ParticipantEventCallbacks[Extract<T, keyof ParticipantEventCallbacks>]>>;
+```

package/generated-docs/core/participantfilter.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "ParticipantFilter 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. -->
+
+# ParticipantFilter type
+
+**Signature:**
+
+```typescript
+export type ParticipantFilter = Parameters<Participant[]["filter"]>["0"];
+```

package/generated-docs/core/participantidentifier.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "ParticipantIdentifier 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. -->
+
+# ParticipantIdentifier type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type ParticipantIdentifier = RequireAtLeastOne<
+  {
+    kind: ParticipantKind;
+    identity: string;
+  },
+  "identity" | "kind"
+>;
+```

package/generated-docs/core/participantinfoobserver.md

@@ -0,0 +1,29 @@
+---
+{
+  "title": "participantInfoObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# participantInfoObserver
+
+**Signature:**
+
+```typescript
+export declare function participantInfoObserver(participant?: Participant):
+  | Observable<
+      | {
+          name: string | undefined;
+          identity: string;
+          metadata: string | undefined;
+        }
+      | {
+          name: string | undefined;
+          identity: string;
+          metadata: string | undefined;
+        }
+    >
+  | undefined;
+```

package/generated-docs/core/participantmedia.cameratrack.md

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

package/generated-docs/core/participantmedia.iscameraenabled.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantMedia.isCameraEnabled property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantMedia.isCameraEnabled property
+
+**Signature:**
+
+```typescript
+isCameraEnabled: boolean;
+```

package/generated-docs/core/participantmedia.ismicrophoneenabled.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantMedia.isMicrophoneEnabled property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantMedia.isMicrophoneEnabled property
+
+**Signature:**
+
+```typescript
+isMicrophoneEnabled: boolean;
+```

package/generated-docs/core/participantmedia.isscreenshareenabled.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantMedia.isScreenShareEnabled property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantMedia.isScreenShareEnabled property
+
+**Signature:**
+
+```typescript
+isScreenShareEnabled: boolean;
+```

package/generated-docs/core/participantmedia.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "ParticipantMedia interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantMedia interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantMedia<T extends Participant = Participant>
+```
+
+## Properties
+
+| Property                                                                | Type             | Description  |
+| ----------------------------------------------------------------------- | ---------------- | ------------ |
+| [cameraTrack?](./core/participantmedia.cameratrack.md)                  | TrackPublication | _(Optional)_ |
+| [isCameraEnabled](./core/participantmedia.iscameraenabled.md)           | boolean          |              |
+| [isMicrophoneEnabled](./core/participantmedia.ismicrophoneenabled.md)   | boolean          |              |
+| [isScreenShareEnabled](./core/participantmedia.isscreenshareenabled.md) | boolean          |              |
+| [microphoneTrack?](./core/participantmedia.microphonetrack.md)          | TrackPublication | _(Optional)_ |
+| [participant](./core/participantmedia.participant.md)                   | T                |              |

package/generated-docs/core/participantmedia.microphonetrack.md

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

package/generated-docs/core/participantmedia.participant.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantMedia.participant property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantMedia.participant property
+
+**Signature:**
+
+```typescript
+participant: T;
+```

package/generated-docs/core/participantpermissionobserver.md

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

package/generated-docs/core/participanttrackevents.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "participantTrackEvents",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# participantTrackEvents
+
+**Signature:**
+
+```typescript
+participantTrackEvents: ParticipantEvent[]
+```

package/generated-docs/core/participanttrackidentifier.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "ParticipantTrackIdentifier 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. -->
+
+# ParticipantTrackIdentifier type
+
+**Signature:**
+
+```typescript
+export type ParticipantTrackIdentifier = RequireAtLeastOne<
+  {
+    sources: Track.Source[];
+    name: string;
+    kind: Track.Kind;
+  },
+  "sources" | "name" | "kind"
+>;
+```

package/generated-docs/core/participanttracksobservable.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "participantTracksObservable",
+  "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. -->
+
+# participantTracksObservable
+
+**Signature:**
+
+```typescript
+export declare function participantTracksObservable(
+  participant: Participant,
+  trackIdentifier: ParticipantTrackIdentifier
+): Observable<TrackReference[]>;
+```

package/generated-docs/core/pin_default_state.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "PIN_DEFAULT_STATE",
+  "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. -->
+
+# PIN_DEFAULT_STATE
+
+**Signature:**
+
+```typescript
+PIN_DEFAULT_STATE: PinState;
+```

package/generated-docs/core/pinstate.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "PinState 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. -->
+
+# PinState type
+
+**Signature:**
+
+```typescript
+export type PinState = TrackReferenceOrPlaceholder[];
+```
+
+**References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

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

@@ -0,0 +1,13 @@
+---
+{ "title": "ReceivedChatMessage.from property" }
+---
+
+<!-- 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,24 @@
+---
+{
+  "title": "ReceivedChatMessage interface",
+  "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. -->
+
+# ReceivedChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface ReceivedChatMessage extends ChatMessage
+```
+
+**Extends:** ChatMessage
+
+## Properties
+
+| Property                                    | Type        | Description  |
+| ------------------------------------------- | ----------- | ------------ |
+| [from?](./core/receivedchatmessage.from.md) | Participant | _(Optional)_ |

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

@@ -0,0 +1,13 @@
+---
+{ "title": "ReceivedDataMessage.from property" }
+---
+
+<!-- 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,24 @@
+---
+{
+  "title": "ReceivedDataMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+
+<!-- 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/receivedtranscriptionsegment.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "ReceivedTranscriptionSegment type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/transcriptions.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ReceivedTranscriptionSegment type
+
+**Signature:**
+
+```typescript
+export type ReceivedTranscriptionSegment = TranscriptionSegment & {
+  receivedAtMediaTimestamp: number;
+  receivedAt: number;
+};
+```