quickvo-sdk-js 0.8.3 → 0.9.1

package/dist/room/PrTaskQueue.d.ts

@@ -0,0 +1,154 @@
+interface Options {
+    /**
+     * 调试模式
+     */
+    debug?: boolean;
+}
+interface Task<T> {
+    /**
+     * 任务唯一标识
+     */
+    key: string;
+    /**
+     * 任务描述
+     */
+    describe: string;
+    /**
+     * 严格模式
+     * @description 如果开启 则不自动清除该任务 需要由外部调用 taskQueue.clear([task.key]) 来清除
+     * @description 如果关闭 则无论任务执行的结果 只要该任务符合并且执行过一次则自动销毁
+     */
+    strict: boolean;
+    /**
+     * 任务执行条件 (当所有条件均为true时 该任务才执行)
+     */
+    conditionKeys: T[];
+    /**
+     * 是否正在运行
+     */
+    runing: boolean;
+    /**
+     * 任务函数
+     */
+    func: () => Promise<unknown>;
+    /**
+     * 当前任务是否符合执行条件
+     */
+    checkAccord: () => boolean;
+    /**
+     * 任务完成
+     */
+    success: (_e: any) => void;
+    /**
+     * 任务失败
+     */
+    fail: (_e: any) => void;
+    /**
+     * 任务结束
+     */
+    complete: () => void;
+    /**
+     * 执行任务
+     */
+    run: () => Promise<void>;
+    /**
+     * 重试任务
+     */
+    retry: () => Promise<void>;
+    /**
+     * 清除任务
+     */
+    clear: () => void;
+}
+interface CreateTask<T> {
+    /**
+     * 任务描述
+     */
+    describe?: string;
+    /**
+     * 严格模式
+     * @description 如果开启 则不自动清除该任务 需要由外部调用 taskQueue.clear([task.key]) 来清除
+     * @description 如果关闭 则无论任务执行的结果 只要该任务符合并且执行过一次则自动销毁
+     */
+    strict?: boolean;
+    /**
+     * 任务超时时间(ms) 任务超时也属于任务执行结果
+     */
+    timeout?: number;
+    /**
+     * 任务执行条件 (当所有条件均为true时 该任务才执行)
+     */
+    conditionKeys: T[];
+    /**
+     * 任务函数
+     */
+    func: () => Promise<unknown>;
+    /**
+     * 任务完成
+     */
+    success?: (_e: any) => void;
+    /**
+     * 任务失败
+     */
+    fail?: (_e: any) => void;
+    /**
+     * 任务结束
+     */
+    complete?: () => void;
+}
+export declare class PrTaskQueue<T extends string> {
+    #private;
+    /**
+     * 初始化条件
+     * @example const taskQueue = new PrTaskQueue(['login','isAdmin'])
+     * @param conditionKeys 条件keys string[]
+     */
+    constructor(conditionKeys: T[], _options?: Options);
+    /**
+     * 设置条件
+     * @param conditionKey 条件名
+     * @param accord 条件状态
+     */
+    setCondition: (conditionKey: T, accord: boolean) => Promise<void>;
+    /**
+     * 创建任务
+     * @param options.describe 描述信息
+     * @param options.conditionKeys 执行条件 （所有条件符合时才执行该任务）
+     * @param options.func 任务函数
+     */
+    createTask: (options: CreateTask<T>) => Promise<{
+        key: string;
+        describe: string;
+        strict: boolean;
+        conditionKeys: T[];
+        runing: boolean;
+        func: () => Promise<unknown>;
+        checkAccord: () => boolean;
+        success: (_e: any) => void;
+        fail: (_e: any) => void;
+        complete: () => void;
+        run: () => Promise<void>;
+        retry: () => Promise<void>;
+        clear: () => void;
+    }>;
+    /**
+     * 尝试执行任务
+     */
+    executeTasks: () => Promise<void>;
+    /**
+     * 清理任务
+     * @param taskKey 任务keys
+     */
+    clear: (taskKeys?: string[]) => void;
+    /**
+     * 查询所有条件当前状态
+     */
+    getConditions: () => {
+        [k: string]: boolean;
+    };
+    /**
+     * 查询所有待执行任务
+     */
+    getTasks: () => Map<String, Task<T>>;
+}
+export {};

package/dist/room/RoomBase.d.ts

@@ -9,10 +9,11 @@ type Options = QuickOptions & RoomOptions & CallsWebSocketOptions & {
 export declare class RoomBase {
     #private;
     options: Options;
+    sdk_service_version: string;
     prohibitNotify: boolean;
     isEarly: boolean;
     isInRoom: boolean;
-    taskQueue: PrTaskQueue<"closeTrack" | "subscribe" | "joinRoom" | "createWs" | "createSession" | "ice" | "createTrack">;
+    taskQueue: PrTaskQueue<"closeTrack" | "renegotiate" | "subscribe" | "publish" | "joinRoom" | "createWs" | "createSession" | "ice" | "createTrack">;
     roomState: K_roomState;
     createAt: number;
     cwsIns: CallsWebSocket;
@@ -29,13 +30,13 @@ export declare class RoomBase {
     };
     constructor(options: QuickOptions);
     /**
-     * 提交日志
+     * reportLogs
      */
     reportLogs: (_type: Report_Log_Type, describe?: string) => void;
     initPhoneyStreams: (audioContext: AudioContext) => void;
     getPhoneyStreams: (mediaType: K_mediaType) => MediaStream;
     /**
-     * 获取房间信息
+     * getRoomInfo
      */
     getRoomInfo: () => {
         roomState: string;
@@ -44,6 +45,7 @@ export declare class RoomBase {
         url?: string;
         logUrl?: string;
         debug?: boolean;
+        reportErr?: boolean;
         callStrategy?: import('../enums/callStrategy').K_callStrategy;
         sdkToken?: string;
         roomId: string;
@@ -54,19 +56,19 @@ export declare class RoomBase {
         earlyId?: string;
     };
     /**
-     * 设置房间状态
+     * setRoomState
      */
     setRoomState: (state: K_roomState) => void;
     /**
-     * 设置SDK属性
+     * setOptions
      */
     setOptions: (options: Partial<Options>) => Promise<void>;
     /**
-     * 停止轨道
+     * stopStream
      */
     stopStream: (stream: MediaStream) => Promise<void>;
     /**
-     * 获取媒体设备错误信息
+     * getMediaDevicesErrInfo
      */
     getMediaDevicesErrInfo: () => Promise<{
         microphoneCamera_audio: string;
@@ -75,11 +77,11 @@ export declare class RoomBase {
         screenSharing_audio: string;
     }>;
     /**
-     * 获取MediaKey
+     * getUserMediaKey
      */
     getUserMediaKey: (userId: string, mediaType: string) => string;
     /**
-     * 获取 CallAction map
+     * getCallActionMap
      */
     getCallActionMap: (callAction?: number) => {
         microphoneCamera_audio: boolean;
@@ -88,24 +90,21 @@ export declare class RoomBase {
         screenSharing_audio: boolean;
     };
     /**
-     * 获取音量
+     * getAverageVolume
      */
     getAverageVolume: (analyser: AnalyserNode, dataArray: Uint8Array) => number;
     /**
-     * 通过轨道计算当前用户的通话状态
+     * getCallAction
      */
     getCallAction: (tracks: UserTrack[]) => Promise<number>;
     /**
-     * 获取指定轨道的名称数组
-     * @param tracks 轨道
+     * getTrackNamesFormTracks
+     * @param tracks
      * @param types  number[] = []
      * @param keyName
      * @returns string[]
      */
     getTrackNamesFormTracks: (tracks: any[], types?: number[], keyName?: string) => string[];
-    /**
-     * 处理为应用层数据
-     */
     usersFilter: (users: RoomUser[]) => RoomUser[];
 }
 export {};

package/dist/room/RoomCalls.d.ts

@@ -3,56 +3,56 @@ import { QuickOptions, RoomOptions, RoomUser, Streams } from '../types';
 import { RoomPeer } from './RoomPeer';
 export declare class RoomCalls extends RoomPeer {
     #private;
-    sdk_service_version: string;
     constructor(options: QuickOptions);
     /**
-     * 预连接
-     * @param mediaTypes MediaType[]
-     * @example quickvo.earlyConnect(['microphoneCamera_audio', 'microphoneCamera_video'])
-     */
-    earlyConnect: (mediaTypes?: K_mediaType[]) => void;
-    /**
-     * 设置本地流
+     * setLocalStream
      * @param mediaType MediaType
-     * @param active 激活状态
+     * @param active boolean
      * @example quickvo.setLocalStream('microphoneCamera_audio', false)
      * @example quickvo.setLocalStream(['microphoneCamera_audio', 'microphoneCamera_video'], false)
      * @returns Promise<Streams>
      */
     setLocalStream: (mediaTypes: K_mediaType[] | K_mediaType, active: boolean) => Promise<Streams>;
     /**
-     * 设置正在使用的媒体设备
-     * @param mediaDeviceKind 设备类型 "audioinput" | "audiooutput" | "videoinput"
-     * @param deviceId 设备ID
+     * setMediaDeviceKind
+     * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"
+     * @param deviceId string
      */
     setMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind, deviceId: string) => Promise<boolean | Streams>;
     /**
-     * 改变屏幕共享流
-     * @param mediaDeviceKind 设备类型 "audioinput" | "audiooutput" | "videoinput"
-     * @param deviceId 设备ID
+     * changeScreenSharing
+     * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"
+     * @param deviceId string
      */
     changeScreenSharing: (mediaTypes: ("screenSharing_video" | "screenSharing_audio")[]) => Promise<void>;
+    createSession: () => Promise<unknown>;
     /**
-     * 加入房间
+     * earlyConnect
+     * @param mediaTypes MediaType[]
+     * @example quickvo.earlyConnect(['microphoneCamera_audio', 'microphoneCamera_video'])
+     */
+    earlyConnect: (mediaTypes?: K_mediaType[]) => void;
+    /**
+     * joinRoom
      * @param roomOptions RoomOptions
      * @example quickvo.joinRoom({ userId: '', roomId: '', sdkToken: '', callType: '1' , newPublishAutoSubscribe: true })
      * @returns Promise<boolean>
      */
     joinRoom: (roomOptions: RoomOptions) => Promise<RoomUser[]>;
     /**
-     * 退出房间
+     * quitRoom
      * @example quickvo.quitRoom()
      * @returns Promise<boolean>
      */
     quitRoom: () => Promise<boolean>;
     /**
-     * 退出房间 不断开连接
+     * quitRoom and continuously open the connection
      * @example quickvo.quitRoomEx()
      * @returns Promise<boolean>
      */
     quitRoomEx: () => Promise<boolean>;
     /**
-     * 同步房间信息
+     * syncRoomInfo
      * @example quickvo.syncRoomInfo()
      */
     syncRoomInfo: () => Promise<RoomUser[]>;
@@ -64,43 +64,46 @@ export declare class RoomCalls extends RoomPeer {
      */
     publish: (mediaTypes: K_mediaType[]) => Promise<RoomUser>;
     /**
-     * 停止发布流
+     * stopPublish
      * @param trackNames  string[] = []
      * @example quickvo.stopPublish(['microphoneCamera_audio'])
      * @returns Promise<RoomUser>
      */
     stopPublish: (mediaTypes?: K_mediaType[]) => Promise<RoomUser>;
     /**
-     * 订阅流
-     * @param trackNames 轨道名称
-     * @param count 订阅失败重试次数
+     * subscribe
+     * @param trackNames strig[]
+     * @param count number
      * @example quickvo.subscribe(['trackName1','trackName2'])
      * @returns Promise<RoomUser[]>
      */
-    subscribe: (trackNames?: string[], count?: number) => Promise<RoomUser[]>;
+    subscribe: (trackNames?: string[], count?: number) => Promise<{
+        users: RoomUser[];
+        detail: {
+            target: string[];
+            success: string[];
+            fail: string[];
+        };
+    }>;
     /**
-     * 协商流
+     * renegotiate
      */
     renegotiate: () => Promise<unknown>;
     /**
-     * 停止订阅流
+     * stopSubscribe
      * @param trackNames  string[] = []
      * @example quickvo.subscribe(['trackName1'])
      */
     stopSubscribe: (trackNames?: string[]) => Promise<boolean>;
     /**
-     * 冻结轨道
-     * @param mediaTypes MediaType[] 轨道类型
-     * @param enabled 是否冻结
+     * inactiveTracks
+     * @param mediaTypes MediaType[]
+     * @param enabled boolean
      * @example quickvo.inactiveTracks(['microphoneCamera_audio'], false)
      */
     inactiveTracks: (mediaTypes: K_mediaType[], enabled: boolean) => Promise<boolean>;
-    /**
-     * 远端调试
-     */
     debugger: () => Promise<any>;
-    /**
-     * 清除缓存
-     */
     shutdown: () => Promise<any>;
+    initHeartbeat: () => void;
+    stopHeartbeat: () => void;
 }

package/dist/room/RoomMedias.d.ts

@@ -8,109 +8,109 @@ export declare class RoomMedias extends RoomBase {
     localStreamsActionMap: Map<K_mediaType, Boolean>;
     constructor(options: QuickOptions);
     /**
-     * 播放所有音频
+     * resume
      */
     resume: () => void;
     /**
-     * 房间所有用户所有媒体流变化
+     * emitNotifyUpdateUsersStreams
      */
     emitNotifyUpdateUsersStreams: (notifys: Array<{
         userId: string;
         updateStreams: { [key in K_mediaType]?: boolean; };
     }>) => Promise<void>;
     /**
-     * 初始化用户媒体上下文
+     * initUserMediaStreamContext
      */
     initUserMediaStreamContext: (userId: string, mediaType: K_mediaType, stream: MediaStream) => Promise<void>;
     /**
-     * 获取用户媒体流上下文
+     * getUserMediaStreamContext
      */
     getUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => AudioMediaContext | VideoMediaContext | undefined;
     /**
-     * 获取用户音频媒体流上下文
+     * getUserAudioMediaStreamContext
      */
     getUserAudioMediaStreamContext: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => AudioMediaContext;
     /**
-     * 删除用户媒体流上下文
+     * removeUserMediaStreamContext
      */
     removeUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => void;
     /**
-     * 获取某个用户的某个数据流
+     * getUserStream
      */
     getUserStream: (userId: string, mediaType: K_mediaType) => MediaStream;
     /**
-     * 获取某个用户的某些数据流
+     * getUserStreams
      */
     getUserStreams: (userId: string, mediaTypes?: K_mediaType[]) => Streams;
     /**
-     * 删除某个用户的某些数据流
+     * removeUserStreams
      */
     removeUserStreams: (userId: string, mediaTypes?: K_mediaType[]) => Promise<void>;
     /**
-     * 清除所有媒体流使用
+     * clearUserStreams
      */
     clearUserStreams: () => void;
     /**
-     * 设置轨道媒体参数
+     * setMediaTrackConstraints
      */
     setMediaTrackConstraints: (mediaType: K_mediaType, constraints: MediaTrackConstraints) => Promise<void>;
     /**
-     * 停止本地流
+     * stopLocalStreams
      */
     stopLocalStreams: (mediaTypes?: K_mediaType[]) => Promise<void>;
     addLocalStream: (mediaType: K_mediaType, stream: MediaStream) => void;
     /**
-     * 初始化本地流
+     * initLocalStream
      */
     initLocalStream: (mediaType: K_mediaType | "microphoneCamera" | "screenSharing") => Promise<void>;
     /**
-     * 获取本地的数据流
+     * getLocalStream
      */
     getLocalStream: (mediaType: K_mediaType) => MediaStream | undefined;
     /**
-     * 获取本地的某些数据流
+     * getLocalStreams
      */
     getLocalStreams: (mediaTypes?: K_mediaType[]) => Streams;
     /**
-     * 获取正在使用的媒体设备ID
-     * @param mediaDeviceKind 设备类型 "audioinput" | "audiooutput" | "videoinput"
-     * @returns deviceId 设备ID
+     * getMediaDeviceKind
+     * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"
+     * @returns deviceId string
      */
     getMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind) => string | undefined;
     /**
-     * 更改音频输出
+     * changeAudiooutput
      */
     changeAudiooutput: () => void;
     /**
-     * 设置正在使用的媒体设备
-     * @param mediaDeviceKind 设备类型 "audioinput" | "audiooutput" | "videoinput"
-     * @param deviceId 设备ID
+     * setDeviceKind
+     * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"
+     * @param deviceId string
      */
     setDeviceKind: (mediaDeviceKind: MediaDeviceKind, deviceId: string) => void;
     /**
-     * 设置音频输出设备
-     * @param deviceId 设备ID
+     * setAudioOutputDevice
+     * @param deviceId string
      * @returns
      */
     setAudioOutputDevice: (deviceId: string) => void;
     /**
-     * 获取可用设备
-     * @param mediaDeviceKind 设备类型 "audioinput" | "audiooutput" | "videoinput"
+     * getEnumerateDevices
+     * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"
      * @returns MediaDeviceInfo[]
      */
     getEnumerateDevices: (mediaDeviceKind: MediaDeviceKind) => Promise<MediaDeviceInfo[]>;
     /**
-     * 获取可用音频输入设备
+     * getEnumerateAudioinputDevices
      * @returns MediaDeviceInfo[]
      */
     getEnumerateAudioinputDevices: () => Promise<MediaDeviceInfo[]>;
     /**
-     * 获取可用音频输出设备
+     * getEnumerateAudioOutputDevices
      * @returns MediaDeviceInfo[]
      */
     getEnumerateAudioOutputDevices: () => Promise<MediaDeviceInfo[]>;
     /**
-     * 获取可用视频输入设备
+     * getEnumerateVideoinputDevices
      * @returns MediaDeviceInfo[]
      */
     getEnumerateVideoinputDevices: () => Promise<MediaDeviceInfo[]>;

package/dist/room/RoomPeer.d.ts

@@ -16,11 +16,11 @@ export declare class RoomPeer extends RoomUsers {
     constructor(options: QuickOptions);
     initPeer: () => void;
     /**
-     * 替换发射器媒体流
+     * replaceSenderStream
      */
     replaceSenderStream: (mediaTypes: K_mediaType[] | undefined, isReal: Boolean) => Promise<void>;
     /**
-     * 获取发射器轨道信息
+     * getSenderTracks
      */
     getSenderTracks: (mediaTypes?: K_mediaType[]) => Promise<{
         type: number;
@@ -30,49 +30,43 @@ export declare class RoomPeer extends RoomUsers {
         mid: string | null;
     }[]>;
     /**
-     * 添加发射器
+     * addSenders
      */
     addSenders: (mediaTypes?: K_mediaType[]) => Promise<("microphoneCamera_audio" | "microphoneCamera_video" | "screenSharing_video" | "screenSharing_audio")[]>;
     /**
-     * 移除发射器
+     * removeSenders
      */
     removeSenders: (mediaTypes?: K_mediaType[]) => Promise<void>;
     /**
-     * 监听订阅轨道结果
+     * onSubscribeUserTracks
      */
     onSubscribeUserTracks: (users: any[]) => Promise<unknown>;
     /**
-     * 关闭某个用户的某些轨道
+     * closeUserTracks
      */
     closeUserTracks: (userId: string, closeTracks?: UserTrack[], remove?: boolean) => Promise<void>;
     createOffer: () => Promise<void>;
     createAnswer: () => Promise<void>;
-    /**
-     * 生成本地sdp
-     */
     getSdp: () => string | undefined;
-    /**
-     * 设置远程描述协议
-     */
     setRemoteDescription: (description: RTCSessionDescriptionInit) => Promise<RTCSessionDescriptionInit>;
     /**
-     * 设置通讯策略
+     * setCallStrategy
      * @param callStrategy "fixedPictureQuality" | "qualityPriority" | "fluencyPriority" | "balancedDowngrade"
      * @param mediaTypes mediaType[] "microphoneCamera_audio" | "microphoneCamera_video" | "screenSharing_video" | "screenSharing_audio"
      * @example quickvo.setCallStrategy('fixedPictureQuality')
      */
     setCallStrategy: (callStrategy: K_callStrategy, mediaTypes?: K_mediaType[]) => Promise<void>;
     /**
-     * 设置 RTCRtpSender 参数
+     * setRTCRtpSenderParameters
      * @param parameters RTCRtpSendParameters
      */
     setRTCRtpSenderParameters: (parameters: RTCRtpSendParameters) => void;
     /**
-     * 获取分析报告
+     * getReportsByMid
      */
     getReportsByMid: (mids?: string[]) => Promise<any[]>;
     /**
-     * 获取房间网络信息
+     * getRoomNetwork
      */
     getRoomNetwork: () => {
         inboundBytes: number;
@@ -82,7 +76,7 @@ export declare class RoomPeer extends RoomUsers {
         jitter: string;
     };
     /**
-     * 获取peer网络情况
+     * getPeerNetwork
      */
     getPeerNetwork: () => {
         inboundBytes: number;
@@ -92,7 +86,7 @@ export declare class RoomPeer extends RoomUsers {
         jitter: string;
     };
     /**
-     * 停止网络报告分析
+     * stopGetPeerStats
      */
     stopGetPeerStats: () => void;
 }