@polyv/wx-live-player-core 3.0.0-dev.12

package/polyv-live-player.d.ts

@@ -0,0 +1,656 @@
+// Generated by dts-bundle v0.7.3
+
+/** @file 入口文件 */
+export default PolyvLive;
+
+export class PolyvLive {
+        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;
+        /**
+            * 事件监听
+            */
+        on<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+        /**
+            * 取消事件监听
+            */
+        off<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+        /**
+            * 销毁播放实例
+            */
+        destroy(): void;
+}
+
+/**
+    * 是/否
+    */
+export type YN = 'Y' | 'N';
+/** 鉴权配置 */
+export interface AuthSetting {
+        /** 应用ID */
+        appId: string;
+        /**
+            * 校验签名
+            * @example
+            * 签名计算示例，注意：请勿在前端代码出现明文appSecret，建议通过后端接口获取appSecret
+            * ```ts
+            * const params = {
+            *  appId: appId,
+            *  channelId: channelId,
+            *  timestamp: new Date().getTime(),
+            * }
+            * const appSecret = '123456';
+            * const sign = md5(`${appId}${timestamp}${appSecret}`).toUpperCase();
+            * ```
+         */
+        sign: string;
+        /** 校验时间戳 */
+        timestamp: number;
+}
+/**
+    * 播放器初始化配置项
+    */
+export interface PlayerConfig {
+        /**
+            * 鉴权参数
+            */
+        auth: AuthSetting;
+        /**
+            * 用户id
+            */
+        uid: string;
+        /**
+            * 频道id
+            */
+        cid: string;
+        /**
+            * 统计数据
+            */
+        statistics?: StatisticsSetting;
+        /**
+            * 回放地址
+            */
+        vodSrc?: string;
+        /**
+            * 回放时长
+            */
+        vodDuration?: number;
+        /**
+            * 自动切换直播和回放视频，默认false
+            */
+        isAutoChange?: boolean;
+        /**
+            * 是否强制使用video组件播放直播, 默认false
+            */
+        forceVideo?: boolean;
+        /**
+            * 默认使用线路
+            */
+        line?: number;
+        /**
+            * 默认使用清晰度
+            */
+        level?: number;
+        /**
+            * 鉴权token
+            */
+        xAuthToken?: string;
+        /**
+            * 延迟内核
+            */
+        playCore?: number;
+}
+/**
+    * 统计数据
+    */
+export type StatisticsSetting = Partial<{
+        param1: string;
+        param2: string;
+        param4: string;
+        param5: string;
+        sessionId: string;
+}>;
+/**
+    * 播放器设置的统计数据
+    */
+export type PlayerStatisticsSetting = Omit<StatisticsSetting, 'sessionId'>;
+/**
+    * 播放类型
+    */
+export enum PlayType {
+        /**
+            * 直播
+            */
+        LIVE = "live",
+        /**
+            * 回放
+            */
+        VOD = "vod",
+        /**
+            * 暖场图片
+            */
+        WARM_IMAGE = "warmImage",
+        /**
+            * 暖场视频
+            */
+        WARM_VIDEO = "warmVideo",
+        /**
+            * 等待开始直播
+            */
+        WAIT_START = "waitStart"
+}
+/**
+    * 清晰度类型
+    */
+export enum LevelType {
+        /**
+            * 流畅
+            */
+        SD = "sd",
+        /**
+            * 高清
+            */
+        HD = "hd",
+        /**
+            * 超清
+            */
+        FHD = "fhd"
+}
+/**
+    * 清晰度列表节点
+    */
+export interface LevelItem {
+        /** 清晰度类型 */
+        type: LevelType;
+        /** 级别 */
+        level: number;
+}
+/**
+    * 线路列表节点
+    */
+export interface LineItem {
+        /** 线路类型 */
+        type: string;
+        /** 线路 */
+        line: number;
+}
+/**
+    * 延迟内核类型
+    */
+export enum PlayCoreType {
+        /** 普通延迟 */
+        CDN = "cdn",
+        /** 无延迟 */
+        QUICK = "quick"
+}
+/**
+    * 延迟内核列表节点
+    */
+export interface PlayCoreItem {
+        /** 延迟内核类型 */
+        type: PlayCoreType;
+        /** 延迟内核 */
+        core: number;
+        /** 是否可启用 */
+        enabled: boolean;
+}
+export interface PlayerMediaInfo {
+        /** 链接(直播、回放、暖场图片、暖场视频链接) */
+        src: string;
+        /** 回放视频返回回放时长 */
+        duration?: number;
+        /** 播放类型 */
+        type: typeof PlayType;
+        /** 线路选项信息 */
+        lines?: {
+                /** 线路选项 */
+                options: LineItem[];
+                /** 当前选中线路 */
+                active: number;
+        };
+        /** 清晰度选项信息 */
+        levels?: {
+                /** 清晰度选项 */
+                options: LevelItem[];
+                /** 当前选中清晰度 */
+                active: number;
+        };
+        /** 延迟内核选项信息 */
+        playCores?: {
+                /** 延迟内核选项 */
+                options: PlayCoreItem[];
+                /** 当前选中延迟内核 */
+                active: number;
+        };
+}
+
+/**
+    * 播放器事件类型
+    */
+export enum PlayerEventsType {
+        /**
+            * 播放器准备完成
+            */
+        READY = "ready",
+        /**
+            * 播放器状态变化
+            */
+        API_STATUS_CHANGE = "api_status_change",
+        /**
+            * 播放器播放类型变化
+            */
+        PLAY_TYPE_CHANGE = "play_type_change",
+        /**
+            * 播放器错误
+            */
+        ERROR = "error",
+        /**
+            * 播放器播放
+            */
+        PLAYING = "playing",
+        /**
+            * 播放器暂停
+            */
+        PAUSE = "pause",
+        /**
+            * 更新媒体信息
+            */
+        UPDATE_MEDIA_INFO = "update_media_info",
+        /**
+            * 线路切换
+            */
+        LINE_CHANGE = "line_change",
+        /**
+            * 清晰度切换
+            */
+        LEVEL_CHANGE = "level_change",
+        /**
+            * 播放配置更新
+            * @ignore
+            */
+        UPDATE_CHANNEL_JSON = "update_channel_json",
+        /**
+            * 播放状态更新
+            * @ignore
+            */
+        LIVE_STATUS_CHANGE = "live_status_change",
+        /**
+            * 延迟播放错误, 切换到正常延迟播放
+            */
+        LATENCY_PLAY_ERROR = "latency_play_error"
+}
+/** 播放器事件 */
+export type PlayerEventMap = {
+        /** 播放器就绪 */
+        [PlayerEventsType.READY]: () => void;
+        /** 播放类型变更 */
+        [PlayerEventsType.PLAY_TYPE_CHANGE]: (playType: PlayType) => void;
+        /** 播放器错误 */
+        [PlayerEventsType.ERROR]: (error: PlayerError) => void;
+        /** 更新媒体信息 */
+        [PlayerEventsType.UPDATE_MEDIA_INFO]: (mediaInfo: PlayerMediaInfo) => void;
+        /** 线路切换 */
+        [PlayerEventsType.LINE_CHANGE]: (line: number) => void;
+        /** 清晰度切换 */
+        [PlayerEventsType.LEVEL_CHANGE]: (level: number) => void;
+        /**
+            * 播放状态更新
+            * @ignore
+         */
+        [PlayerEventsType.LIVE_STATUS_CHANGE]: (statusInfo: IGetApiStatusResponse) => void;
+        /**
+            * 播放配置更新
+            * @ignore
+         */
+        [PlayerEventsType.UPDATE_CHANNEL_JSON]: (channelJsonInfo: IChannelJsonConfig) => void;
+        /** 延迟播放错误 */
+        [PlayerEventsType.LATENCY_PLAY_ERROR]: () => void;
+};
+
+export interface PlayerError {
+        /**
+            * 错误码, 详见`ErrorCode`
+            */
+        code: string;
+}
+export enum ErrorCode {
+        /**
+            * 未知错误
+            */
+        UNKNOWN = "000",
+        /**
+            * 传入参数非法或鉴权失败
+            */
+        UN_LEGAL = "001",
+        /**
+            * 账号异常
+            */
+        ACCOUNT_ABNORMAL = "002",
+        /**
+            * 配置加载失败
+            */
+        CONFIG_LOAD_FAIL = "011"
+}
+
+/**
+    * 播放器状态
+    */
+export enum ApiStatus {
+        /**
+            * 直播进行中
+            */
+        LIVE = "live",
+        /**
+            * 直播结束
+            */
+        END = "end",
+        /**
+            * 中途暂停
+            */
+        STOP = "stop"
+}
+/**
+    * 获取API状态接口响应参数
+    */
+export interface IGetApiStatusResponse {
+        /**
+            * 状态
+            */
+        status: ApiStatus;
+        /**
+            * 场次ID
+            */
+        sessionId: string;
+}
+/**
+    * 获取API状态接口请求参数
+    */
+export interface IGetApiStatusRequest {
+        /**
+            * 频道ID
+            */
+        channelId: string;
+        /**
+            * 流名
+            */
+        stream: string;
+        /**
+            * 随机数
+            */
+        ran: number;
+}
+
+/**
+    * 多码率配置
+    */
+export interface IDefinitions {
+        /**
+            * 码率
+            */
+        definition: string;
+        /**
+            * 地址
+            */
+        url: string;
+        /**
+            * m3u8地址
+            */
+        m3u8: string;
+}
+/**
+    * 多码率配置
+    */
+export interface IMultirateModel {
+        /**
+            * 默认码率
+            */
+        defaultDefinition: string;
+        /**
+            * 默认码率地址
+            */
+        defaultDefinitionUrl: string;
+        /**
+            * 默认码率m3u8地址
+            */
+        defaultDefinitionM3u8Url: string;
+        /**
+            * 多码率配置
+            */
+        definitions: IDefinitions[];
+}
+export interface ILineModel {
+        /**
+            * flv地址
+            */
+        flv: string;
+        /**
+            * m3u8地址
+            */
+        m3u8: string;
+        /**
+            * cdn类型
+            */
+        cdnType: string;
+        /**
+            * 多码率配置
+            */
+        multirateModel: IMultirateModel;
+        /**
+            * 无延迟播放地址
+            */
+        quickLiveUrl?: string;
+        /**
+            * 无延迟播放是否开启
+            */
+        quickLiveEnabled: YN;
+}
+/**
+    * 频道配置接口响应加密数据
+    */
+export interface IChannelJsonEncryptResponse {
+        /**
+            * 状态码
+            */
+        code: number;
+        /**
+            * 状态信息
+            */
+        status: string;
+        /**
+            * 加密数据
+            */
+        body: string;
+}
+/**
+    * 频道播放器配置响应参数
+    */
+export interface IChannelJsonConfig {
+        /**
+            * 流名
+            */
+        stream: string;
+        /**
+            * 封面图片
+            */
+        coverImage: string;
+        /**
+            * 暖场图片
+            */
+        waitImage: string;
+        /**
+            * 暖场视频
+            */
+        warmUpFlv: string;
+        /**
+            * m3u8地址
+            */
+        m3u8Url: string;
+        /**
+            * 频道直播状态查询频率, 单位秒
+            */
+        channelLiveStatusQueryFrequency: number;
+        /**
+            * 线路配置
+            */
+        lines: ILineModel[];
+        /**
+            * 回放视频 (mp4格式)
+            */
+        recordFileUrl: string;
+        /**
+            * 回放视频（m3u8格式）
+            */
+        recordFileM3u8Url: string;
+        /**
+            * 回放时长
+            */
+        recordFileDuration: number;
+        /**
+            * 回放场次ID
+            */
+        recordFileSessionId: string;
+        /**
+            * 频道详细信息
+            */
+        channelRestrictModel: {
+                /**
+                    * 直播频道所属的账号情况
+                    */
+                userStatus: string;
+        };
+        /**
+            * 拉流防盗链
+            */
+        aliPullProtectExpTime: number;
+}
+/**
+    * 频道配置接口请求参数
+    */
+export interface IChannelJsonRequest {
+        /**
+            * 随机数
+            */
+        ran: number;
+}
+export interface IGetNewestPlayUrlsResponse {
+        /**
+            * flv地址
+            */
+        flv: string;
+        /**
+            * m3u8地址
+            */
+        m3u8: string;
+}
+