@volcengine/veplayer 1.12.0-rc.1 → 1.12.0-rc.2

package/index.d.ts

@@ -194,6 +194,222 @@ export interface IRtmConfig {
 	 */
 	backupStreamType: "hls" | "flv";
 }
+/**
+ * @brief 弹幕配置。
+ * @list Options
+ * @kind property
+ */
+/** {en}
+ * @list Options
+ * @kind property
+ */
+export interface IDanmuConfig {
+	/**
+	 * @brief 弹幕透明度。取值如下：
+	 *
+	 *        - `0`：透明度 0。
+	 *        - `33`：透明度 33%。
+	 *        - `66`：透明度 66%。
+	 *        - `99`：透明度 100%。
+	 * @default 99
+	 */
+	/** {en}
+	 * @brief 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
+	 */
+	opacity?: number;
+	/**
+	 * @brief 弹幕区域大小。取值如下：
+	 *
+	 *        - `0`：弹幕区域占全屏的 1/4。
+	 *        - `33`：弹幕区域占全屏的 1/2。
+	 *        - `66`：弹幕区域占全屏的 3/4。
+	 *        - `99`：弹幕区域占满全屏。
+	 * @default 99
+	 */
+	/** {en}
+	 * @brief 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
+	 */
+	area?: number;
+	/**
+	 * @brief 弹幕滚动速度。取值如下：
+	 *
+	 *        - `0`：弹幕速度为 1/4。
+	 *        - `20`：弹幕速度为 1/2。
+	 *        - `40`：弹幕速度为 1。
+	 *        - `60`：弹幕速度为 5/4。
+	 *        - `80`：弹幕速度为 3/2。
+	 *        - `100`：弹幕速度为 2。
+	 * @default 40
+	 */
+	/** {en}
+	 * @brief 速度, 枚举值[0, 20, 40, 60, 80, 100]， 实际对应1/4, 1/2,1,5/4,3/2,2
+	 */
+	speed?: number;
+	/**
+	 * @brief 弹幕字体大小。取值如下：
+	 *
+	 *        - `0`：字体大小为 14 px。
+	 *        - `50`：字体大小为 16 px。
+	 *        - `100`：字体大小为 20 px。
+	 * @default 50
+	 */
+	/** {en}
+	 * @brief 字体大小， 枚举值[0, 50, 100]，实际对应14px 16px 20px
+	 */
+	fontSize?: number;
+	/**
+	 * @brief 是否打开面板。取值如下：
+	 *
+	 *        - `false`：关闭面板。
+	 *        - `true`：打开面板。
+	 * @default false
+	 */
+	/** {en}
+	 * @brief 是否打开面板
+	 */
+	active?: boolean;
+	/**
+	 * @brief 是否展示弹幕设置面板。取值如下：
+	 *
+	 *        - `false`：不展示弹幕设置面板。
+	 *        - `true`：展示弹幕设置面板。
+	 * @default true
+	 * @hidden
+	 */
+	/** {en}
+	 * @brief 是否展示弹幕设置面板
+	 */
+	usePanel?: boolean;
+	/**
+	 * @brief 弹幕列表。
+	 * @default -
+	 */
+	/** {en}
+	 * @brief 弹幕列表
+	 */
+	danmuItems?: DanmuItem[];
+	/**
+	 * @hidden
+	 * @type {ExternalItem[]}
+	 * @memberof IDanmuConfig
+	 */
+	external?: ExternalItem[];
+	/**
+	 * @hidden
+	 */
+	maskConfig?: IMaskConfig;
+	/**
+	 * @hidden
+	 */
+	maskActive?: boolean;
+}
+export interface IMaskConfig {
+	maskUrl: string;
+	maskOffset?: number;
+	interval?: number;
+}
+/** {zh}
+ * @hidden
+ * @brief 语言类型
+ */
+/** {en}
+ * @hidden
+ * @brief 语言类型
+ */
+export interface Lang {
+	zh: string;
+	en: string;
+	[props: string]: string;
+}
+/** {zh}
+ * @brief 弹幕项
+ * @list Options
+ * @kind property
+ * @export
+ * @interface DanmuItem
+ */
+/** {en}
+ * @list Options
+ * @kind property
+ * @export
+ * @interface DanmuItem
+ * @brief 弹幕项
+ */
+export interface DanmuItem {
+	/**
+	 * 弹幕唯一id
+	 *
+	 * @type {string}
+	 * @memberof DanmuItem
+	 * @brief 弹幕唯一 ID。
+	 */
+	/** {en}
+	 * @brief 弹幕唯一id
+	 */
+	id: string;
+	/**
+	 * 弹幕文案
+	 *
+	 * @type {string}
+	 * @memberof DanmuItem
+	 * @brief 弹幕文案。
+	 */
+	/** {en}
+	 * @brief 弹幕文案
+	 */
+	txt: string;
+	/**
+	 * 弹幕出现时间, 单位为ms
+	 * @default 0
+	 * @brief 弹幕出现时间，单位为毫秒。
+	 */
+	/** {en}
+	 * @brief 弹幕出现时间, 单位为ms
+	 */
+	start?: number;
+	/**
+	 * 是否优先显示
+	 * @hidden
+	 * @type {boolean}
+	 * @memberof DanmuItem
+	 */
+	prior?: boolean;
+	/**
+	 * 弹幕持续显示时间, 单位为ms
+	 * @default 5000
+	 *
+	 * @type {number}
+	 * @memberof DanmuItem
+	 * @brief 弹幕持续显示时长，单位为毫秒。
+	 */
+	/** {en}
+	 * @brief 弹幕持续显示时间, 单位为ms
+	 */
+	duration?: number;
+	/**
+	 * @brief 弹幕样式。示例如下：`style : { color: '#ff9500', fontSize: '20px', padding: '2px 11px'}`
+	 * @example
+	 * ``` javascript
+	 * {
+	 *    color: '#ff9500',
+	 *    fontSize: '20px',
+	 *    padding: '2px 11px'
+	 * }
+	 *```
+	 * @type {Partial<Record<Property, string>>}
+	 * @memberof DanmuItem
+	 */
+	/** {en}
+	 * @brief 弹幕样式
+	 */
+	style?: CSSStyleDeclaration;
+}
+export interface ExternalItem {
+	key: string;
+	name: string;
+	value: boolean;
+	lang?: Lang;
+}
 /**
  * @brief 外挂字幕配置。
  * @list Options