@rongcloud/plugin-rtc 5.4.4 → 5.4.6-alpha.1

package/README.md

@@ -1 +1,50 @@
-# @rongcloud/plugin-rtc
+# 使用说明
+## 安装依赖 @rongcloud/plugin-rtc
+
+> RTC 消息通信需要依赖 IMLib 进行消息收发，所以需要先安装 IMLib
+### 一、 安装消息通信依赖 IMLib
+
+1. 查看最新包所依赖模块
+
+```
+npm info "@rongcloud/imlib-next@latest" peerDependencies
+```
+
+2. 安装所依赖的模块
+
+> npm version > 5.0
+>
+> 将所有依赖安装到 `dependencies` 的位置
+
+```
+npx install-peerdeps -x "--save-prod" @rongcloud/imlib-next@latest
+```
+
+
+### 二、 安装音视频通信 RTCLib
+1. 查看最新包所依赖模块
+
+```
+npm info "@rongcloud/plugin-rtc@latest" peerDependencies
+```
+
+2. 安装所依赖的模块
+
+> npm version > 5.0
+>
+> 将所有依赖安装到 `dependencies` 的位置
+
+```
+npx install-peerdeps -x "--save-prod" @rongcloud/plugin-rtc@latest
+```
+
+## RTC 使用
+
+1. 融云开发者文档 [^快速开始](https://doc.rongcloud.cn/live/Web/5.X/quickstart/init)
+
+2. demo 体验 [rongcloud-rtc-web-demo](https://github.com/rongcloud/rongcloud-rtc-web-demo)
+2. 流程说明
+    - [初始化](https://doc.rongcloud.cn/live/Web/5.X/quickstart/init)
+    - 创建房间并加入
+    - 在房间内发布资源
+    - 订阅房间内已经发布的资源

package/dist/core/webrtc/sdp/ASdpBuilder.d.ts

@@ -1,5 +1,5 @@
 import { IRCTrackBitrate } from '../../interfaces';
-import { ISdpSemantics } from './ASdpStrategy';
+import { ISdpSemantics, RtpTransceiverDirection } from './ASdpStrategy';
 /**
  * 以字符串的形式 硬处理 SDP 信息
  * 对于 plan-b | unified-plan 数据的处理 方式是相同的。
@@ -12,6 +12,8 @@ export default abstract class ASdpBuilder {
     protected SDPHeader: string;
     protected videoStreams: string[];
     protected audioStreams: string[];
+    get videoSdps(): string[];
+    get audioSdps(): string[];
     constructor(SDP: string, type: ISdpSemantics);
     /**
      * 它从 SDP 中删除空行和尾随空格
@@ -37,7 +39,7 @@ export default abstract class ASdpBuilder {
      * @param {string} stream - string - 要修改的 SDP 字符串
      * @returns 正在返回流。
      */
-    clearInactiveOrRecvonly(stream: string): string;
+    static clearInactiveOrRecvonly(stream: string): string;
     /**
      * 它采用 SDP 标头和音频和视频流并将它们连接到一个字符串中
      * @returns SDP 标头和音频和视频流的字符串。
@@ -54,6 +56,12 @@ export default abstract class ASdpBuilder {
      * @param {string} streamId - 音频流的媒体流 ID。
      */
     setAudioBitrateWithStreamId(bitrate: IRCTrackBitrate, streamId: string): ASdpBuilder;
+    /**
+     * 它设置特定 MID 的音频比特率。
+     * @param {IRCTrackBitrate} bitrate - 音频流的比特率，以 kbps 为单位。
+     * @param {string} mid - 音频流的媒体流 ID。
+     */
+    setAudioBitrateWithMid(bitrate: IRCTrackBitrate, mid: string): ASdpBuilder;
     /**
      * 它接受一个 SDP 音频块和一个比特率，并返回比特率设置为给定值的 SDP 音频块
      * @param {string} sdpAudioBlock - SDP 的音频块。
@@ -80,6 +88,12 @@ export default abstract class ASdpBuilder {
      * @param {string} streamId - 媒体流 ID。
      */
     setVideoBitrateWithStreamId(bitrate: IRCTrackBitrate, streamId: string): ASdpBuilder;
+    /**
+     * 它设置特定中间的视频比特率， 针对 SDP 中给定 mid 的 video 元素添加码率设置。
+     * @param {IRCTrackBitrate} bitrate - 您要设置的比特率。
+     * @param {string} streamId - 媒体流 ID。
+     */
+    setVideoBitrateWithMid(bitrate: IRCTrackBitrate, mid: string): ASdpBuilder;
     /**
      * 它设置视频项目的比特率。
      * @param {string} sdpVideoBlock - SDP 的视频块。
@@ -94,5 +108,7 @@ export default abstract class ASdpBuilder {
      * @returns 正在返回 sdpVideoBlock。
      */
     private addVideoBlineAS;
+    clearnSsrcWithMid(mid: string, direction: RtpTransceiverDirection): ASdpBuilder;
+    private clearSSRC;
 }
 //# sourceMappingURL=ASdpBuilder.d.ts.map

package/dist/core/webrtc/sdp/ASdpStrategy.d.ts

@@ -8,6 +8,11 @@ export declare enum SdpSemantics {
     PLANB = "plan-b",
     UNIFIEDPLAN = "unified-plan"
 }
+export declare enum RtpTransceiverDirection {
+    SENDONLY = "sendonly",
+    RECVONLY = "recvonly",
+    INACTIVE = "inactive"
+}
 export interface IOfferInfo {
     type: 'offer';
     sdp: string;

package/dist/core/webrtc/sdp/UnifiedPlanStrategy.d.ts

@@ -14,8 +14,12 @@ export declare class UnifiedPlanStrategy extends ASdpStrategy {
     private _subedTracks;
     updateRecvTransceiverMap(trackId: string, transceiver: RTCRtpTransceiver): void;
     updateSubRemoteTracks(tracks: RCRemoteTrack[]): void;
+    protected midMsid: {
+        [key: string]: string;
+    };
     createOffer(iceRestart: boolean): Promise<IOfferInfo>;
     setRemoteAnswer(sdp: string): Promise<RCRTCCode>;
-    protected resetSdp(sdp: string): string;
+    protected resetOfferSdp(sdp: string): string;
+    protected resetAnswerSdp(sdp: string): string;
 }
 //# sourceMappingURL=UnifiedPlanStrategy.d.ts.map

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.4.4
- * CommitId - bc1f8f530851278c199d53868ad7c199d465f45e
- * Tue Aug 09 2022 15:25:48 GMT+0800 (China Standard Time)
+ * RCRTC - v5.4.6-alpha.1
+ * CommitId - d109ea1eb1987a80bf3299b86d39859d331d65b8
+ * Fri Aug 19 2022 11:59:39 GMT+0800 (中国标准时间)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, RTCMode, IRuntime, RTCPluginContext, IJoinRTCRoomData, IReceivedMessage, ErrorCode, RTCJoinType, IRTCUserData, KVString, IServerRTCRoomEntry, LogLevel, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -3872,4 +3872,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-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 };
+export { BackgroundPictureFillMode, IAudienceRoomEventListener, 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 };