@rongcloud/plugin-rtc 5.6.8 → 5.6.9-enterprise.1

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /*
- * RCRTC - v5.6.8
- * CommitId - 5b57db6e6132740cd12ae9f67466cab1090ce82c
- * Fri Jan 06 2023 15:07:57 GMT+0800 (China Standard Time)
+ * RCRTC - v5.6.9-enterprise.1
+ * CommitId - d8e8805bcf8f7e6302273f3fee5efba569e78d73
+ * Mon Feb 13 2023 19:00:46 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
+import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, RCConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -98,7 +98,9 @@ declare enum RCRTCCode {
     /** 获取媒体资源时，无系统权限 */
     SYSTEM_PERMISSION_DENIED = 53033,
     /** 发布时无有效资源，如 track 已被销毁 */
-    PUBLISH_TRACKS_IS_INVALID = 53034
+    PUBLISH_TRACKS_IS_INVALID = 53034,
+    /** 流状态为 ended */
+    TRACK_READYSTATE_IS_ENDED = 53035
 }
 
 /**
@@ -1526,7 +1528,7 @@ declare class RTCContext {
     };
     getCurrentId(): string;
     getNaviInfo(): IRTCNaviInfo | null;
-    getConnectionStatus(): ConnectionStatus;
+    getConnectionStatus(): RCConnectionStatus;
     getAppkey(): string;
     /** web 端发 rtcPing */
     webRtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<{
@@ -1547,7 +1549,7 @@ declare class RTCContext {
     }> | Promise<IAsyncRes<any>>;
     sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): IPromiseResult<IReceivedMessage>;
     registerRTCSignalListener(listener?: ((buffer: Uint8Array) => void) | undefined): void;
-    registerConnectionStateChangeListener(listener: (status: ConnectionStatus) => void): void;
+    registerConnectionStateChangeListener(listener: (status: RCConnectionStatus) => void): void;
     registerDisconnectListener(listener: () => void): void;
     registerDestroyListener(listener: () => void): void;
     registerMessageListener(listener: (message: IReceivedMessage) => boolean): void;
@@ -4024,7 +4026,8 @@ interface IRCRTCInitOptions {
      */
     pingGap?: number;
     /**
-     * 优化使用的 SDP 协议版本，仅当运行时浏览器支持相应 SDP 协议版本时生效
+     * 目前该参数仅在 Chrome 浏览器 72 - 92 之间版本有效，其他浏览器或版本将优先尝试使用 `unified-plan`，
+     * 在不支持 `unified-plan` 的情况下使用 `plan-b` 协议。
      */
     sdpSemantics?: ISdpSemantics;
     /**
@@ -4466,6 +4469,13 @@ declare class RCMCUConfigBuilder {
     clearCustomizeInputAudio(): RCMCUConfigBuilder;
     /**
      * 给单道流添加水印
+     * @param trackId 资源 Id
+     * @param uri 水印图片的地址，需注意图片需要是 png 格式
+     * @param x 相对于整体画布的起始位置 x 坐标（百分比），有效值 `0.0` - `1.0`
+     * @param y 相对于整体画布的起始位置 y 坐标（百分比），有效值 `0.0` - `1.0`
+     * @param width 相对于整体画布的宽（百分比），有效值 `0.0` - `1.0`
+     * @param height 相对于整体画布的高（百分比），有效值 `0.0` - `1.0`
+     * @description 注意，参数中 x + width 不得大于 1，y + height 不得大于 1，否则调用 flush() 时会提示 46020 错误
      */
     addPictureWaterMark(trackId: string, uri: string, x: number, y: number, w: number, h: number): RCMCUConfigBuilder;
     /**
@@ -5040,4 +5050,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-export { BackgroundPictureFillMode, IAudienceRoomEventListener, ICameraVideoProfile, ILiveAudioState, 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, RTCJoinType, device, helper, installer };
+export { BackgroundPictureFillMode, IAudienceRoomEventListener, ICameraVideoProfile, ICreateLocalTrackOptions, IJoinResCDNInfo, ILiveAudioState, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPubSuccessRes, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRTCUserData, 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, RTCJoinType, device, helper, installer };