@video-lab/react-frame 3.1.0 → 4.0.1

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import { AudioHealthPayload, BufferHealthPayload, ControlVisibilityConfig, DanmakuConfig, DanmakuItem, DeliveredPlayerEvent, FirstFramePayload, FrameFreezePayload, KernelHealthPayload, LocaleConfig, MediaSource, PageFullscreenAdapter, PageFullscreenAdapter as PageFullscreenAdapter$1, PageFullscreenState, PageFullscreenState as PageFullscreenState$1, PauseImageConfig, PlaybackContext, PlaybackContextPayload, PlayerError, PlayerEvent, PosterConfig, PresetName, QualityLevel, SourceRouteEventPayload, SubtitleTrackInfo, UserActionPayload } from "@video-lab/protocol";
+import { AudioHealthPayload, BufferHealthPayload, ControlVisibilityConfig, DanmakuConfig, DanmakuItem, ErrorActionResult, ErrorButtonColors, FirstFramePayload, FrameFreezePayload, KernelHealthPayload, LoadingOverlayContext, LocaleConfig, MediaSource, PageFullscreenAdapter, PageFullscreenAdapter as PageFullscreenAdapter$1, PageFullscreenState, PageFullscreenState as PageFullscreenState$1, PauseImageConfig, PlaybackContext, PlaybackContextPayload, PlayerError, PlayerEvent, PosterConfig, PresetName, QualityLevel, ResolveSource, SourceRouteEventPayload, SubtitleTrackInfo, UserActionPayload } from "@video-lab/protocol";
+import { PlayerProvider, PlayerProviderProps, usePlayerI18n } from "@video-lab/react-config";
 import { PlayerFrameHandle } from "@video-lab/frame-core";
 import { CSSProperties, ReactNode } from "react";
 //#region src/types.d.ts
@@ -22,14 +23,29 @@ interface VideoPlayerFrameProps {
   pageFullscreen?: PageFullscreenAdapter$1;
   /** 视频源。字符串按 URL 处理,对象可带 type / live / hls 等 */
   source: MediaSource | string;
+  /** 当前 URL 授权失效时由宿主取得完整新源；函数不会跨 iframe 传输。 */
+  resolveSource?: ResolveSource;
   autoplay?: boolean;
   muted?: boolean;
   loop?: boolean;
   controls?: boolean;
   /** 默认错误覆盖层，省略时开启。仅初始化读取；变更须重新挂载，不影响错误事件。 */
   showErrorOverlay?: boolean;
-  /** 是否显示 SDK 运行时 Loading；构造期读取，默认 true。 */
-  showLoadingOverlay?: boolean;
+  /** 是否显示 SDK 默认运行时 Loading；构造期读取，默认 true。 */
+  showDefaultLoadingOverlay?: boolean;
+  /** 在默认 Loading 转圈下显示状态文案；默认 false。 */
+  showLoadingText?: boolean;
+  /** 默认错误动作按钮的背景色与文字色；五种接入方式一致。 */
+  errorButtonColors?: ErrorButtonColors;
+  /**
+   * 在宿主 DOM 中渲染首次与运行时 Loading。传入后替换 iframe 内默认 Loading；
+   * 显隐和阶段由 SDK 管理，不受 `showDefaultLoadingOverlay` 影响。
+   */
+  renderLoading?: (context: LoadingOverlayContext) => ReactNode;
+  /** 自定义封面；显隐由 SDK 管理，在宿主 DOM 中渲染。 */
+  renderPoster?: () => ReactNode;
+  /** 自定义暂停画面；显隐由 SDK 管理，在宿主 DOM 中渲染。 */
+  renderPause?: () => ReactNode;
   /** 内置控件初始化显示策略；修改后须由宿主显式重建播放器。 */
   controlVisibility?: ControlVisibilityConfig;
   /** false 时播放器不接收指针事件(点击穿透到下层) */
@@ -56,14 +72,14 @@ interface VideoPlayerFrameProps {
    */
   preload?: 'none' | 'metadata' | 'auto';
   /** 封面。字符串按 URL 处理,对象形态可带 `fit` / `loading` —— 和 inline 面同宽(契约 PosterConfig) */
-  poster?: string | PosterConfig;
+  poster?: string | PosterConfig | null;
   /**
    * 暂停时盖在画面中央的静态图(ADR-043)。字符串按 URL 处理,对象形态可带
-   * `fit`(默认 `contain`,与封面的 `cover` 不同 —— 暂停图通常是完整构图)/ `closable`。
+   * `fit`(默认 `contain`,与封面的 `cover` 不同 —— 暂停图通常是完整构图)。
    *
    * **带倒计时 / 跳转 / 推荐列表的不在这里做** —— 那是业务调度,归团队封装层(ADR-025)。
    */
-  pauseImage?: string | PauseImageConfig;
+  pauseImage?: string | PauseImageConfig | null;
   preset?: PresetName;
   /** iframe 部署基础 URL，可包含自定义目录。 */
   origin?: string;
@@ -86,7 +102,6 @@ interface VideoPlayerFrameProps {
   children?: ReactNode;
   /** 完整的契约事件流，供遥测适配器使用；不裁剪 iframe 转发的 payload。 */
   onPlayerEvent?: (event: PlayerEvent) => void;
-  onDeliveredPlayerEvent?: (event: DeliveredPlayerEvent) => void;
   /**
    * metadata 就绪。`quality` 是可切档位清单(单码率源为空数组),团队层据此渲染清晰度菜单;
    * `subtitles` 是可切字幕轨清单(无字幕源为空/缺省,契约 1.0.0 起可选,ADR-027),团队层据此渲染字幕菜单。
@@ -246,6 +261,8 @@ interface VideoPlayerFrameHandle {
   /** 清空屏上弹幕(ADR-028) */
   clearDanmaku(): Promise<void>;
   retry(): Promise<void>;
+  /** 执行当前终态的默认错误按钮动作；无动作或已销毁时返回 unavailable。 */
+  performErrorAction(): Promise<ErrorActionResult>;
   destroy(): Promise<void>;
   getCurrentTime(): number;
   getDuration(): number;
@@ -283,5 +300,4 @@ interface VideoPlayerFrameHandle {
  */
 declare const VideoPlayerFrame: import("react").ForwardRefExoticComponent<VideoPlayerFrameProps & import("react").RefAttributes<VideoPlayerFrameHandle>>;
 //#endregion
-export { type DanmakuConfig, type DanmakuItem, type MediaSource, type PageFullscreenAdapter, type PageFullscreenState, type PlayerError, type PlayerHandle, type QualityLevel, type SubtitleTrackInfo, VideoPlayerFrame, type VideoPlayerFrameHandle, type VideoPlayerFrameProps };
-//# sourceMappingURL=index.d.cts.map
+export { type DanmakuConfig, type DanmakuItem, type LoadingOverlayContext, type MediaSource, type PageFullscreenAdapter, type PageFullscreenState, type PlayerError, type PlayerHandle, PlayerProvider, type PlayerProviderProps, type QualityLevel, type ResolveSource, type SubtitleTrackInfo, VideoPlayerFrame, type VideoPlayerFrameHandle, type VideoPlayerFrameProps, usePlayerI18n };

package/dist/index.d.mts

@@ -1,6 +1,7 @@
+import { PlayerProvider, PlayerProviderProps, usePlayerI18n } from "@video-lab/react-config";
+import { AudioHealthPayload, BufferHealthPayload, ControlVisibilityConfig, DanmakuConfig, DanmakuItem, ErrorActionResult, ErrorButtonColors, FirstFramePayload, FrameFreezePayload, KernelHealthPayload, LoadingOverlayContext, LocaleConfig, MediaSource, PageFullscreenAdapter, PageFullscreenAdapter as PageFullscreenAdapter$1, PageFullscreenState, PageFullscreenState as PageFullscreenState$1, PauseImageConfig, PlaybackContext, PlaybackContextPayload, PlayerError, PlayerEvent, PosterConfig, PresetName, QualityLevel, ResolveSource, SourceRouteEventPayload, SubtitleTrackInfo, UserActionPayload } from "@video-lab/protocol";
 import { CSSProperties, ReactNode } from "react";
 import { PlayerFrameHandle } from "@video-lab/frame-core";
-import { AudioHealthPayload, BufferHealthPayload, ControlVisibilityConfig, DanmakuConfig, DanmakuItem, DeliveredPlayerEvent, FirstFramePayload, FrameFreezePayload, KernelHealthPayload, LocaleConfig, MediaSource, PageFullscreenAdapter, PageFullscreenAdapter as PageFullscreenAdapter$1, PageFullscreenState, PageFullscreenState as PageFullscreenState$1, PauseImageConfig, PlaybackContext, PlaybackContextPayload, PlayerError, PlayerEvent, PosterConfig, PresetName, QualityLevel, SourceRouteEventPayload, SubtitleTrackInfo, UserActionPayload } from "@video-lab/protocol";
 //#region src/types.d.ts
 /**
  * 消费方拿到的播放器句柄(逃生舱)。
@@ -22,14 +23,29 @@ interface VideoPlayerFrameProps {
   pageFullscreen?: PageFullscreenAdapter$1;
   /** 视频源。字符串按 URL 处理,对象可带 type / live / hls 等 */
   source: MediaSource | string;
+  /** 当前 URL 授权失效时由宿主取得完整新源；函数不会跨 iframe 传输。 */
+  resolveSource?: ResolveSource;
   autoplay?: boolean;
   muted?: boolean;
   loop?: boolean;
   controls?: boolean;
   /** 默认错误覆盖层，省略时开启。仅初始化读取；变更须重新挂载，不影响错误事件。 */
   showErrorOverlay?: boolean;
-  /** 是否显示 SDK 运行时 Loading；构造期读取，默认 true。 */
-  showLoadingOverlay?: boolean;
+  /** 是否显示 SDK 默认运行时 Loading；构造期读取，默认 true。 */
+  showDefaultLoadingOverlay?: boolean;
+  /** 在默认 Loading 转圈下显示状态文案；默认 false。 */
+  showLoadingText?: boolean;
+  /** 默认错误动作按钮的背景色与文字色；五种接入方式一致。 */
+  errorButtonColors?: ErrorButtonColors;
+  /**
+   * 在宿主 DOM 中渲染首次与运行时 Loading。传入后替换 iframe 内默认 Loading；
+   * 显隐和阶段由 SDK 管理，不受 `showDefaultLoadingOverlay` 影响。
+   */
+  renderLoading?: (context: LoadingOverlayContext) => ReactNode;
+  /** 自定义封面；显隐由 SDK 管理，在宿主 DOM 中渲染。 */
+  renderPoster?: () => ReactNode;
+  /** 自定义暂停画面；显隐由 SDK 管理，在宿主 DOM 中渲染。 */
+  renderPause?: () => ReactNode;
   /** 内置控件初始化显示策略；修改后须由宿主显式重建播放器。 */
   controlVisibility?: ControlVisibilityConfig;
   /** false 时播放器不接收指针事件(点击穿透到下层) */
@@ -56,14 +72,14 @@ interface VideoPlayerFrameProps {
    */
   preload?: 'none' | 'metadata' | 'auto';
   /** 封面。字符串按 URL 处理,对象形态可带 `fit` / `loading` —— 和 inline 面同宽(契约 PosterConfig) */
-  poster?: string | PosterConfig;
+  poster?: string | PosterConfig | null;
   /**
    * 暂停时盖在画面中央的静态图(ADR-043)。字符串按 URL 处理,对象形态可带
-   * `fit`(默认 `contain`,与封面的 `cover` 不同 —— 暂停图通常是完整构图)/ `closable`。
+   * `fit`(默认 `contain`,与封面的 `cover` 不同 —— 暂停图通常是完整构图)。
    *
    * **带倒计时 / 跳转 / 推荐列表的不在这里做** —— 那是业务调度,归团队封装层(ADR-025)。
    */
-  pauseImage?: string | PauseImageConfig;
+  pauseImage?: string | PauseImageConfig | null;
   preset?: PresetName;
   /** iframe 部署基础 URL，可包含自定义目录。 */
   origin?: string;
@@ -86,7 +102,6 @@ interface VideoPlayerFrameProps {
   children?: ReactNode;
   /** 完整的契约事件流，供遥测适配器使用；不裁剪 iframe 转发的 payload。 */
   onPlayerEvent?: (event: PlayerEvent) => void;
-  onDeliveredPlayerEvent?: (event: DeliveredPlayerEvent) => void;
   /**
    * metadata 就绪。`quality` 是可切档位清单(单码率源为空数组),团队层据此渲染清晰度菜单;
    * `subtitles` 是可切字幕轨清单(无字幕源为空/缺省,契约 1.0.0 起可选,ADR-027),团队层据此渲染字幕菜单。
@@ -246,6 +261,8 @@ interface VideoPlayerFrameHandle {
   /** 清空屏上弹幕(ADR-028) */
   clearDanmaku(): Promise<void>;
   retry(): Promise<void>;
+  /** 执行当前终态的默认错误按钮动作；无动作或已销毁时返回 unavailable。 */
+  performErrorAction(): Promise<ErrorActionResult>;
   destroy(): Promise<void>;
   getCurrentTime(): number;
   getDuration(): number;
@@ -283,5 +300,4 @@ interface VideoPlayerFrameHandle {
  */
 declare const VideoPlayerFrame: import("react").ForwardRefExoticComponent<VideoPlayerFrameProps & import("react").RefAttributes<VideoPlayerFrameHandle>>;
 //#endregion
-export { type DanmakuConfig, type DanmakuItem, type MediaSource, type PageFullscreenAdapter, type PageFullscreenState, type PlayerError, type PlayerHandle, type QualityLevel, type SubtitleTrackInfo, VideoPlayerFrame, type VideoPlayerFrameHandle, type VideoPlayerFrameProps };
-//# sourceMappingURL=index.d.mts.map
+export { type DanmakuConfig, type DanmakuItem, type LoadingOverlayContext, type MediaSource, type PageFullscreenAdapter, type PageFullscreenState, type PlayerError, type PlayerHandle, PlayerProvider, type PlayerProviderProps, type QualityLevel, type ResolveSource, type SubtitleTrackInfo, VideoPlayerFrame, type VideoPlayerFrameHandle, type VideoPlayerFrameProps, usePlayerI18n };