@volcengine/veplayer 2.12.0-rc.2 → 2.12.1

package/veplayer.d.ts

@@ -5619,15 +5619,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 +10805,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 {

package/veplayer.live.d.ts

@@ -5619,15 +5619,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 +10805,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 {