@munsonlabs/video-player 0.2.6 → 0.2.8

package/dist/elements/index.d.mts

@@ -1,5 +1,5 @@
 import { Ref, UnwrapNestedRefs } from "vue";
-//#region src/composables/player/emitter.d.ts
+//#region src/adapters/emitter.d.ts
 type PlaybackListener = (...args: unknown[]) => void;
 //#endregion
 //#region src/types/playback.d.ts
@@ -18,6 +18,23 @@ interface QualityLevelInfo {
   bitrate: number;
   label: string;
 }
+interface AdapterCaptions {
+  tracks(): CaptionTrackInfo[];
+  active(): number | null;
+  select(index: number | null): void;
+}
+interface AdapterQuality {
+  levels(): QualityLevelInfo[];
+  current(): number | null;
+  isAuto(): boolean;
+  select(index: number | null): void;
+}
+interface AdapterPip {
+  isSupported(): boolean;
+  isActive(): boolean;
+  toggle(): void;
+}
+type PlaybackEvent = 'play' | 'pause' | 'playing' | 'ended' | 'error' | 'timeupdate' | 'durationchange' | 'progress' | 'volumechange' | 'ratechange' | 'seeked' | 'waiting' | 'canplay' | 'qualitychange' | 'captionschange' | 'pipchange' | 'adstart' | 'adend' | 'nativefullscreenenter' | 'nativefullscreenexit' | 'fullscreen-pending' | 'fullscreen-pending-done';
 interface PlaybackAdapter {
   readonly el: HTMLElement;
   play(): Promise<void>;
@@ -34,24 +51,17 @@ interface PlaybackAdapter {
   setPlaybackRate(rate: number): void;
   bufferedEnd(): number;
   error(): MediaErrorLike | null;
-  setSrc(src: string, type?: string): void;
+  load(src: string, type?: string): void;
+  retry(): void;
   supportsPlaybackRate(): boolean;
-  supportsCaptions(): boolean;
-  getCaptionTracks(): CaptionTrackInfo[];
-  setCaptionTrack(index: number | null): void;
-  getActiveCaptionTrack(): number | null;
-  supportsQuality(): boolean;
-  getQualityLevels(): QualityLevelInfo[];
-  getCurrentQuality(): number | null;
-  isAutoQuality(): boolean;
-  setQuality(index: number | null): void;
-  supportsPip(): boolean;
-  isPipActive(): boolean;
-  togglePip(): void;
+  captions?: AdapterCaptions;
+  quality?: AdapterQuality;
+  pip?: AdapterPip;
+  reveal?(videoEl: HTMLVideoElement): void;
   enterFullscreen(): void;
   exitFullscreen(): void;
-  on(event: string, listener: PlaybackListener): void;
-  off(event: string, listener: PlaybackListener): void;
+  on(event: PlaybackEvent, listener: PlaybackListener): void;
+  off(event: PlaybackEvent, listener: PlaybackListener): void;
   dispose(): void;
 }
 interface ResolvedSource {
@@ -83,7 +93,7 @@ type PlatformConfig = Pick<Matcher, 'key' | 'test'> & ({
   resolveSource?: SourceResolver;
 });
 //#endregion
-//#region src/composables/player/playerState.d.ts
+//#region src/ui/player/playerState.d.ts
 declare function createPlayerState(props: PlayerProps): {
   isPlaying: import("vue").Ref<boolean, boolean>;
   hasEnded: import("vue").Ref<boolean, boolean>;
@@ -93,12 +103,12 @@ declare function createPlayerState(props: PlayerProps): {
   hasStarted: import("vue").Ref<boolean, boolean>;
   isError: import("vue").Ref<boolean, boolean>;
   errorMessage: import("vue").Ref<string, string>;
-  current: import("vue").Ref<number, number>;
-  total: import("vue").Ref<number, number>;
+  currentTime: import("vue").Ref<number, number>;
+  duration: import("vue").Ref<number, number>;
   buffered: import("vue").Ref<number, number>;
   progress: import("vue").ComputedRef<number>;
   bufferedDisplay: import("vue").ComputedRef<number>;
-  vol: import("vue").Ref<number, number>;
+  currentVolume: import("vue").Ref<number, number>;
   isMuted: import("vue").Ref<boolean, boolean>;
   isAudible: import("vue").ComputedRef<boolean>;
   isLooping: import("vue").Ref<boolean, boolean>;
@@ -131,7 +141,7 @@ declare function createPlayerState(props: PlayerProps): {
     bitrate: number;
     label: string;
   }[]>;
-  currentQualityIndex: import("vue").Ref<number | null, number | null>;
+  currentQualityHeight: import("vue").Ref<number | null, number | null>;
   isAutoQuality: import("vue").Ref<boolean, boolean>;
   supportsPip: import("vue").Ref<boolean, boolean>;
   isPipActive: import("vue").Ref<boolean, boolean>;
@@ -139,25 +149,27 @@ declare function createPlayerState(props: PlayerProps): {
 };
 type PlayerState = ReturnType<typeof createPlayerState>;
 //#endregion
-//#region src/composables/player/usePlayerControls.d.ts
-interface UsePlayerControlsReturn {
+//#region src/ui/player/createPlayerControls.d.ts
+interface PlayerControls {
   play: () => Promise<void>;
   pause: () => void;
   replay: () => Promise<void>;
   togglePlay: () => void;
-  seek: (percent: number) => void;
-  seekTo: (seconds: number) => void;
+  seek: (seconds: number) => void;
   toggleMute: () => void;
   setVolume: (vol: number) => void;
   toggleLoop: () => void;
   setPlaybackRate: (rate: number) => void;
   setCaptionTrack: (index: number | null) => void;
-  setQuality: (index: number | null) => void;
+  setQuality: (height: number | null) => void;
+  applyQuality: (height: number | null, options?: {
+    remember?: boolean;
+  }) => void;
   togglePip: () => void;
 }
 //#endregion
-//#region src/composables/player/usePlayer.d.ts
-type UsePlayerReturn = PlayerState & UsePlayerControlsReturn & {
+//#region src/ui/player/usePlayer.d.ts
+type UsePlayerReturn = PlayerState & PlayerControls & {
   fire: (type: StateChangeType, extras?: Partial<StateChangeEvent>) => void;
   retry: () => void;
   isBuffering: Ref<boolean>;
@@ -167,9 +179,9 @@ type UsePlayerReturn = PlayerState & UsePlayerControlsReturn & {
   toggleFullscreen: () => void;
 };
 //#endregion
-//#region src/composables/player/playerSurface.d.ts
-declare const PLAYER_METHOD_KEYS: readonly ["retry", "play", "pause", "replay", "togglePlay", "seek", "seekTo", "toggleMute", "setVolume", "toggleFullscreen", "toggleLoop", "toggleAdMute", "setPlaybackRate", "setCaptionTrack", "setQuality", "togglePip"];
-declare const PLAYER_STATE_KEYS: readonly ["isPlaying", "hasEnded", "isReady", "isLoaded", "isAdPlaying", "isAdPaused", "isAdMuted", "adRemainingTime", "isLive", "isBuffering", "current", "total", "vol", "isMuted", "isAudible", "isLooping", "currentPlaybackRate", "hasStarted", "isError", "errorMessage", "progress", "bufferedDisplay", "isFullscreen", "supportsPlaybackRate", "supportsCaptions", "captionTracks", "activeCaptionIndex", "supportsQuality", "qualityLevels", "currentQualityIndex", "isAutoQuality", "supportsPip", "isPipActive", "isNativeUi"];
+//#region src/ui/player/playerSurface.d.ts
+declare const PLAYER_METHOD_KEYS: readonly ["retry", "play", "pause", "replay", "togglePlay", "seek", "toggleMute", "setVolume", "toggleFullscreen", "toggleLoop", "toggleAdMute", "setPlaybackRate", "setCaptionTrack", "setQuality", "togglePip"];
+declare const PLAYER_STATE_KEYS: readonly ["isPlaying", "hasEnded", "isReady", "isLoaded", "isAdPlaying", "isAdPaused", "isAdMuted", "adRemainingTime", "isLive", "isBuffering", "currentTime", "duration", "currentVolume", "isMuted", "isAudible", "isLooping", "currentPlaybackRate", "hasStarted", "isError", "errorMessage", "progress", "bufferedDisplay", "isFullscreen", "supportsPlaybackRate", "supportsCaptions", "captionTracks", "activeCaptionIndex", "supportsQuality", "qualityLevels", "currentQualityHeight", "isAutoQuality", "supportsPip", "isPipActive", "isNativeUi"];
 type PlayerMethodKey = (typeof PLAYER_METHOD_KEYS)[number];
 type PlayerStateKey = (typeof PLAYER_STATE_KEYS)[number];
 //#endregion
@@ -194,7 +206,7 @@ interface StateChangeEvent {
   isMuted?: boolean;
   playbackRate?: number;
   captionIndex?: number | null;
-  qualityIndex?: number | null;
+  qualityHeight?: number | null;
   isPipActive?: boolean;
   isLooping?: boolean;
   element?: HTMLElement | null;
@@ -231,10 +243,12 @@ interface PlayerProps {
   adMacroParams?: Record<string, string>;
   headerBidding?: HeaderBiddingConfig;
   tracks?: CaptionTrackDef[];
+  captionLine?: number;
   autoplay?: boolean;
   muted?: boolean;
   volume?: number;
   playbackRate?: number;
+  quality?: number | null;
   nativeUi?: boolean;
   payload?: Record<string, unknown> | string;
   action?: PlayerAction | null;
@@ -267,17 +281,14 @@ export declare function resolvePlatform(url: string): {
 export declare function registerPlatform(config: PlatformConfig): void;
 //#endregion
 //#region src/elements/core.d.ts
-declare const VideoPlayerElement: import("vue").VueElementConstructor<PlayerProps>;
-declare const VideoStageElement: import("vue").VueElementConstructor<{
-  pin?: PinCorner | "full-width";
-  playlist?: VideoEntry[];
-}>;
+declare const VideoPlayerElement: import("vue").VueElementConstructor<unknown>;
+declare const VideoStageElement: import("vue").VueElementConstructor<unknown>;
 declare const VideoPlaceholderElement: import("vue").VueElementConstructor<VideoEntry>;
-declare const VideoCardElement: import("vue").VueElementConstructor<VideoEntry>;
+declare const VideoCardElement: import("vue").VueElementConstructor<unknown>;
 declare const HideMarkerElement: import("vue").VueElementConstructor<{}>;
 export declare function defineElements(): void;
 //#endregion
-//#region src/composables/controls/useResolvedPlayer.d.ts
+//#region src/ui/controls/useResolvedPlayer.d.ts
 interface ResolvedPlayerProps {
   player?: PlayerHandle | null;
   for?: string;
@@ -298,6 +309,8 @@ declare const VolumeSliderElement: import("vue").VueElementConstructor<ResolvedP
 declare const TimeDisplayElement: import("vue").VueElementConstructor<ResolvedPlayerProps>;
 declare const TranscriptElement: import("vue").VueElementConstructor<ResolvedPlayerProps & {
   cues?: TranscriptCue[] | string;
+  speechPitch?: number;
+  speechRate?: number;
 }>;
 //#endregion
-export { BufferingElement, CaptionsButtonElement, type EmbedAdapterFactory, type EmbedAdapterOptions, FullscreenButtonElement, HideMarkerElement, LoopButtonElement, type Matcher, type MediaErrorLike, MuteButtonElement, PipButtonElement, type PlatformConfig, PlayButtonElement, type PlaybackAdapter, PlaybackRateButtonElement, QualityButtonElement, type ResolvedSource, ScrubberElement, type SourceResolver, TimeDisplayElement, TranscriptElement, VideoCardElement, VideoPlaceholderElement, VideoPlayerElement, VideoStageElement, VolumeSliderElement };
+export { type AdapterCaptions, type AdapterPip, type AdapterQuality, BufferingElement, CaptionsButtonElement, type EmbedAdapterFactory, type EmbedAdapterOptions, FullscreenButtonElement, HideMarkerElement, LoopButtonElement, type Matcher, type MediaErrorLike, MuteButtonElement, PipButtonElement, type PlatformConfig, PlayButtonElement, type PlaybackAdapter, type PlaybackEvent, PlaybackRateButtonElement, QualityButtonElement, type ResolvedSource, ScrubberElement, type SourceResolver, TimeDisplayElement, TranscriptElement, VideoCardElement, VideoPlaceholderElement, VideoPlayerElement, VideoStageElement, VolumeSliderElement };