aliyun-rtc-sdk 6.11.1 → 6.11.2

package/dist/types/index.d.ts

@@ -386,16 +386,16 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
     /**
      * @brief 是否推送音频流
      * @param enabled 是否开启/关闭本地音频流推送
-     - true: 开启音频流推送
-     - false: 关闭音频流推送
+     *  - true: 开启音频流推送
+     *  - false: 关闭音频流推送
      * @note SDK默认设置推送音频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效
      */
     publishLocalAudioStream(enabled: boolean): Promise<void>;
     /**
      * @brief 查询是否设置推送音频流
      * @return
-     - true: 已设置推送
-     - false: 未设置推送
+     *  - true: 已设置推送
+     *  - false: 未设置推送
      * @note SDK默认设置推送音频流，如果需要取消推送音频流，可以通过 {@link publishLocalAudioStream}方法设置为不推送
      */
     isLocalAudioStreamPublished(): boolean;
@@ -436,8 +436,8 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
     /**
      * @brief 是否推送本地视频流
      * @param enabled 是否开启/关闭本地视频流推送
-     - true: 开启视频流推送
-     - false: 关闭视频流推送
+     * - true: 开启视频流推送
+     * - false: 关闭视频流推送
      * @note SDK默认设置推送视频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效
      */
     publishLocalVideoStream(enabled: boolean): Promise<void>;
@@ -514,7 +514,7 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @param uid 用户ID。从App server分配的唯一标示符
      * @return 返回一个远端用户对象。详见{@link RemoteUser}
      */
-    getUserInfo(uid: string): RemoteUser | undefined;
+    getUserInfo(uid: string): AliRtcRemoteUserInfo | undefined;
     /**
      * @brief 查询用户是否在线
      * @param uid 用户ID，从App server分配的唯一标示符。不可为NULL
@@ -589,7 +589,7 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @param {boolean} mute 停止或恢复远端的音频播放
      * - true：停止播放
      * - false（默认值）：恢复播放
-     * @note 拉流和解码不受影响, 支持 joinChannel 之前和之后设置
+     * @note 拉流和解码不受影响，支持 {@link joinChannel} 之前和之后设置
      */
     muteRemoteAudioPlaying(uid: string, mute?: boolean): void;
     /**
@@ -597,7 +597,7 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @param {boolean} mute 停止或恢复远端的音频播放
      * - true：停止播放
      * - false（默认值）：恢复播放
-     * @note 拉流和解码不受影响, 支持 joinChannel 之前和之后设置
+     * @note 拉流和解码不受影响，支持 {@link joinChannel} 之前和之后设置
      */
     muteAllRemoteAudioPlaying(mute?: boolean): void;
     /**
@@ -769,6 +769,12 @@ declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @param streamUrl 推流地址
      */
     stopPublishLiveStream(streamUrl: string): Promise<any>;
+    /**
+     * @brief 停止旁路直播
+     * @details SDK提供了停止旁路直播的功能
+     * @param taskId 任务Id
+     */
+    stopPublishLiveStreamWithTaskId(taskId: string): Promise<any>;
     /**
      * 获取旁路直播状态
      * @param streamUrl 推流地址
@@ -1364,6 +1370,107 @@ declare interface AliRtcLocalAudioStats {
     stats: any;
 }
 
+export declare class AliRtcLocalStreamInfo extends default_2<AliRtcLocalStreamListener> {
+    type: AliRtcRawDataStreamType;
+    originVideoTrack?: MediaStreamTrack;
+    videoSource?: VideoStreamSource;
+    private _videoMuted;
+    originAudioTrack?: MediaStreamTrack;
+    audioSource?: AudioStreamSource;
+    private _audioMuted;
+    private _targetVideoTrack?;
+    private _targetDualVideoTrack?;
+    private _targetAudioTrack?;
+    private _publishVideoStream?;
+    private _publishDualVideoStream?;
+    private _publishAudioStream?;
+    private _previewStream?;
+    plugins: AliRtcPlugin[];
+    private _profileManager?;
+    cameraVideoConstraints?: IVideoConstraints;
+    micAudioConstraints?: IAudioConstraints;
+    private get profileManager();
+    get audioProfile(): AudioProfileKey | undefined;
+    constructor(type: AliRtcRawDataStreamType);
+    private onVideoTrackEnded;
+    private onAudioTrackEnded;
+    updateSource(newStream: LocalStream, newVideoSource?: VideoStreamSource, newAudioSource?: AudioStreamSource): Promise<void>;
+    get currentProfile(): string | undefined;
+    get currentVideoTrack(): MediaStreamTrack | undefined;
+    get currentDualVideoTrack(): MediaStreamTrack | undefined;
+    get publishVideoStream(): LocalStream | undefined;
+    get publishDualVideoStream(): LocalStream | undefined;
+    get currentAudioTrack(): MediaStreamTrack | undefined;
+    get publishAudioStream(): LocalStream | undefined;
+    get previewStream(): LocalStream | undefined;
+    /**
+     * 更新 VideoTrack
+     * @param videoTrack
+     */
+    updateVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 DualVideoTrack
+     * @param videoTrack
+     * @param force
+     */
+    updateDualVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 AudioTrack
+     * @param audioTrack
+     */
+    updateAudioTrack(audioTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 设置音频流静音
+     * @param muted
+     */
+    setAudioMuted(muted: boolean): void;
+    get isAudioMuted(): boolean;
+    /**
+     * 设置视频流静音
+     * @param muted
+     */
+    setVideoMuted(muted: boolean): void;
+    get isVideoMuted(): boolean;
+    process(localStreamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    /**
+     * 停止视频流
+     */
+    stopVideo(): void;
+    /**
+     * 停止音频流
+     */
+    stopAudio(): void;
+    /**
+     * 停止视频流和音频流
+     */
+    stop(): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     * @param profileValue
+     */
+    updateVideoProfile(profileName?: string, profileValue?: IProfile): Promise<void>;
+    get videoProfile(): string | undefined;
+    setVideoContentHint(hint?: string): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     */
+    updateAudioProfile(profileKey: AudioProfileKey): Promise<void>;
+    /**
+     * 复制视频 profile 到指定 LocalStream
+     * @param publishStream
+     */
+    cloneVideoProfile(publishStream: LocalStream): Promise<void>;
+    addPlugin(plugin: AliRtcPlugin): void;
+    removePlugin(plugin: AliRtcPlugin): boolean;
+}
+
+declare interface AliRtcLocalStreamListener {
+    videotrackended: () => void;
+    audiotrackended: () => void;
+}
+
 declare interface AliRtcLocalVideoStats {
     track: AliRtcVideoTrack;
     streamType?: AliRtcVideoStreamType;
@@ -1414,12 +1521,12 @@ export declare abstract class AliRtcPlugin extends default_2<AliRtcPluginListene
     enable(): void;
     disable(): void;
     get isEnable(): boolean;
-    protected audioUpdated(streamInfo: LocalStreamInfo): boolean;
-    protected videoUpdated(streamInfo: LocalStreamInfo): boolean;
-    execute(streamInfo: LocalStreamInfo, streamInfos: LocalStreamInfo[]): Promise<void>;
-    abstract shouldUpdate(streamInfo: LocalStreamInfo, streamInfos: LocalStreamInfo[]): boolean;
-    abstract process(streamInfo: LocalStreamInfo, streamInfos: LocalStreamInfo[]): Promise<void>;
-    clear(_streamInfo?: LocalStreamInfo): void;
+    protected audioUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    protected videoUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    execute(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    abstract shouldUpdate(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): boolean;
+    abstract process(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    clear(_streamInfo?: AliRtcLocalStreamInfo): void;
 }
 
 declare interface AliRtcPluginListener {
@@ -1439,8 +1546,8 @@ export declare enum AliRtcPluginTrackType {
 }
 
 export declare enum AliRtcPluginType {
-    PRE_PROCESSER = 0,
-    POST_PROCESSER = 1
+    PRE_PROCESSOR = 0,
+    POST_PROCESSOR = 1
 }
 
 export declare enum AliRtcPublishState {
@@ -1472,6 +1579,24 @@ declare interface AliRtcRemoteAudioStats {
     stats: any;
 }
 
+export declare class AliRtcRemoteUserInfo {
+    private remoteUser;
+    constructor(remoteUser: RemoteUser);
+    get userId(): string;
+    get displayName(): string;
+    get isMuteAudioPlaying(): boolean;
+    get hasAudio(): boolean;
+    get hasCamera(): boolean;
+    get hasCameraLarge(): boolean;
+    get hasCameraSmall(): boolean;
+    get hasScreenShare(): boolean;
+    get isAudioSubscribing(): boolean;
+    get isVideoSubscribing(): boolean;
+    get isVideoLargeSubscribing(): boolean;
+    get isVideoSmallSubscribing(): boolean;
+    get isScreenSubscribing(): boolean;
+}
+
 declare interface AliRtcRemoteVideoStats {
     uid: string;
     track: AliRtcVideoTrack;
@@ -1826,93 +1951,6 @@ declare interface _LocalStreamConfig extends IStreamConfig {
     screenProfile?: string;
 }
 
-declare class LocalStreamInfo extends default_2<LocalStreamListener> {
-    type: AliRtcRawDataStreamType;
-    originVideoTrack?: MediaStreamTrack;
-    videoSource?: VideoStreamSource;
-    originAudioTrack?: MediaStreamTrack;
-    audioSource?: AudioStreamSource;
-    private _targetVideoTrack?;
-    private _targetDualVideoTrack?;
-    private _targetAudioTrack?;
-    private _publishVideoStream?;
-    private _publishDualVideoStream?;
-    private _publishAudioStream?;
-    private _previewStream?;
-    plugins: AliRtcPlugin[];
-    private _profileManager?;
-    cameraVideoConstraints?: IVideoConstraints;
-    micAudioConstraints?: IAudioConstraints;
-    private get profileManager();
-    get audioProfile(): AudioProfileKey | undefined;
-    constructor(type: AliRtcRawDataStreamType);
-    private onVideoTrackEnded;
-    private onAudioTrackEnded;
-    updateSource(newStream: LocalStream, newVideoSource?: VideoStreamSource, newAudioSource?: AudioStreamSource): Promise<void>;
-    get currentProfile(): string | undefined;
-    get currentVideoTrack(): MediaStreamTrack | undefined;
-    get currentDualVideoTrack(): MediaStreamTrack | undefined;
-    get publishVideoStream(): LocalStream | undefined;
-    get publishDualVideoStream(): LocalStream | undefined;
-    get currentAudioTrack(): MediaStreamTrack | undefined;
-    get publishAudioStream(): LocalStream | undefined;
-    get previewStream(): LocalStream | undefined;
-    /**
-     * 更新 VideoTrack
-     * @param videoTrack
-     */
-    updateVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
-    /**
-     * 更新 DualVideoTrack
-     * @param videoTrack
-     * @param force
-     */
-    updateDualVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
-    /**
-     * 更新 AudioTrack
-     * @param audioTrack
-     */
-    updateAudioTrack(audioTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
-    process(localStreamInfos: LocalStreamInfo[]): Promise<void>;
-    /**
-     * 停止视频流
-     */
-    stopVideo(): void;
-    /**
-     * 停止音频流
-     */
-    stopAudio(): void;
-    /**
-     * 停止视频流和音频流
-     */
-    stop(): void;
-    /**
-     * 应该在执行完 plugin 后调用
-     * @param profileName
-     * @param profileValue
-     */
-    updateVideoProfile(profileName?: string, profileValue?: IProfile): Promise<void>;
-    get videoProfile(): string | undefined;
-    setVideoContentHint(hint?: string): void;
-    /**
-     * 应该在执行完 plugin 后调用
-     * @param profileName
-     */
-    updateAudioProfile(profileKey: AudioProfileKey): Promise<void>;
-    /**
-     * 复制视频 profile 到指定 LocalStream
-     * @param publishStream
-     */
-    cloneVideoProfile(publishStream: LocalStream): Promise<void>;
-    addPlugin(plugin: AliRtcPlugin): void;
-    removePlugin(plugin: AliRtcPlugin): boolean;
-}
-
-declare interface LocalStreamListener {
-    videotrackended: () => void;
-    audiotrackended: () => void;
-}
-
 declare class LocalStreamManager extends default_2<LocalStreamManagerListener> {
     /**
      * @ignore
@@ -1921,8 +1959,8 @@ declare class LocalStreamManager extends default_2<LocalStreamManagerListener> {
     private pluginManager;
     private publishingCameraVideoStream;
     private publishingScreenVideoStream;
-    cameraStreamInfo: LocalStreamInfo;
-    screenStreamInfo: LocalStreamInfo;
+    cameraStreamInfo: AliRtcLocalStreamInfo;
+    screenStreamInfo: AliRtcLocalStreamInfo;
     private streamInfos;
     private _audioCaptureDisabled;
     private _cameraCaptureDisabled;
@@ -1934,6 +1972,12 @@ declare class LocalStreamManager extends default_2<LocalStreamManagerListener> {
     get audioCaptureDisabled(): boolean;
     set audioCaptureDisabled(closed: boolean);
     get cameraCaptureDisabled(): boolean;
+    setAudioMuted(muted: boolean): void;
+    get isAudioMuted(): boolean;
+    setCameraMuted(muted: boolean): void;
+    get isCameraMuted(): boolean;
+    setScreenMuted(muted: boolean): void;
+    get isScreenMuted(): boolean;
     set cameraCaptureDisabled(closed: boolean);
     get publishLocalAudioStreamEnabled(): boolean;
     set publishLocalAudioStreamEnabled(enable: boolean);
@@ -2064,6 +2108,9 @@ declare class LocalUser extends User {
     setScreenProfile(key: string, profile?: IProfile): Promise<void>;
     setCameraDirection(direction: AliRtcCameraDirection): void;
     setCameraDeviceId(deviceId: string): void;
+    muteLocalCamera(mute: boolean): void;
+    muteLocalMic(mute: boolean): void;
+    muteLocalScreen(mute: boolean): void;
     setMicrophoneDeviceId(deviceId: string): void;
     updatePubId(): void;
     clearPublishState(): void;
@@ -2473,6 +2520,7 @@ declare class RemoteUser extends User {
      */
     static logName: string;
     remoteCallid: string;
+    remoteUserInfo: AliRtcRemoteUserInfo;
     protected localUserId: string;
     protected lastPubId: string;
     protected stream?: RemoteStream;
@@ -2508,8 +2556,11 @@ declare class RemoteUser extends User {
     setWantSubScreen(value: boolean): void;
     setRemoteDefaultVideoStreamType(type: AliRtcVideoStreamType): void;
     setAudioMuted(value: boolean): void;
+    getAudioMuted(): boolean;
     get hasAudioTrack(): boolean;
     get hasVideoTrack(): boolean;
+    get hasVideoLargeTrack(): boolean;
+    get hasVideoSmallTrack(): boolean;
     get hasScreenTrack(): boolean;
     get isAudioSubscribing(): boolean;
     get isVideoSubscribing(): boolean;
@@ -2519,6 +2570,7 @@ declare class RemoteUser extends User {
     get audioEnabled(): boolean;
     get videoEnabled(): boolean;
     get screenEnabled(): boolean;
+    get getAudioTrack(): MediaStreamAudioTrack | undefined;
     get getCameraStream(): RemoteStream | undefined;
     get getScreenStream(): RemoteStream | undefined;
     setViewConfig(view: AliRtcLocalView, track: AliRtcVideoTrack): void;
@@ -2880,7 +2932,6 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private dcResolve?;
     dcConnectingPromise?: Promise<unknown>;
     private _publishingTracks;
-    private subscribeAddBatcher;
     constructor(localStreamManager: LocalStreamManager);
     setEncodedInsertableStreams(enable: boolean): void;
     destroy(): void;
@@ -2911,7 +2962,14 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     } | undefined>;
     subscibeStop(streamUrl: string): Promise<void>;
     publish(streamUrl: string): Promise<string>;
-    subscribe(remoteSubscribeOptions: RemoteSubscribeOptions): Promise<unknown>;
+    subscribe(remoteSubscribeOptions: RemoteSubscribeOptions): Promise<{
+        traceId: string;
+        stream: RemoteStream;
+    } | {
+        url: string;
+        stream: RemoteStream;
+        traceId?: string | undefined;
+    } | null>;
     getSubscribeVideoStats(streamUrl: string, msid?: string): Promise<unknown>;
     getSubscribeAudioStats(streamUrl: string, msid?: string): Promise<unknown>;
     sendSEI(streamUrl: string, data: ArrayBuffer, repeatCount: number, payloadType: number): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.11.1",
+  "version": "6.11.2",
   "type": "module",
   "main": "dist/aliyun-rtc-sdk.js",
   "types": "dist/types/index.d.ts",