@aceshooting/lyra-ui 3.7.0 → 3.8.0

package/dist/components/av-player/av-player.class.d.ts

@@ -0,0 +1,215 @@
+import { type PropertyValues, type TemplateResult } from 'lit';
+import { LyraElement } from '../../internal/lyra-element.js';
+import type { LyraAnchor, LyraAnchorKind, HighlightActivateDetail, AnchorResultDetail } from '../document-viewer/anchors.js';
+import '../virtual-list/virtual-list.js';
+export type AvKind = 'audio' | 'video';
+/** One synced transcript entry. `end` is exclusive; an omitted `end` extends to the next cue (or
+ *  forever, for the last one). */
+export interface LyraAvCue {
+    id: string;
+    start: number;
+    end?: number;
+    text: string;
+    speaker?: string;
+}
+/** A native `<track>` source (subtitles/captions/descriptions), wired straight through to the
+ *  underlying media element. */
+export interface LyraAvTrack {
+    src: string;
+    kind: 'subtitles' | 'captions' | 'descriptions';
+    srclang: string;
+    label: string;
+    default?: boolean;
+}
+export interface LyraAvPlayerEventMap {
+    'lyra-play': CustomEvent<undefined>;
+    'lyra-pause': CustomEvent<undefined>;
+    'lyra-load': CustomEvent<{
+        duration: number;
+        kind: AvKind;
+    }>;
+    'lyra-time-change': CustomEvent<{
+        currentTime: number;
+    }>;
+    'lyra-rate-change': CustomEvent<{
+        rate: number;
+    }>;
+    'lyra-cue-change': CustomEvent<{
+        id: string | null;
+    }>;
+    'lyra-highlight-activate': CustomEvent<HighlightActivateDetail>;
+    'lyra-anchor-result': CustomEvent<AnchorResultDetail>;
+    'lyra-search-change': CustomEvent<{
+        query: string;
+        matchCount: number;
+        activeIndex: number;
+    }>;
+    'lyra-render-error': CustomEvent<{
+        error: unknown;
+    }>;
+}
+declare class LyraAvPlayerBase extends LyraElement<LyraAvPlayerEventMap> {
+}
+declare const LyraAvPlayer_base: typeof LyraAvPlayerBase & (new (...args: any[]) => import("../../internal/anchor-target.js").LyraAnchorTarget & {
+    renderAnchorLiveRegion(): unknown;
+});
+/**
+ * `<lyra-av-player>` — audio/video player built on a native `<audio>`/`<video>` element, plus a cue
+ * transcript synced to `currentTime`, `time-range` anchor/highlight support, an optional
+ * dependency-free waveform (peaks in, no in-component decoding), and playback-rate control. Owns
+ * recorded-media transcript sync; distinct from `<lyra-transcript-feed>` (live captions for an
+ * in-progress voice session) and `<lyra-playback>` (an index stepper over `[0, length)` for
+ * time-series dashboards — no media involved in either).
+ *
+ * Adopts `DocumentAnchorTarget` with `anchorKinds: ['time-range']` only. No text selection is bound:
+ * transcript rows render inside `<lyra-virtual-list>`'s own nested shadow root, one boundary deeper
+ * than the mixin's default selection lookup resolves.
+ *
+ * The transcript virtualizes through `<lyra-virtual-list>` the same way `pdf-viewer.class.ts`
+ * virtualizes pages: `items`/`renderItem`/`keyFunction`/`activeId` props, and the active cue's
+ * scroll-into-view comes for free from `activeId` rather than any custom follow logic.
+ *
+ * @customElement lyra-av-player
+ * @event lyra-play - Playback started.
+ * @event lyra-pause - Playback paused.
+ * @event lyra-load - Media metadata finished loading. `detail: { duration, kind }`.
+ * @event lyra-time-change - `detail: { currentTime }`, throttled to at most 4/s while playing, plus
+ *   one extra emission per `seek()` regardless of the throttle window.
+ * @event lyra-rate-change - `detail: { rate }`.
+ * @event lyra-cue-change - The active transcript cue changed. `detail: { id }` (`null` when none is
+ *   active).
+ * @event lyra-highlight-activate - A `time-range` highlight marker was activated. `detail: { id }`.
+ * @event lyra-anchor-result - Fired after `anchor` (or a `scrollToAnchor()` call) is applied.
+ *   `detail: { found }`.
+ * @event lyra-search-change - Fired from `search()`/`searchNext()`/`searchPrevious()`/
+ *   `clearSearch()`. `detail: { query, matchCount, activeIndex }`.
+ * @event lyra-render-error - The native media element reported an `error` event. `detail: { error }`.
+ * @csspart base - The root wrapper.
+ * @csspart media - The native `<audio>`/`<video>` element.
+ * @csspart toolbar - The playback-rate control row.
+ * @csspart rate-select - The playback-rate `<select>`.
+ * @csspart timeline - The waveform canvas or plain seek rail; click-to-seek and arrow-key seeking.
+ * @csspart timeline-marker - One clickable marker per `time-range` highlight (`data-tone`,
+ *   `data-active`).
+ * @csspart transcript - The virtualized cue list (`<lyra-virtual-list>` itself).
+ * @csspart cue - One transcript row (`aria-current`, `data-match`, `data-active-match`).
+ * @csspart cue-time - A cue's timestamp label.
+ * @csspart cue-speaker - A cue's speaker label.
+ * @csspart cue-text - A cue's text.
+ * @csspart error - The error region.
+ * @cssprop [--lyra-av-player-transcript-height=var(--lyra-size-16rem)] - Block size of the
+ *   virtualized transcript list.
+ */
+export declare class LyraAvPlayer extends LyraAvPlayer_base {
+    static styles: import("lit").CSSResultGroup[];
+    static properties: {
+        playbackRate: {
+            type: NumberConstructor;
+            attribute: string;
+            reflect: boolean;
+            noAccessor: boolean;
+        };
+    };
+    /** Media URL; validated with `safeMediaSrc` before it ever reaches the `<audio>`/`<video>` `src`. */
+    src: string;
+    /** Accessible name of `[part="base"]` and of the native `[part="media"]` element (the actual
+     *  keyboard tab stop, which would otherwise be nameless); a host `aria-label` wins, then the
+     *  localized `avPlayerLabel` fallback. */
+    name: string;
+    /** Forces `audio`/`video` rendering, overriding the `mime-type`-based auto-detection. */
+    kind?: AvKind;
+    /** Drives auto-detection: an `audio/*` mime type renders `<audio>`; anything else renders
+     *  `<video>`. Ignored once `kind` is set explicitly. */
+    mimeType: string;
+    /** Poster image for `<video>`; ignored for `<audio>`. */
+    poster: string;
+    loop: boolean;
+    muted: boolean;
+    preload: 'none' | 'metadata' | 'auto';
+    private _playbackRate;
+    /** Playback-rate multiplier, reflected to the native media element. Clamped to
+     *  `[MIN_PLAYBACK_RATE, MAX_PLAYBACK_RATE]` -- a non-finite or wildly out-of-range assignment
+     *  (e.g. a bad computed value) self-heals rather than reaching `HTMLMediaElement.playbackRate`
+     *  unsanitized. */
+    get playbackRate(): number;
+    set playbackRate(next: number);
+    /** Selectable rates offered by `[part="rate-select"]`. */
+    rates: number[];
+    /** Transcript entries, rendered as a virtualized, `currentTime`-synced list. */
+    cues: LyraAvCue[];
+    /** Normalized `0..1` waveform amplitude samples. Empty renders a plain seek rail instead of a
+     *  canvas -- this component never decodes audio itself. */
+    peaks: number[];
+    /** Native `<track>` sources (subtitles/captions/descriptions). */
+    tracks: LyraAvTrack[];
+    /** From `DocumentAnchorTarget` — only `time-range` anchors resolve here. */
+    readonly anchorKinds: readonly LyraAnchorKind[];
+    private duration;
+    private currentTimeState;
+    private activeCueId;
+    private searchQuery;
+    private searchMatches;
+    private activeSearchIndex;
+    private metadataLoaded;
+    private renderError;
+    private mediaEl?;
+    private canvasEl?;
+    private lastTimeChangeAt;
+    private pendingSeek;
+    /** Live playback position: the media element's own `currentTime` once mounted, else the last
+     *  locally-tracked value (e.g. a `seek()` issued before metadata loaded). */
+    get currentTime(): number;
+    set currentTime(value: number);
+    private detectedKind;
+    protected updated(changed: PropertyValues): void;
+    connectedCallback(): void;
+    firstUpdated(): void;
+    disconnectedCallback(): void;
+    private onWindowResize;
+    /** Proxies the native media element's `play()`. A no-op before the element mounts. */
+    play(): void;
+    /** Proxies the native media element's `pause()`. A no-op before the element mounts. */
+    pause(): void;
+    /** Plays if paused, pauses if playing. A no-op before the element mounts. */
+    toggle(): void;
+    /** Sets `currentTime` and forces an immediate `lyra-time-change`, bypassing the playing-time throttle. */
+    seek(seconds: number): void;
+    protected applyAnchor(anchor: LyraAnchor): Promise<boolean>;
+    private onLoadedMetadata;
+    private onPlay;
+    private onPause;
+    private onMediaError;
+    private emitTimeChange;
+    private onTimeUpdate;
+    private onSeeked;
+    /** Case-insensitive substring match over cue text and speaker. Resolves the match count. */
+    search(query: string): Promise<number>;
+    /** Advances to the next match, wrapping to the first after the last. No-op with no matches. */
+    searchNext(): void;
+    /** Moves to the previous match, wrapping to the last before the first. No-op with no matches. */
+    searchPrevious(): void;
+    /** Clears the query, matches, and active index, and emits a zero-match `lyra-search-change`. */
+    clearSearch(): void;
+    private emitSearchChange;
+    private drawWaveform;
+    private onHighlightActivate;
+    private renderMarkers;
+    private onTimelineClick;
+    private onTimelineKeyDown;
+    /** `[part="rate-select"]`'s `<option>` values -- `rates`, plus the current `playbackRate` spliced
+     *  in (numerically sorted) when it isn't already one of them. A native `<select>` shows its first
+     *  option whenever no `<option>` carries `selected` at all, so a `playbackRate` set outside the
+     *  offered `rates` list (a caller-driven value, or a rate offered by an earlier `rates` array that
+     *  has since been narrowed) would otherwise display a rate that doesn't match `playbackRate`. */
+    private rateOptions;
+    private renderCue;
+    private renderTracks;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'lyra-av-player': LyraAvPlayer;
+    }
+}
+export {};
+//# sourceMappingURL=av-player.class.d.ts.map

package/dist/components/av-player/av-player.class.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"av-player.class.d.ts","sourceRoot":"","sources":["../../../src/components/av-player/av-player.class.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAC;AAG9E,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE7D,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EAEd,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,iCAAiC,CAAC;AAGzC,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEvC;kCACkC;AAClC,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;gCACgC;AAChC,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,WAAW,GAAG,UAAU,GAAG,cAAc,CAAC;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAuBD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACpC,YAAY,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7D,kBAAkB,EAAE,WAAW,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzD,kBAAkB,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAClD,iBAAiB,EAAE,WAAW,CAAC;QAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,yBAAyB,EAAE,WAAW,CAAC,uBAAuB,CAAC,CAAC;IAChE,oBAAoB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACtD,oBAAoB,EAAE,WAAW,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9F,mBAAmB,EAAE,WAAW,CAAC;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACtD;AAED,cAAM,gBAAiB,SAAQ,WAAW,CAAC,oBAAoB,CAAC;CAAG;;;;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,YAAa,SAAQ,iBAAsC;IACtE,MAAM,CAAC,MAAM,iCAAwC;IAOrD,MAAM,CAAC,UAAU;QACf,YAAY;YAAI,IAAI;YAAU,SAAS;YAAmB,OAAO;YAAQ,UAAU;;MACnF;IAEF,qGAAqG;IACzF,GAAG,SAAM;IACrB;;8CAE0C;IAC9B,IAAI,SAAM;IACtB,yFAAyF;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAC;IAC1B;4DACwD;IAClB,QAAQ,SAAM;IACpD,yDAAyD;IAC7C,MAAM,SAAM;IACK,IAAI,UAAS;IACb,KAAK,UAAS;IAC/B,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAc;IAC/D,OAAO,CAAC,aAAa,CAAK;IAC1B;;;uBAGmB;IACnB,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,IAAI,YAAY,CAAC,IAAI,EAAE,MAAM,EAI5B;IACD,0DAA0D;IAC1B,KAAK,EAAE,MAAM,EAAE,CAA2B;IAC1E,gFAAgF;IAChD,IAAI,EAAE,SAAS,EAAE,CAAM;IACvD;+DAC2D;IAC3B,KAAK,EAAE,MAAM,EAAE,CAAM;IACrD,kEAAkE;IAClC,MAAM,EAAE,WAAW,EAAE,CAAM;IAE3D,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAkB;IAExD,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,iBAAiB,CAAM;IAC/B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,WAAW,CAAS;IAEd,OAAO,CAAC,OAAO,CAAC,CAAmB;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAoB;IAExE,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,WAAW,CAAuB;IAE1C;iFAC6E;IAC7E,IAAI,WAAW,IAAI,MAAM,CAExB;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAU5B;IAED,OAAO,CAAC,YAAY;IAKpB,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAO/C;IAED,iBAAiB,IAAI,IAAI,CAQxB;IAED,YAAY,IAAI,IAAI,CAEnB;IAED,oBAAoB,IAAI,IAAI,CAG3B;IAED,OAAO,CAAC,cAAc,CAAmC;IAEzD,sFAAsF;IACtF,IAAI,IAAI,IAAI,CAEX;IACD,uFAAuF;IACvF,KAAK,IAAI,IAAI,CAEZ;IACD,6EAA6E;IAC7E,MAAM,IAAI,IAAI,CAGb;IACD,0GAA0G;IAC1G,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAG1B;IAED,UAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAIhE;IAED,OAAO,CAAC,gBAAgB,CAQtB;IAEF,OAAO,CAAC,MAAM,CAEZ;IACF,OAAO,CAAC,OAAO,CAEb;IACF,OAAO,CAAC,YAAY,CAGlB;IAEF,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,YAAY,CAclB;IAEF,OAAO,CAAC,QAAQ,CAAyC;IAEzD,4FAA4F;IACtF,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAY3C;IAED,+FAA+F;IAC/F,UAAU,IAAI,IAAI,CAIjB;IAED,iGAAiG;IACjG,cAAc,IAAI,IAAI,CAIrB;IAED,gGAAgG;IAChG,WAAW,IAAI,IAAI,CAKlB;IAED,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,YAAY;IAqBpB,OAAO,CAAC,mBAAmB,CAIzB;IAEF,OAAO,CAAC,aAAa;IAwBrB,OAAO,CAAC,eAAe,CAMrB;IAEF,OAAO,CAAC,iBAAiB,CA6BvB;IAEF;;;;qGAIiG;IACjG,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,SAAS,CAgBf;IAEF,OAAO,CAAC,YAAY;IASpB,MAAM,IAAI,cAAc,CAwFvB;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,gBAAgB,EAAE,YAAY,CAAC;KAChC;CACF"}