quickvo-sdk-js 0.9.3 → 0.9.5

package/dist/room/NetworkQualityTester.d.ts

@@ -0,0 +1,44 @@
+export declare class NetworkQualityTester {
+    targetUrls: string[];
+    results: any[];
+    constructor(targetUrls?: string[]);
+    testAll(): Promise<{
+        overallSuccess: boolean;
+        message: string;
+        totalTests?: undefined;
+        successfulTests?: undefined;
+        averageDownloadSpeed?: undefined;
+        averageResponseTime?: undefined;
+        totalDataTransferred?: undefined;
+        detailedResults?: undefined;
+    } | {
+        overallSuccess: boolean;
+        totalTests: number;
+        successfulTests: number;
+        averageDownloadSpeed: string;
+        averageResponseTime: string;
+        totalDataTransferred: string;
+        detailedResults: any[];
+        message?: undefined;
+    }>;
+    testUrl(url: string): Promise<void>;
+    analyzeResults(): {
+        overallSuccess: boolean;
+        message: string;
+        totalTests?: undefined;
+        successfulTests?: undefined;
+        averageDownloadSpeed?: undefined;
+        averageResponseTime?: undefined;
+        totalDataTransferred?: undefined;
+        detailedResults?: undefined;
+    } | {
+        overallSuccess: boolean;
+        totalTests: number;
+        successfulTests: number;
+        averageDownloadSpeed: string;
+        averageResponseTime: string;
+        totalDataTransferred: string;
+        detailedResults: any[];
+        message?: undefined;
+    };
+}

package/dist/room/RoomBase.d.ts

@@ -3,6 +3,8 @@ import { QuickOptions, Report_Log_Type, RoomOptions, RoomUser, UserTrack } from
 import { CallsWebSocket, CallsWebSocketOptions } from './CallsWebSocket';
 import { K_mediaType } from '../enums/mediaType';
 import { PrTaskQueue } from 'pr-task-queue';
+import { NetworkQualityTester } from './NetworkQualityTester';
+import { StreamRecorder } from './StreamRecorder';
 type Options = QuickOptions & RoomOptions & CallsWebSocketOptions & {
     earlyId?: string;
 };
@@ -12,15 +14,19 @@ export declare class RoomBase {
     prohibitNotify: boolean;
     isEarly: boolean;
     isInRoom: boolean;
-    taskQueue: PrTaskQueue<"closeTrack" | "renegotiate" | "subscribe" | "publish" | "joinRoom" | "createWs" | "createSession" | "ice" | "createTrack">;
+    taskQueue: PrTaskQueue<"publish" | "subscribe" | "renegotiate" | "closeTrack" | "joinRoom" | "createWs" | "createSession" | "ice" | "createTrack">;
     roomState: K_roomState;
     createAt: number;
     cwsIns: CallsWebSocket;
     peerIns: RTCPeerConnection;
     transceiverMap: Map<"microphoneCamera_audio" | "microphoneCamera_video" | "screenSharing_video" | "screenSharing_audio", RTCRtpTransceiver>;
+    sendChannel: RTCDataChannel;
+    receiveChannel: RTCDataChannel;
     userMap: Map<string, RoomUser>;
     setLocalStreamActiveMap: Map<K_mediaType, Boolean>;
     phoneyStreams: Map<K_mediaType, MediaStream>;
+    recorder: StreamRecorder;
+    networkQualityTester: NetworkQualityTester;
     mediaDevicesErrInfo: {
         microphoneCamera_audio: string;
         microphoneCamera_video: string;
@@ -32,7 +38,7 @@ export declare class RoomBase {
      * reportLogs
      */
     reportLogs: (_type: Report_Log_Type, describe?: string) => void;
-    initPhoneyStreams: (audioContext: AudioContext) => void;
+    initPhoneyStreams: (audioContext: AudioContext, mediaTypes?: K_mediaType[]) => void;
     getPhoneyStreams: (mediaType: K_mediaType) => MediaStream;
     /**
      * getRoomInfo
@@ -79,6 +85,10 @@ export declare class RoomBase {
      * getUserMediaKey
      */
     getUserMediaKey: (userId: string, mediaType: string) => string;
+    /**
+     * getCallAction
+     */
+    getCallAction: (tracks: UserTrack[]) => Promise<number>;
     /**
      * getCallActionMap
      */
@@ -89,13 +99,18 @@ export declare class RoomBase {
         screenSharing_audio: boolean;
     };
     /**
-     * getAverageVolume
+     * getBanBehaviorMap
      */
-    getAverageVolume: (analyser: AnalyserNode, dataArray: Uint8Array) => number;
+    getBanBehaviorMap: (num?: number) => {
+        microphoneCamera_audio: boolean;
+        microphoneCamera_video: boolean;
+        screenSharing_video: boolean;
+        screenSharing_audio: boolean;
+    };
     /**
-     * getCallAction
+     * getAverageVolume
      */
-    getCallAction: (tracks: UserTrack[]) => Promise<number>;
+    getAverageVolume: (analyser: AnalyserNode, dataArray: Uint8Array) => number;
     /**
      * getTrackNamesFormTracks
      * @param tracks

package/dist/room/RoomCalls.d.ts

@@ -102,6 +102,21 @@ export declare class RoomCalls extends RoomPeer {
      * @example quickvo.inactiveTracks(['microphoneCamera_audio'], false)
      */
     inactiveTracks: (mediaTypes: K_mediaType[], enabled: boolean) => Promise<boolean>;
+    /**
+     * setBanBehaviors
+     */
+    setBanBehaviors: (usersBehaviors: Array<{
+        id: string;
+        banBehaviors: { [key in K_mediaType]?: boolean; };
+    }>) => Promise<unknown>;
+    /**
+     * pubChannel
+     */
+    pubChannel: () => Promise<Boolean>;
+    /**
+     * subChannel
+     */
+    subChannel: (userChannels?: any[]) => Promise<Boolean>;
     debugger: () => Promise<any>;
     shutdown: () => Promise<any>;
     initHeartbeat: () => void;

package/dist/room/RoomMedias.d.ts

@@ -1,16 +1,22 @@
 import { K_mediaType } from '../enums/mediaType';
 import { QuickOptions, Streams } from '../types';
-import { AudioMediaContext } from './mediaStreams/AudioMediaContext';
-import { VideoMediaContext } from './mediaStreams/VideoMediaContext';
+import { VideoMediaContext } from './VideoMediaContext';
 import { RoomBase } from './RoomBase';
+import { PrAudioStream } from 'pr-audio-stream';
 export declare class RoomMedias extends RoomBase {
     #private;
     localStreamsActionMap: Map<K_mediaType, Boolean>;
+    audioContext: AudioContext;
     constructor(options: QuickOptions);
+    initMediaPhoneyStreams: (mediaTypes?: K_mediaType[]) => void;
     /**
-     * resume
+     * initLocalStreamsFilter
      */
-    resume: () => void;
+    initLocalStreamsFilter: () => void;
+    /**
+     * setFilterStream
+     */
+    setLocalFilterStream: (mediaType: K_mediaType, filterStreamFunc: (old_stream: MediaStream) => Promise<MediaStream>) => void;
     /**
      * emitNotifyUpdateUsersStreams
      */
@@ -25,15 +31,15 @@ export declare class RoomMedias extends RoomBase {
     /**
      * getUserMediaStreamContext
      */
-    getUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => AudioMediaContext | VideoMediaContext | undefined;
+    getUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => VideoMediaContext | PrAudioStream | undefined;
     /**
      * getUserAudioMediaStreamContext
      */
-    getUserAudioMediaStreamContext: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => AudioMediaContext;
+    getUserAudioMediaStreamContext: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => PrAudioStream | undefined;
     /**
      * removeUserMediaStreamContext
      */
-    removeUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => void;
+    removeUserMediaStreamContext: (userId: string, mediaType: K_mediaType) => boolean | VideoMediaContext | undefined;
     /**
      * getUserStream
      */
@@ -58,6 +64,11 @@ export declare class RoomMedias extends RoomBase {
      * stopLocalStreams
      */
     stopLocalStreams: (mediaTypes?: K_mediaType[]) => Promise<void>;
+    /**
+     * addLocalStream
+     * @param mediaType
+     * @param stream
+     */
     addLocalStream: (mediaType: K_mediaType, stream: MediaStream) => void;
     /**
      * initLocalStream
@@ -66,11 +77,11 @@ export declare class RoomMedias extends RoomBase {
     /**
      * getLocalStream
      */
-    getLocalStream: (mediaType: K_mediaType) => MediaStream | undefined;
+    getLocalStream: (mediaType: K_mediaType) => Promise<MediaStream | undefined>;
     /**
      * getLocalStreams
      */
-    getLocalStreams: (mediaTypes?: K_mediaType[]) => Streams;
+    getLocalStreams: (mediaTypes?: K_mediaType[]) => Promise<Streams>;
     /**
      * getMediaDeviceKind
      * @param mediaDeviceKind "audioinput" | "audiooutput" | "videoinput"

package/dist/room/RoomPeer.d.ts

@@ -15,6 +15,14 @@ export declare class RoomPeer extends RoomUsers {
     };
     constructor(options: QuickOptions);
     initPeer: () => void;
+    /**
+     * initSendChannel
+     */
+    initSendChannel: (label: string | undefined, id: number) => void;
+    /**
+     * initReceiveChannel
+     */
+    initReceiveChannel: (label: string | undefined, id: number) => void;
     /**
      * replaceSenderStream
      */

package/dist/room/RoomUsers.d.ts

@@ -1,7 +1,6 @@
 import { K_mediaType } from '../enums/mediaType';
-import { QuickOptions, RoomUser, UserTrack } from '../types';
+import { QuickOptions, RoomUser, UserAudioFilterOptions, UserTrack } from '../types';
 import { RoomMedias } from './RoomMedias';
-import { UserAudioFilterOptions } from './mediaStreams/AudioMediaContext';
 export declare class RoomUsers extends RoomMedias {
     constructor(options: QuickOptions);
     /**
@@ -15,27 +14,66 @@ export declare class RoomUsers extends RoomMedias {
      * setAudioFilter
      */
     setAudioFilter: (options?: Partial<UserAudioFilterOptions>) => Promise<void>;
+    /**
+     * setVolume
+     * @param userId
+     * @param mediaType
+     * @param gain 0-1
+     */
+    setVolume: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", gain: number) => void;
     /**
      * setEnhanceGain
      * @param userId
      * @param mediaType
      * @param gain 0-100
      */
-    setEnhanceGain: (userId: string, mediaType: K_mediaType, gain: number) => Promise<void>;
+    setEnhanceGain: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", gain: number) => Promise<void>;
     /**
-     * setVolume
+     * setSpeaker
      * @param userId
      * @param mediaType
      * @param gain 0-1
      */
-    setVolume: (userId: string, mediaType: K_mediaType, gain: number) => void;
+    setSpeaker: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", gain: number) => void;
+    /**
+     * 播放音效
+     */
+    playBgs: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", buffer: AudioBuffer | null) => Promise<unknown> | undefined;
+    /**
+     * 设置音效音量
+     */
+    setBgsGain: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", gain: number) => void;
+    /**
+     * 停止音效
+     */
+    stopBgs: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => void;
+    /**
+     * 播放音乐
+     */
+    playBgm: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", buffer: AudioBuffer | null) => Promise<unknown> | undefined;
+    /**
+     * 设置背景音乐音量
+     */
+    setBgmGain: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", gain: number) => void;
+    /**
+     * 停止音乐
+     */
+    stopBgm: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => void;
+    /**
+     * 开关音效融合
+     */
+    changBgsMix: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", state: boolean) => void;
+    /**
+     * 开关音乐融合
+     */
+    changBgmMix: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio", state: boolean) => void;
     /**
      * getVolume
      * @param userId
      * @param mediaType
      * @returns volume
      */
-    getVolume: (userId: string, mediaType: K_mediaType) => number;
+    getVolume: (userId: string, mediaType: "microphoneCamera_audio" | "screenSharing_audio") => number | undefined;
     /**
      * clearUsers
      */
@@ -77,14 +115,18 @@ export declare class RoomUsers extends RoomMedias {
      */
     getUsersId: () => Promise<string[]>;
     /**
-     * getCaller
+     * getSelfInfo
      */
-    getCaller: () => Promise<RoomUser>;
+    getSelfInfo: () => Promise<RoomUser>;
     updateIsPublished: (userId: string, isPublished?: boolean) => Promise<void>;
     /**
      * setUserUpdateStreams
      */
     setUserUpdateStreams: (userId: string, mediaType: K_mediaType, state?: boolean) => Promise<void>;
+    /**
+     * updateUserChannels
+     */
+    updateUserChannels: (userId: string, channels: any[] | undefined, merge: Boolean) => Promise<void>;
     /**
      * updateUsertracks
      */
@@ -93,6 +135,10 @@ export declare class RoomUsers extends RoomMedias {
      * updateUserCallAction
      */
     updateUserCallAction: (userId: string, callAction?: number) => Promise<void>;
+    /**
+     * updateUserBehaviors
+     */
+    updateUserBehaviors: (userId: string, banBehavior?: number) => Promise<void>;
     /**
      * updateUserNetwork
      */

package/dist/room/StreamRecorder.d.ts

@@ -0,0 +1,36 @@
+export declare class StreamRecorder {
+    #private;
+    onchange: (_e: any) => void;
+    onDurationChange: (_e: number) => void;
+    constructor();
+    /**
+     * start
+     */
+    start: (fileName?: string) => Promise<void>;
+    /**
+     * pause
+     */
+    pause: () => Promise<void>;
+    /**
+     * resume
+     */
+    resume: () => Promise<void>;
+    /**
+     * stop
+     */
+    stop: () => Promise<void>;
+    /**
+     * getDuration
+     */
+    getDuration: () => number;
+    /**
+     * getInfo
+     */
+    getInfo: () => {
+        active: boolean;
+        pause: boolean;
+        startTime: number;
+        endTime: number;
+        duration: number;
+    };
+}

package/dist/types.d.ts

@@ -54,6 +54,7 @@ export interface Message extends protos.com.quick.voice.proto.ICommonReq {
      * 格式化时间戳
      */
     timeStr?: string;
+    sn?: number;
 }
 /**
  * 用户轨道
@@ -100,6 +101,19 @@ export interface UserTrack {
      */
     settings?: MediaTrackSettings;
 }
+/**
+ * 数据通道
+ */
+export interface Channel {
+    /**
+     * dataChannelName
+     */
+    dataChannelName: string;
+    /**
+     * id
+     */
+    id: number;
+}
 /**
  * 事件
  */
@@ -169,6 +183,14 @@ export interface RoomUser {
     callActionMap: {
         [key in K_mediaType]: boolean;
     };
+    /**
+     * 禁止行为
+     */
+    banBehavior: number;
+    banBehaviorStr: string;
+    banBehaviorMap: {
+        [key in K_mediaType]: boolean;
+    };
     /**
      * 通话行为
      */
@@ -181,6 +203,10 @@ export interface RoomUser {
      * 加入时间
      */
     joinTime: number;
+    /**
+     * 是否为房间所有者
+     */
+    isOwner: boolean;
     /**
      * 是否为自己
      */
@@ -208,6 +234,10 @@ export interface RoomUser {
      * 用户轨道
      */
     tracks: UserTrack[];
+    /**
+     * 用户数据通道
+     */
+    channels: Channel[];
     /**
      * 是否更新了流
      */
@@ -245,4 +275,9 @@ export interface RoomOptions {
      */
     newPublishAutoSubscribe?: boolean;
 }
+export interface UserAudioFilterOptions {
+    autoGainControl: boolean;
+    noiseSuppression: boolean;
+    echoCancellation: boolean;
+}
 export type Report_Log_Type = 'ws_c_timeout' | 'webrtc_c_timeout' | 'join_room_error' | 'publish_error' | 'subscribe_error' | 'close_track_error' | 'heartbeat_e_timeout' | 'heartbeat_i_timeout' | 'quit_room_error';

package/package.json

@@ -1,44 +1,50 @@
-{
-  "name": "quickvo-sdk-js",
-  "description": "提供快捷接入单对单、单对多、群体会议、舞台会议等音视频功能。",
-  "version": "0.9.3",
-  "type": "module",
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/index.umd.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.umd.cjs"
-    }
-  },
-  "scripts": {
-    "build": "tsc && vite build"
-  },
-  "dependencies": {
-    "pako": "^2.1.0",
-    "pr-task-queue": "^0.4.4",
-    "pr-tools": "^1.5.7",
-    "pr-ws": "^0.2.5",
-    "sdp-transform": "^2.15.0"
-  },
-  "devDependencies": {
-    "protobufjs": "^7.4.0",
-    "typescript": "^5.8.2",
-    "vite": "^6.2.2",
-    "vite-plugin-bundle-obfuscator": "^1.6.0",
-    "vite-plugin-dts": "^4.5.3"
-  },
-  "private": false,
-  "author": "Breathe",
-  "keywords": [
-    "quickvo-sdk-js"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Breathe97/quickvo-sdk-js"
-  }
-}
+{
+  "name": "quickvo-sdk-js",
+  "description": "提供快捷接入单对单、单对多、群体会议、舞台会议等音视频功能。",
+  "version": "0.9.5",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.umd.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.umd.cjs"
+    }
+  },
+  "scripts": {
+    "build": "tsc && vite build"
+  },
+  "dependencies": {
+    "@timecat/player": "1.2.0-alpha.27",
+    "@timecat/recorder": "1.2.0-alpha.27",
+    "opus-decoder": "^0.7.10",
+    "pako": "^2.1.0",
+    "pr-audio-stream": "^0.1.0",
+    "pr-task-queue": "^0.4.4",
+    "pr-tools": "^1.5.7",
+    "pr-ws": "^0.2.5",
+    "sdp-transform": "^2.15.0",
+    "timecatjs": "1.2.0-alpha.27",
+    "webm-duration-fix": "^1.0.4"
+  },
+  "devDependencies": {
+    "protobufjs": "^7.4.0",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.2",
+    "vite-plugin-bundle-obfuscator": "^1.6.0",
+    "vite-plugin-dts": "^4.5.3"
+  },
+  "private": false,
+  "author": "Breathe",
+  "keywords": [
+    "quickvo-sdk-js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Breathe97/quickvo-sdk-js"
+  }
+}

package/dist/room/mediaStreams/AudioMediaContext.d.ts

@@ -1,55 +0,0 @@
-export interface UserAudioFilterOptions {
-    autoGainControl: boolean;
-    noiseSuppression: boolean;
-    echoCancellation: boolean;
-}
-export declare class AudioMediaContext {
-    options: UserAudioFilterOptions;
-    kind: "audio";
-    stream: MediaStream;
-    inputGain: number;
-    outputGain: number;
-    enhanceGain: number;
-    audio: HTMLAudioElement;
-    audioContext: AudioContext;
-    sourceNode: MediaStreamAudioSourceNode;
-    inputGainNode: GainNode;
-    analyserNode: AnalyserNode;
-    analyserArrayData: Uint8Array;
-    outputGainNode: GainNode;
-    destinationNode: MediaStreamAudioDestinationNode;
-    constructor(track: MediaStreamTrack, audioContext: AudioContext);
-    initNodes: () => void;
-    /**
-     * 停止
-     */
-    stop: () => void;
-    /**
-     * 替换媒体
-     */
-    replaceStream: (stream: MediaStream) => void;
-    /**
-     * 获取数据流
-     */
-    getStream: () => MediaStream;
-    /**
-     * 静音
-     */
-    setMute: (state?: boolean) => void;
-    /**
-     * 设置麦克风增强音量
-     */
-    setEnhanceGain: (gain: number) => Promise<void>;
-    /**
-     * 设置扬声器音量
-     */
-    setVolumeGain: (gain: number) => void;
-    /**
-     * 获取输入音量
-     */
-    getVolume: () => number;
-    /**
-     * 设置音频过滤
-     */
-    setFilter: (options?: Partial<UserAudioFilterOptions>) => Partial<UserAudioFilterOptions>;
-}