@munsonlabs/video-player 0.2.3 → 0.2.5

package/dist/elements/index.d.mts

@@ -1,18 +1,7 @@
-import "vue";
+import { Ref, UnwrapNestedRefs } from "vue";
 //#region src/composables/player/emitter.d.ts
 type PlaybackListener = (...args: unknown[]) => void;
 //#endregion
-//#region src/adapters/embeds/embedShared.d.ts
-interface EmbedAdapterOptions {
-  src: string;
-  poster?: string;
-  autoplay?: boolean;
-  muted?: boolean;
-  volume?: number;
-  nativeUi?: boolean;
-  customVars?: Record<string, unknown>;
-}
-//#endregion
 //#region src/types/playback.d.ts
 interface MediaErrorLike {
   code: number;
@@ -31,7 +20,7 @@ interface QualityLevelInfo {
 }
 interface PlaybackAdapter {
   readonly el: HTMLElement;
-  play(): void | Promise<void>;
+  play(): Promise<void>;
   pause(): void;
   paused(): boolean;
   currentTime(): number;
@@ -61,7 +50,7 @@ interface PlaybackAdapter {
   togglePip(): void;
   enterFullscreen(): void;
   exitFullscreen(): void;
-  on(event: string | string[], listener: PlaybackListener): void;
+  on(event: string, listener: PlaybackListener): void;
   off(event: string, listener: PlaybackListener): void;
   dispose(): void;
 }
@@ -76,6 +65,14 @@ interface Matcher {
   key: string;
   embed: boolean;
 }
+interface EmbedAdapterOptions {
+  src: string;
+  poster?: string;
+  autoplay?: boolean;
+  muted?: boolean;
+  volume?: number;
+  nativeUi?: boolean;
+}
 type EmbedAdapterFactory = (videoEl: HTMLVideoElement, options: EmbedAdapterOptions) => PlaybackAdapter;
 type SourceResolver = (url: string) => ResolvedSource | Promise<ResolvedSource>;
 type PlatformConfig = Pick<Matcher, 'key' | 'test'> & ({
@@ -86,6 +83,96 @@ type PlatformConfig = Pick<Matcher, 'key' | 'test'> & ({
   resolveSource?: SourceResolver;
 });
 //#endregion
+//#region src/composables/player/playerState.d.ts
+declare function createPlayerState(props: PlayerProps): {
+  isPlaying: import("vue").Ref<boolean, boolean>;
+  hasEnded: import("vue").Ref<boolean, boolean>;
+  isReady: import("vue").Ref<boolean, boolean>;
+  isLoaded: import("vue").Ref<boolean, boolean>;
+  isLive: import("vue").Ref<boolean, boolean>;
+  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>;
+  buffered: import("vue").Ref<number, number>;
+  progress: import("vue").ComputedRef<number>;
+  bufferedDisplay: import("vue").ComputedRef<number>;
+  vol: import("vue").Ref<number, number>;
+  isMuted: import("vue").Ref<boolean, boolean>;
+  isAudible: import("vue").ComputedRef<boolean>;
+  isLooping: import("vue").Ref<boolean, boolean>;
+  currentPlaybackRate: import("vue").Ref<number, number>;
+  supportsPlaybackRate: import("vue").Ref<boolean, boolean>;
+  isAdPlaying: import("vue").Ref<boolean, boolean>;
+  isAdPaused: import("vue").Ref<boolean, boolean>;
+  isAdMuted: import("vue").Ref<boolean, boolean>;
+  adRemainingTime: import("vue").Ref<number, number>;
+  supportsCaptions: import("vue").Ref<boolean, boolean>;
+  captionTracks: import("vue").Ref<{
+    index: number;
+    label: string;
+    language: string;
+  }[], CaptionTrackInfo[] | {
+    index: number;
+    label: string;
+    language: string;
+  }[]>;
+  activeCaptionIndex: import("vue").Ref<number | null, number | null>;
+  supportsQuality: import("vue").Ref<boolean, boolean>;
+  qualityLevels: import("vue").Ref<{
+    index: number;
+    height: number;
+    bitrate: number;
+    label: string;
+  }[], QualityLevelInfo[] | {
+    index: number;
+    height: number;
+    bitrate: number;
+    label: string;
+  }[]>;
+  currentQualityIndex: 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>;
+  isNativeUi: import("vue").Ref<boolean, boolean>;
+};
+type PlayerState = ReturnType<typeof createPlayerState>;
+//#endregion
+//#region src/composables/player/usePlayerControls.d.ts
+interface UsePlayerControlsReturn {
+  play: () => Promise<void>;
+  pause: () => void;
+  replay: () => Promise<void>;
+  togglePlay: () => void;
+  seek: (percent: number) => void;
+  seekTo: (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;
+  togglePip: () => void;
+}
+//#endregion
+//#region src/composables/player/usePlayer.d.ts
+type UsePlayerReturn = PlayerState & UsePlayerControlsReturn & {
+  fire: (type: StateChangeType, extras?: Partial<StateChangeEvent>) => void;
+  retry: () => void;
+  isBuffering: Ref<boolean>;
+  toggleAdMute: () => void;
+  isFullscreen: Ref<boolean>;
+  isFullscreenPending: Ref<boolean>;
+  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"];
+type PlayerMethodKey = (typeof PLAYER_METHOD_KEYS)[number];
+type PlayerStateKey = (typeof PLAYER_STATE_KEYS)[number];
+//#endregion
 //#region src/types/player.d.ts
 type BuiltinAction = 'mute' | 'loop' | 'autoplay';
 interface CustomAction {
@@ -94,6 +181,25 @@ interface CustomAction {
   onClick: () => void;
 }
 type PlayerAction = BuiltinAction | CustomAction;
+type StateChangeType = 'loaded' | 'play' | 'pause' | 'ended' | 'seeked' | 'error' | 'adstart' | 'adend' | 'volumechange' | 'ratechange' | 'captionchange' | 'qualitychange' | 'pipchange' | 'loopchange' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'controlsopen' | 'controlsclose' | 'stageopen' | 'stageclose' | 'bufferstart' | 'bufferend' | 'timeupdate' | 'tap';
+interface StateChangeEvent {
+  type: StateChangeType;
+  currentTime: number;
+  duration: number;
+  src: string;
+  error?: {
+    code: number;
+    message: string;
+  } | null;
+  isMuted?: boolean;
+  playbackRate?: number;
+  captionIndex?: number | null;
+  qualityIndex?: number | null;
+  isPipActive?: boolean;
+  isLooping?: boolean;
+  element?: HTMLElement | null;
+  payload?: Record<string, unknown>;
+}
 interface HeaderBiddingAdUnit {
   code: string;
   mediaTypes: {
@@ -118,7 +224,7 @@ interface CaptionTrackDef {
 }
 interface PlayerProps {
   src: string;
-  title?: string;
+  label?: string;
   poster?: string;
   aspectRatio?: string;
   adTagUrl?: string;
@@ -130,8 +236,6 @@ interface PlayerProps {
   volume?: number;
   playbackRate?: number;
   nativeUi?: boolean;
-  autoStage?: boolean;
-  lazy?: boolean;
   payload?: Record<string, unknown> | string;
   action?: PlayerAction | null;
   disableTapCapture?: boolean;
@@ -139,74 +243,37 @@ interface PlayerProps {
   controls?: boolean;
   playInView?: boolean;
   pin?: PinCorner;
+  loop?: boolean;
+  preload?: PreloadMode;
 }
 type PinCorner = 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-type VideoEntry = PlayerProps;
-interface VideoSelectDetail extends VideoEntry {
-  fromGesture?: boolean;
+type PreloadMode = 'none' | 'metadata' | 'auto';
+interface VideoEntry extends PlayerProps {
+  lazy?: boolean;
+  autoStage?: boolean;
 }
 interface TranscriptCue {
   time: number;
   end?: number;
   text: string;
 }
-interface PlayerHandle {
-  isPlaying: boolean;
-  togglePlay(): void;
-  hasEnded: boolean;
-  isError: boolean;
-  retry(): void;
-  isMuted: boolean;
-  toggleMute(): void;
-  isAudible: boolean;
-  isFullscreen: boolean;
-  toggleFullscreen(): void;
-  current: number;
-  total: number;
-  seek(percent: number): void;
-  bufferedDisplay: number;
-  isBuffering: boolean;
-  isLive: boolean;
-  vol: number;
-  setVolume(vol: number): void;
-  isLooping: boolean;
-  toggleLoop(): void;
-  supportsPip: boolean;
-  isPipActive: boolean;
-  togglePip(): void;
-  supportsCaptions: boolean;
-  captionTracks: CaptionTrackInfo[];
-  activeCaptionIndex: number | null;
-  setCaptionTrack(index: number | null): void;
-  supportsQuality: boolean;
-  qualityLevels: QualityLevelInfo[];
-  currentQualityIndex: number | null;
-  isAutoQuality: boolean;
-  setQuality(index: number | null): void;
-  supportsPlaybackRate: boolean;
-  currentPlaybackRate: number;
-  setPlaybackRate(rate: number): void;
-}
+type PlayerHandle = Pick<UnwrapNestedRefs<UsePlayerReturn>, PlayerMethodKey | PlayerStateKey>;
 //#endregion
 //#region src/adapters/index.d.ts
-export declare function registerMatcher(matcher: Matcher): void;
-export declare function registerEmbedAdapter(key: string, factory: EmbedAdapterFactory): void;
-export declare function registerSourceResolver(key: string, resolver: SourceResolver): void;
+export declare function resolvePlatform(url: string): {
+  key: string;
+  embed: boolean;
+};
 export declare function registerPlatform(config: PlatformConfig): void;
 //#endregion
 //#region src/elements/core.d.ts
-declare const VideoPlayerElement: import("vue").VueElementConstructor<PlayerProps & {
-  hasPlaylist?: boolean;
-  hasNext?: boolean;
-  hasPrevious?: boolean;
-  autoAdvance?: boolean;
-}>;
+declare const VideoPlayerElement: import("vue").VueElementConstructor<PlayerProps>;
 declare const VideoStageElement: import("vue").VueElementConstructor<{
-  pin?: "bottom-right" | "bottom-left" | "top-right" | "top-left" | "full-width";
+  pin?: PinCorner | "full-width";
   playlist?: VideoEntry[];
 }>;
-declare const VideoPlaceholderElement: import("vue").VueElementConstructor<VideoSelectDetail>;
-declare const VideoCardElement: import("vue").VueElementConstructor<VideoSelectDetail>;
+declare const VideoPlaceholderElement: import("vue").VueElementConstructor<VideoEntry>;
+declare const VideoCardElement: import("vue").VueElementConstructor<VideoEntry>;
 declare const HideMarkerElement: import("vue").VueElementConstructor<{}>;
 export declare function defineElements(): void;
 //#endregion