@volcengine/veplayer 2.5.0 → 2.6.0-rc.0

package/veplayer.d.ts

@@ -4167,7 +4167,6 @@ declare namespace strategy {
     }
     type StrategyCreator<T, R extends keyof ModulesMap = any> = (options?: T) => Strategy<T, R>;
     const createFlvMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
-    const createFlvMssStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
     const createHlsMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginHls>;
     const createSoftDecodeH264Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
     const createSoftDecodeH265Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
@@ -4219,12 +4218,10 @@ declare function isMseSupported(codec?: string): boolean;
  * @returns
  */
 declare function isSoftDecodeSupported(): Promise<boolean>;
-declare function isMMSSupported(): boolean;
 declare const util: {
     getStreamType: typeof getStreamType;
     isMseSupported: typeof isMseSupported;
     isSoftDecodeSupported: typeof isSoftDecodeSupported;
-    isMMSSupported: typeof isMMSSupported;
     appendSearchParams: (url?: string | undefined, searchParams?: Record<string, string> | undefined) => string;
     getUrlObject: (url?: string | undefined) => URL | undefined;
     createDom(el?: string | undefined, tpl?: string | undefined, attrs?: {
@@ -5265,6 +5262,13 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      * @brief Configures the information panel for the player, including options to show/hide the panel and the time interval between each information update. The panel supports displaying information for HLS and FLV addresses. If you opt for software decoding, additional information related to software decoding will be displayed.
      */
     infoPanel?: InfoPanelConfig;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @brief Configurations for advertising
+     */
+    ad?: AdConfig;
     /** {zh}
      * @brief 为播放器设置直播时移配置，接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
      */
@@ -5526,6 +5530,76 @@ interface TimeShiftConfig {
      */
     position?: string;
 }
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Advertising schedule for a single ad break
+ */
+interface AdRule {
+    /** {en}
+     * @brief When to play the configured ad tag
+     *        - `pre`:  Ad plays as a preroll
+     *        - `post`:  Ad plays as a postroll
+     *        - (timecode): Ad plays at a specific time, in HH:MM:SS or HH:MM:SS.sss format
+     */
+    offset: string;
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins, must be a VAST xml
+     */
+    tag: string;
+}
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Configurations for Google IMA SDK
+ */
+interface ImaConfig {
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins
+     */
+    adTagUrl?: string;
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins when enableSCTE35 is `true`, must be a VAST xml
+     */
+    adTagUrlForSCTE35?: string;
+    /** {en}
+     * @brief The entire advertising schedule, containing multiple ad breaks
+     */
+    schedule?: AdRule[];
+}
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Configurations for advertising
+ */
+interface AdConfig {
+    /** {en}
+     * @brief Ad client that will be used to display advertisements
+     *        - `google-ima`：Use the Google IMA SDK
+     */
+    adType: "google-ima";
+    /** {en}
+     * @brief Property enabling SCTE-35 tag in hls manifest
+     * - false: SCTE-35 disabled
+     * - true: SCTE-35 enabled
+     * @default false
+     */
+    enableSCTE35?: boolean;
+    /** {en}
+     * @brief Configurations for Google IMA SDK
+     * @listtip Required when adType is `google-ima`
+     */
+    ima?: ImaConfig;
+}
 /** {zh}
  * @list option
  * @kind property
@@ -5608,21 +5682,6 @@ interface Rtm {
      * @brief Specify the recent time length for network evaluation in milliseconds. The default is 1000, which means evaluating the network conditions over the last 1000 milliseconds.
      */
     networkEvaluateInterval?: number;
-    /** {zh}
-     * @brief 断流后重新拉流是否无缝播放。
-     * @default false
-     */
-    /** {en}
-     * @brief
-     */
-    seamlesslyReload?: boolean;
-    /** {zh}
-     * @brief 暂停后多久断流，默认不断流。
-     */
-    /** {en}
-     * @brief
-     */
-    disconnectTime?: number;
 }
 /** {zh}
  * @list option
@@ -6427,7 +6486,6 @@ declare function isRTMSupported(): Promise<boolean>;
  * @returns
  */
 declare function isRTMSupportCodec(codec?: string): Promise<boolean>;
-declare function isFLVSupported(): boolean;
 declare module MobilePlayerPanelWrapper {
     export { MobilePlayerPanel };
 }
@@ -9892,12 +9950,10 @@ declare namespace live {
      * @returns
      */
     function isSoftDecodeSupported(): Promise<boolean>;
-    function isMMSSupported(): boolean;
     const util: {
         getStreamType: typeof getStreamType;
         isMseSupported: typeof isMseSupported;
         isSoftDecodeSupported: typeof isSoftDecodeSupported;
-        isMMSSupported: typeof isMMSSupported;
         appendSearchParams: (url?: string | undefined, searchParams?: Record<string, string> | undefined) => string;
         getUrlObject: (url?: string | undefined) => URL | undefined;
         createDom(el?: string | undefined, tpl?: string | undefined, attrs?: {
@@ -10560,6 +10616,13 @@ declare namespace live {
          * @brief Configures the information panel for the player, including options to show/hide the panel and the time interval between each information update. The panel supports displaying information for HLS and FLV addresses. If you opt for software decoding, additional information related to software decoding will be displayed.
          */
         infoPanel?: InfoPanelConfig;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @brief Configurations for advertising
+         */
+        ad?: AdConfig;
         /** {zh}
          * @brief 为播放器设置直播时移配置，接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
          */
@@ -10821,6 +10884,76 @@ declare namespace live {
          */
         position?: string;
     }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Advertising schedule for a single ad break
+     */
+    interface AdRule {
+        /** {en}
+         * @brief When to play the configured ad tag
+         *        - `pre`:  Ad plays as a preroll
+         *        - `post`:  Ad plays as a postroll
+         *        - (timecode): Ad plays at a specific time, in HH:MM:SS or HH:MM:SS.sss format
+         */
+        offset: string;
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins, must be a VAST xml
+         */
+        tag: string;
+    }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Configurations for Google IMA SDK
+     */
+    interface ImaConfig {
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins
+         */
+        adTagUrl?: string;
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins when enableSCTE35 is `true`, must be a VAST xml
+         */
+        adTagUrlForSCTE35?: string;
+        /** {en}
+         * @brief The entire advertising schedule, containing multiple ad breaks
+         */
+        schedule?: AdRule[];
+    }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Configurations for advertising
+     */
+    interface AdConfig {
+        /** {en}
+         * @brief Ad client that will be used to display advertisements
+         *        - `google-ima`：Use the Google IMA SDK
+         */
+        adType: "google-ima";
+        /** {en}
+         * @brief Property enabling SCTE-35 tag in hls manifest
+         * - false: SCTE-35 disabled
+         * - true: SCTE-35 enabled
+         * @default false
+         */
+        enableSCTE35?: boolean;
+        /** {en}
+         * @brief Configurations for Google IMA SDK
+         * @listtip Required when adType is `google-ima`
+         */
+        ima?: ImaConfig;
+    }
     /** {zh}
      * @list option
      * @kind property
@@ -10903,21 +11036,6 @@ declare namespace live {
          * @brief Specify the recent time length for network evaluation in milliseconds. The default is 1000, which means evaluating the network conditions over the last 1000 milliseconds.
          */
         networkEvaluateInterval?: number;
-        /** {zh}
-         * @brief 断流后重新拉流是否无缝播放。
-         * @default false
-         */
-        /** {en}
-         * @brief
-         */
-        seamlesslyReload?: boolean;
-        /** {zh}
-         * @brief 暂停后多久断流，默认不断流。
-         */
-        /** {en}
-         * @brief
-         */
-        disconnectTime?: number;
     }
     /** {zh}
      * @list option
@@ -11697,4 +11815,4 @@ declare namespace live {
      */
     function createLivePlayer(options?: LiveVePlayerOptions): Promise<VePlayerLive>;
 }
-export { Codec, DecodeType, Degradation, DynamicModule, RTMCodec, ListType, Plugin, ExposedSource, VePlayerLive, util, register, registerPlugin, createLivePlayer, isMseSupported, isSoftDecodeSupported, isRTMSupported, isFLVSupported, isRTMSupportCodec, isMMSSupported, load, POSITIONS, EN, ZH_CN, Sniffer, live };
+export { Codec, DecodeType, Degradation, DynamicModule, RTMCodec, ListType, Plugin, ExposedSource, VePlayerLive, util, register, registerPlugin, createLivePlayer, isMseSupported, isSoftDecodeSupported, isRTMSupported, isRTMSupportCodec, load, POSITIONS, EN, ZH_CN, Sniffer, live };

package/veplayer.live.d.ts

@@ -4167,7 +4167,6 @@ declare namespace strategy {
     }
     type StrategyCreator<T, R extends keyof ModulesMap = any> = (options?: T) => Strategy<T, R>;
     const createFlvMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
-    const createFlvMssStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
     const createHlsMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginHls>;
     const createSoftDecodeH264Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
     const createSoftDecodeH265Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
@@ -4219,12 +4218,10 @@ declare function isMseSupported(codec?: string): boolean;
  * @returns
  */
 declare function isSoftDecodeSupported(): Promise<boolean>;
-declare function isMMSSupported(): boolean;
 declare const util: {
     getStreamType: typeof getStreamType;
     isMseSupported: typeof isMseSupported;
     isSoftDecodeSupported: typeof isSoftDecodeSupported;
-    isMMSSupported: typeof isMMSSupported;
     appendSearchParams: (url?: string | undefined, searchParams?: Record<string, string> | undefined) => string;
     getUrlObject: (url?: string | undefined) => URL | undefined;
     createDom(el?: string | undefined, tpl?: string | undefined, attrs?: {
@@ -5265,6 +5262,13 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      * @brief Configures the information panel for the player, including options to show/hide the panel and the time interval between each information update. The panel supports displaying information for HLS and FLV addresses. If you opt for software decoding, additional information related to software decoding will be displayed.
      */
     infoPanel?: InfoPanelConfig;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @brief Configurations for advertising
+     */
+    ad?: AdConfig;
     /** {zh}
      * @brief 为播放器设置直播时移配置，接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
      */
@@ -5526,6 +5530,76 @@ interface TimeShiftConfig {
      */
     position?: string;
 }
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Advertising schedule for a single ad break
+ */
+interface AdRule {
+    /** {en}
+     * @brief When to play the configured ad tag
+     *        - `pre`:  Ad plays as a preroll
+     *        - `post`:  Ad plays as a postroll
+     *        - (timecode): Ad plays at a specific time, in HH:MM:SS or HH:MM:SS.sss format
+     */
+    offset: string;
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins, must be a VAST xml
+     */
+    tag: string;
+}
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Configurations for Google IMA SDK
+ */
+interface ImaConfig {
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins
+     */
+    adTagUrl?: string;
+    /** {en}
+     * @brief URL of the ad tag for IMA plugins when enableSCTE35 is `true`, must be a VAST xml
+     */
+    adTagUrlForSCTE35?: string;
+    /** {en}
+     * @brief The entire advertising schedule, containing multiple ad breaks
+     */
+    schedule?: AdRule[];
+}
+/** {zh}
+ * @hidden
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Configurations for advertising
+ */
+interface AdConfig {
+    /** {en}
+     * @brief Ad client that will be used to display advertisements
+     *        - `google-ima`：Use the Google IMA SDK
+     */
+    adType: "google-ima";
+    /** {en}
+     * @brief Property enabling SCTE-35 tag in hls manifest
+     * - false: SCTE-35 disabled
+     * - true: SCTE-35 enabled
+     * @default false
+     */
+    enableSCTE35?: boolean;
+    /** {en}
+     * @brief Configurations for Google IMA SDK
+     * @listtip Required when adType is `google-ima`
+     */
+    ima?: ImaConfig;
+}
 /** {zh}
  * @list option
  * @kind property
@@ -5608,21 +5682,6 @@ interface Rtm {
      * @brief Specify the recent time length for network evaluation in milliseconds. The default is 1000, which means evaluating the network conditions over the last 1000 milliseconds.
      */
     networkEvaluateInterval?: number;
-    /** {zh}
-     * @brief 断流后重新拉流是否无缝播放。
-     * @default false
-     */
-    /** {en}
-     * @brief
-     */
-    seamlesslyReload?: boolean;
-    /** {zh}
-     * @brief 暂停后多久断流，默认不断流。
-     */
-    /** {en}
-     * @brief
-     */
-    disconnectTime?: number;
 }
 /** {zh}
  * @list option
@@ -6427,7 +6486,6 @@ declare function isRTMSupported(): Promise<boolean>;
  * @returns
  */
 declare function isRTMSupportCodec(codec?: string): Promise<boolean>;
-declare function isFLVSupported(): boolean;
 declare module MobilePlayerPanelWrapper {
     export { MobilePlayerPanel };
 }
@@ -9892,12 +9950,10 @@ declare namespace live {
      * @returns
      */
     function isSoftDecodeSupported(): Promise<boolean>;
-    function isMMSSupported(): boolean;
     const util: {
         getStreamType: typeof getStreamType;
         isMseSupported: typeof isMseSupported;
         isSoftDecodeSupported: typeof isSoftDecodeSupported;
-        isMMSSupported: typeof isMMSSupported;
         appendSearchParams: (url?: string | undefined, searchParams?: Record<string, string> | undefined) => string;
         getUrlObject: (url?: string | undefined) => URL | undefined;
         createDom(el?: string | undefined, tpl?: string | undefined, attrs?: {
@@ -10560,6 +10616,13 @@ declare namespace live {
          * @brief Configures the information panel for the player, including options to show/hide the panel and the time interval between each information update. The panel supports displaying information for HLS and FLV addresses. If you opt for software decoding, additional information related to software decoding will be displayed.
          */
         infoPanel?: InfoPanelConfig;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @brief Configurations for advertising
+         */
+        ad?: AdConfig;
         /** {zh}
          * @brief 为播放器设置直播时移配置，接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
          */
@@ -10821,6 +10884,76 @@ declare namespace live {
          */
         position?: string;
     }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Advertising schedule for a single ad break
+     */
+    interface AdRule {
+        /** {en}
+         * @brief When to play the configured ad tag
+         *        - `pre`:  Ad plays as a preroll
+         *        - `post`:  Ad plays as a postroll
+         *        - (timecode): Ad plays at a specific time, in HH:MM:SS or HH:MM:SS.sss format
+         */
+        offset: string;
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins, must be a VAST xml
+         */
+        tag: string;
+    }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Configurations for Google IMA SDK
+     */
+    interface ImaConfig {
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins
+         */
+        adTagUrl?: string;
+        /** {en}
+         * @brief URL of the ad tag for IMA plugins when enableSCTE35 is `true`, must be a VAST xml
+         */
+        adTagUrlForSCTE35?: string;
+        /** {en}
+         * @brief The entire advertising schedule, containing multiple ad breaks
+         */
+        schedule?: AdRule[];
+    }
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Configurations for advertising
+     */
+    interface AdConfig {
+        /** {en}
+         * @brief Ad client that will be used to display advertisements
+         *        - `google-ima`：Use the Google IMA SDK
+         */
+        adType: "google-ima";
+        /** {en}
+         * @brief Property enabling SCTE-35 tag in hls manifest
+         * - false: SCTE-35 disabled
+         * - true: SCTE-35 enabled
+         * @default false
+         */
+        enableSCTE35?: boolean;
+        /** {en}
+         * @brief Configurations for Google IMA SDK
+         * @listtip Required when adType is `google-ima`
+         */
+        ima?: ImaConfig;
+    }
     /** {zh}
      * @list option
      * @kind property
@@ -10903,21 +11036,6 @@ declare namespace live {
          * @brief Specify the recent time length for network evaluation in milliseconds. The default is 1000, which means evaluating the network conditions over the last 1000 milliseconds.
          */
         networkEvaluateInterval?: number;
-        /** {zh}
-         * @brief 断流后重新拉流是否无缝播放。
-         * @default false
-         */
-        /** {en}
-         * @brief
-         */
-        seamlesslyReload?: boolean;
-        /** {zh}
-         * @brief 暂停后多久断流，默认不断流。
-         */
-        /** {en}
-         * @brief
-         */
-        disconnectTime?: number;
     }
     /** {zh}
      * @list option
@@ -11699,5 +11817,4 @@ declare namespace live {
 }
 declare const isMseSupported$0: typeof isMseSupported;
 declare const isSoftDecodeSupported$0: typeof isSoftDecodeSupported;
-declare const isMMSSupported$0: typeof isMMSSupported;
-export { Codec, DecodeType, Degradation, DynamicModule, RTMCodec, ListType, Plugin, ExposedSource, VePlayerLive, util, register, registerPlugin, createLivePlayer, isMseSupported$0 as isMseSupported, isSoftDecodeSupported$0 as isSoftDecodeSupported, isRTMSupported, isFLVSupported, isRTMSupportCodec, isMMSSupported$0 as isMMSSupported, load, POSITIONS, EN, ZH_CN, Sniffer, live };
+export { Codec, DecodeType, Degradation, DynamicModule, RTMCodec, ListType, Plugin, ExposedSource, VePlayerLive, util, register, registerPlugin, createLivePlayer, isMseSupported$0 as isMseSupported, isSoftDecodeSupported$0 as isSoftDecodeSupported, isRTMSupported, isRTMSupportCodec, load, POSITIONS, EN, ZH_CN, Sniffer, live };

package/veplayer.vod.d.ts

@@ -3994,7 +3994,6 @@ declare namespace strategy {
     }
     type StrategyCreator<T, R extends keyof ModulesMap = any> = (options?: T) => Strategy<T, R>;
     const createFlvMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
-    const createFlvMssStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginFlv>;
     const createHlsMseStrategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginHls>;
     const createSoftDecodeH264Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
     const createSoftDecodeH265Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;