@volcengine/veplayer 2.12.0 → 2.12.2-rc.0

package/veplayer.d.ts

@@ -5424,6 +5424,7 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5468,6 +5469,7 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5619,15 +5621,56 @@ declare class Sources extends OptionsIcon {
         to: Source;
     }): void;
 }
+/**
+ * @brief 自动播放配置。
+ * @list Options
+ * @kind property
+ */
+/** {en}
+ * @brief Autoplay configuration.
+ * @list Options
+ * @kind property
+ */
 interface IAutoplayPluginConfig {
+    /**
+     * @hidden
+     */
     position?: string;
-    // 有声音自动播放失败时是否降级成静音自动播放
+    /** {zh}
+     * @brief 有声音自动播放失败时是否降级成静音自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
+     * @default false
+     */
     enableDegradeMuteAutoplay?: boolean;
-    // 启用微信jsBridge方式的自动播放
+    /** {zh}
+     * @brief 启用微信jsBridge方式的自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to enable wxJsBridge autoplay.
+     * @default false
+     */
     enableWxJsBridgeAutoplay?: boolean;
-    // 用户触发自动播放的目标dom
+    /** {zh}
+     * @brief 用户触发自动播放的目标dom。
+     * @default window.document.body
+     */
+    /** {en}
+     * @brief The target dom of user action autoplay.
+     * @default window.document.body
+     */
     userActionDom?: Node;
-    // 开启任意点击/触摸的用户行为触发自动播放
+    /** {zh}
+     * @brief 开启任意点击/触摸的用户行为触发自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to enable user action autoplay.
+     * @default false
+     */
     enableUserActionAutoplay?: boolean;
 }
 declare class Autoplay extends Plugin {
@@ -10764,15 +10807,56 @@ declare namespace live {
             to: Source;
         }): void;
     }
+    /**
+     * @brief 自动播放配置。
+     * @list Options
+     * @kind property
+     */
+    /** {en}
+     * @brief Autoplay configuration.
+     * @list Options
+     * @kind property
+     */
     interface IAutoplayPluginConfig {
+        /**
+         * @hidden
+         */
         position?: string;
-        // 有声音自动播放失败时是否降级成静音自动播放
+        /** {zh}
+         * @brief 有声音自动播放失败时是否降级成静音自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
+         * @default false
+         */
         enableDegradeMuteAutoplay?: boolean;
-        // 启用微信jsBridge方式的自动播放
+        /** {zh}
+         * @brief 启用微信jsBridge方式的自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to enable wxJsBridge autoplay.
+         * @default false
+         */
         enableWxJsBridgeAutoplay?: boolean;
-        // 用户触发自动播放的目标dom
+        /** {zh}
+         * @brief 用户触发自动播放的目标dom。
+         * @default window.document.body
+         */
+        /** {en}
+         * @brief The target dom of user action autoplay.
+         * @default window.document.body
+         */
         userActionDom?: Node;
-        // 开启任意点击/触摸的用户行为触发自动播放
+        /** {zh}
+         * @brief 开启任意点击/触摸的用户行为触发自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to enable user action autoplay.
+         * @default false
+         */
         enableUserActionAutoplay?: boolean;
     }
     class Autoplay extends Plugin {
@@ -13561,6 +13645,13 @@ declare namespace live {
          * The player parses the SEI information.
          */
         SEI = "sei",
+        /** {zh}
+         * SEI 信息与播放进度对齐。SEI 在解析后会被缓存，待播放进度到达该 SEI 对应的时间点时抛出。
+         */
+        /** {en}
+         * The SEI information is aligned with the playback progress. The player caches the parsed SEI and emits it when the playback progress reaches the timestamp of the SEI.
+         */
+        SEI_IN_TIME = "seiInTime",
         /** {zh}
          * 时移状态切换
          */
@@ -14232,6 +14323,67 @@ declare namespace live {
                 uuid: string;
             };
         }) => void;
+        /** {zh}
+         * SEI 信息与播放进度对齐。
+         * @param data SEI 信息，与 SEI 事件的回调数据结构一致
+         */
+        /** {en}
+         * The SEI information is aligned with the playback progress.
+         * @param data The SEI information. The data structure is the same as that of the SEI event.
+         */
+        [LiveEvents.SEI_IN_TIME]: (data: {
+            /** {zh}
+             * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
+             */
+            /** {en}
+             * The actual presentation timestamp (PTS) of the video frame.
+             */
+            originPts: number;
+            /** {zh}
+             * 修正后的 PTS。在直播场景中，播放器会根据观众进入直播间时间，从 0 开始重新定义显示时间戳 PTS。
+             */
+            /** {en}
+             * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
+             */
+            pts: number;
+            /** {zh}
+             * 该 SEI 消息在当前直播视频中的时间点，单位为 s。
+             */
+            /** {en}
+             * The timestamp of the SEI message in the current live stream, in seconds.
+             */
+            time: number;
+            data: {
+                /** {zh}
+                 * SEI 数据。
+                 */
+                /** {en}
+                 * The SEI data.
+                 */
+                payload: Uint8Array;
+                /** {zh}
+                 * SEI 类型。
+                 */
+                /** {en}
+                 * The SEI type.
+                 */
+                type: number;
+                /** {zh}
+                 * SEI 大小。
+                 */
+                /** {en}
+                 * The SEI size.
+                 */
+                size: number;
+                /** {zh}
+                 * SEI UUID，不存在则为空字符串。
+                 */
+                /** {en}
+                 * The SEI UUID or an empty string if the SEI UUID doesn't exist.
+                 */
+                uuid: string;
+            };
+        }) => void;
         /** {zh}
          * @brief 时移状态切换。
          * @param isTimeShift 是否是时移状态。
@@ -14473,6 +14625,7 @@ declare namespace live {
         HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
         HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;

package/veplayer.live.d.ts

@@ -5424,6 +5424,7 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5468,6 +5469,7 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5619,15 +5621,56 @@ declare class Sources extends OptionsIcon {
         to: Source;
     }): void;
 }
+/**
+ * @brief 自动播放配置。
+ * @list Options
+ * @kind property
+ */
+/** {en}
+ * @brief Autoplay configuration.
+ * @list Options
+ * @kind property
+ */
 interface IAutoplayPluginConfig {
+    /**
+     * @hidden
+     */
     position?: string;
-    // 有声音自动播放失败时是否降级成静音自动播放
+    /** {zh}
+     * @brief 有声音自动播放失败时是否降级成静音自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
+     * @default false
+     */
     enableDegradeMuteAutoplay?: boolean;
-    // 启用微信jsBridge方式的自动播放
+    /** {zh}
+     * @brief 启用微信jsBridge方式的自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to enable wxJsBridge autoplay.
+     * @default false
+     */
     enableWxJsBridgeAutoplay?: boolean;
-    // 用户触发自动播放的目标dom
+    /** {zh}
+     * @brief 用户触发自动播放的目标dom。
+     * @default window.document.body
+     */
+    /** {en}
+     * @brief The target dom of user action autoplay.
+     * @default window.document.body
+     */
     userActionDom?: Node;
-    // 开启任意点击/触摸的用户行为触发自动播放
+    /** {zh}
+     * @brief 开启任意点击/触摸的用户行为触发自动播放。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to enable user action autoplay.
+     * @default false
+     */
     enableUserActionAutoplay?: boolean;
 }
 declare class Autoplay extends Plugin {
@@ -10764,15 +10807,56 @@ declare namespace live {
             to: Source;
         }): void;
     }
+    /**
+     * @brief 自动播放配置。
+     * @list Options
+     * @kind property
+     */
+    /** {en}
+     * @brief Autoplay configuration.
+     * @list Options
+     * @kind property
+     */
     interface IAutoplayPluginConfig {
+        /**
+         * @hidden
+         */
         position?: string;
-        // 有声音自动播放失败时是否降级成静音自动播放
+        /** {zh}
+         * @brief 有声音自动播放失败时是否降级成静音自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
+         * @default false
+         */
         enableDegradeMuteAutoplay?: boolean;
-        // 启用微信jsBridge方式的自动播放
+        /** {zh}
+         * @brief 启用微信jsBridge方式的自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to enable wxJsBridge autoplay.
+         * @default false
+         */
         enableWxJsBridgeAutoplay?: boolean;
-        // 用户触发自动播放的目标dom
+        /** {zh}
+         * @brief 用户触发自动播放的目标dom。
+         * @default window.document.body
+         */
+        /** {en}
+         * @brief The target dom of user action autoplay.
+         * @default window.document.body
+         */
         userActionDom?: Node;
-        // 开启任意点击/触摸的用户行为触发自动播放
+        /** {zh}
+         * @brief 开启任意点击/触摸的用户行为触发自动播放。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to enable user action autoplay.
+         * @default false
+         */
         enableUserActionAutoplay?: boolean;
     }
     class Autoplay extends Plugin {
@@ -13561,6 +13645,13 @@ declare namespace live {
          * The player parses the SEI information.
          */
         SEI = "sei",
+        /** {zh}
+         * SEI 信息与播放进度对齐。SEI 在解析后会被缓存，待播放进度到达该 SEI 对应的时间点时抛出。
+         */
+        /** {en}
+         * The SEI information is aligned with the playback progress. The player caches the parsed SEI and emits it when the playback progress reaches the timestamp of the SEI.
+         */
+        SEI_IN_TIME = "seiInTime",
         /** {zh}
          * 时移状态切换
          */
@@ -14232,6 +14323,67 @@ declare namespace live {
                 uuid: string;
             };
         }) => void;
+        /** {zh}
+         * SEI 信息与播放进度对齐。
+         * @param data SEI 信息，与 SEI 事件的回调数据结构一致
+         */
+        /** {en}
+         * The SEI information is aligned with the playback progress.
+         * @param data The SEI information. The data structure is the same as that of the SEI event.
+         */
+        [LiveEvents.SEI_IN_TIME]: (data: {
+            /** {zh}
+             * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
+             */
+            /** {en}
+             * The actual presentation timestamp (PTS) of the video frame.
+             */
+            originPts: number;
+            /** {zh}
+             * 修正后的 PTS。在直播场景中，播放器会根据观众进入直播间时间，从 0 开始重新定义显示时间戳 PTS。
+             */
+            /** {en}
+             * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
+             */
+            pts: number;
+            /** {zh}
+             * 该 SEI 消息在当前直播视频中的时间点，单位为 s。
+             */
+            /** {en}
+             * The timestamp of the SEI message in the current live stream, in seconds.
+             */
+            time: number;
+            data: {
+                /** {zh}
+                 * SEI 数据。
+                 */
+                /** {en}
+                 * The SEI data.
+                 */
+                payload: Uint8Array;
+                /** {zh}
+                 * SEI 类型。
+                 */
+                /** {en}
+                 * The SEI type.
+                 */
+                type: number;
+                /** {zh}
+                 * SEI 大小。
+                 */
+                /** {en}
+                 * The SEI size.
+                 */
+                size: number;
+                /** {zh}
+                 * SEI UUID，不存在则为空字符串。
+                 */
+                /** {en}
+                 * The SEI UUID or an empty string if the SEI UUID doesn't exist.
+                 */
+                uuid: string;
+            };
+        }) => void;
         /** {zh}
          * @brief 时移状态切换。
          * @param isTimeShift 是否是时移状态。
@@ -14473,6 +14625,7 @@ declare namespace live {
         HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
         HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;

package/veplayer.vod.d.ts

@@ -5080,6 +5080,7 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5124,6 +5125,7 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
+        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;