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

package/types/index.d.ts

@@ -0,0 +1,202 @@
+/**
+ * 是/否
+ */
+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 declare enum PlayType {
+    /**
+     * 直播
+     */
+    LIVE = "live",
+    /**
+     * 回放
+     */
+    VOD = "vod",
+    /**
+     * 暖场图片
+     */
+    WARM_IMAGE = "warmImage",
+    /**
+     * 暖场视频
+     */
+    WARM_VIDEO = "warmVideo",
+    /**
+     * 等待开始直播
+     */
+    WAIT_START = "waitStart"
+}
+/**
+ * 清晰度类型
+ */
+export declare enum LevelType {
+    /**
+     * 流畅
+     */
+    SD = "sd",
+    /**
+     * 高清
+     */
+    HD = "hd",
+    /**
+     * 超清
+     */
+    FHD = "fhd"
+}
+/**
+ * 清晰度列表节点
+ */
+export interface LevelItem {
+    /** 清晰度类型 */
+    type: LevelType;
+    /** 级别 */
+    level: number;
+}
+/**
+ * 线路列表节点
+ */
+export interface LineItem {
+    /** 线路类型 */
+    type: string;
+    /** 线路 */
+    line: number;
+}
+/**
+ * 延迟内核类型
+ */
+export declare 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;
+    };
+}

package/utils/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 限制数字范围
+ * @param num 原始数字
+ * @param min 最小值
+ * @param max 最大值
+ * @returns 限制后的数字
+ */
+export declare function limit(num: number, min?: number, max?: number): number;
+/**
+ * 清除字符串的双引号
+ * @param str 原始字符串
+ * @returns 清除双引号后的字符串
+ */
+export declare function removeQuotes(str: string): string;
+/**
+ * 拼接url
+ * @param url 原始url
+ * @param str 拼接字符串
+ * @returns 拼接后的url
+ */
+export declare function concatUrl(url: string, str: string): string;
+/**
+ * 检测链接是否为m3u8格式
+ * @param url 需要检测的链接
+ * @returns 是否为m3u8格式
+ */
+export declare function isM3u8(url: string): boolean;
+/**
+ * 比较版本号
+ * @param versionA 版本号A
+ * @param versionB 版本号B
+ * @returns 比较结果
+ */
+export declare function compareVersions(versionA: string, versionB: string): 1 | -1 | 0;

package/utils/stringByte.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 获取配置文件解密k ey
+ */
+export declare function getString(): string;
+/**
+ * 获取配置文件解密i v
+ */
+export declare function getString2(): string;
+/**
+ * 字符串转字节数组
+ * @param str
+ */
+export declare function stringToBytes(str: string): number[];