@werxt/livekit-components-react 2.9.20

package/dist/hooks/useRemoteParticipants.d.ts

@@ -0,0 +1,30 @@
+import { RoomEvent, RemoteParticipant, Room } from 'livekit-client';
+/** @public */
+export interface UseRemoteParticipantsOptions {
+    /**
+     * To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates.
+     * By default it updates on all relevant RoomEvents to keep the returned participants array up to date.
+     * The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
+     */
+    updateOnlyOn?: RoomEvent[];
+    /**
+     * The room to use. If not provided, the hook will use the room from the context.
+     */
+    room?: Room;
+}
+/**
+ * The `useRemoteParticipants` hook returns all remote participants (without the local) of the current room.
+ * @remarks
+ * To optimize performance, you can use the `updateOnlyOn` property to decide on what `RoomEvents` the hook updates.
+ *
+ * @example
+ * ```tsx
+ * const participants = useRemoteParticipants();
+ * <ParticipantLoop participants={participants}>
+ *  <ParticipantName />
+ * </ParticipantLoop>
+ * ```
+ * @public
+ */
+export declare function useRemoteParticipants(options?: UseRemoteParticipantsOptions): RemoteParticipant[];
+//# sourceMappingURL=useRemoteParticipants.d.ts.map

package/dist/hooks/useRemoteParticipants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRemoteParticipants.d.ts","sourceRoot":"","sources":["../../src/hooks/useRemoteParticipants.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAIzE,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,GAAE,4BAAiC,uBAW/E"}

package/dist/hooks/useRoomInfo.d.ts

@@ -0,0 +1,21 @@
+import { Room } from 'livekit-client';
+/**
+ * The `useRoomInfo` hook returns the name and metadata of the given `Room`.
+ * @remarks
+ * Needs to be called inside a `RoomContext` or by passing a `Room` instance.
+ *
+ * @example
+ * ```tsx
+ * const { name, metadata } = useRoomInfo();
+ * ```
+ * @public
+ */
+export interface UseRoomInfoOptions {
+    room?: Room;
+}
+/** @public */
+export declare function useRoomInfo(options?: UseRoomInfoOptions): {
+    name: string;
+    metadata: string | undefined;
+};
+//# sourceMappingURL=useRoomInfo.d.ts.map

package/dist/hooks/useRoomInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRoomInfo.d.ts","sourceRoot":"","sources":["../../src/hooks/useRoomInfo.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAK3C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,cAAc;AACd,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB;;;EAS3D"}

package/dist/hooks/useSequentialRoomConnectDisconnect.d.ts

@@ -0,0 +1,27 @@
+import { Room } from 'livekit-client';
+/** @public */
+export type UseSequentialRoomConnectDisconnectResults<R extends Room | undefined> = {
+    connect: typeof Room.prototype.connect & (R extends undefined ? null : unknown);
+    disconnect: typeof Room.prototype.disconnect & (R extends undefined ? null : unknown);
+};
+/**
+ * When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for
+ * a room.connect(...) in the effect body to start running while the room.disconnect() is still
+ * running. This hook sequentializes these two operations, so they always happen in order and
+ * never overlap.
+ *
+ * @example
+ * ```ts
+ * const { connect, disconnect } = useSequentialRoomConnectDisconnect(room);
+ *
+ * // Connecting to a room:
+ * useEffect(() => {
+ *   connect();
+ *   return () => disconnect();
+ * }, [connect, disconnect]);
+ * ```
+ *
+ * @public
+ */
+export declare function useSequentialRoomConnectDisconnect<R extends Room | undefined>(room: R): UseSequentialRoomConnectDisconnectResults<R>;
+//# sourceMappingURL=useSequentialRoomConnectDisconnect.d.ts.map

package/dist/hooks/useSequentialRoomConnectDisconnect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSequentialRoomConnectDisconnect.d.ts","sourceRoot":"","sources":["../../src/hooks/useSequentialRoomConnectDisconnect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAUlD,cAAc;AACd,MAAM,MAAM,yCAAyC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,IAAI;IAClF,OAAO,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC;IAChF,UAAU,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC;CACvF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kCAAkC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,EAC3E,IAAI,EAAE,CAAC,GACN,yCAAyC,CAAC,CAAC,CAAC,CAqI9C"}

package/dist/hooks/useSession.d.ts

@@ -0,0 +1,130 @@
+import { default as TypedEventEmitter } from 'typed-emitter';
+import { Room, ConnectionState, TrackPublishOptions, TokenSourceConfigurable, TokenSourceFixed, TokenSourceFetchOptions, RoomConnectOptions } from 'livekit-client';
+import { AgentState } from './useAgent';
+import { TrackReference } from '@livekit/components-core';
+/** @beta */
+export declare enum SessionEvent {
+    ConnectionStateChanged = "connectionStateChanged",
+    /**
+     * Emits when an error is encountered while attempting to create a track.
+     * Use MediaDeviceFailure.getFailure(error) to get the reason of failure.
+     * args: (error: Error, kind: MediaDeviceKind)
+     */
+    MediaDevicesError = "mediaDevicesError",
+    /**
+     * Emits when an error is received while decrypting frame received frame information.
+     * args: (error: Error)
+     */
+    EncryptionError = "encryptionError"
+}
+/** @beta */
+export type SessionCallbacks = {
+    [SessionEvent.ConnectionStateChanged]: (newAgentConnectionState: ConnectionState) => void;
+    [SessionEvent.MediaDevicesError]: (error: Error) => void;
+    [SessionEvent.EncryptionError]: (error: Error) => void;
+};
+/** @beta */
+export type SessionConnectOptions = {
+    /** Optional abort signal which if triggered will terminate connecting even if it isn't complete */
+    signal?: AbortSignal;
+    tracks?: {
+        microphone?: {
+            enabled?: boolean;
+            publishOptions?: TrackPublishOptions;
+        };
+        camera?: {
+            enabled?: boolean;
+            publishOptions?: TrackPublishOptions;
+        };
+        screenShare?: {
+            enabled?: boolean;
+            publishOptions?: TrackPublishOptions;
+        };
+    };
+    /** Options for Room.connect(.., .., opts) */
+    roomConnectOptions?: RoomConnectOptions;
+};
+/** @beta */
+export type SwitchActiveDeviceOptions = {
+    /**
+     *  If true, adds an `exact` constraint to the getUserMedia request.
+     *  The request will fail if this option is true and the device specified is not actually available
+     */
+    exact?: boolean;
+};
+type SessionStateCommon = {
+    room: Room;
+    internal: {
+        emitter: TypedEventEmitter<SessionCallbacks>;
+        tokenSource: TokenSourceConfigurable | TokenSourceFixed;
+        agentConnectTimeoutMilliseconds?: number;
+        agentTimeoutFailureReason: string | null;
+        startAgentTimeout: (agentConnectTimeoutMilliseconds?: number) => void;
+        clearAgentTimeout: () => void;
+        clearAgentTimeoutFailureReason: () => void;
+        updateAgentTimeoutState: (agentState: AgentState) => void;
+        updateAgentTimeoutParticipantExists: (agentParticipantExists: boolean) => void;
+    };
+};
+type SessionStateConnecting = SessionStateCommon & {
+    connectionState: ConnectionState.Connecting;
+    isConnected: false;
+    local: {
+        cameraTrack: undefined;
+        microphoneTrack: undefined;
+        screenShareTrack: undefined;
+    };
+};
+type SessionStateConnected = SessionStateCommon & {
+    connectionState: ConnectionState.Connected | ConnectionState.Reconnecting | ConnectionState.SignalReconnecting;
+    isConnected: true;
+    local: {
+        cameraTrack?: TrackReference;
+        microphoneTrack?: TrackReference;
+        screenShareTrack?: TrackReference;
+    };
+};
+type SessionStateDisconnected = SessionStateCommon & {
+    connectionState: ConnectionState.Disconnected;
+    isConnected: false;
+    local: {
+        cameraTrack: undefined;
+        microphoneTrack: undefined;
+        screenShareTrack: undefined;
+    };
+};
+type SessionActions = {
+    /** Returns a promise that resolves once the room connects. */
+    waitUntilConnected: (signal?: AbortSignal) => void;
+    /** Returns a promise that resolves once the room disconnects */
+    waitUntilDisconnected: (signal?: AbortSignal) => void;
+    prepareConnection: () => Promise<void>;
+    /** Connect to the underlying room and dispatch any agents */
+    start: (options?: SessionConnectOptions) => Promise<void>;
+    /** Disconnect from the underlying room */
+    end: () => Promise<void>;
+};
+/** @beta */
+export type UseSessionReturn = (SessionStateConnecting | SessionStateConnected | SessionStateDisconnected) & SessionActions;
+type UseSessionCommonOptions = {
+    room?: Room;
+    /**
+     * Amount of time in milliseonds the system will wait for an agent to join the room, before
+     * transitioning to the "failure" state.
+     */
+    agentConnectTimeoutMilliseconds?: number;
+};
+type UseSessionConfigurableOptions = UseSessionCommonOptions & TokenSourceFetchOptions;
+type UseSessionFixedOptions = UseSessionCommonOptions;
+/**
+ * A Session represents a managed connection to a Room which can contain Agents.
+ * @beta
+ */
+export declare function useSession(tokenSource: TokenSourceConfigurable, options?: UseSessionConfigurableOptions): UseSessionReturn;
+/**
+ * A Session represents a managed connection to a Room which can contain Agents.
+ * @beta
+ */
+export declare function useSession(tokenSource: TokenSourceFixed, options?: UseSessionFixedOptions): UseSessionReturn;
+export {};
+//# sourceMappingURL=useSession.d.ts.map

package/dist/hooks/useSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSession.d.ts","sourceRoot":"","sources":["../../src/hooks/useSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,iBAAiB,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,IAAI,EAEJ,eAAe,EACf,mBAAmB,EAEnB,uBAAuB,EACvB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAEnB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,EAAE,UAAU,EAAoC,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG1D,YAAY;AACZ,oBAAY,YAAY;IACtB,sBAAsB,2BAA2B;IACjD;;;;OAIG;IACH,iBAAiB,sBAAsB;IACvC;;;OAGG;IACH,eAAe,oBAAoB;CACpC;AAED,YAAY;AACZ,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,YAAY,CAAC,sBAAsB,CAAC,EAAE,CAAC,uBAAuB,EAAE,eAAe,KAAK,IAAI,CAAC;IAC1F,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACzD,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACxD,CAAC;AAEF,YAAY;AACZ,MAAM,MAAM,qBAAqB,GAAG;IAClC,mGAAmG;IACnG,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE;YACX,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,cAAc,CAAC,EAAE,mBAAmB,CAAC;SACtC,CAAC;QACF,MAAM,CAAC,EAAE;YACP,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,cAAc,CAAC,EAAE,mBAAmB,CAAC;SACtC,CAAC;QACF,WAAW,CAAC,EAAE;YACZ,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,cAAc,CAAC,EAAE,mBAAmB,CAAC;SACtC,CAAC;KACH,CAAC;IAEF,6CAA6C;IAC7C,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF,YAAY;AACZ,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE;QACR,OAAO,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QAC7C,WAAW,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;QACxD,+BAA+B,CAAC,EAAE,MAAM,CAAC;QAEzC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;QACzC,iBAAiB,EAAE,CAAC,+BAA+B,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;QACtE,iBAAiB,EAAE,MAAM,IAAI,CAAC;QAC9B,8BAA8B,EAAE,MAAM,IAAI,CAAC;QAC3C,uBAAuB,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;QAC1D,mCAAmC,EAAE,CAAC,sBAAsB,EAAE,OAAO,KAAK,IAAI,CAAC;KAChF,CAAC;CACH,CAAC;AAEF,KAAK,sBAAsB,GAAG,kBAAkB,GAAG;IACjD,eAAe,EAAE,eAAe,CAAC,UAAU,CAAC;IAC5C,WAAW,EAAE,KAAK,CAAC;IAEnB,KAAK,EAAE;QACL,WAAW,EAAE,SAAS,CAAC;QACvB,eAAe,EAAE,SAAS,CAAC;QAC3B,gBAAgB,EAAE,SAAS,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,KAAK,qBAAqB,GAAG,kBAAkB,GAAG;IAChD,eAAe,EACX,eAAe,CAAC,SAAS,GACzB,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,kBAAkB,CAAC;IACvC,WAAW,EAAE,IAAI,CAAC;IAElB,KAAK,EAAE;QACL,WAAW,CAAC,EAAE,cAAc,CAAC;QAC7B,eAAe,CAAC,EAAE,cAAc,CAAC;QACjC,gBAAgB,CAAC,EAAE,cAAc,CAAC;KACnC,CAAC;CACH,CAAC;AAEF,KAAK,wBAAwB,GAAG,kBAAkB,GAAG;IACnD,eAAe,EAAE,eAAe,CAAC,YAAY,CAAC;IAC9C,WAAW,EAAE,KAAK,CAAC;IAEnB,KAAK,EAAE;QACL,WAAW,EAAE,SAAS,CAAC;QACvB,eAAe,EAAE,SAAS,CAAC;QAC3B,gBAAgB,EAAE,SAAS,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,8DAA8D;IAC9D,kBAAkB,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;IACnD,gEAAgE;IAChE,qBAAqB,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;IAEtD,iBAAiB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC,6DAA6D;IAC7D,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D,0CAA0C;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B,CAAC;AAEF,YAAY;AACZ,MAAM,MAAM,gBAAgB,GAAG,CAC3B,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,CAC3B,GACC,cAAc,CAAC;AAEjB,KAAK,uBAAuB,GAAG;IAC7B,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;;OAGG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF,KAAK,6BAA6B,GAAG,uBAAuB,GAAG,uBAAuB,CAAC;AACvF,KAAK,sBAAsB,GAAG,uBAAuB,CAAC;AAiItD;;;GAGG;AACH,wBAAgB,UAAU,CACxB,WAAW,EAAE,uBAAuB,EACpC,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB,CAAC;AACpB;;;GAGG;AACH,wBAAgB,UAAU,CACxB,WAAW,EAAE,gBAAgB,EAC7B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,gBAAgB,CAAC"}

package/dist/hooks/useSessionMessages.d.ts

@@ -0,0 +1,29 @@
+import { default as TypedEventEmitter } from 'typed-emitter';
+import { SendTextOptions } from 'livekit-client';
+import { ReceivedMessage, ReceivedChatMessage } from '@livekit/components-core';
+import { UseSessionReturn } from './useSession';
+/** @beta */
+export type UseSessionMessagesReturn = {
+    messages: Array<ReceivedMessage>;
+    /** Is a send operation currently in progress? */
+    isSending: boolean;
+    send: (message: string, options?: SendTextOptions) => Promise<ReceivedChatMessage>;
+    internal: {
+        emitter: TypedEventEmitter<MessagesCallbacks>;
+    };
+};
+/** @beta */
+export declare enum MessagesEvent {
+    /**
+     * Emits when a new message is received from a participant
+     * args: (message: ReceivedMessage)
+     */
+    MessageReceived = "messageReceived"
+}
+/** @beta */
+export type MessagesCallbacks = {
+    [MessagesEvent.MessageReceived]: (message: ReceivedMessage) => void;
+};
+/** @beta */
+export declare function useSessionMessages(session?: UseSessionReturn): UseSessionMessagesReturn;
+//# sourceMappingURL=useSessionMessages.d.ts.map

package/dist/hooks/useSessionMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSessionMessages.d.ts","sourceRoot":"","sources":["../../src/hooks/useSessionMessages.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,iBAAiB,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EACL,eAAe,EACf,mBAAmB,EAIpB,MAAM,0BAA0B,CAAC;AAKlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,YAAY;AACZ,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEjC,iDAAiD;IACjD,SAAS,EAAE,OAAO,CAAC;IAEnB,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEnF,QAAQ,EAAE;QACR,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;KAC/C,CAAC;CACH,CAAC;AAEF,YAAY;AACZ,oBAAY,aAAa;IACvB;;;OAGG;IACH,eAAe,oBAAoB;CACpC;AAED,YAAY;AACZ,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,YAAY;AACZ,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,wBAAwB,CA8GvF"}

package/dist/hooks/useSettingsToggle.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+/** @alpha */
+export interface UseSettingsToggleProps {
+    props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+/**
+ * The `useSettingsToggle` hook provides state and functions for toggling the settings menu.
+ * @remarks
+ * Depends on the `LayoutContext` to work properly.
+ * @see {@link SettingsMenu}
+ * @alpha
+ */
+export declare function useSettingsToggle({ props }: UseSettingsToggleProps): {
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        'aria-pressed': string;
+    };
+};
+//# sourceMappingURL=useSettingsToggle.d.ts.map

package/dist/hooks/useSettingsToggle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSettingsToggle.d.ts","sourceRoot":"","sources":["../../src/hooks/useSettingsToggle.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,aAAa;AACb,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,KAAK,EAAE,EAAE,sBAAsB;;;;;;EAelE"}

package/dist/hooks/useSortedParticipants.d.ts

@@ -0,0 +1,7 @@
+import { Participant } from 'livekit-client';
+/**
+ * The `useSortedParticipants` hook returns the participants sorted by importance.
+ * @public
+ */
+export declare function useSortedParticipants(participants: Array<Participant>): Participant[];
+//# sourceMappingURL=useSortedParticipants.d.ts.map

package/dist/hooks/useSortedParticipants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSortedParticipants.d.ts","sourceRoot":"","sources":["../../src/hooks/useSortedParticipants.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,iBAUrE"}

package/dist/hooks/useSpeakingParticipants.d.ts

@@ -0,0 +1,16 @@
+import { Room } from 'livekit-client';
+/** @public */
+export type UseSpeakingParticipantsOptions = {
+    room?: Room;
+};
+/**
+ * The `useSpeakingParticipants` hook returns only the active speakers of all participants.
+ *
+ * @example
+ * ```tsx
+ * const activeSpeakers = useSpeakingParticipants();
+ * ```
+ * @public
+ */
+export declare function useSpeakingParticipants(options?: UseSpeakingParticipantsOptions): import('livekit-client').Participant[];
+//# sourceMappingURL=useSpeakingParticipants.d.ts.map

package/dist/hooks/useSpeakingParticipants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSpeakingParticipants.d.ts","sourceRoot":"","sources":["../../src/hooks/useSpeakingParticipants.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,cAAc;AACd,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,8BAA8B,0CAM/E"}

package/dist/hooks/useStartAudio.d.ts

@@ -0,0 +1,27 @@
+import { Room } from 'livekit-client';
+import * as React from 'react';
+/** @alpha */
+export interface UseStartAudioProps {
+    room?: Room;
+    props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+/**
+ * In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button.
+ * The `useStatAudio` hook returns an object with a boolean `canPlayAudio` flag
+ * that indicates whether audio playback is allowed in the current context,
+ * as well as a `startAudio` function that can be called in a button `onClick` callback to start audio playback in the current context.
+ *
+ * @see Autoplay policy on MDN web docs for more info: {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Best_practices#autoplay_policy}
+ * @alpha
+ */
+export declare function useStartAudio({ room, props }: UseStartAudioProps): {
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayAudio: boolean;
+};
+//# sourceMappingURL=useStartAudio.d.ts.map

package/dist/hooks/useStartAudio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStartAudio.d.ts","sourceRoot":"","sources":["../../src/hooks/useStartAudio.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,aAAa;AACb,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,kBAAkB;;;;;;;;;EA2BhE"}

package/dist/hooks/useStartVideo.d.ts

@@ -0,0 +1,26 @@
+import { Room } from 'livekit-client';
+import * as React from 'react';
+/** @alpha */
+export interface UseStartVideoProps {
+    room?: Room;
+    props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+/**
+ * In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button.
+ * The `useStartVideo` hook returns an object with a boolean `canPlayVideo` flag
+ * that indicates whether video playback is allowed in the current context,
+ * as well as a `startVideo` function that can be called in a button `onClick` callback to start video playback in the current context.
+ *
+ * @alpha
+ */
+export declare function useStartVideo({ room, props }: UseStartVideoProps): {
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayVideo: boolean;
+};
+//# sourceMappingURL=useStartVideo.d.ts.map

package/dist/hooks/useStartVideo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStartVideo.d.ts","sourceRoot":"","sources":["../../src/hooks/useStartVideo.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,aAAa;AACb,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;CACtD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,kBAAkB;;;;;;;;;EA2BhE"}

package/dist/hooks/useSwipe.d.ts

@@ -0,0 +1,24 @@
+import * as React from 'react';
+/**
+ * @alpha
+ */
+export type UseSwipeOptions = {
+    minSwipeDistance?: number;
+    onLeftSwipe?: () => void;
+    onRightSwipe?: () => void;
+};
+/**
+ * Simple implementation to detect horizontal swipe actions.
+ * Accepts callbacks for on right and left swipes.
+ * @example
+ * ```tsx
+ *  <div
+      onTouchStart={onTouchStart}
+      onTouchMove={onTouchMove}
+      onTouchEnd={onTouchEnd}
+    >
+ * ```
+ * @alpha
+ */
+export declare function useSwipe(element: React.RefObject<HTMLElement>, options?: UseSwipeOptions): void;
+//# sourceMappingURL=useSwipe.d.ts.map

package/dist/hooks/useSwipe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSwipe.d.ts","sourceRoot":"","sources":["../../src/hooks/useSwipe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,OAAO,GAAE,eAAoB,QA2C5F"}

package/dist/hooks/useTextStream.d.ts

@@ -0,0 +1,20 @@
+import { Room } from 'livekit-client';
+import { TextStreamData } from '@livekit/components-core';
+/** @beta */
+export type UseTextStreamOptions = {
+    room?: Room;
+};
+/**
+ * @beta
+ * @param topic - the topic to listen to
+ * @returns an array of TextStreamData that holds the text, participantInfo, and streamInfo
+ * @example
+ * ```tsx
+ * const { textStreams } = useTextStream('my-topic');
+ * return <div>{textStreams.map((textStream) => textStream.text)}</div>;
+ * ```
+ */
+export declare function useTextStream(topic: string, options?: UseTextStreamOptions): {
+    textStreams: TextStreamData[];
+};
+//# sourceMappingURL=useTextStream.d.ts.map

package/dist/hooks/useTextStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTextStream.d.ts","sourceRoot":"","sources":["../../src/hooks/useTextStream.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAKhF,YAAY;AACZ,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB;;EAY1E"}

package/dist/hooks/useToken.d.ts

@@ -0,0 +1,20 @@
+/** @public */
+export interface UserInfo {
+    identity?: string;
+    name?: string;
+    metadata?: string;
+}
+/** @public */
+export interface UseTokenOptions {
+    userInfo?: UserInfo;
+}
+/**
+ * The `useToken` hook fetches a token from the given token endpoint with the given user info.
+ *
+ * @example
+ * ```tsx
+ * const token = useToken(<token-endpoint>, roomName, { userInfo: { identity, name }});
+ * ```
+ * @public */
+export declare function useToken(tokenEndpoint: string | undefined, roomName: string, options?: UseTokenOptions): string | undefined;
+//# sourceMappingURL=useToken.d.ts.map

package/dist/hooks/useToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useToken.d.ts","sourceRoot":"","sources":["../../src/hooks/useToken.ts"],"names":[],"mappings":"AAGA,cAAc;AACd,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;aAOa;AACb,wBAAgB,QAAQ,CACtB,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,eAAoB,sBA2B9B"}

package/dist/hooks/useTrack.d.ts

@@ -0,0 +1,4 @@
+/**
+ * TODO decide whether we want to expose this
+ */
+//# sourceMappingURL=useTrack.d.ts.map

package/dist/hooks/useTrack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrack.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrack.ts"],"names":[],"mappings":"AAIA;;GAEG"}

package/dist/hooks/useTrackByName.d.ts

@@ -0,0 +1,10 @@
+import { Participant } from 'livekit-client';
+/**
+ * This function `useTrackByName` allows you to access a track by referencing its track name.
+ * Inside the function, it ensures that the a valid `participant` reference is available by checking
+ * for both a passed participant argument and, if not available, a valid participant context.
+ *
+ * @public
+ */
+export declare function useTrackByName(name: string, participant?: Participant): import('@livekit/components-core').TrackReferenceOrPlaceholder;
+//# sourceMappingURL=useTrackByName.d.ts.map

package/dist/hooks/useTrackByName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackByName.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackByName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,kEAGrE"}

package/dist/hooks/useTrackMutedIndicator.d.ts

@@ -0,0 +1,18 @@
+import { TrackReferenceOrPlaceholder } from '@livekit/components-core';
+interface TrackMutedIndicatorReturnType {
+    isMuted: boolean;
+    className: string;
+}
+/**
+ * The `useTrackMutedIndicator` hook is used to implement the `TrackMutedIndicator` component
+ * and returns the muted state of the given track.
+ *
+ * @example
+ * ```tsx
+ * const { isMuted } = useTrackMutedIndicator(trackRef);
+ * ```
+ * @public
+ */
+export declare function useTrackMutedIndicator(trackRef?: TrackReferenceOrPlaceholder): TrackMutedIndicatorReturnType;
+export {};
+//# sourceMappingURL=useTrackMutedIndicator.d.ts.map

package/dist/hooks/useTrackMutedIndicator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackMutedIndicator.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackMutedIndicator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,2BAA2B,EAGjC,MAAM,0BAA0B,CAAC;AAKlC,UAAU,6BAA6B;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,CAAC,EAAE,2BAA2B,GACrC,6BAA6B,CAiB/B"}

package/dist/hooks/useTrackRefBySourceOrName.d.ts

@@ -0,0 +1,7 @@
+import { TrackReferenceOrPlaceholder, TrackSource } from '@livekit/components-core';
+import { Track } from 'livekit-client';
+/**
+ * @internal
+ */
+export declare function useTrackRefBySourceOrName(source: TrackSource<Track.Source>): TrackReferenceOrPlaceholder;
+//# sourceMappingURL=useTrackRefBySourceOrName.d.ts.map

package/dist/hooks/useTrackRefBySourceOrName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackRefBySourceOrName.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackRefBySourceOrName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGzF,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAChC,2BAA2B,CAmB7B"}

package/dist/hooks/useTrackSyncTime.d.ts

@@ -0,0 +1,10 @@
+import { TrackReferenceOrPlaceholder } from '@livekit/components-core';
+/**
+ * @internal
+ * @deprecated this is an internal hook that's only used by deprecated APIs
+ */
+export declare function useTrackSyncTime(ref: TrackReferenceOrPlaceholder | undefined): {
+    timestamp: number;
+    rtpTimestamp: number | undefined;
+};
+//# sourceMappingURL=useTrackSyncTime.d.ts.map

package/dist/hooks/useTrackSyncTime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackSyncTime.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackSyncTime.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,2BAA2B,EAAyB,MAAM,0BAA0B,CAAC;AAGnG;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,2BAA2B,GAAG,SAAS;;;EAS5E"}

package/dist/hooks/useTrackToggle.d.ts

@@ -0,0 +1,27 @@
+import { ToggleSource } from '@livekit/components-core';
+import { Room } from 'livekit-client';
+import { TrackToggleProps } from '../components';
+import * as React from 'react';
+/** @public */
+export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackToggleProps<T>, 'showIcon'> {
+    room?: Room;
+}
+/**
+ * The `useTrackToggle` hook is used to implement the `TrackToggle` component and returns state
+ * and functionality of the given track.
+ *
+ * @example
+ * ```tsx
+ * const { buttonProps, enabled } = useTrackToggle(trackRef);
+ * return <button {...buttonProps}>{enabled ? 'disable' : 'enable'}</button>;
+ * ```
+ * @public
+ */
+export declare function useTrackToggle<T extends ToggleSource>({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest }: UseTrackToggleProps<T>): {
+    toggle: ((forceState?: boolean) => Promise<void>) | ((forceState?: boolean, captureOptions?: import('@livekit/components-core').CaptureOptionsBySource<T> | undefined) => Promise<boolean | undefined>);
+    enabled: boolean;
+    pending: boolean;
+    track: import('livekit-client').LocalTrackPublication | undefined;
+    buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
+};
+//# sourceMappingURL=useTrackToggle.d.ts.map

package/dist/hooks/useTrackToggle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackToggle.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackToggle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAKtD,cAAc;AACd,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,YAAY,CACzD,SAAQ,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;IAC7C,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,EACrD,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,cAAc,EACd,aAAa,EACb,IAAI,EACJ,GAAG,IAAI,EACR,EAAE,mBAAmB,CAAC,CAAC,CAAC;;;;;iBAuDhB,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC;EAErD"}

package/dist/hooks/useTrackTranscription.d.ts

@@ -0,0 +1,26 @@
+import { ReceivedTranscriptionSegment, TrackReferenceOrPlaceholder } from '@livekit/components-core';
+import { TranscriptionSegment } from 'livekit-client';
+/**
+ * @alpha
+ * @deprecated Use useTranscription instead
+ */
+export interface TrackTranscriptionOptions {
+    /**
+     * how many transcription segments should be buffered in state
+     * @defaultValue 100
+     */
+    bufferSize?: number;
+    /**
+     * optional callback for retrieving newly incoming transcriptions only
+     */
+    onTranscription?: (newSegments: TranscriptionSegment[]) => void;
+}
+/**
+ * @returns An object consisting of `segments` with maximum length of opts.bufferSize
+ * @alpha
+ * @deprecated Use useTranscription instead
+ */
+export declare function useTrackTranscription(trackRef: TrackReferenceOrPlaceholder | undefined, options?: TrackTranscriptionOptions): {
+    segments: ReceivedTranscriptionSegment[];
+};
+//# sourceMappingURL=useTrackTranscription.d.ts.map

package/dist/hooks/useTrackTranscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackTranscription.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackTranscription.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,4BAA4B,EAMjC,KAAK,2BAA2B,EAEjC,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAI3D;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,WAAW,EAAE,oBAAoB,EAAE,KAAK,IAAI,CAAC;CAGjE;AAOD;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,2BAA2B,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,yBAAyB;;EA8BpC"}