@volcengine/veplayer 1.15.3-rc.1 → 1.15.3-rc.3

package/README.md

@@ -0,0 +1,47 @@
+### VePlayer
+
+[火山引擎视频云](https://www.volcengine.com/)Web播放器SDK，自动适配PC和H5场景，支持MP4、HLS、FLV、DASH等多种格式的点播和直播，结合视频云具有播放质量日志上报、加密播放等功能。
+
+### 引入依赖
+通过包管理工具将 SDK 的依赖安装到项目中。
+```bash
+npm install @volcengine/veplayer --save
+```
+在项目中引入 VePlayer 和样式文件。
+```javascript
+import VePlayer from '@volcengine/veplayer';
+import '@volcengine/veplayer/index.min.css';
+```
+
+### 添加播放容器
+在需要展示播放器的页面添加播放器容器，例如，在 index.html 中加入以下代码。
+```javascript
+<div id="video"></div>
+```
+### 播放器实例化
+在获取到视频地址后，实例化播放器。
+
+#### 点播
+```javascript
+const player = new VePlayer({
+    id: 'video', // 视频容器dom的id
+    url: "https://demo.vod.com/xxx.mp4", // 视频地址
+    vodLogOpts: {
+        vtype: 'MP4', // 视频格式，HLS协议的视频请传入HLS
+        tag: '普通视频', // 业务标签，用于区分业务中不同的场景，方便后续进行多维度分析
+        line_app_id: 348293, // 【必选】该值为 int 类型，接入视频点播的SDK应用id，可以从点播控制台-点播SDK-应用管理获取
+        line_user_id: 'XXX' // 用户 id， String 或者 int 类型, 不传入将是一个根据用户浏览器随机生成的值
+    }
+});
+```
+点播功能的详细说明参考[火山引擎-视频点播-Web 点播SDK](https://www.volcengine.com/docs/4/127897)
+
+#### 直播
+```javascript
+const playerSdk = new VePlayer({
+  id: 'video',
+  isLive: true,
+  url: '//livepull.example.com/appname/streamname.flv'
+});
+```
+直播功能的详细说明参考[火山引擎-视频直播-Web SDK-拉流SDK](https://www.volcengine.com/docs/6469/127525)

package/index.d.ts

@@ -80,21 +80,8 @@ export interface ISdkErrorConfig {
 	 * @hidden
 	 */
 	isNeedDemoteBack?: boolean;
-	/**
-	 * @brief 是否允许回退到同清晰度不同线路的 fallbackurl：
-	 *        - `false`：只能在当前 defintion 范围内 fallback。
-	 *        - `true`：允许 fallback 相同清晰度，不同的线路的 fallbackurl。
-	 * @default true
-	 *
-	 */
-	/** {en}
-	 * @brief Is demote to different line enabled? The values are as follows:
-	 *        - `false`: only demote in current definition line.
-	 *        - `true`: allow demote to different line.
-	 */
-	allowDemoteToDifferentLine?: boolean;
 	/** {zh}
-	 * @brief 报错后重试轮数。
+	 * @brief 报错后重试次数。
 	 * @default 1
 	 */
 	retryLoopNum?: number;
@@ -826,61 +813,6 @@ export interface IDefinitionDemotePlugin {
 	 *        - `true`: automatic downgrade is enabled.
 	 */
 	isNeedAutoDemote?: boolean;
-	/**
-	 * @brief 当用户开启 fallbackUrl 降级（降级到备用线路) 时，优先降级清晰度还是 fallbackUrl，取值如下：
-	 *        - `false`：优先在同一个清晰度的所有 fallback 之间切换, 都有问题的情况下，再降低到下一个清晰度
-	 *        - `true`：优先降级清晰度, 清晰度降到最低之后，再在最后一个清晰度的 fallbackUrl 之间切换
-	 * @default false
-	 *
-	 */
-	/** {en}
-	 * @brief Is demote quality first? The values are as follows:
-	 *        - `false`: not demote quality first.
-	 *        - `true`: demote quality first.
-	 */
-	shouldDemoteDefinitionFirst?: boolean;
-	/**
-	 * @brief 是否开启 fallbackUrl 降级：
-	 *        - `false`：不尝试降级到备用线路。
-	 *        - `true`：尝试降级到备用线路。
-	 * @default true
-	 *
-	 */
-	/** {en}
-	 * @brief Is automatic downgrade enabled? The values are as follows:
-	 *        - `false`: not try to play fallbackUrl first.
-	 *        - `true`: try to play fallbackUrl first before demote definition.
-	 */
-	isNeedDemoteBack?: boolean;
-	/**
-	 * @brief 是否允许回退到同清晰度不同线路的 fallbackurl：
-	 *        - `false`：只能在当前 defintion 范围内 fallback。
-	 *        - `true`：允许 fallback 相同清晰度，不同的线路的 fallbackurl。
-	 * @default true
-	 *
-	 */
-	/** {en}
-	 * @brief Is demote to different line enabled? The values are as follows:
-	 *        - `false`: only demote in current definition line.
-	 *        - `true`: allow demote to different line.
-	 */
-	allowDemoteToDifferentLine?: boolean;
-	/**
-	 * @brief 同一清晰度降级至 fallbackurl 的重试轮数。
-	 * @default 1
-	 */
-	/** {en}
-	 * @brief The retry loop number for all available fallbackUrl.
-	 */
-	retryLoopNum?: number;
-	/**
-	 * @brief 在降级时到下一个definition 时，是否显示 toast 提示。
-	 * @default 1
-	 */
-	/** {en}
-	 * @brief Whether to show toast when demote to next definition.
-	 */
-	bumpToastWhenDemoteToNextDefinition?: boolean;
 	/**
 	 * @brief 清晰度降级顺序。数组中的元素需与 `playList` 中的 `definition` 相对应。
 	 * @default []
@@ -942,10 +874,6 @@ export declare class DefinitionDemotePlugin extends Plugin {
 	longWaitingEmitTime: number;
 	waitingStartTime: number;
 	playerData: PlayerData;
-	fallbackState: {
-		retryTimes: number;
-		idx: number;
-	};
 	static get defaultConfig(): IDefinitionDemotePlugin;
 	constructor(args: any);
 	registerLanguageTexts(): {
@@ -965,12 +893,6 @@ export declare class DefinitionDemotePlugin extends Plugin {
 	_clearTime(): void;
 	clearState(): void;
 	demote(): void;
-	executeDemoteFallbackFirst(): void;
-	executeDemoteDefinitionFirst(): void;
-	getRetryListForCurrentDefinition(): any[];
-	getRetryListForCurrentDefinitionAcrossAllLines(): any[];
-	resetTimes(): void;
-	changeMainOrBackup(): boolean;
 	changeUrl(url: Url): void;
 	showToast(definition: Stream): void;
 	destroy(): void;
@@ -4726,7 +4648,6 @@ declare class PlayerData {
 	 * @description: 获取满足当前直播条件的流
 	 */
 	getCurrentStreams(): Stream[];
-	getStreamsMatchCurrentDefinition(): Stream[];
 	/**
 	 * @description: 获取根据线路ID去重的流，用于获取有几个线路
 	 */
@@ -6154,11 +6075,11 @@ export declare const Events: {
 	 */
 	REFRESH_CLICK: string;
 	/** {zh}
-	 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl。
+	 * @brief 报错时触发降级。
 	 */
 	PLAY_BACKUP_CHANGE: string;
 	/** {zh}
-	 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl, 所有可执行降级结束，无可用 fallbackUrl
+	 * @brief 报错时触发的降级结束。
 	 */
 	PLAY_BACKUP_CHANGE_FINISH: string;
 	/** {zh}
@@ -6189,15 +6110,6 @@ export declare const Events: {
 	 * @brief 清晰度降级。
 	 */
 	DEFINITION_DEMOTE: string;
-	/** {zh}
-	 * @brief 已降至最低清晰度。
-	 */
-	DEFINITION_DEMOTE_ALL_DONE: string;
-	/** {zh}
-	 * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级，
-	 * 无论两者哪个优先级更高，待所有可执行的降级操作均执行完毕，会触发该事件。
-	 */
-	DEMOTE_ALL_DONE: string;
 	/** {zh}
 	 * @hidden
 	 */
@@ -6834,11 +6746,11 @@ export declare const Event: {
 		 */
 		REFRESH_CLICK: string;
 		/** {zh}
-		 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl。
+		 * @brief 报错时触发降级。
 		 */
 		PLAY_BACKUP_CHANGE: string;
 		/** {zh}
-		 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl, 所有可执行降级结束，无可用 fallbackUrl
+		 * @brief 报错时触发的降级结束。
 		 */
 		PLAY_BACKUP_CHANGE_FINISH: string;
 		/** {zh}
@@ -6869,15 +6781,6 @@ export declare const Event: {
 		 * @brief 清晰度降级。
 		 */
 		DEFINITION_DEMOTE: string;
-		/** {zh}
-		 * @brief 已降至最低清晰度。
-		 */
-		DEFINITION_DEMOTE_ALL_DONE: string;
-		/** {zh}
-		 * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级，
-		 * 无论两者哪个优先级更高，待所有可执行的降级操作均执行完毕，会触发该事件。
-		 */
-		DEMOTE_ALL_DONE: string;
 		/** {zh}
 		 * @hidden
 		 */