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

package/README.md

@@ -0,0 +1,153 @@
+
+# 直播小程序播放核心 SDK
+
+## 🎉 当前版本功能概览
+
+保利威直播小程序插件现已全面升级，为您提供更强大、更灵活的直播观看体验！
+
+### ✨ 核心功能特性
+
+- **🎥 多场景播放支持**：直播、回放、暖场图片/视频无缝切换
+- **🌐 多语言国际化**：逐步支持中文、英文等多语言界面
+- **🎮 画中画模式**：支持小窗播放，提升用户体验
+- **⚡ 无延迟播放**：支持超低延迟直播，实时互动更流畅
+- **🎛️ 灵活控制插槽**：9种自定义控制插槽，满足各种UI需求
+- **📱 响应式设计**：完美适配各种屏幕尺寸
+
+
+### 🎯 重大功能升级
+
+#### 🌟 新增画中画(PiP)支持
+- **功能描述**：支持小窗播放模式，用户可以在观看直播的同时进行其他操作
+- **技术实现**：基于微信小程序原生 `picture-in-picture-mode` 属性
+- **使用场景**：多任务处理、边看边聊、后台播放等
+- **配置方式**：
+  ```javascript
+  <plv-live-player
+    pipMode="{{ ['push', 'pop'] }}"
+    config="{{ config }}"
+  />
+  ```
+
+#### ⚡ 无延迟播放技术
+- **功能描述**：支持超低延迟直播播放，延迟可低至1秒以内
+- **技术特点**：
+  - 智能设备兼容性检测
+  - 自动降级机制
+- **设备要求**：
+  - 微信基础库 ≥ 1.7.0
+  - Android系统 ≥ 8.0.27
+  - iOS系统 ≥ 8.0.34
+- **配置方式**：
+  ```javascript
+  // 在设置面板中可选择"正常延迟"或"无延迟"模式
+  ```
+
+#### 🌍 多语言国际化支持
+- **支持语言**：中文(zh_CN)、英文(en)
+- **功能特点**：
+  - 完整的界面文本翻译
+  - 动态语言切换
+  - 模板字符串支持
+- **配置方式**：逐步开启, 后续将支持全量开放
+
+#### 🎛️ 增强的控制插槽系统
+新增9种自定义控制插槽，支持完全自定义播放器界面：
+
+| 插槽类型 | 描述 | 使用场景 |
+|---------|------|----------|
+| `skin` | 完整控制栏 | 完全自定义控制栏 |
+| `skin-play` | 播放按钮 | 自定义播放按钮样式 |
+| `skin-pause` | 暂停按钮 | 自定义暂停按钮样式 |
+| `skin-enterFullScreen` | 进入全屏按钮 | 自定义全屏按钮 |
+| `skin-exitFullScreen` | 退出全屏按钮 | 自定义退出全屏按钮 |
+| `skin-progress` | 进度条 | 自定义进度条组件 |
+| `skin-setting` | 设置按钮 | 自定义设置按钮 |
+| `skin-refresh` | 刷新按钮 | 自定义刷新按钮 |
+| `skin-latency-setting` | 延迟设置 | 自定义延迟模式选择 |
+
+#### 🔥 暖场功能增强
+- **暖场图片**：支持自定义暖场图片显示
+- **暖场视频**：支持暖场视频流播放
+- **自动切换**：直播开始后自动切换到直播流
+
+### 🎮 播放控制增强
+
+#### 📱 播放器接口
+提供丰富的播放器控制接口：
+
+```javascript
+// 播放控制
+player.play();                    // 播放
+player.pause();                   // 暂停
+player.enterFullScreen();         // 进入全屏
+player.exitFullScreen();          // 退出全屏
+player.refresh();                 // 刷新(仅直播)
+player.seek(50);                  // 快进(仅回放)
+
+// 获取播放器上下文
+const playerCtx = player.getVideoContext();
+playerCtx.exitPictureInPicture(); // 退出画中画
+```
+
+#### 🎛️ 设置面板功能
+- **线路切换**：支持多线路选择
+- **清晰度切换**：支持多码率选择
+- **播放倍速**：支持0.5x-2x倍速播放(仅回放)
+- **延迟模式**：支持正常延迟/无延迟切换
+
+### 📊 事件系统完善
+
+#### 🎯 播放事件
+完整的播放状态事件监听：
+
+```javascript
+// 播放状态事件
+bind:videoPlay="onVideoPlay"           // 视频开始播放
+bind:videoPause="onVideoPause"         // 视频暂停播放
+bind:videoEnded="onVideoEnded"         // 视频播放结束
+bind:videoWaiting="onVideoWaiting"     // 视频缓冲中
+bind:videoError="onVideoError"         // 视频播放异常
+
+// 直播专用事件
+bind:livePlay="onLivePlay"             // 直播开始播放
+bind:livePause="onLivePause"           // 直播暂停播放
+bind:liveEnded="onLiveEnded"           // 直播结束
+bind:liveWaiting="onLiveWaiting"       // 直播缓冲中
+bind:liveError="onLiveError"           // 直播异常
+
+// 回放专用事件
+bind:vodPlay="onVodPlay"               // 回放开始播放
+bind:vodPause="onVodPause"             // 回放暂停播放
+bind:vodEnded="onVodEnded"             // 回放结束
+bind:vodTimeUpdate="onVodTimeUpdate"   // 回放时间更新
+bind:vodDurationUpdate="onVodDurationUpdate" // 回放时长更新
+bind:vodWaiting="onVodWaiting"         // 回放缓冲中
+bind:vodSeekCompleted="onVodSeekCompleted" // 回放跳转完成
+bind:vodError="onVodError"             // 回放异常
+
+// 界面事件
+bind:fullScreenChange="onFullScreenChange" // 全屏状态变化
+bind:resolutionChange="onResolutionChange" // 分辨率变化
+```
+
+### 🛠️ 开发体验提升
+
+#### 📚 完整文档支持
+- **API文档**：详细的接口说明和使用示例
+- **类型定义**：完整的TypeScript类型支持
+- **开发指南**：从安装到部署的完整教程
+
+
+## 🎯 性能优化
+
+### 🚀 播放性能
+- **首屏加载**：优化到1秒以内
+- **切换流畅度**：线路/清晰度切换无卡顿
+- **内存占用**：优化内存使用，减少卡顿
+
+### 📱 用户体验
+- **响应速度**：控制按钮响应时间 < 100ms
+- **错误处理**：完善的错误提示和自动重试
+
+

package/api/api-url.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 鉴权、频道配置接口
+ */
+export declare const AUTH_URL: string;
+/**
+ * 限制配置接口
+ */
+export declare const RESTRICT_JSON_URL: string;
+/**
+ * 限制配置备用接口
+ */
+export declare const RESTRICT_JSON_BACKUP_URL: string;
+/**
+ * 频道配置接口
+ */
+export declare const CHANNEL_JSON_URL: string;
+/**
+ * 频道配置备用接口
+ */
+export declare const CHANNEL_JSON_BACKUP_URL: string;
+/**
+ * 获取API状态
+ */
+export declare const API_STATUS_URL: string;
+/**
+ * 发送统计日志接口
+ */
+export declare const STATISTICS_URL: string;
+/**
+ * 发送统计备用日志接口
+ */
+export declare const STATISTICS_BACKUP_URL: string;

package/api/index.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 鉴权校验接口
+ * @param appId
+ * @param sign
+ * @param timestamp
+ * @param cid
+ * @returns
+ */
+export declare function checkAuth<K>(params: {
+    appId: string;
+    sign: string;
+    timestamp: number;
+    channelId: string;
+}): Promise<K>;
+/**
+ * 鉴权校验接口
+ * @param params
+ */
+export declare function checkAuthByToken<K>(params: {
+    channelId: string;
+    token: string;
+}): Promise<K>;
+/**
+ * 获取限制信息配置
+ * @param uid 用户ID
+ * @param cid 频道ID
+ * @returns 限制信息配置
+ */
+export declare function getBackupRestrictJson<T, K>(uid: string, cid: string): Promise<K>;
+/**
+ * 获取限制信息配置备用接口
+ * @param uid 用户ID
+ * @param cid 频道ID
+ * @returns 限制信息配置
+ */
+export declare function getRestrictJson<T, K>(uid: string, cid: string): Promise<K>;
+/**
+ * 获取频道配置
+ * @param uid 用户ID
+ * @param cid 频道ID
+ * @returns 频道配置
+ */
+export declare function getChannelJson<T, K>(uid: string, cid: string): Promise<K>;
+/**
+ * 获取频道配置
+ * @param uid 用户ID
+ * @param cid 频道ID
+ * @returns 频道配置
+ */
+export declare function getBackupChannelJson<T, K>(uid: string, cid: string): Promise<K>;
+/**
+ * 获取API状态
+ * @param cid 频道ID
+ * @param streamName 流名
+ * @returns
+ */
+export declare function getApiStatus<T, K>(cid: string, streamName: string): Promise<K>;
+/**
+ * 发送统计日志
+ * @param data 统计数据
+ * @returns
+ */
+export declare function sendStatistics<T, K>(data: T): Promise<K>;
+/**
+ * 发送统计日志, 备用接口
+ * @param data 统计数据
+ * @returns
+ */
+export declare function sendBackupStatistics<T, K>(data: T): Promise<K>;

package/api/request.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 请求器
+ * @param url
+ * @param options
+ * @returns
+ */
+export declare function request<T, R>(url: string, options: T): Promise<R>;

package/core.d.ts

@@ -0,0 +1,93 @@
+import Store from './store';
+import { Statistics } from './modules/statistics/statistics-module';
+import { Status } from './modules/status/status-module';
+import { RestrictJson } from './modules/restrict/restrict-module';
+import { ChannelModule } from './modules/channel/channel-module';
+import { Auth } from './modules/auth/auth-module';
+import { Warm } from './modules/warm/warm-module';
+import { Live } from './modules/live/live-module';
+import { Playback } from './modules/playback/playback-module';
+import { LineControl } from './modules/line-control/line-control-module';
+import { LevelControl } from './modules/level-control/level-control-module';
+import { QuickControl } from './modules/quick-control/quick-control-module';
+import { Monitor } from './modules/monitor/monitor-module';
+import EventEmitter from 'eventemitter3';
+import { PlayerConfig } from './types';
+export default class PlayerCore {
+    config: PlayerConfig;
+    /**
+     * 数据存储
+     */
+    store: Store;
+    /**
+     * 事件
+     */
+    events: EventEmitter;
+    /**
+     * 鉴权
+     */
+    auth: Auth;
+    /**
+     * 限制观看配置
+     */
+    restrict: RestrictJson;
+    /**
+     * 频道配置
+     */
+    channel: ChannelModule;
+    /**
+     * 状态
+     */
+    status: Status;
+    /**
+     * 统计
+     */
+    statistics: Statistics;
+    /**
+     * 暖场
+     */
+    warm: Warm;
+    /**
+     * 直播
+     */
+    live: Live;
+    /**
+     * 回放
+     */
+    playback: Playback;
+    /**
+     * 无延迟控制
+     */
+    quickControl: QuickControl;
+    /**
+     * 线路控制
+     */
+    lineControl: LineControl;
+    /**
+     * 清晰度控制
+     */
+    levelControl: LevelControl;
+    /**
+     * 监控
+     */
+    monitor: Monitor;
+    /**
+     * 是否已触发播放就绪事件
+     */
+    private __hasTriggerReady;
+    constructor(config: PlayerConfig);
+    /**
+     * 初始化数据存储
+     */
+    private initStore;
+    getConfig(): PlayerConfig;
+    /**
+     * 更新播放器信息
+     */
+    updatePlayerInfo(): void;
+    /**
+     * 触发类型变更事件 （update_media_info）
+     */
+    private __emitTypeChangeEvent;
+    destroy(): void;
+}

package/events-type.d.ts

@@ -0,0 +1,86 @@
+import { PlayType, PlayerMediaInfo } from './types';
+import { PlayerError } from './types/error-code';
+import { IGetApiStatusResponse } from './modules/status/type';
+import { IChannelJsonConfig } from './modules/channel/type';
+/**
+ * 播放器事件类型
+ */
+export declare 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;
+};

package/export.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './events-type';
+export * from './modules/status/export';

package/index.d.ts

@@ -0,0 +1,4 @@
+/** @file 入口文件 */
+import { PolyvLive } from './player';
+export default PolyvLive;
+export * from './export';

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

@@ -0,0 +1,14 @@
+/**
+ * @file 鉴权
+ */
+import { ModuleBase } from '../module-base';
+/**
+ * 鉴权
+ */
+export declare class Auth extends ModuleBase {
+    /**
+     * 检查是否有对应频道的观看权限
+     * @returns
+     */
+    check(): Promise<void>;
+}

package/modules/auth/type.d.ts

@@ -0,0 +1,18 @@
+import { YN } from '../../types';
+/**
+ * 频道配置响应参数
+ */
+export interface IDetailConfig {
+    /**
+     * 无延迟可用状态
+     */
+    pureRtcAvailState: YN;
+    /**
+     * 无延迟开关状态
+     */
+    quickLiveEnabled: YN;
+    /**
+     * rtc类型
+     */
+    rtcType: string;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * @file channel.json 模块
+ */
+import { ModuleBase } from '../module-base';
+import { IChannelJsonConfig } from './type';
+export declare class ChannelModule extends ModuleBase {
+    /**
+     * 获取频道配置
+     * @returns
+     */
+    getChannelJson(): Promise<IChannelJsonConfig | undefined>;
+    private __decryptChannelData;
+    /**
+     * 检查账号状态
+     * @param status 账号状态
+     */
+    private __checkAccount;
+    /**
+     * 获取频道配置并存储配置
+     * @returns
+     */
+    getChannelJsonAndStoreConfig(): Promise<IChannelJsonConfig | undefined>;
+}

package/modules/channel/type.d.ts

@@ -0,0 +1,163 @@
+import { YN } from "../../types";
+/**
+ * 多码率配置
+ */
+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;
+}