quickvo-sdk-js 1.6.8 → 1.6.10

package/README.md

@@ -30,10 +30,10 @@
 
 ```ts
 type T_mediaType = {
-  readonly microphoneCamera_audio: '麦克风-默认轨道'
-  readonly microphoneCamera_video: '摄像头-默认轨道'
-  readonly screenSharing_video: '屏幕共享-视频轨道'
-  readonly screenSharing_audio: '屏幕共享-音频轨道'
+  readonly mc_audio: '麦克风-默认轨道'
+  readonly mc_video: '摄像头-默认轨道'
+  readonly ss_video: '屏幕共享-视频轨道'
+  readonly ss_audio: '屏幕共享-音频轨道'
 }
 type K_mediaType = keyof T_mediaType
 ```
@@ -216,11 +216,11 @@ export const quickvo = new QuickVO({ appid: 'A6B499768801DJT8ACA11E5F842DB6DF' }
 
 ```vue
 <template>
-  <video ref="microphoneCamera_audio_ref"></video>
+  <video ref="mc_audio_ref"></video>
 </template>
 
 <script setup lang="ts">
-const microphoneCamera_audio_ref = ref<HTMLVideoElement>()
+const mc_audio_ref = ref<HTMLVideoElement>()
 </script>
 ```
 
@@ -239,9 +239,9 @@ quickvo.addNotify({
     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['mc_audio']) {
+      const stream = await quickvo.getUserStream(id, 'mc_audio')
+      const dom = mc_audio_ref.value // 当然 如果你使用原生js，那么这里也只需要拿到对应的dom
       dom.srcObject = stream
 
       // 下面的几行代码是非必须的 但是还是建议这样做 先暂停再播放 防止重复赋值播放带来的警告或异常错误
@@ -252,13 +252,13 @@ quickvo.addNotify({
       }
     }
 
-    if (updateStreams['microphoneCamera_video']) {
+    if (updateStreams['mc_video']) {
       // ...
     }
-    if (updateStreams['screenSharing_audio']) {
+    if (updateStreams['ss_audio']) {
       // ...
     }
-    if (updateStreams['screenSharing_video']) {
+    if (updateStreams['ss_video']) {
       // ...
     }
   }
@@ -269,22 +269,22 @@ quickvo.addNotify({
 
 - 通常如果应用层需要实现本地预览麦克风、摄像头等待发布的媒体流时，你可以尝试调用该 api，目前支持开启以下四种类型：
 
-1. 麦克风 microphoneCamera_audio
-2. 摄像头 microphoneCamera_video
-3. 屏幕音频 screenSharing_audio （由于浏览器内部机制，不能单独选择该媒体，因此在选择屏幕音频时，直接设置共享屏幕音视频）
-4. 屏幕视频 screenSharing_video （如果你需要单独共享屏幕画面 而不共享屏幕音频才考虑选择该类型，更多的建议直接开启 screenSharing_audio 然后主动控制流媒体的发布、暂停）
+1. 麦克风 mc_audio
+2. 摄像头 mc_video
+3. 屏幕音频 ss_audio （由于浏览器内部机制，不能单独选择该媒体，因此在选择屏幕音频时，直接设置共享屏幕音视频）
+4. 屏幕视频 ss_video （如果你需要单独共享屏幕画面 而不共享屏幕音频才考虑选择该类型，更多的建议直接开启 ss_audio 然后主动控制流媒体的发布、暂停）
 
 ```ts
 /**
  * 设置本地流
  * @param mediaType MediaType
  * @param active 激活状态
- * @example quickvo.setLocalStream(['microphoneCamera_audio'], false)
+ * @example quickvo.setLocalStream(['mc_audio'], false)
  * @returns Promise<Streams>
  */
-quickvo.setLocalStream(['microphoneCamera_audio'], true).then((streams) => {
+quickvo.setLocalStream(['mc_audio'], true).then((streams) => {
   // 因考虑到易用性（与 onLocalStream 保持一致） 这里会返回所有本地流对象
-  const stream = streams['microphoneCamera_audio']
+  const stream = streams['mc_audio']
   // 拿到所需要的 stream 然后进行渲染 (这里以原生js使用方式作为参考)
   document.querySelector<HTMLVideoElement>('#my-dom-view')?.srcObject = stream
 })
@@ -314,15 +314,15 @@ quickvo.joinRoom(options)
  * 发布流
  * @param mediaTypes MediaType[]
  * @param count 发布失败重试次数
- * @example quickvo.publish(['microphoneCamera_audio', 'microphoneCamera_video'], 3)
+ * @example quickvo.publish(['mc_audio', 'mc_video'], 3)
  * @returns Promise<RoomUser>
  */
-quickvo.publish(['microphoneCamera_audio', 'microphoneCamera_video'], 3).then((user) => {
+quickvo.publish(['mc_audio', 'mc_video'], 3).then((user) => {
   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['mc_audio']) {
+    const stream = await quickvo.getUserStream(id, 'mc_audio')
+    const dom = mc_audio_ref.value // 当然 如果你使用原生js，那么这里也只需要拿到对应的dom
     dom.srcObject = stream
   }
 })
@@ -344,9 +344,9 @@ quickvo.subscribe(['123']).then((users) => {
   for (const user of 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['mc_audio']) {
+      const stream = await quickvo.getUserStream(id, 'mc_audio')
+      const dom = mc_audio_ref.value // 当然 如果你使用原生js，那么这里也只需要拿到对应的dom
       dom.srcObject = stream
     }
   }
@@ -409,6 +409,37 @@ quickvo.quitRoom()
 
 ### 版本迭代说明
 
+- 版本：1.6.0 (2026-01-28)
+
+#### api名称变更
+
+```
+setSpeaker => setSpeakerVolume
+setVolume => setInputVolume
+```
+
+#### 枚举变更
+
+```ts
+export const enum_mediaType = {
+  ['mc_audio']: '麦克风-默认轨道',
+  ['mc_video']: '摄像头-默认轨道',
+
+  ['ss_video']: '屏幕共享-视频轨道',
+  ['ss_audio']: '屏幕共享-音频轨道'
+} as const
+```
+
+#### 视频渲染变更
+
+- 现在视频流不需要重新渲染 当sdk内部通知有该用户开启即可获取该用户视频流。
+
+```ts
+const stream = quickvo.getUserStream(props.userInfo.id, 'mc_video')
+video_dom.srcObject = stream
+video_dom.play()
+```
+
 - 版本：1.5.0 (2025-11-19)
 
 ```
@@ -421,8 +452,8 @@ quickvo.quitRoom()
 
 以下是升级指南:
 在任何调用 inactiveTracks 的地方 全部修改为 pauseTracks。( 注意：第二个参数 boolean 相反 前者描述的是启用什么轨道 后者描述的是暂停什么轨道 )
-如 quickvo.inactiveTracks(['microphoneCamera_video'], false) // 冻结视频轨道
-修改为 quickvo.pauseTracks。(['microphoneCamera_video'], true) // 暂停视频轨道
+如 quickvo.inactiveTracks(['mc_video'], false) // 冻结视频轨道
+修改为 quickvo.pauseTracks。(['mc_video'], true) // 暂停视频轨道
 
 
 ```
@@ -440,18 +471,18 @@ quickvo.quitRoom()
 由原来的
 quickvo.subscribe(['trackName1','trackName2'])
 调整为
-quickvo.subscribe([{ userId: '123', mediaTypes: ['microphoneCamera_audio', 'microphoneCamera_video'] }])
+quickvo.subscribe([{ userId: '123', mediaTypes: ['mc_audio', 'mc_video'] }])
 
 由原来的
 quickvo.stopSubscribe(['trackName1','trackName2'])
 调整为
-quickvo.stopSubscribe([{ userId: '123', mediaTypes: ['microphoneCamera_audio', 'microphoneCamera_video'] }])
+quickvo.stopSubscribe([{ userId: '123', mediaTypes: ['mc_audio', 'mc_video'] }])
 
 SDK内部提供了方便开发者升级的api：
 /**
 * getUsersMediaTypeBytrackNames
 * @param trackNames string[]
-* @returns [{ userId: '123', mediaTypes: ['mediaTypes', 'microphoneCamera_video'] }]
+* @returns [{ userId: '123', mediaTypes: ['mediaTypes', 'mc_video'] }]
 */
 
 const usersMediaType = quickvo.getUsersMediaTypeBytrackNames(['trackName1','trackName2'])

package/dist/QuickVO.d.ts

@@ -14,40 +14,40 @@ export declare class QuickVO {
         callback?: (e: any) => void;
     }) => string;
     setOptions: (options: Partial<QuickOptions & import('./types').RoomOptions>) => void;
-    getLocalStream: (mediaType: import('./enums/mediaType').K_mediaType) => MediaStream;
+    getLocalStream: (mediaType: import('./enums').K_mediaType) => MediaStream;
     getLocalStreams: () => {
         mc_audio: MediaStream;
         mc_video: MediaStream;
         ss_video: MediaStream;
         ss_audio: MediaStream;
     };
-    setActiveNoise: (mediaType: import('./enums/mediaType').K_mediaType, state: boolean) => void;
+    setActiveNoise: (mediaType: import('./enums').K_mediaType, state: boolean) => void;
     getUserContent: (userId?: string) => import('./base/modules/users/modules/LocalUser').LocalUser | import('./base/modules/users/modules/RemoteUser').RemoteUser | undefined;
-    getUserStream: (userId: string, mediaType: import('./enums/mediaType').K_mediaType) => MediaStream | undefined;
-    getVolume: (userId: string, mediaType: import('./enums/mediaType').K_mediaType) => number | 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/mediaType').K_mediaType, gain: number) => void;
-    setEnhanceGain: (userId: string, mediaType: import('./enums/mediaType').K_mediaType, gain: number) => Promise<void>;
-    setSpeakerVolume: (userId: string, mediaType: import('./enums/mediaType').K_mediaType, gain: number) => void;
-    getUserAudioMediaStreamContext: (userId: string, mediaType: import('./enums/mediaType').K_mediaType) => import('pr-audio-stream').PrAudioStream | 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;
     getEnumerateDevices: (mediaDeviceKind: MediaDeviceKind) => Promise<import('./types').DeviceInfo[]>;
     getMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind) => string | undefined;
     getMediaDevicesErrInfo: () => Promise<{
         mc_audio: string;
         mc_video: string;
     }>;
-    setCallStrategy: (callStrategy: import('./enums/callStrategy').K_callStrategy, mediaTypes?: import('./enums/mediaType').K_mediaType[]) => Promise<void>;
-    setLocalStream: (mediaTypes: import('./enums/mediaType').K_mediaType[], active: boolean) => Promise<unknown>;
+    setCallStrategy: (callStrategy: import('./enums').K_callStrategy, mediaTypes?: import('./enums').K_mediaType[]) => Promise<void>;
+    setLocalStream: (mediaTypes: import('./enums').K_mediaType[], active: boolean) => Promise<unknown>;
     setMediaDeviceKind: (mediaDeviceKind: MediaDeviceKind, deviceId: string | undefined) => Promise<unknown>;
-    setMediaTrackConstraints: (mediaType: import('./enums/mediaType').K_mediaType, constraints: MediaTrackConstraints) => Promise<void>;
-    earlyConnect: (mediaTypes?: import('./enums/mediaType').K_mediaType[]) => Promise<unknown>;
+    setMediaTrackConstraints: (mediaType: import('./enums').K_mediaType, constraints: MediaTrackConstraints) => Promise<void>;
+    earlyConnect: (mediaTypes?: import('./enums').K_mediaType[]) => Promise<unknown>;
     joinRoom: (roomOptions: import('./types').RoomOptions) => Promise<unknown>;
-    publish: (mediaTypes: import('./enums/mediaType').K_mediaType[]) => Promise<boolean>;
-    stopPublish: (mediaTypes: import('./enums/mediaType').K_mediaType[]) => Promise<boolean>;
-    pauseTracks: (mediaTypes: import('./enums/mediaType').K_mediaType[], pause: boolean) => Promise<boolean>;
+    publish: (mediaTypes: import('./enums').K_mediaType[]) => Promise<boolean>;
+    stopPublish: (mediaTypes: import('./enums').K_mediaType[]) => Promise<boolean>;
+    pauseTracks: (mediaTypes: import('./enums').K_mediaType[], pause: boolean) => Promise<boolean>;
     subscribe: (usersMediaTypes?: import('./types').UserMediaTypes[]) => Promise<unknown>;
     stopSubscribe: (usersMediaTypes?: import('./types').UserMediaTypes[]) => Promise<boolean>;
     toggleRoomSpeechLang: (data: {
@@ -59,9 +59,9 @@ export declare class QuickVO {
     quitRoom: () => Promise<boolean>;
     quitRoomEx: () => Promise<boolean>;
     destroy: () => void;
-    getLocalUserTrackReports: (mediaType: import('./enums/mediaType').K_mediaType) => import('./types').TrackReport;
-    getRemoteUserTrackReports: (userId: string, origin: "sfu" | "p2p", direction: "sends" | "recvs", mediaType: import('./enums/mediaType').K_mediaType) => import('./types').TrackReport | undefined;
-    _openP2P: (remoteUserId: string, mediaTypes: import('./enums/mediaType').K_mediaType[], isRemotePush: boolean) => Promise<unknown>;
+    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;
+    _openP2P: (remoteUserId: string, mediaTypes: import('./enums').K_mediaType[], isRemotePush: boolean) => Promise<unknown>;
     _restoreRoom: () => Promise<void>;
     _debugger: () => Promise<void>;
     _ai: () => Promise<void>;

package/dist/base/modules/users/modules/RemotePeerTrackAnalysis.d.ts

@@ -1,6 +1,5 @@
 import { TrackReport } from '../../../../types';
 export declare class RemotePeerTrackAnalysis {
-    types: string[];
     trackReport: TrackReport;
     packetsSent: number;
     packetsLost: number;

package/dist/base/modules/users/modules/RemoteUserP2P.d.ts

@@ -30,7 +30,6 @@ export declare class RemoteUserP2P {
         [key in K_mediaType]?: boolean;
     };
     tracks: MediaStreamTrack[];
-    averageOffsetBytesSents: number[];
     on: On;
     waitings: {
         candidateCollected: () => Promise<unknown>;
@@ -42,8 +41,6 @@ export declare class RemoteUserP2P {
         config: Config;
         remoteUserId: string;
     });
-    getAverageOffsetBytesSent: () => number | undefined;
-    saveAverageOffsetBytesSents: (averageOffsetBytesSent: number) => void;
     remoteChannelSend: (message: any) => Promise<void>;
     init: () => void;
     initSenders: (mediaType_transceivers?: MediaTypeTransceiver[], direction?: RTCRtpTransceiverDirection) => ("mc_audio" | "mc_video" | "ss_video" | "ss_audio")[];

package/dist/enums/index.d.ts

@@ -0,0 +1,7 @@
+export * from './callStrategy';
+export * from './eventName';
+export * from './notifyName';
+export * from './mediaType';
+export * from './quality';
+export * from './roomState';
+export * from './trackType';

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './QuickVO';
 export * from './types';
+export * from './enums/index';