quickvo-sdk-js 0.0.8 → 0.1.0

package/README.md

@@ -235,14 +235,15 @@ quickvo.addNotify({
 
     // 你可用在渲染每一个user时对 updateStreams进行监听 每一个user均包含字段 updateStreams 当用户流发送变化你需要重新获取流并渲染到界面
 
-    // 以第一个用户为例 我们发现他需要更新 麦克风流
+    // 以第一个用户为例 我们发现他需要更新 摄像头视频流
+    // 在 0.0.9版本之后,客户端无需再关心和处理音频媒体的播放了 SDK内部已经实现了处理
     const [user] = users
     const { id, updateStreams } = user
 
-    // 需要更新 麦克风
-    if (updateStreams['microphoneCamera_audio']) {
-      const stream = await quickvo.getUserStream(id, 'microphoneCamera_audio')
-      const dom = microphoneCamera_audio_ref.value // 当然 如果你使用原生js，那么这里也只需要拿到对应的dom
+    // 需要更新 摄像头视频流
+    if (updateStreams['microphoneCamera_video']) {
+      const stream = await quickvo.getUserStream(id, 'microphoneCamera_video')
+      const dom = microphoneCamera_video_ref.value // 当然 如果你使用原生js，那么这里也只需要拿到对应的dom
       dom.srcObject = stream
 
       // 下面的几行代码是非必须的 但是还是建议这样做 先暂停再播放 防止重复赋值播放带来的警告或异常错误
@@ -299,10 +300,10 @@ quickvo.setLocalStream('microphoneCamera_audio', true).then((streams) => {
 /**
  * 加入房间
  * @param roomOptions RoomOptions
- * @example quickvo.joinRoom({ userId: '', roomId: '', sdkToken: '', callType: '1' })
+ * @example quickvo.joinRoom({ userId: '', roomId: '', sdkToken: '', callType: '1', autoSubscribe: true })
  * @returns Promise<boolean>
  */
-const options: RoomOptions = { userId: '', roomId: '', sdkToken: '', callType: '1' }
+const options: RoomOptions = { userId: '', roomId: '', sdkToken: '', callType: '1', autoSubscribe: true }
 quickvo.joinRoom(options)
 ```
 

package/dist/QuickVO.d.ts

@@ -1,117 +1,8 @@
-import { Notify, QuickVO_Options, RoomOptions, RoomUser, Streams, UserAudioFilterOptions } from './types';
-import { K_callStrategy } from './enums/callStrategy';
-import { K_mediaType } from './enums/mediaType';
-export declare class QuickVO {
+import { Room } from './room/Room';
+import { QuickOptions } from './types';
+export declare class QuickVO extends Room {
     #private;
-    constructor(options: QuickVO_Options);
-    /**
-     * 设置本地流
-     * @param mediaType MediaType
-     * @param active 激活状态
-     * @example quickvo.setLocalStream('microphoneCamera_audio', false)
-     * @returns Promise<Streams>
-     */
-    setLocalStream: (mediaType: K_mediaType, active: boolean) => Promise<Streams>;
-    /**
-     * 设置媒体参数
-     * @param mediaType MediaType
-     * @param constraints
-     * @example quickvo.setConstraints('microphoneCamera_video', { frameRate: { min: 10, ideal: frameRateIdeal } })
-     * @returns Promise<Streams>
-     */
-    setConstraints: (mediaType: K_mediaType, constraints: MediaTrackConstraints) => Promise<MediaStream>;
-    /**
-     * 设置 RTCRtpSender 参数
-     * @param parameters RTCRtpSendParameters
-     */
-    setRTCRtpSenderParameters: (parameters: RTCRtpSendParameters) => void;
-    /**
-     * 设置 通讯策略
-     * @param callStrategy "fixedPictureQuality" | "qualityPriority" | "fluencyPriority" | "balancedDowngrade"
-     * @example quickvo.setCallStrategy('fixedPictureQuality')
-     */
-    setCallStrategy: (callStrategy: K_callStrategy) => void;
-    /**
-     * 销毁引擎
-     * @example quickvo.destroy()
-     */
-    destroy: () => Promise<void>;
-    /**
-     * 添加广播事件
-     * @param notify Notify
-     * @returns sn
-     */
-    addNotify: (notify: Notify) => string;
-    /**
-     * 加入房间
-     * @param roomOptions RoomOptions
-     * @example quickvo.joinRoom({ userId: '', roomId: '', sdkToken: '', callType: '1', autoSubscribe: true })
-     * @returns Promise<boolean>
-     */
-    joinRoom: (roomOptions: RoomOptions) => Promise<RoomUser[]>;
-    /**
-     * 退出房间
-     * @example quickvo.quitRoom()
-     * @returns Promise<boolean>
-     */
-    quitRoom: () => Promise<RoomUser[]>;
-    /**
-     * 同步房间信息
-     * @example quickvo.syncRoomInfo()
-     */
-    syncRoomInfo: () => Promise<RoomUser[]>;
-    /**
-     * 发布流
-     * @param mediaTypes MediaType[]
-     * @param count 发布失败重试次数
-     * @example quickvo.publish(['microphoneCamera_audio', 'microphoneCamera_video'], 3)
-     * @returns Promise<RoomUser>
-     */
-    publish: (mediaTypes: K_mediaType[], count?: number) => Promise<RoomUser>;
-    /**
-     * 停止发布流
-     * @param trackNames  string[] = []
-     * @example quickvo.stopPublish(['microphoneCamera_audio'])
-     * @returns Promise<RoomUser>
-     */
-    stopPublish: (mediaTypes?: K_mediaType[]) => Promise<RoomUser>;
-    /**
-     * 订阅流
-     * @param trackNames 轨道名称
-     * @param count 订阅失败重试次数
-     * @example quickvo.subscribe(['trackName1','trackName2'])
-     * @returns Promise<RoomUser[]>
-     */
-    subscribe: (trackNames?: string[], count?: number) => Promise<RoomUser[]>;
-    /**
-     * 停止订阅流
-     * @param trackNames  string[] = []
-     * @example quickvo.subscribe(['trackName1'])
-     */
-    stopSubscribe: (trackNames?: string[]) => Promise<boolean>;
-    /**
-     * 获取某个用户完整数据
-     * @param userId string
-     * @example quickvo.getUserInfo('123')
-     * @returns Promise<RoomUser>
-     */
-    getUserInfo: (userId: string) => Promise<RoomUser>;
-    /**
-     * 冻结轨道
-     * @param mediaTypes MediaType[] 轨道类型
-     * @param enabled 是否冻结
-     * @param userId 用户id
-     * @example quickvo.inactiveTracks(['microphoneCamera_audio'], false)
-     */
-    inactiveTracks: (mediaTypes: K_mediaType[], enabled: boolean, userId?: string) => Promise<void>;
-    /**
-     * 获取指定轨道的名称数组
-     * @param tracks 轨道
-     * @param types  number[] = []
-     * @param keyName
-     * @returns string[]
-     */
-    getTrackNamesFormTracks: (tracks: any[], types?: number[], keyName?: string) => string[];
+    constructor(options: QuickOptions);
     /**
      * 添加 FrameRequestCallback
      * @param key string
@@ -123,60 +14,4 @@ export declare class QuickVO {
      * @param keys string[] = []
      */
     clearRequestAnimationFrame: (keys?: string[]) => Promise<number[]>;
-    /**
-     * 设置音量
-     * @param userId
-     * @param mediaType
-     */
-    setVolume: (userId: string, mediaType: K_mediaType, gain: number) => void;
-    /**
-     * 获取声音大小
-     * @param userId
-     * @param mediaType
-     * @returns volume
-     */
-    getVolume: (userId: string, mediaType: K_mediaType) => number;
-    /**
-     * 获取用户音频处理上下文
-     * @param userId
-     * @param mediaType
-     * @returns UserAudioContext | undefined
-     */
-    getUserAudioContext: (userId: string, mediaType: K_mediaType) => import('./types').UserAudioContext | undefined;
-    /**
-     * 获取当前最大音量用户
-     */
-    getMaxVolumeUser: () => {
-        id: string;
-        volume: number;
-    } | undefined;
-    /**
-     * 获取网络情况
-     */
-    getPeerNetwork: () => {
-        lostRate: string;
-        roundTripTime: string;
-        jitter: string;
-    };
-    /**
-     * 获取某个用户的某个数据流
-     * @param userId 用户ID
-     * @param mediaType 媒体类型
-     * @returns Promise<MediaStream>
-     */
-    getUserStream: (userId: string, mediaType: K_mediaType) => Promise<MediaStream>;
-    /**
-     * 获取某个用户的全部数据流
-     * @param userId 用户ID
-     * @returns Promise<Streams>
-     */
-    getUserStreams: (userId: string) => Promise<Streams>;
-    /**
-     * 设置音频过滤
-     */
-    setAudioFilter: (options?: Partial<UserAudioFilterOptions>) => Promise<void>;
-    /**
-     * 远端调试
-     */
-    debugger: () => Promise<any>;
 }

package/dist/enums/notifyName.d.ts

@@ -4,16 +4,17 @@ export declare const enum_notifyName: {
     readonly healthCheck: "心跳检测";
     readonly onNetQuality: "网络质量回调";
     readonly onLogin: "登录回调";
+    readonly onLocalStream: "更新本地媒体流";
     readonly onRoomUsers: "房间用户变化";
+    readonly onRoomState: "房间状态变化";
     readonly onJoinRoom: "加入房间回调";
     readonly onQuitRoom: "退出房间回调";
     readonly onPublish: "监听到流发布";
     readonly onCloseTrack: "关闭轨道";
     readonly onUpdateCall: "更新通讯状态";
-    readonly onLocalStream: "更新本地媒体流";
-    readonly onIceDisconnected: "ice断开";
     readonly onTokenExpired: "Token已过期";
     readonly destroyRoom: "销毁房间";
+    readonly onDestroy: "销毁";
 };
 export type T_notifyName = typeof enum_notifyName;
 export type K_notifyName = keyof T_notifyName;
@@ -23,4 +24,4 @@ export declare const notifyName_options: {
     label: any;
 }[];
 export declare const notifyName_keys: (keyof typeof enum_notifyName)[];
-export declare const notifyName_vals: ("关闭轨道" | "网络情况变更" | "房间网络情况变更" | "心跳检测" | "网络质量回调" | "登录回调" | "房间用户变化" | "加入房间回调" | "退出房间回调" | "监听到流发布" | "更新通讯状态" | "更新本地媒体流" | "ice断开" | "Token已过期" | "销毁房间")[];
+export declare const notifyName_vals: ("关闭轨道" | "网络情况变更" | "房间网络情况变更" | "心跳检测" | "网络质量回调" | "登录回调" | "更新本地媒体流" | "房间用户变化" | "房间状态变化" | "加入房间回调" | "退出房间回调" | "监听到流发布" | "更新通讯状态" | "Token已过期" | "销毁房间" | "销毁")[];

package/dist/enums/roomState.d.ts

@@ -0,0 +1,17 @@
+export declare const enum_roomState: {
+    readonly ready: "已就绪";
+    readonly checkAuth: "正在鉴权";
+    readonly connect: "连接中";
+    readonly connected: "已连接";
+    readonly reconnect: "正在重新连接";
+    readonly disconnected: "已断开";
+};
+export type T_roomState = typeof enum_roomState;
+export type K_roomState = keyof T_roomState;
+export type V_roomState = T_roomState[K_roomState];
+export declare const roomState_options: {
+    value: any;
+    label: any;
+}[];
+export declare const roomState_keys: (keyof typeof enum_roomState)[];
+export declare const roomState_vals: ("已就绪" | "正在鉴权" | "连接中" | "已连接" | "正在重新连接" | "已断开")[];