dingrtc 3.9.7-4 → 3.9.7-7

package/dist/index.d.ts

@@ -1666,10 +1666,11 @@ declare class MixedLocalAudioTrack extends EventEmitter<ITrackEvent> {
     private _screenAudioTrack;
     private mixedAudioTrackResult;
     private publication;
+    private serviceManager;
     private _trackId;
     private logger;
     trackMediaType: string;
-    constructor(reporter: Reporter);
+    constructor(serviceManager: ServiceManager);
     getTrackId(): string;
     getScreenAudioTrack(): LocalAudioTrack;
     setScreenAudioTrack(newScreenAudioTrack: LocalAudioTrack): void;
@@ -1678,7 +1679,17 @@ declare class MixedLocalAudioTrack extends EventEmitter<ITrackEvent> {
     isPublished: () => boolean;
     setPublication: (publication?: Publication) => void;
     getPublication: () => Publication;
-    private updateMicTrackHandler;
+    private micTrackEventHandler;
+    private screenAudioTrackEventHandler;
+    private _audioTrackInnerEventHandler;
+    private notifyMicDeviceMuted;
+    /**
+     * 跟mic状态含义和逻辑略有不同。
+     * 通知其他人本端音频媒体中是否有屏幕共享的音频
+     * @param enabled
+     * @returns
+     */
+    private notifyScreenAudioEnabled;
     updateMixedAudioTrackToPub: () => void;
     private mixAudioTracks;
     clear: () => void;
@@ -1716,6 +1727,10 @@ declare class Publication extends EventEmitter<IPublishEvents> {
     logger: ILogger;
     mid: string;
     encodings: SenderEncoding[];
+    /**
+     * 记录本地的rtc stream control的状态，防止重复发送消息
+     */
+    private rtcStreamMuted;
     private feedbackIndex;
     private monitor;
     constructor(options: PublicationOptions);
@@ -1751,7 +1766,8 @@ declare class SessionManager extends EventEmitter<SessionManagerEvent> {
     reporter: Reporter;
     logger: ILogger;
     mixedLocalAudioTrack: MixedLocalAudioTrack;
-    repubPromise: Promise<void>;
+    republishPromise: Promise<void>;
+    resubscribePromise: Promise<void>;
     constructor(client: DingRTCClient, serviceManager: ServiceManager);
     private getOrCreatePeerConnection;
     /**
@@ -1766,6 +1782,7 @@ declare class SessionManager extends EventEmitter<SessionManagerEvent> {
      */
     handleStuckResubscribe(sessions: Subscription[]): Promise<void>;
     private handleResubscribe;
+    private _handleResubscribe;
     getSessionByStreamId(id: string): Subscription;
     private handleResubSuccess;
     private handleServerFailover;
@@ -1802,10 +1819,9 @@ interface PeerConnectionProps {
  */
 declare class PeerConnection extends EventEmitter<IPeerConnectionEvents> {
     pc: RTCPeerConnection;
-    private pendingTask;
     rtcSignaling: RtcSignaling;
     state: PeerConnectionState;
-    private exchangeSdpTask;
+    private processingExchangeSdp;
     monitor: PeerConnectionMonitor;
     peerConnectionTimer: number;
     createPeerConnectionPromise: PromiseLikeObject;
@@ -1832,7 +1848,6 @@ declare class PeerConnection extends EventEmitter<IPeerConnectionEvents> {
     constructor(props: PeerConnectionProps);
     startSinglePC: (isFailover?: boolean) => Promise<void>;
     private stopSinglePC;
-    reset(): void;
     closePeerConnection(): void;
     private onTrack;
     fireEndedEvent(): void;
@@ -1848,10 +1863,10 @@ declare class PeerConnection extends EventEmitter<IPeerConnectionEvents> {
     private detachEvents;
     private onIceGatheringStateChange;
     /**
-     * @deprecated 目前没有被调用，考虑删除
-     * @returns
+     *
+     * @param isSinglePCFailover
+     * @returns 正常返回即成功，如果异常则失败
      */
-    startTask(): Promise<unknown>;
     private exchangeSDP;
     reoffer(): Promise<void>;
     handleHighProfileFallback(): void;
@@ -1878,6 +1893,7 @@ interface SubscriptionOptions {
      */
     userConfigResolution?: ResolutionInfo$1;
     uid?: string;
+    targetMediaType: TrackMediaType;
 }
 /**
  * @internal
@@ -1905,6 +1921,7 @@ declare class Subscription extends EventEmitter<ISubscribeEvents> {
     videoStatsMap: Map<string, RemoteVideoStates>;
     transceiver: RTCRtpTransceiver;
     transceivers?: RTCRtpTransceiver[];
+    targetMediaType: TrackMediaType;
     constructor(options: SubscriptionOptions);
     private logTrackEnded;
     private logTrackUnmute;
@@ -2018,7 +2035,7 @@ declare class User extends EventEmitter {
     /**
      * @internal
      */
-    getRemoteVideoTrack(session: Subscription, auxiliary?: boolean): RemoteVideoTrack;
+    updateSubbedVideoTrack(session: Subscription, auxiliary?: boolean): RemoteVideoTrack;
     toJSON: () => {
         userId: string;
         userName: string;
@@ -2060,6 +2077,14 @@ interface IClientEvents {
      * 在大部分情况下，你只需要监听 user-published 和 user-unpublished 就可以完成订阅、取消订阅、展示远端用户是否打开了摄像头和麦克风等工作，无需特别关注实际用户状态的变化，SDK 会自动处理用户状态变化。
      */
     'user-info-updated': (uid: string, msg: 'mute-audio' | 'mute-video' | 'unmute-audio' | 'unmute-video') => void;
+    /**
+     * 用户的麦克风采集数据是否设置静音
+     */
+    'user-mic-audio-muted': (uid: string, muted: boolean) => void;
+    /**
+     * 用户的屏幕共享音频数据是否混入音频流进行发布
+     */
+    'user-screencast-audio-mixed': (uid: string, mixed: boolean) => void;
     /**
      * 提示频道内正在说话的远端用户列表，三人及以上时自动开启。
      * @param uids 正在说话人的uid，第一个为音量最高的人，列表为空时代表无人在说话。
@@ -2245,7 +2270,7 @@ declare class DingRTCClient extends EventEmitter<IClientEvents> {
      * @param {SubscribeParam[]} batchSubscribeParam
      * @returns void
      */
-    batchSubscribe(batchSubscribeParam: SubscribeParam$1[]): Promise<SubscribeResult[]>;
+    batchSubscribe(batchSubscribeParam: SubscribeParam[]): Promise<SubscribeResult[]>;
     /**
      * 取消订阅远端用户的音视频轨道。
      * @param uid 远端用户id。
@@ -2418,6 +2443,7 @@ declare class RtcUserManager extends EventEmitter<UserManagerEvent> {
     clear(): void;
     private handleEvent;
     setParticipantProperties(stats: string): Promise<signal_msg.IResponse>;
+    notifyParticipantProperties(propertiesJsonStr: string): Promise<signal_msg.IResponse>;
 }
 
 /**
@@ -2451,7 +2477,7 @@ declare class ServiceManager extends EventEmitter<ChannelEvens> {
     handleStreamEvent(action: StreamEventAction, payload: StreamEventPlayload): void;
     handleGroupEvent(action: GroupEventAction, group: Group | string, extraPayload?: GroupUser | signal_msg.IGroupProperty | string | signal_msg.IGroupAudioInfo): void;
     handleUserEvent(action: UserEventAction, payload: User): void;
-    getStream(param: SubscribeParam): signal_msg.IStream;
+    getStream(param: InternalSubscribeParam): signal_msg.IStream;
     private handleSubscribeParam;
     private checkUnsubParam;
     join(joinInfo: JoinParam): Promise<ISignal_msg.IJoinResponse>;
@@ -2465,9 +2491,15 @@ declare class ServiceManager extends EventEmitter<ChannelEvens> {
      */
     publish(tracks: LocalTrack[]): Promise<void>;
     unpublish(tracks: LocalTrack[]): Promise<void>;
-    private getRemoteTrack;
-    batchSubscribe(batchSubscribeParams: SubscribeParam[]): Promise<SubscribeResult[]>;
-    batchUnsubscribe(batchUnsubscribeParam: SubscribeParam[]): Promise<void> | Promise<IBatchSubscribeResult[]>;
+    private updateSubbedRemoteTrack;
+    batchSubscribe(batchSubscribeParams: InternalSubscribeParam[]): Promise<SubscribeResult[]>;
+    batchUnsubscribe(batchUnsubscribeParam: InternalSubscribeParam[]): Promise<void | IBatchSubscribeResult[]>;
+    /**
+     * TODO: 这里的事件很奇怪，似乎是专门给asr sdk使用的
+     * resub 过程如何处理？
+     * @param subscribed
+     * @param streamId
+     */
     private updateSubscribedAudioStream;
     subscribeGroup(groupId: string): Promise<RemoteAudioTrack>;
     unsubscribeGroup(groupId: string): Promise<void>;
@@ -3009,7 +3041,7 @@ type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
  * @required mediaType 订阅的轨道媒体类型
  * @optional auxiliary 如果订阅视频轨道，是否订阅共享视频流
  */
-interface SubscribeParam$1 {
+interface SubscribeParam {
     uid: string;
     mediaType: TrackMediaType;
     auxiliary?: boolean;
@@ -3415,6 +3447,7 @@ interface IBatchSubscribeParam {
     track?: RemoteTrack;
     error?: DingRTCError;
     streamType?: RemoteStreamType;
+    targetMediaType: TrackMediaType;
     uid?: string;
     session?: Subscription;
     profileFallback?: boolean;
@@ -3450,7 +3483,7 @@ interface SenderEncoding {
     targetHeight?: number;
     priority?: string;
 }
-interface SubscribeParam {
+interface InternalSubscribeParam {
     uid?: string;
     groupId?: string;
     auxiliary?: boolean;
@@ -3499,9 +3532,10 @@ declare class LocalTrack extends Track {
     protected setMediaStreamTrack(track: MediaStreamTrack): void;
     play(mediaWrapperElement?: string | HTMLElement, config?: VideoPlayerConfig): void;
     /**
-     * 启用/禁用该轨道。
+     * 启用/禁用该轨道。禁用时销毁媒体流，如果流来自mic和cam设备，将不再占用设备，启用后重新请求特定的媒体流
+     * 如果该track已经发布，通知其他用户 rtc 流已经unmute，参考setMuted操作
      *
-     * 轨道禁用后，播放和发布都将被停止。
+     * 轨道禁用后，播放将停止，通知其他用户 rtc 流已经mute。
      *
      * @param enabled 是否启用该轨道
      * - true: 启用该轨道。
@@ -3515,12 +3549,11 @@ declare class LocalTrack extends Track {
      */
     close(): void;
     /**
-     * 发送或暂停发送该轨道的媒体数据。
-     *
-     * 如果该轨道已发布，调用 setMuted(true) 后，远端会触发 mute-video 事件。再调用 setMuted(false) 后，远端会触发 unmute-video 事件。
-     * @param muted 发送或暂停发送该轨道的媒体数据
-     *  - true: 发送媒体数据
-     *  - false: 暂停发送媒体数据
+     * 把音频源mute，如果当前track已经被发布出去，如果当前track是video类型，那么其他用户会收到 video-mute 或者video-unmute事件。
+     * 如果当前track是来自麦克风或者屏幕共享的音频流，且是最后一个被mute的音频源，那么其他用户会收到 audio-mute 或者audio-unmute事件，
+     * 如果不是最后一个被mute/unmute操作的音频源，那么其他用户不会收到 audio-mute 或者audio-unmute事件
+     * 支持发布之前调用，在publish之后会补mute动作
+     * @param muted 是否mute
      */
     setMuted(muted: boolean): Promise<void>;
     private getAudioTrack;
@@ -3852,4 +3885,4 @@ declare class DingRTC extends EventEmitter<IGlobalEvent> {
 declare const _default: DingRTC;
 
 export { AudioSourceInfo, AudioSourceState, CameraVideoTrack, DingRTCClient, FALLBACK_SUB_VIDEO_PROFILE, LocalAudioTrack, LocalTrack, LocalVideoTrack, MicrophoneAudioTrack, RemoteAudioTrack, RemoteTrack, User as RemoteUser, RemoteVideoTrack, Track, VideoSourceInfo, _default as default };
-export type { BufferSourceAudioTrackConfig, CameraVideoTrackConfig, ChannelEvens, ConnectionState, CustomAudioTrackConfig, CustomVideoTrackConfig, DeviceInfo, DisconnectedReason, GlobalClientConfigInfo, Group, GroupAudioRoute, GroupPropertyUpdateTypes, GroupUser, IClientEvents, ICommonExceptionEvent, IGlobalEvent, ISharedChannelInstance, JoinGroupConfig, JoinParam, LeaveGroupConfig, LocalAudioStates, LocalVideoStates, LocalVideoStatesMap, LogLevel, MicrophoneAudioTrackConfig, NetworkQuality, OptimizationMode, RemoteAudioStates, RemoteStreamType, RemoteVideoStates, RemoteVideoStatesMap, ScreenVideoTrackConfig, SubscribeParam$1 as SubscribeParam, SubscribeResult, TrackMediaType, UnsubscribeParam, VideoDimension, VideoEncoderConfiguration, VideoPlayerConfig };
+export type { BufferSourceAudioTrackConfig, CameraVideoTrackConfig, ChannelEvens, ConnectionState, CustomAudioTrackConfig, CustomVideoTrackConfig, DeviceInfo, DisconnectedReason, GlobalClientConfigInfo, Group, GroupAudioRoute, GroupPropertyUpdateTypes, GroupUser, IClientEvents, ICommonExceptionEvent, IGlobalEvent, ISharedChannelInstance, JoinGroupConfig, JoinParam, LeaveGroupConfig, LocalAudioStates, LocalVideoStates, LocalVideoStatesMap, LogLevel, MicrophoneAudioTrackConfig, NetworkQuality, OptimizationMode, RemoteAudioStates, RemoteStreamType, RemoteVideoStates, RemoteVideoStatesMap, ScreenVideoTrackConfig, SubscribeParam, SubscribeResult, TrackMediaType, UnsubscribeParam, VideoDimension, VideoEncoderConfiguration, VideoPlayerConfig };