@byteplus/veplayer 1.1.2 → 1.6.0-alpha.0

package/README.md

@@ -1,52 +1,64 @@
-## Byteplus
+### Volcengine/player
 
-### Introduction
-By byteplus-veplayer, you can build a web video player application for playing multiple formats/protocols video (including mp4\hls\flv\dash),
-which can meet the needs of businesses based on video-on-demand and live video services provided by [BytePlus](https://www.byteplus.com/en/)
+火山引擎视频云播放器
 
-### Start
+### 安装
 
-1. Install
+```bash
+npm install @volcengine/veplayer --save
+```
 
-    ```
-    $ npm install @byteplus/veplayer
-    ```
-
-2. Usage
-
-   Step 1:
-
-    ```html
-    <div id="vs"></div>
-    ```
-   Step 2:
-
-    ```js
-    const playerSdk = new VePlayer({
-        id: 'vs',
-        width: 600,
-        height: 400,
-        streamType: 'hls',
-        url: 'http://xx.demo.com/demo.m3u8',
-        playList: [
-            {
-                streamType: 'hls',
-                definition: 'HD',
-                url: 'http://xx.demo.com/demo_hd.m3u8',
-            },
-            {
-                streamType: 'hls',
-                definition: 'UD',
-                url: 'http://xx.demo.com/demo_ud.m3u8',
-            },
-            {
-                streamType: 'hls',
-                definition: 'SD',
-                url: 'http://xx.demo.com/demo_sd.m3u8',
-            },
-        ]
-    });
-    ```
-   
-### Document 
+### 示例
 
+```js
+const playerSdk = new VePlayer({
+  id: 'mse',
+  isLive: true,
+  streamType: 'rtm',
+  url: '/url',
+  playList: [
+    {
+      lineId: 1,
+      lineTextKey: '线路一',
+      url: '/url',
+      definition: 'ld',
+      streamType: 'rtm',
+      definitionTextKey: 'LD',
+    },
+    {
+      lineId: 1,
+      lineTextKey: '线路一',
+      url: '/url',
+      definition: 'hd',
+      streamType: 'rtm',
+      definitionTextKey: 'HD',
+    },
+    {
+      lineId: 1,
+      lineTextKey: '线路一',
+      url: '/url',
+      definition: 'uhd',
+      streamType: 'rtm',
+      definitionTextKey: 'UHD',
+    },
+    {
+      lineId: 2,
+      lineTextKey: '线路二',
+      url: '/url',
+      definition: 'ld',
+      streamType: 'rtm',
+      definitionTextKey: 'LD',
+    },
+    {
+      lineId: 2,
+      lineTextKey: '线路二',
+      url: '/url',
+      definition: 'hd',
+      streamType: 'rtm',
+      definitionTextKey: 'HD',
+    },
+  ],
+  width: 600,
+  height: 400,
+});
+```

package/dist/index.d.ts

@@ -1104,8 +1104,6 @@ declare enum PlatformEnum {
 export interface apiMapItem {
 	playDomain: string;
 	backupPlayDomain?: string;
-	licenseUrl: string;
-	keyDomain: string;
 }
 declare enum CodecType {
 	H265 = "h265",
@@ -1723,6 +1721,11 @@ export interface IPlayAuthTokenConfig {
 	 * @memberof IPlayAuthTokenConfig
 	 */
 	getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
+	/**
+	 * 是否禁用DRM解密播放降级，默认false
+	 * @type {boolean}
+	 */
+	disDrmDegraded?: boolean;
 	/**
 	 * 可携带aid等透传参数，如
 	 * {aid: 1234}，以playAuthToken下发的参数的优先级最高。
@@ -2037,6 +2040,7 @@ declare class VePlayer {
 	private _isFirstCreated;
 	/**
 	 * @hidden
+	 * 要注册的sdk插件
 	 *
 	 * @type {*}
 	 * @memberof VePlayer
@@ -2044,6 +2048,7 @@ declare class VePlayer {
 	sdkPlugins: any[];
 	/**
 	 * @hidden
+	 * 缓存运行的sdk插件实例
 	 *
 	 * @type {*}
 	 * @memberof VePlayer
@@ -2237,13 +2242,7 @@ declare class VePlayer {
 	getCurrentPlayerConfig(): {
 		type?: "vod" | "live";
 		isLive?: boolean;
-		lineId?: string | number; /**
-		 * @description 触发sdk事件
-		 *
-		 * @param {string} action
-		 * @param {*} [payload]
-		 * @memberof VePlayer
-		 */
+		lineId?: string | number;
 		definition?: string;
 		startTime?: number;
 		volume?: number;
@@ -2376,7 +2375,7 @@ declare class VePlayer {
 	set src(url: any);
 	/**
 	 * 切换视频url
-	 * @param {string} url 同一个视频，切换视频地址
+	 * @param {string} url 同一个视频，更新视频地址
 	 * @notes 切换后从切换前的时间点继续播放
 	 * @return {Promise<void>}
 	 * @memberof VePlayer
@@ -2386,15 +2385,15 @@ declare class VePlayer {
 	 * 重建播放下一个
 	 *
 	 * @param {playerConfig} config
-	 * @param { boolean } isNewVideo 是否是新视频，默认true。若未false即表示同一个视频切换token播放，会在切换前时间点继续播放
+	 * @param { boolean } isNewVideo 是否是新视频，默认true。若为false即表示同一个视频切换token播放，会在切换前时间点继续播放
 	 * @memberof VePlayer
 	 */
 	next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
 	/**
-	 * 切换视频源，主要用于在视频过期时更新视频源
+	 * 切换视频源
 	 *
 	 * @param {IPlayerConfig} config
-	 * @param { boolean } isNewVideo 是否是新视频，默认true。若未false即表示同一个视频切换token播放，会在切换前时间点继续播放
+	 * @param { boolean } isNewVideo 是否是新视频，默认true。若为false即表示同一个视频切换地址播放，会在切换前的时间点继续播放
 	 * @return{Promise<any>}
 	 * @memberof VePlayer
 	 */