@polyv/wx-live-player-core 3.0.0 → 3.1.0

package/player.d.ts

@@ -0,0 +1,151 @@
+/// <reference types="miniprogram-api-typings" />
+import { PlayerConfig, PlayType, PlayerStatisticsSetting } from './types';
+import { PlayerEventMap } from './events-type';
+export declare class PolyvLive {
+    /**
+     * 播放内核
+     */
+    private __playerCore;
+    /**
+     * 是否已经初始化
+     */
+    private __inited;
+    constructor(config: PlayerConfig);
+    /**
+     * 播放器初始化
+     * @description 初始化播放器, 包括鉴权, 解析当前状态等操作
+     */
+    setUp(): Promise<void>;
+    /**
+     * 获取播放类型
+     * @returns 播放类型
+     * @description 可以通过 `getPlayType` 主动获取当前的播放类型
+     *
+     * @example
+     * ```ts
+     * const playType = player.getPlayType();
+     *
+     * if (playType === PlayType.WAIT_START) {
+     *   console.log('当前暂无直播, 显示暂未直播盖图');
+     * }}
+     * ```
+     */
+    getPlayType(): PlayType;
+    /**
+     * 刷新当前播放流
+     * @description 一般用于直播过程中, 出现卡顿等情况, 主动刷新当前播放流
+     * @example
+     * ```ts
+     * <button bind:tap="refresh"></button>
+     *
+     * player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
+     *  const { playType, src } = mediaInfo;
+     *  this.setData({ src });
+     * });
+     *
+     * // 调用刷新流接口，触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
+     * function refresh() {
+     *   player.refresh();
+     * }
+     * ```
+     */
+    refresh(): void;
+    /**
+     * 设置统计参数
+     * @description 播放中途如设置昵称, 可以通过`setStatics`更新统计参数。一般param1用于设置用户唯一Id，param2用于设置用户昵称等信息
+     * @param statics 统计参数
+     * @example
+     * ```ts
+     * player.setStatics({
+     *   param2: '昵称',
+     * });
+     * ```
+     */
+    setStatics(statics: PlayerStatisticsSetting): void;
+    /**
+     * 开始统计播放时长
+     * @description 连麦结束，需要调用`startCountPd`开始统计播放时长
+     * @ignore
+     */
+    startCountPd(): void;
+    /**
+     * 暂停统计播放时长
+     * @description 连麦中途，CDN播放器会暂停统计播放时长，需要调用`stopCountPd`暂停统计播放时长
+     * @ignore
+     */
+    stopCountPd(): void;
+    /**
+     * 切换线路
+     * @description 切换线路, 切换线路后, 会触发`UPDATE_MEDIA_INFO`事件
+     * @param line 线路索引 0 代表线路1
+     * @example
+     * ```ts
+     * <button bind:tap="changeLine"></button>
+     *
+     * player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
+     *  const { playType, src } = mediaInfo;
+     *  this.setData({ src });
+     * });
+     *
+     * // 调用切换线路接口，触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
+     * function changeLine() {
+     *   player.changeLine(0);
+     * }
+     * ```
+     */
+    changeLine(line: number): void;
+    /**
+     * 切换清晰度
+     * @description 切换清晰度, 切换清晰度后, 会触发`UPDATE_MEDIA_INFO`事件
+     * @param level 清晰度索引 0 代表流畅
+     * @example
+     * ```ts
+     * <button bind:tap="changeLevel"></button>
+     *
+     * player.on(PlayerEventsType.UPDATE_MEDIA_INFO, (mediaInfo: MediaInfo) => {
+     *  const { playType, src } = mediaInfo;
+     *  this.setData({ src });
+     * });
+     *
+     * // 调用切换清晰度接口，触发`UPDATE_MEDIA_INFO`事件更新视频播放地址
+     * function changeLevel() {
+     *   player.changeLevel();
+     * }
+     * ```
+     */
+    changeLevel(level: number): void;
+    /**
+     * 切换延迟内核
+     * @description 切换延迟内核, 切换延迟内核后, 会触发`UPDATE_MEDIA_INFO`事件
+     * @param playCore 延迟内核索引 0 代表普通延迟 1 代表无延迟
+     */
+    changePlayCore(playCore: number): void;
+    /**
+     * 监测播放组件状态回调
+     */
+    setLivePlayerStateChange(e: WechatMiniprogram.LivePlayerStateChange): void;
+    /**
+     * 开始缓冲
+     */
+    setLoadingStart(): void;
+    /**
+     * 结束缓冲
+     */
+    setLoadingEnd(): void;
+    /**
+     * 播放失败
+     */
+    setPlayError(args?: any): void;
+    /**
+     * 事件监听
+     */
+    on<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+    /**
+     * 取消事件监听
+     */
+    off<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+    /**
+     * 销毁播放实例
+     */
+    destroy(): void;
+}

package/polyv-live-player.d.ts

@@ -118,6 +118,18 @@ export class PolyvLive {
             * 监测播放组件状态回调
             */
         setLivePlayerStateChange(e: WechatMiniprogram.LivePlayerStateChange): void;
+        /**
+            * 开始缓冲
+            */
+        setLoadingStart(): void;
+        /**
+            * 结束缓冲
+            */
+        setLoadingEnd(): void;
+        /**
+            * 播放失败
+            */
+        setPlayError(args?: any): void;
         /**
             * 事件监听
             */
@@ -418,6 +430,85 @@ export type PlayerEventMap = {
         [PlayerEventsType.LATENCY_PLAY_ERROR]: () => void;
 };
 
+/**
+    * QoS事件类型枚举
+    */
+export enum QosEventType {
+        /**
+            * 初始化
+            */
+        INIT = "init",
+        /**
+            * 频道配置更新
+            */
+        LOAD_CHANNEL_JSON = "cjson",
+        /**
+            * 限制配置更新
+            */
+        LOAD_RESTRICT_JSON = "rjson",
+        /**
+            * 二次缓冲结束
+            */
+        BUFFER = "buffer",
+        /**
+            * 加载到画面的时长
+            */
+        LOADING = "loading",
+        /**
+            * 播放错误
+            */
+        PLAY_ERROR = "error",
+        /**
+            * 播放卡顿
+            */
+        STALLING = "stalling",
+        /**
+            * 直播状态切换
+            */
+        SWITCH = "switch",
+        /**
+            * 直播状态
+            */
+        STATUS_LIVE = "statuslive"
+}
+/**
+    * 基础QoS数据接口
+    */
+export interface IQosBaseData {
+        /**
+            * 用户ID
+            */
+        uid: string;
+        /**
+            * 频道ID
+            */
+        cid: string;
+        /**
+            * 播放ID
+            */
+        pid: string;
+        /**
+            * 时间戳
+            */
+        ts: number;
+        /**
+            * 当前播放链接域名
+            */
+        domain?: string;
+        /**
+            * 会话ID
+            */
+        session_id?: string;
+        /**
+            * 客户端信息
+            */
+        client?: string;
+        /**
+            * 动态参数
+            */
+        [key: string]: any;
+}
+
 export interface PlayerError {
         /**
             * 错误码, 详见`ErrorCode`
@@ -633,6 +724,10 @@ export interface IChannelJsonConfig {
             * 拉流防盗链
             */
         aliPullProtectExpTime: number;
+        /**
+            * 卡顿事件发送频率，单位秒
+            */
+        stallingSendFrequency?: number;
 }
 /**
     * 频道配置接口请求参数