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

package/modules/level-control/level-control-module.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @file 清晰度控制模块
+ */
+import { ModuleBase } from '../module-base';
+import { LevelItem } from '../../types';
+export declare class LevelControl extends ModuleBase {
+    private readonly definitionMap;
+    /**
+     * 获取清晰度配置
+     */
+    getLevelSetting(): LevelItem[];
+    /**
+     * 设置初始线路
+     */
+    setInitDefaultLevel(): void;
+    /**
+     * 根据线路获取默认清晰度索引
+     * @param lineIndex
+     * @returns
+     */
+    getDefaultLevelIndexByLineIndex(lineIndex: number): number;
+    /**
+     * 切换清晰度
+     * @param level
+     * @returns
+     * */
+    changeLevel(level: number): void;
+    /**
+     * 根据清晰度获取源
+     * @param src
+     * @returns
+     */
+    getSrcFromLevel(src: string): string;
+}

package/modules/line-control/line-control-module.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @file 线路控制模块
+ */
+import { ModuleBase } from '../module-base';
+import { LineItem } from '../../types';
+export declare class LineControl extends ModuleBase {
+    /**
+     * 获取线路配置
+     */
+    getLineSetting(): LineItem[];
+    /**
+     * 设置初始线路
+     */
+    setInitDefaultLine(): void;
+    /**
+     * 切换线路
+     * @param line
+     * @returns
+     */
+    changeLine(line: number): void;
+    /**
+     * 根据线路获取源
+     * @param src
+     * @returns
+     */
+    getSrcFromLine(src: string): string;
+}

package/modules/live/live-module.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 直播模块
+ */
+import { ModuleBase } from '../module-base';
+export declare class Live extends ModuleBase {
+    /**
+     * 获取最新直播播放链接
+     */
+    getLiveSrc(): string;
+    /**
+     * 获取最新播放地址
+     */
+    resetLatestPlayUrl(): Promise<void>;
+}

package/modules/module-base.d.ts

@@ -0,0 +1,7 @@
+import PlayerCore from '../core';
+export declare class ModuleBase {
+    private __playerCore;
+    constructor(__playerCore: PlayerCore);
+    getPlayerCore(): PlayerCore;
+    destroy(): void;
+}

package/modules/monitor/monitor-module.d.ts

@@ -0,0 +1,20 @@
+import { ModuleBase } from '../module-base';
+export declare class Monitor extends ModuleBase {
+    /**
+     * 轮询定时器
+     */
+    private __timer;
+    /**
+     * 开始监控
+     */
+    start(): void;
+    /**
+     * 检查是否开始监控
+     */
+    private isStartCheck;
+    private __getPullTime;
+    /**
+     * 停止监控
+     */
+    private __stopTimer;
+}

package/modules/playback/playback-module.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 回放模块
+ */
+import { ModuleBase } from '../module-base';
+import { PlayType } from '../../types';
+export declare class Playback extends ModuleBase {
+    /**
+     * 获取最新回放配置
+     */
+    getPlaybackSetting(): {
+        playType: PlayType;
+        src: string;
+        duration: number | undefined;
+        sessionId: string;
+    } | undefined;
+}

package/modules/quick-control/quick-control-module.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @file 无延迟控制模块
+ */
+/// <reference types="miniprogram-api-typings" />
+import { ModuleBase } from '../module-base';
+import { PlayCoreType } from '../../types';
+export declare class QuickControl extends ModuleBase {
+    /**
+     * 频道是否可以使用无延迟播放
+     * @returns
+     */
+    canUseQuick(): boolean;
+    /**
+     * 设备是否支持无延迟播放
+     * @returns
+     */
+    canQuickSupport(): boolean;
+    /**
+     * 获取无延迟播放地址
+     */
+    getSrcFromQuick(src: string): string;
+    /**
+     * 获取延迟内核配置
+     */
+    getPlayCoreSetting(): {
+        type: PlayCoreType;
+        core: number;
+        enabled: boolean;
+    }[];
+    /**
+     * 设置初始延迟内核
+     */
+    setInitDefaultPlayCore(): void;
+    /**
+     * 切换延迟内核
+     * @param playCore 延迟内核索引 0 代表普通延迟 1 代表无延迟
+     */
+    changePlayCore(playCore: number): void;
+    setLivePlayerStateChange(e: WechatMiniprogram.LivePlayerStateChange): void;
+}

package/modules/restrict/restrict-module.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @file restrict.json 模块
+ */
+import { ModuleBase } from '../module-base';
+export declare class RestrictJson extends ModuleBase {
+    /**
+     * 获取限制信息的配置
+     * @returns
+     */
+    private __getRestrictJson;
+    /**
+     * 获取限制信息的配置备用接口
+     * @returns
+     */
+    private __getBackupRestrictJson;
+    /**
+     * 检查是否可以观看
+     * @returns
+     */
+    checkCanWatch(): Promise<void>;
+}

package/modules/restrict/type.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 用户状态
+ */
+type RestrictUserStatus = 'NORMAL' | '';
+/**
+ * 限制信息配置接口返回内容
+ */
+export interface IRestrictJsonResponse {
+    /**
+     * 用户状态
+     */
+    userStatus: RestrictUserStatus;
+    /**
+     * 是否可以观看
+     */
+    canWatch: boolean;
+    /**
+     * 错误码
+     */
+    errorCode: string;
+}
+/**
+ * 限制信息配置接口请求参数
+ */
+export interface IRestrictJsonRequest {
+    /**
+     * 用户ID
+     */
+    uid: string;
+    /**
+     * 频道ID
+     */
+    cid: string;
+}
+export {};

package/modules/statistics/statistics-module.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @file 统计模块
+ */
+import { ModuleBase } from '../module-base';
+import PlayerCore from '../../core';
+import { PlayerStatisticsSetting } from '../../types';
+export declare class Statistics extends ModuleBase {
+    /**
+     * 开始时间戳
+     */
+    private __startTimeStamps;
+    /**
+     * 轮询定时器
+     */
+    private __pollingInterval;
+    /**
+     * 播放唯一标识 PID
+     */
+    pid: string;
+    /**
+     * 轮询间隔时间
+     */
+    private __pollingIntervalTime;
+    /**
+     * 播放时长
+     */
+    playDuration: number;
+    /**
+     * 播放时长计算定时器
+     */
+    private __playDurationCountInterval;
+    /**
+     * 停留时长开始时间戳
+     */
+    private __stayDurationStartTimeStamps;
+    /**
+     * 统计数据
+     */
+    private __updatingStatistics;
+    constructor(playerCore: PlayerCore);
+    /**
+     * 初始化
+     */
+    private __init;
+    startPolling(): void;
+    stopPolling(): void;
+    startCountPd(): void;
+    stopCountPd(): void;
+    /**
+     * 发送统计日志
+     */
+    sendStatistics(): Promise<void>;
+    /**
+     * 设置统计数据
+     * @param statics 统计数据
+     */
+    setStatics(statics: PlayerStatisticsSetting): void;
+    /**
+     * 改变统计基础参数
+     */
+    changeStatisticsBaseParams(): void;
+    /**
+     * 获取播放唯一标识 PID, 需要注意PID变更pd需要同时重置为0
+     * @returns
+     */
+    private __getPid;
+    destroy(): void;
+}

package/modules/status/export.d.ts

@@ -0,0 +1 @@
+export { ApiStatus } from './type';

package/modules/status/status-module.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file 流状态模块
+ */
+import { ModuleBase } from '../module-base';
+import PlayerCore from '../../core';
+export declare class Status extends ModuleBase {
+    /**
+     * 开始时间戳
+     */
+    private __startTimeStamps;
+    /**
+     * 轮询定时器
+     */
+    private __pollingInterval;
+    constructor(playerCore: PlayerCore);
+    /**
+     * 初始化
+     */
+    private __init;
+    /**
+     * 获取轮询间隔时间
+     * @returns
+     */
+    private __getPollingIntervalTime;
+    /**
+     * 获取流名
+     * @returns
+     */
+    private __getStreamName;
+    /**
+     * 获取频道ID
+     * @returns
+     */
+    private __getCid;
+    startPolling(): void;
+    /**
+     * 停止轮询
+     */
+    stopPolling(): void;
+    destroy(): void;
+}

package/modules/status/type.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 播放器状态
+ */
+export declare 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;
+}

package/modules/warm/warm-module.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 暖场模块
+ */
+import { ModuleBase } from '../module-base';
+import { PlayType } from '../../types';
+export declare class Warm extends ModuleBase {
+    /**
+     * 获取暖场配置
+     */
+    getWarmSetting(): {
+        playType: PlayType;
+        src: string;
+    } | undefined;
+}

package/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@polyv/wx-live-player-core",
+  "version": "3.0.0-dev.12",
+  "main": "polyv-live-player.js",
+  "types": "polyv-live-player.d.ts"
+}

package/player.d.ts

@@ -0,0 +1,139 @@
+/// <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;
+    /**
+     * 事件监听
+     */
+    on<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+    /**
+     * 取消事件监听
+     */
+    off<K extends keyof PlayerEventMap>(event: K, listener: PlayerEventMap[K]): void;
+    /**
+     * 销毁播放实例
+     */
+    destroy(): void;
+}