quickvo-sdk-js 1.6.71 → 1.6.73

package/dist/src/QuickVO.d.ts

@@ -1,85 +0,0 @@
-import { QuickOptions } from './types';
-export declare class QuickVO {
-    static version: string;
-    private _base;
-    /** 监听注册顺序：Base → ActionBase → ActionSFU → ActionP2P；同名 cws.on.* 以后构造者为准（房间/进房等由 ActionSFU 注册） */
-    private _ACTION_BASE;
-    private _ACTION_SFU;
-    private _ACTION_P2P;
-    constructor(options: QuickOptions);
-    recorder: import('./base/modules/StreamRecorder').StreamRecorder;
-    use: ({ rnnoise }: {
-        rnnoise?: import('./base/Base').PrRnnoise;
-    }) => void;
-    setCallStrategy: (callStrategy: import('./enums').K_callStrategy, mediaTypes?: import('./enums').K_mediaType[]) => Promise<void>;
-    addNotify: (notify: import('./base/modules/notifyPayloadMap').QuickvoNotify) => string;
-    setOptions: (options: Partial<QuickOptions & import('./types').RoomOptions>) => void;
-    getLocalStream: (mediaType: import('./enums').K_mediaType) => MediaStream;
-    getLocalStreams: () => {
-        mc_audio: MediaStream;
-        mc_video: MediaStream;
-        ss_video: MediaStream;
-        ss_audio: MediaStream;
-    };
-    setActiveNoise: (mediaType: import('./enums').K_mediaType, state: boolean) => void;
-    hasPermissions: (type: "subscribe" | "publish") => boolean;
-    getUserContent: (userId?: string) => import('./base/modules/users/modules/LocalUser').LocalUser | import('./base/modules/users/modules/RemoteUser').RemoteUser | undefined;
-    getUserStream: (userId: string, mediaType: import('./enums').K_mediaType) => MediaStream | undefined;
-    getVolume: (userId: string, mediaType: import('./enums').K_mediaType) => number | undefined;
-    getMaxVolumeUser: () => {
-        id: string;
-        volume: number;
-    } | undefined;
-    setInputVolume: (userId: string, mediaType: import('./enums').K_mediaType, gain: number) => void;
-    setEnhanceGain: (userId: string, mediaType: import('./enums').K_mediaType, gain: number) => Promise<void>;
-    setSpeakerVolume: (userId: string, mediaType: import('./enums').K_mediaType, gain: number) => void;
-    getUserAudioMediaStreamContext: (userId: string, mediaType: import('./enums').K_mediaType) => import('pr-audio-stream').PrAudioStream | undefined;
-    playBgs: (userId: string, mediaType: import('./enums').K_mediaType, buffer: AudioBuffer | null) => Promise<void>;
-    changBgsMix: (userId: string, mediaType: import('./enums').K_mediaType, mix: boolean) => Promise<void>;
-    stopBgs: (userId: string, mediaType: import('./enums').K_mediaType) => Promise<void>;
-    setBgsGain: (userId: string, mediaType: import('./enums').K_mediaType, gain: number) => Promise<void>;
-    playBgm: (userId: string, mediaType: import('./enums').K_mediaType, buffer: AudioBuffer | null) => Promise<void>;
-    changBgmMix: (userId: string, mediaType: import('./enums').K_mediaType, mix: boolean) => Promise<void>;
-    stopBgm: (userId: string, mediaType: import('./enums').K_mediaType) => Promise<void>;
-    setBgmGain: (userId: string, mediaType: import('./enums').K_mediaType, gain: number) => Promise<void>;
-    getEnumerateDevices: (mediaDeviceKind: MediaDeviceKind) => Promise<import('./types').DeviceInfo[]>;
-    getMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind) => string | undefined;
-    getMediaDevicesErrInfo: () => Promise<{
-        mc_audio: string;
-        mc_video: string;
-    }>;
-    setLocalStream: (mediaTypes: import('./enums').K_mediaType[], active: boolean) => Promise<void>;
-    setMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind, deviceId: string | undefined) => Promise<void>;
-    setMediaTrackConstraints: (mediaType: import('./enums').K_mediaType, constraints: MediaTrackConstraints) => Promise<void>;
-    earlyConnect: () => Promise<true | undefined>;
-    joinRoom: (roomOptions: import('./types').RoomOptions) => Promise<string>;
-    publish: (mediaTypes: import('./enums').K_mediaType[]) => Promise<true>;
-    stopPublish: (mediaTypes: import('./enums').K_mediaType[]) => Promise<true>;
-    subscribe: (usersMediaTypes?: import('./types').UserMediaTypes[]) => Promise<true>;
-    stopSubscribe: (usersMediaTypes?: import('./types').UserMediaTypes[]) => Promise<true>;
-    setBehaviors: (usersBehaviors: Array<{
-        id: string;
-        behaviors: { [key in import('./enums').K_mediaType]?: boolean; };
-    }>) => Promise<import('./protos/protoEvent').MessageRspCore<"preventUsersBehavior">>;
-    updateSimulcast: (simulcast: "f" | "h" | "q") => Promise<void>;
-    toggleRoomSpeechLang: (data: {
-        input: string;
-        output: string;
-        translateEnable?: boolean;
-    }) => void;
-    updateToken: (sdkToken: string) => void;
-    quitRoom: () => Promise<string>;
-    quitRoomEx: () => Promise<string>;
-    destroy: () => void;
-    addRequestAnimationFrame: (key: string, func: FrameRequestCallback, options?: {
-        fps?: number;
-    }) => void;
-    clearRequestAnimationFrame: (keys?: string[]) => void;
-    getLocalUserTrackReports: (mediaType: import('./enums').K_mediaType) => import('./types').TrackReport;
-    getRemoteUserTrackReports: (userId: string, origin: "sfu" | "p2p", direction: "sends" | "recvs", mediaType: import('./enums').K_mediaType) => import('./types').TrackReport | undefined;
-    getRoomAction: () => number;
-    _openP2P: (remoteUserId: string, mediaTypes: import('./enums').K_mediaType[], isRemotePush: boolean) => Promise<void>;
-    _restoreRoom: () => Promise<void>;
-    _debugger: () => Promise<void>;
-    _ai: () => Promise<void>;
-}

package/dist/src/base/modules/cws/quickvoCodecWorkerMain.d.ts

@@ -1,6 +0,0 @@
-import { OnMessageFormatResult } from '../../../protos/protoEvent';
-export declare function decodeCwsBinary<E extends string = string>(buffer: ArrayBuffer): Promise<OnMessageFormatResult<E>>;
-/** gzip 压缩（发送侧 / 日志上报）；失败时回退主线程 pako */
-export declare function gzipCompressBytes(data: Uint8Array): Promise<Uint8Array>;
-/** 终止 CWS 编解码 Worker；`QuickVO.destroy` 时应调用。之后可再次懒创建 Worker。 */
-export declare function destroyQuickvoCodecWorker(): void;

package/dist/src/base/modules/notifyPayloadMap.d.ts

@@ -1,119 +0,0 @@
-import { K_notifyName } from '../../enums/notifyName';
-import { K_roomState } from '../../enums/roomState';
-import { CwsNotifyPayloadFor } from '../../protos/protoEvent';
-import { RoomUser } from '../../types';
-/**
- * SDK 内部派发的通知名（不经由 CWS OnMessageDataMap）
- */
-export type SdkOnlyNotifyName = 'onLog' | 'onRoomUsers' | 'onRoomNetwork' | 'onDevicechange' | 'onPeerState' | 'onRoomState';
-/** QuickVO.addNotify / Notifys 支持的完整事件名 */
-export type K_quickvoNotifyName = K_notifyName | SdkOnlyNotifyName;
-type WithSn<T> = T & {
-    sn?: string;
-};
-type CwsNotifyPayloadWithSn<K extends K_notifyName> = WithSn<CwsNotifyPayloadFor<K>>;
-/** 与 Config.network / ActionSFU 网络汇总一致 */
-export type RoomNetworkNotifyData = {
-    sfu: {
-        inboundBytes: number;
-        outboundBytes: number;
-        lostRate: number;
-        roundTripTime: number;
-        jitter: number;
-        quality: number;
-        averageQuality: number;
-        velocityPush: number;
-        velocityPull: number;
-    };
-    p2p: {
-        inboundBytes: number;
-        outboundBytes: number;
-        lostRate: number;
-        roundTripTime: number;
-        jitter: number;
-        quality: number;
-        averageQuality: number;
-        velocityPush: number;
-        velocityPull: number;
-    };
-};
-/** 与 Base._reportLog 的 type 参数一致 */
-export type ReportLogNotifyType = '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';
-/**
- * 各通知事件 emit 第二参 / callback 第一参的精确类型
- */
-export type NotifyPayloadMap = {
-    [K in K_notifyName]: CwsNotifyPayloadWithSn<K>;
-} & {
-    onLog: WithSn<{
-        code: number;
-        desc: string;
-        data: {
-            message: unknown;
-        } | {
-            type: ReportLogNotifyType;
-        };
-    }>;
-    onRoomUsers: WithSn<{
-        code: number;
-        desc: string;
-        data: RoomUser[];
-    }>;
-    onRoomNetwork: WithSn<{
-        code: number;
-        desc: string;
-        data: RoomNetworkNotifyData;
-    }>;
-    onDevicechange: WithSn<{
-        code: number;
-        desc: string;
-        data: Record<string, never>;
-    }>;
-    onPeerState: WithSn<{
-        code: number;
-        desc: string;
-        data: {
-            state: RTCPeerConnectionState;
-        };
-    }>;
-    onRoomState: WithSn<{
-        code: number;
-        desc: string;
-        data: {
-            state: K_roomState;
-        };
-    }>;
-};
-export type NotifyEmitPayloadFor<E extends K_quickvoNotifyName> = NotifyPayloadMap[E];
-/** 所有通知 payload 的联合（需按 event 收窄时请用 NotifyEmitPayloadFor<E>） */
-export type NotifyEmitPayloadUnion = NotifyPayloadMap[K_quickvoNotifyName];
-/**
- * addNotify 注册的 discriminated union：event 与 callback 参数类型联动
- */
-export type QuickvoNotify = {
-    [E in K_quickvoNotifyName]: {
-        sn?: string;
-        event: E;
-        callback?: (e: NotifyPayloadMap[E]) => void;
-    };
-}[K_quickvoNotifyName];
-/**
- * 辅助推断：注册通知时无需手写 payload 泛型
- * @example
- * ```ts
- * quickvo.addNotify(defineQuickvoNotify({
- *   event: 'onJoinRoom',
- *   callback: (e) => e.data.user,
- * }))
- * ```
- */
-export declare function defineQuickvoNotify<const E extends K_quickvoNotifyName>(notify: {
-    sn?: string;
-    event: E;
-    callback?: (e: NotifyPayloadMap[E]) => void;
-}): {
-    sn?: string;
-    event: E;
-    callback?: (e: NotifyPayloadMap[E]) => void;
-};
-export {};

package/dist/src/protos/gen/modules/Rtc_pb.d.ts

@@ -1,70 +0,0 @@
-import { GenEnum, GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
-import { TrackType } from './Room_pb';
-import { Message } from '@bufbuild/protobuf';
-/**
- * Describes the file modules/Rtc.proto.
- */
-export declare const file_modules_Rtc: GenFile;
-/**
- * @generated from message com.quick.voice.proto.RtcTrack
- */
-export type RtcTrack = Message<"com.quick.voice.proto.RtcTrack"> & {
-    /**
-     * @generated from field: string userId = 1;
-     */
-    userId: string;
-    /**
-     * @generated from field: string mid = 2;
-     */
-    mid: string;
-    /**
-     * @generated from field: string trackName = 3;
-     */
-    trackName: string;
-    /**
-     * 与 Room.proto 中 TrackType 数值一致，避免同 package 下重复枚举符号（buf/protoc 要求）
-     *
-     * @generated from field: com.quick.voice.proto.TrackType type = 4;
-     */
-    type: TrackType;
-    /**
-     * @generated from field: bool isActive = 5;
-     */
-    isActive: boolean;
-};
-/**
- * Describes the message com.quick.voice.proto.RtcTrack.
- * Use `create(RtcTrackSchema)` to create a new message.
- */
-export declare const RtcTrackSchema: GenMessage<RtcTrack>;
-/**
- * @generated from message com.quick.voice.proto.UpdateTrackState
- */
-export type UpdateTrackState = Message<"com.quick.voice.proto.UpdateTrackState"> & {
-    /**
-     * @generated from field: string roomId = 1;
-     */
-    roomId: string;
-    /**
-     * @generated from field: repeated com.quick.voice.proto.RtcTrack tracks = 2;
-     */
-    tracks: RtcTrack[];
-};
-/**
- * Describes the message com.quick.voice.proto.UpdateTrackState.
- * Use `create(UpdateTrackStateSchema)` to create a new message.
- */
-export declare const UpdateTrackStateSchema: GenMessage<UpdateTrackState>;
-/**
- * @generated from enum com.quick.voice.proto.RtcEvent
- */
-export declare enum RtcEvent {
-    /**
-     * @generated from enum value: UpdateTrackActive = 0;
-     */
-    UpdateTrackActive = 0
-}
-/**
- * Describes the enum com.quick.voice.proto.RtcEvent.
- */
-export declare const RtcEventSchema: GenEnum<RtcEvent>;

package/dist/src/protos/protoCodec.d.ts

@@ -1,19 +0,0 @@
-import { CommonRsp } from './gen/modules/BaseData_pb';
-/** 与原先 protobufjs 在业务侧用法对齐：CommonRsp 外层 sn/time/valid 使用 number */
-export type CommonRspDecoded = Omit<CommonRsp, 'sn' | 'time' | 'valid'> & {
-    sn: number;
-    time: number;
-    valid: number;
-};
-/** @bufbuild/protobuf 解码后的消息会带运行时字段 `$typeName`，业务/日志里不需要，递归去掉 */
-export declare function stripProtobufRuntimeMeta<T>(value: T): T;
-export declare function decodeCommonRsp(buffer: Uint8Array): CommonRspDecoded;
-export declare function encodeCommonReq(init: {
-    event: string;
-    data: Uint8Array;
-    sn?: number;
-    time?: number;
-    valid?: number;
-    version?: number;
-    compress?: boolean;
-}): Uint8Array;

package/dist/src/workers/cwsCodec/CwsCodecCore.d.ts

@@ -1,7 +0,0 @@
-/** 仅在 Worker 内实例化：解码 + gzip（与主线程逻辑一致） */
-export declare class CwsCodecCore {
-    decode(buffer: ArrayBuffer): {
-        data_remote: Uint8Array<ArrayBuffer>;
-    };
-    gzipCompress(buffer: ArrayBuffer): Uint8Array;
-}

package/dist/src/workers/cwsCodec/CwsCodecWorker.d.ts

@@ -1,15 +0,0 @@
-import { OnMessageFormatResult } from '../../protos/protoEvent';
-export type CwsCodecWorkerOptions = {
-    onFatal?: () => void;
-};
-export declare class CwsCodecWorker {
-    worker: Worker;
-    private nextId;
-    private pending;
-    private options;
-    constructor(options?: CwsCodecWorkerOptions);
-    private failAll;
-    decode(buffer: ArrayBuffer): Promise<OnMessageFormatResult>;
-    gzipCompress(buffer: ArrayBuffer): Promise<Uint8Array>;
-    destroy: () => void;
-}

package/dist/src/workers/cwsCodec/type.d.ts

@@ -1,33 +0,0 @@
-import { OnMessageFormatResult } from '../../protos/protoEvent';
-export type CwsCodecWorkerRequest = {
-    id: number;
-    action: 'decode';
-    data: {
-        buffer: ArrayBuffer;
-    };
-} | {
-    id: number;
-    action: 'gzipCompress';
-    data: {
-        buffer: ArrayBuffer;
-    };
-} | {
-    id: number;
-    action: 'destroy';
-    data?: Record<string, never>;
-};
-export type CwsCodecWorkerResponse = {
-    id: number;
-    ok: true;
-    kind: 'decode';
-    result: OnMessageFormatResult;
-} | {
-    id: number;
-    ok: true;
-    kind: 'gzipCompress';
-    buffer: ArrayBuffer;
-} | {
-    id: number;
-    ok: false;
-    error: string;
-};