@werxt/livekit-components-react 2.9.20

package/dist/hooks/useTrackVolume.d.ts

@@ -0,0 +1,49 @@
+import { LocalAudioTrack, RemoteAudioTrack, AudioAnalyserOptions } from 'livekit-client';
+import { TrackReference, TrackReferenceOrPlaceholder } from '@livekit/components-core';
+/**
+ * @alpha
+ * Hook for tracking the volume of an audio track using the Web Audio API.
+ */
+export declare function useTrackVolume(trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReference, options?: AudioAnalyserOptions): number;
+/**
+ * Interface for configuring options for the useMultibandTrackVolume hook.
+ * @alpha
+ */
+export interface MultiBandTrackVolumeOptions {
+    bands?: number;
+    /**
+     * cut off of frequency bins on the lower end
+     * Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
+     */
+    loPass?: number;
+    /**
+     * cut off of frequency bins on the higher end
+     * Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
+     */
+    hiPass?: number;
+    /**
+     * update should run every x ms
+     */
+    updateInterval?: number;
+    analyserOptions?: AnalyserOptions;
+}
+/**
+ * Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.
+ * @alpha
+ */
+export declare function useMultibandTrackVolume(trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder, options?: MultiBandTrackVolumeOptions): number[];
+/**
+ * @alpha
+ */
+export interface AudioWaveformOptions {
+    barCount?: number;
+    volMultiplier?: number;
+    updateInterval?: number;
+}
+/**
+ * @alpha
+ */
+export declare function useAudioWaveform(trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder, options?: AudioWaveformOptions): {
+    bars: number[];
+};
+//# sourceMappingURL=useTrackVolume.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackVolume.d.ts","sourceRoot":"","sources":["../../src/hooks/useTrackVolume.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE9F,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,2BAA2B,EACjC,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,qBAAqB,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,cAAc,EAC3E,OAAO,GAAE,oBAAgE,UAmC1E;AAqBD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAUD;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,qBAAqB,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,2BAA2B,EACxF,OAAO,GAAE,2BAAgC,YA0D1C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAQD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,2BAA2B,EACxF,OAAO,GAAE,oBAAyB;;EA0DnC"}

package/dist/hooks/useTracks.d.ts

@@ -0,0 +1,29 @@
+import { SourcesArray, TrackReference, TrackReferenceOrPlaceholder, TrackSourceWithOptions } from '@livekit/components-core';
+import { Participant, Room, RoomEvent, Track } from 'livekit-client';
+/** @public */
+export type UseTracksOptions = {
+    updateOnlyOn?: RoomEvent[];
+    onlySubscribed?: boolean;
+    room?: Room;
+};
+/** @public */
+export type UseTracksHookReturnType<T> = T extends Track.Source[] ? TrackReference[] : T extends TrackSourceWithOptions[] ? TrackReferenceOrPlaceholder[] : never;
+/**
+ * The `useTracks` hook returns an array of `TrackReference` or `TrackReferenceOrPlaceholder` depending on the provided `sources` property.
+ * If only subscribed tracks are desired, set the `onlySubscribed` property to `true`.
+ * @example
+ * ```ts
+ * // Return all camera track publications.
+ * const trackReferences: TrackReference[] = useTracks([Track.Source.Camera])
+ * ```
+ * @example
+ * ```ts
+ * // Return all subscribed camera tracks as well as placeholders for
+ * // participants without a camera subscription.
+ * const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks([{source: Track.Source.Camera, withPlaceholder: true}])
+ * ```
+ * @public
+ */
+export declare function useTracks<T extends SourcesArray = Track.Source[]>(sources?: T, options?: UseTracksOptions): UseTracksHookReturnType<T>;
+export declare function requiredPlaceholders<T extends SourcesArray>(sources: T, participants: Participant[]): Map<Participant['identity'], Track.Source[]>;
+//# sourceMappingURL=useTracks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTracks.d.ts","sourceRoot":"","sources":["../../src/hooks/useTracks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,2BAA2B,EAC3B,sBAAsB,EAEvB,MAAM,0BAA0B,CAAC;AAOlC,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAIvC,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,GAC7D,cAAc,EAAE,GAChB,CAAC,SAAS,sBAAsB,EAAE,GAChC,2BAA2B,EAAE,GAC7B,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,YAAY,GAAG,KAAK,CAAC,MAAM,EAAE,EAC/D,OAAO,GAAE,CAMH,EACN,OAAO,GAAE,gBAAqB,GAC7B,uBAAuB,CAAC,CAAC,CAAC,CA6D5B;AAUD,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,YAAY,EACzD,OAAO,EAAE,CAAC,EACV,YAAY,EAAE,WAAW,EAAE,GAC1B,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAsB9C"}

package/dist/hooks/useTranscriptions.d.ts

@@ -0,0 +1,21 @@
+import { Room } from 'livekit-client';
+/**
+ * @beta
+ */
+export interface UseTranscriptionsOptions {
+    room?: Room;
+    participantIdentities?: string[];
+    trackSids?: string[];
+}
+/**
+ * @beta
+ * useTranscriptions is a hook that returns the transcriptions for the given participant identities and track sids,
+ * if no options are provided, it will return all transcriptions
+ * @example
+ * ```tsx
+ * const transcriptions = useTranscriptions();
+ * return <div>{transcriptions.map((transcription) => transcription.text)}</div>;
+ * ```
+ */
+export declare function useTranscriptions(opts?: UseTranscriptionsOptions): import('@livekit/components-core').TextStreamData[];
+//# sourceMappingURL=useTranscriptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTranscriptions.d.ts","sourceRoot":"","sources":["../../src/hooks/useTranscriptions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,CAAC,EAAE,wBAAwB,uDAuBhE"}

package/dist/hooks/useVisualStableUpdate.d.ts

@@ -0,0 +1,27 @@
+import { TrackReferenceOrPlaceholder } from '@livekit/components-core';
+/** @public */
+export interface UseVisualStableUpdateOptions {
+    /** Overwrites the default sort function. */
+    customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
+}
+/**
+ * The `useVisualStableUpdate` hook is used to prevent visually jarring jumps and shifts of elements
+ * in an array. The algorithm only starts to update when there are more items than visually fit
+ * on a page. If this is the case, it will make sure that speaking participants move to the first
+ * page and are always visible.
+ * @remarks
+ * Updating the array can occur because attendees leave or join a room, or because they mute/unmute
+ * or start speaking.
+ * The hook is used for the `GridLayout` and `CarouselLayout` components.
+ *
+ * @example
+ * ```tsx
+ * const trackRefs = useTracks();
+ * const updatedTrackRefs = useVisualStableUpdate(trackRefs, itemPerPage);
+ * ```
+ * @public
+ */
+export declare function useVisualStableUpdate(
+/** `TrackReference`s to display in the grid.  */
+trackReferences: TrackReferenceOrPlaceholder[], maxItemsOnPage: number, options?: UseVisualStableUpdateOptions): TrackReferenceOrPlaceholder[];
+//# sourceMappingURL=useVisualStableUpdate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useVisualStableUpdate.d.ts","sourceRoot":"","sources":["../../src/hooks/useVisualStableUpdate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAI5E,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,kBAAkB,CAAC,EAAE,CACnB,eAAe,EAAE,2BAA2B,EAAE,KAC3C,2BAA2B,EAAE,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,qBAAqB;AACnC,iDAAiD;AACjD,eAAe,EAAE,2BAA2B,EAAE,EAC9C,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,4BAAiC,GACzC,2BAA2B,EAAE,CA4B/B"}

package/dist/hooks/useVoiceAssistant.d.ts

@@ -0,0 +1,43 @@
+import { RemoteParticipant } from 'livekit-client';
+import { ReceivedTranscriptionSegment, TrackReference } from '@livekit/components-core';
+import { AgentState } from './useAgent';
+/**
+ * @beta
+ */
+export interface VoiceAssistant {
+    /**
+     * The agent participant.
+     */
+    agent: RemoteParticipant | undefined;
+    /**
+     * The current state of the agent.
+     */
+    state: AgentState;
+    /**
+     * The microphone track published by the agent or associated avatar worker (if any).
+     */
+    audioTrack: TrackReference | undefined;
+    /**
+     * The camera track published by the agent or associated avatar worker (if any).
+     */
+    videoTrack: TrackReference | undefined;
+    /**
+     * The transcriptions of the agent's microphone track (if any).
+     */
+    agentTranscriptions: ReceivedTranscriptionSegment[];
+    /**
+     * The agent's participant attributes.
+     */
+    agentAttributes: RemoteParticipant['attributes'] | undefined;
+}
+/**
+ * This hook looks for the first agent-participant in the room.
+ * @remarks This hook requires an agent running with livekit-agents \>= 0.9.0
+ * @example
+ * ```tsx
+ * const { state, audioTrack, agentTranscriptions, agentAttributes } = useVoiceAssistant();
+ * ```
+ * @beta
+ */
+export declare function useVoiceAssistant(): VoiceAssistant;
+//# sourceMappingURL=useVoiceAssistant.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useVoiceAssistant.d.ts","sourceRoot":"","sources":["../../src/hooks/useVoiceAssistant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAEL,KAAK,4BAA4B,EACjC,KAAK,cAAc,EACpB,MAAM,0BAA0B,CAAC;AAMlC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,cAAc,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,UAAU,EAAE,cAAc,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,mBAAmB,EAAE,4BAA4B,EAAE,CAAC;IACpD;;OAEG;IACH,eAAe,EAAE,iBAAiB,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;CAC9D;AAID;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,IAAI,cAAc,CAoDlD"}

package/dist/hooks/useWarnAboutMissingStyles.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ */
+export declare function useWarnAboutMissingStyles(): void;
+//# sourceMappingURL=useWarnAboutMissingStyles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useWarnAboutMissingStyles.d.ts","sourceRoot":"","sources":["../../src/hooks/useWarnAboutMissingStyles.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,yBAAyB,SAIxC"}