@rongcloud/plugin-rtc 5.4.2 → 5.4.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.4.2
- * CommitId - 70db3a426400ee9ed6b37015c553787be663f508
- * Tue Jul 12 2022 15:10:18 GMT+0800 (China Standard Time)
+ * RCRTC - v5.4.3
+ * CommitId - 14f0acc9bca79c93547703c573d297dbd301594c
+ * Tue Aug 02 2022 09:57:21 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, RTCMode, IRuntime, RTCPluginContext, IJoinRTCRoomData, IReceivedMessage, ErrorCode, RTCJoinType, IRTCUserData, KVString, IServerRTCRoomEntry, LogLevel, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -88,7 +88,9 @@ declare enum RCRTCCode {
     /** 方法在 PK 房间上不可用 */
     THE_FUNCTION_IS_DISABLED_IN_PKROOM = 53030,
     /** 资源没有全部发成功 */
-    SOME_TRACKS_PUBLISH_FAILED = 53031
+    SOME_TRACKS_PUBLISH_FAILED = 53031,
+    /** electron 中 mac 系统暂不支持屏幕共享采集声音 */
+    MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO = 53032
 }
 
 /**
@@ -213,7 +215,8 @@ declare abstract class RCTrack extends EventEmitter {
      */
     play(element?: HTMLVideoElement, options?: {
         volume?: number;
-        audioDeviceId: string;
+        audioDeviceId?: string;
+        autoplay: boolean;
     }): Promise<{
         code: RCRTCCode;
     }>;
@@ -230,6 +233,47 @@ declare abstract class RCTrack extends EventEmitter {
     private __validateVideoNodeName;
 }
 
+declare enum RCAudioBitrate {
+    /**
+     * 标清音质
+     */
+    Speech = "Speech",
+    /**
+     * 音乐音质
+     */
+    Music = "Music",
+    /**
+     * 音乐高清音质
+     */
+    MusicHigh = "MusicHigh"
+}
+declare enum RCVideoBitrate {
+    /**
+     * Bitrate { max: 150, min: 80 }
+     */
+    LEVEL0 = "LEVEL0",
+    /**
+     * Bitrate { max: 280, min: 120 }
+     */
+    LEVEL1 = "LEVEL1",
+    /**
+     * Bitrate { max: 650, min: 150 }
+     */
+    LEVEL2 = "LEVEL2",
+    /**
+     * Bitrate { max: 1000, min: 200 }
+     */
+    LEVEL3 = "LEVEL3",
+    /**
+     * Bitrate { max: 2200, min: 250 }
+     */
+    LEVEL4 = "LEVEL4",
+    /**
+     * Bitrate { max: 4000, min: 400 }
+     */
+    LEVEL5 = "LEVEL5"
+}
+
 declare abstract class RCLocalTrack extends RCTrack {
     /**
      * 本地流结束事件通知
@@ -279,17 +323,16 @@ declare abstract class RCLocalTrack extends RCTrack {
 declare class RCLocalAudioTrack extends RCLocalTrack {
     constructor(tag: string, userId: string, track: MediaStreamTrack);
     /**
-     * 为本地流设定上行码率，仅视频流有效，音频默认 32 kbps，不支持修改
-     * @param max 最大码率，`0` 表示不限制
-     * @param min 最小码率，`0` 表示不限制
-     * @param start 起始码率
+     * 它设置推荐的音频码率。
+     * @param {RCAudioBitrate} audio - RCA音频比特率
      */
-    setBitrate(max?: number, min?: number, start?: number): void;
+    setRecommendBitrate(audio: RCAudioBitrate): void;
     /**
-     * 获取码率配置，当未指定码率时，将取得动态码率计算值
-     * @returns
+     * 它设置视频的比特率。
+     * @param {number} max - 客户端将使用的最大比特率。
+     * @param {number[]} args - [分钟，开始]
      */
-    getBitrate(): IRCTrackBitrate;
+    setBitrate(max: number, ...args: number[]): void;
 }
 declare class RCLocalVideoTrack extends RCLocalTrack {
     private _isTiny;
@@ -297,6 +340,17 @@ declare class RCLocalVideoTrack extends RCLocalTrack {
     __isTiny(): boolean;
     getStreamId(): string;
     getTrackId(): string;
+    /**
+     * 它设置推荐的音频码率
+     * @param {RCVideoBitrate} video - RC视频比特率
+     */
+    setRecommendBitrate(video: RCVideoBitrate): void;
+    /**
+     * 它设置视频的比特率。
+     * @param {number} max - 视频可以编码的最大比特率。
+     * @param {number[]} args - [最大、最小、开始]
+     */
+    setBitrate(max: number, ...args: number[]): void;
 }
 declare abstract class RCLocalFileTrack extends RCLocalTrack {
     /**
@@ -334,6 +388,8 @@ declare class RCCameraVideoTrack extends RCLocalVideoTrack {
 }
 declare class RCScreenVideoTrack extends RCLocalVideoTrack {
 }
+declare class RCScreenAudioTrack extends RCLocalAudioTrack {
+}
 
 declare class RCRemoteTrack extends RCTrack {
     constructor(tag: string, userId: string, kind: 'audio' | 'video', roomId?: string);
@@ -1011,99 +1067,27 @@ interface IMCUOutputConfig {
         pushurl: string;
     }[];
 }
-/**
- * 时间戳参数，用于水印
- */
-interface ITimestampAttrs {
-    /**
-     * 时区
-     */
-    timezone: number;
-    /**
-     * 字体像素大小
-     */
-    fontSize: number;
-    /**
-     * 字体颜色
-     */
-    color: 'black' | 'white';
-    /**
-     * 透明度，有效值 `0.0` 至 `1.0`
-     */
-    alpha: number;
-    /**
-     * 相较于整体画布的 x 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    x: number;
-    /**
-     * 相较于整体画布的 y 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    y: number;
-}
-/**
- * 文本参数，用于水印
- */
-interface ITextAttrs {
-    /**
-     * 文字内容
-     */
-    content: string;
-    /**
-     * 文字像素
-     */
-    fontSize: number;
-    /**
-     * 文字颜色
-     */
-    color: 'black' | 'white';
-    /**
-     * 透明度，有效值 `0.0` 至 `1.0`
-     */
-    alpha: number;
-    /**
-     * 相较于整体画布的 x 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    x: number;
-    /**
-     * 相较于整体画布的 y 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    y: number;
-}
-/**
- * 屏幕水印配置
- */
-interface IWaterMarkConfig {
-    /**
-     * 时间戳水印配置
-     */
-    timestamp?: ITimestampAttrs;
-    /**
-     * 图片水印配置
-     */
-    picture?: IPictureAttrs[];
-    /**
-     * 文字水印配置
-     */
-    text: ITextAttrs[];
-}
 /**
  * 合流前的单一视频流水印配置
+ *【客户端仅提供图片水印设置】
  */
-interface IMCUSignalScreenWaterMarkConfig extends IWaterMarkConfig {
+interface IMCUSignalScreenWaterMarkConfig {
     /**
      * 媒体流的 msid
      */
     streamId: string;
+    picture: IPictureAttrs[];
 }
 interface IMCUWaterMarkConfig {
+    enable: 'on' | 'off';
     /**
      * 合流后的屏幕水印配置
+     *【客户端暂不提供合流水印设置】
      */
-    mixScreen: IWaterMarkConfig;
     /**
      * 合流前的单人视频流水印配置
      */
-    signalScreen: IMCUSignalScreenWaterMarkConfig[];
+    singleScreen: IMCUSignalScreenWaterMarkConfig[];
 }
 /**
  * 发布到服务器的 MCU 配置数据
@@ -1112,7 +1096,7 @@ interface IMCUConfig {
     /**
      * 为向后兼容，当前为常量 1
      */
-    version: 1;
+    version: 2;
     /**
      * 布局模式，在只配置推流 CDN 时，该值不存在
      */
@@ -1771,6 +1755,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     private _handlePingResult;
     /**
      * 设置房间上行资源的总码率配置
+     * @deprecated use RCLocalTrack.setBitrate instead of setBitrate
      * @description
      * * 自 v5.1.0 版本开始，推荐使用 `RCLocalTrack.setBitrate` 对不同流分别指定码率。
      * * 该方法仅在 SDP `plan-b` 协议下（Chrome 92 与 Safari 11 之前的版本）有效。
@@ -2446,6 +2431,10 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _onConnectionStateChange;
     private _onICEConnectionStateChange;
     private _onTrackReady;
+    /**
+     * 它设置对等连接的比特率。
+     * @deprecated use RCLocalTrack.setBitrate instead of setBitrate
+     */
     setBitrate(max: number, min: number, start?: number): Promise<void>;
     createOffer(iceRestart: boolean): Promise<IOfferInfo>;
     setRemoteAnswer(answer: string): Promise<RCRTCCode>;
@@ -2577,7 +2566,8 @@ interface IVideoProfile {
  */
 interface IScreenVideoProfile extends IVideoProfile {
     /**
-     * Electron 平台下通过 `desktopCapturer.getSources` 获取到的 sourceId，在 Electron 环境下为必填项。
+     * Electron 平台下通过 `desktopCapturer.getSources` 获取到的 sourceId，
+     * 不传 chromeMediaSourceId 时默认共享桌面，传入时共享指定窗口。
      * @see `https://www.electronjs.org/docs/api/desktop-capturer`
      */
     chromeMediaSourceId?: string;
@@ -2830,7 +2820,7 @@ interface IRoomEventListener extends IRCRTCTrackEventListener {
      * 另一种可能是己方 rtcPing 失败次数超出上限
      * @param byServer 当值为 `false` 时，说明本端 rtcPing 超时；当值为 `true` 时，说明本端收到被踢出房间通知
      */
-    onKickOff?(byServer: boolean, state?: RCKickReason): void;
+    onKickOff?(byServer: boolean, state?: RCKickReason, kickExtra?: any): void;
     /**
      * 接收到房间信令时回调，用户可通过房间实例的 sendMessage 接口发送信令
      * @param name 信令名
@@ -3254,6 +3244,19 @@ declare class RCMCUConfigBuilder {
      * @since v5.3.7
      */
     clearCustomizeInputAudio(): RCMCUConfigBuilder;
+    /**
+     * 给单道流添加水印
+     */
+    addPictureWaterMark(trackId: string, uri: string, x: number, y: number, w: number, h: number): RCMCUConfigBuilder;
+    /**
+     * 删除所有水印
+     */
+    clearPictureWaterMark(): RCMCUConfigBuilder;
+    /**
+   * 移除对合流后的某个视频流中添加的指定水印图片
+   * @param uri
+   */
+    removePictureWaterMark(trackId: string, uri: string): RCMCUConfigBuilder;
     /**
      * 设置 MCU 混流配置
      * @param videoList 视频输入混流列表，为 null 代表视频全混流，为空集合代表视频全不混流，否则按照输入列表进行混流
@@ -3474,68 +3477,19 @@ declare class RCAudienceClient {
     private _onTrackReady;
 }
 
-/**
- * RTC 业务客户端
- * @public
- */
-declare class RCRTCClient {
-    private readonly _context;
-    private readonly _runtime;
-    private readonly _options;
-    private readonly _service;
-    constructor(_context: RTCPluginContext, _runtime: IRuntime, _options: IRCRTCInitOptions);
-    private _handleMessage;
-    /**
-     * 获取加入的连麦房间
-     */
-    private _getJoinedPKRoomList;
-    /**
-     * 获取当前用户 Id，若 IM 未连接，这返回 `''`
-     * @returns
-     */
-    getCurrentId(): string;
-    private _crtRoom;
-    /**
-     * 加入普通音视频房间
-     * @param roomId
-     * @param joinType 多端处理方式，公有云暂不支持该字段
-     * @param outerUserDatas 业务层设置人员属性
-     */
-    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean): Promise<{
-        room?: RCRTCRoom;
-        code: RCRTCCode;
-        userIds?: string[];
-        tracks?: RCRemoteTrack[];
-    }>;
-    /**
-     * 主播加入直播房间或观众上麦场景调用，观众上麦之前需先取消已订阅的直播间资源
-     * @param roomId 房间 Id
-     * @param livingType 直播间类型，`RCLivingType.AUDIO` 为音频直播，`RCLivingType.VIDEO` 为音视频直播
-     * @param joinType 多端处理方式，公有云暂不支持该字段
-     * @param outerUserDatas 业务层设置人员属性
-     */
-    joinLivingRoom(roomId: string, livingType: RCLivingType, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean): Promise<{
-        room?: RCLivingRoom;
-        code: RCRTCCode;
-        userIds?: string[];
-        tracks?: RCRemoteTrack[];
-        CDNEnable?: boolean;
-    }>;
-    private _audience;
-    /**
-     * 获取直播观众客户端
-     */
-    getAudienceClient(useMutilPeerC?: boolean): RCAudienceClient;
-    private _onIMStatusChange;
-    private _onIMDisconnect;
-    private _onIMUninit;
+declare class RCMediaStreamCapture {
+    protected readonly _context: RTCPluginContext;
+    constructor(_context: RTCPluginContext);
+    private _isElectron;
+    private _getMediaStream;
     /**
-     * 退出并销毁当前房间实例，退出后该房间的所有方法将不可用
+     * 如果用户设置了音频约束为true，那么我们将音频约束设置为一个空对象，
+     * 然后我们将检查浏览器是否支持noiseSuppression、autoGainControl和echoCancellation约束，
+     * 如果支持，那么我们将设置音频约束为真
+     * @param {any} constraints - 约束参数与 getUserMedia 方法中的约束参数相同。
+     * @returns 返回值是约束对象。
      */
-    leaveRoom(room: RCAbstractRoom): Promise<{
-        code: RCRTCCode;
-    }>;
-    private _getMediaStream;
+    private setConstraintsConfig;
     /**
      * 从麦克风中捕获音轨数据
      * @param tag
@@ -3581,6 +3535,18 @@ declare class RCRTCClient {
         code: RCRTCCode;
         track?: RCScreenVideoTrack;
     }>;
+    /**
+     * 创建带音频的屏幕共享资源
+     * @param tag 屏幕共享视轨数据标识
+     * @param options
+     * @description electron 中 mac 系统暂不支持屏幕共享采集声音
+     * @returns 在可以取到音频的情况下，tracks 中包含音轨和视轨；取不到音视频时 tracks 仅返回视轨
+     */
+    createScreenWithAudioTracks(tag?: string, options?: IScreenVideoProfile): Promise<{
+        code: RCRTCCode;
+        tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[];
+    }>;
+    private _createScreenTracks;
     /**
      * 创建 RCLocalAudioTrack 实例
      * @param tag
@@ -3622,6 +3588,78 @@ declare class RCRTCClient {
         code: RCRTCCode;
         tracks: RCLocalTrack[];
     }>;
+    /**
+     * 它接受一个 MediaStream 和一个可选的选项对象并返回一个 MediaStreamTracks 数组
+     * @param {MediaStream} stream - MediaStream - 从中获取曲目的流。
+     * @param {ICreateLocalTrackOptions} [options] - ICreateLocalTrackOptions
+     * @returns 一组 MediaStreamTrack 对象。
+     */
+    static getTracksWithOptions(stream: MediaStream, options?: ICreateLocalTrackOptions): Array<MediaStreamTrack | undefined>;
+}
+
+/**
+ * RTC 业务客户端
+ * @public
+ */
+declare class RCRTCClient extends RCMediaStreamCapture {
+    protected readonly _context: RTCPluginContext;
+    private readonly _runtime;
+    private readonly _options;
+    private readonly _service;
+    constructor(_context: RTCPluginContext, _runtime: IRuntime, _options: IRCRTCInitOptions);
+    private _handleMessage;
+    /**
+     * 获取加入的连麦房间
+     */
+    private _getJoinedPKRoomList;
+    /**
+     * 获取当前用户 Id，若 IM 未连接，这返回 `''`
+     * @returns
+     */
+    getCurrentId(): string;
+    private _crtRoom;
+    /**
+     * 加入普通音视频房间
+     * @param roomId
+     * @param joinType 多端处理方式
+     * @param outerUserDatas 业务层设置人员属性
+     * @param useMutilPeerC 是否使用多 peerConnection 发布资源
+     * @param roomType 加入房间的类型 默认参数 RTCMode.RTC
+     */
+    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean, roomType?: RTCMode): Promise<{
+        room?: RCRTCRoom;
+        code: RCRTCCode;
+        userIds?: string[];
+        tracks?: RCRemoteTrack[];
+    }>;
+    /**
+     * 主播加入直播房间或观众上麦场景调用，观众上麦之前需先取消已订阅的直播间资源
+     * @param roomId 房间 Id
+     * @param livingType 直播间类型，`RCLivingType.AUDIO` 为音频直播，`RCLivingType.VIDEO` 为音视频直播
+     * @param joinType 多端处理方式，公有云暂不支持该字段
+     * @param outerUserDatas 业务层设置人员属性
+     */
+    joinLivingRoom(roomId: string, livingType: RCLivingType, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean): Promise<{
+        room?: RCLivingRoom;
+        code: RCRTCCode;
+        userIds?: string[];
+        tracks?: RCRemoteTrack[];
+        CDNEnable?: boolean;
+    }>;
+    private _audience;
+    /**
+     * 获取直播观众客户端
+     */
+    getAudienceClient(useMutilPeerC?: boolean): RCAudienceClient;
+    private _onIMStatusChange;
+    private _onIMDisconnect;
+    private _onIMUninit;
+    /**
+     * 退出并销毁当前房间实例，退出后该房间的所有方法将不可用
+     */
+    leaveRoom(room: RCAbstractRoom): Promise<{
+        code: RCRTCCode;
+    }>;
     private _crtAudienceLivingRoom;
     /**
      * 观众加入直播房间
@@ -3721,4 +3759,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IReqResPKOptions, IRoomEventListener, IRoomPKEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenVideoTrack, RCTag, RCTrack, device, helper, installer };
+export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPubSuccessRes, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IReqResPKOptions, IRoomEventListener, IRoomPKEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCAudioBitrate, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaStreamCapture, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenAudioTrack, RCScreenVideoTrack, RCTag, RCTrack, RCVideoBitrate, device, helper, installer };