@rongcloud/plugin-rtc 5.4.5 → 5.4.7-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/command/LocalTrackMuteCommand.d.ts

@@ -4,7 +4,15 @@ import { RCLocalTrack } from '../tracks/RCLocalTrack';
 import { BaseCommand } from './BaseCommand';
 export declare class LocalTrackMuteCommand extends BaseCommand<void> {
     private localTrack;
-    constructor(localTrack: RCLocalTrack);
+    /**
+     * 接收 signal 扩散状态变更的结果
+     */
+    private readonly _recvSignalResultFn;
+    constructor(localTrack: RCLocalTrack, 
+    /**
+     * 接收 signal 扩散状态变更的结果
+     */
+    _recvSignalResultFn: Function);
     execute(store: Store, invoker: Invoker): Promise<void>;
 }
 //# sourceMappingURL=LocalTrackMuteCommand.d.ts.map

package/dist/core/enums/RCLoggerTag.d.ts

@@ -168,19 +168,19 @@ export declare enum RCLoggerTag {
      */
     L_ABSTRACT_ROOM_DELETE_ROOM_ATTRIBUTE_R = "L-abstract_room_delete_room_attribute_R",
     /**
-     * 房间推流的任务
+     * 房间发布资源的任务
      */
     L_ABSTRACT_ROOM_PUBLISH_T = "L-abstract_room_publish-T",
     /**
-     * 房间推流的结果
+     * 房间发布资源结果
      */
     L_ABSTRACT_ROOM_PUBLISH_R = "L-abstract_room_publish-R",
     /**
-     * 房间停止推流的任务
+     * 房间取消发布资源的任务
      */
     L_ABSTRACT_ROOM_UNPUBLISH_T = "L-abstract_room_unpublish-T",
     /**
-     * 房间停止推流结果
+     * 房间取消发布资源结果
      */
     L_ABSTRACT_ROOM_UNPUBLISH_R = "L-abstract_room_unpublish-R",
     /**

package/dist/core/enums/RCRTCCode.d.ts

@@ -83,6 +83,8 @@ export declare enum RCRTCCode {
     /** electron 中 mac 系统暂不支持屏幕共享采集声音 */
     MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO = 53032,
     /** 获取媒体资源时，无系统权限 */
-    SYSTEM_PERMISSION_DENIED = 53033
+    SYSTEM_PERMISSION_DENIED = 53033,
+    /** 发布时无有效资源，如 track 已被销毁 */
+    PUBLISH_TRACKS_IS_INVALID = 53034
 }
 //# sourceMappingURL=RCRTCCode.d.ts.map

package/dist/core/enums/RCRTCResolution.d.ts

@@ -17,13 +17,13 @@ export declare const RongRTCVideoBitrate: {
         maxBitrate: number;
         minBitrate: number;
     };
-    W256_H144: {
+    W180_H180: {
         width: number;
         height: number;
         maxBitrate: number;
         minBitrate: number;
     };
-    W320_H180: {
+    W240_H180: {
         width: number;
         height: number;
         maxBitrate: number;
@@ -35,19 +35,31 @@ export declare const RongRTCVideoBitrate: {
         maxBitrate: number;
         minBitrate: number;
     };
+    W256_H144: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W320_H180: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
     W320_H240: {
         width: number;
         height: number;
         maxBitrate: number;
         minBitrate: number;
     };
-    W480_H360: {
+    W360_H360: {
         width: number;
         height: number;
         maxBitrate: number;
         minBitrate: number;
     };
-    W640_H360: {
+    W480_H360: {
         width: number;
         height: number;
         maxBitrate: number;
@@ -59,6 +71,12 @@ export declare const RongRTCVideoBitrate: {
         maxBitrate: number;
         minBitrate: number;
     };
+    W640_H360: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
     W640_H480: {
         width: number;
         height: number;
@@ -71,6 +89,18 @@ export declare const RongRTCVideoBitrate: {
         maxBitrate: number;
         minBitrate: number;
     };
+    W848_H480: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W960_H720: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
     W1280_H720: {
         width: number;
         height: number;

package/dist/core/enums/RCResolution.d.ts

@@ -11,6 +11,11 @@ export declare enum RCResolution {
     W640_H480 = "W640_H480",
     W720_H480 = "W720_H480",
     W1280_H720 = "W1280_H720",
-    W1920_H1080 = "W1920_H1080"
+    W1920_H1080 = "W1920_H1080",
+    W180_H180 = "W180_H180",
+    W240_H180 = "W240_H180",
+    W360_H360 = "W360_H360",
+    W848_H480 = "W848_H480",
+    W960_H720 = "W960_H720"
 }
 //# sourceMappingURL=RCResolution.d.ts.map

package/dist/core/tracks/RCLocalTrack.d.ts

@@ -17,12 +17,16 @@ export declare abstract class RCLocalTrack extends RCTrack {
      * 本地流已销毁
      */
     static __INNER_EVENT_DESTROY__: string;
+    /**
+     * track 是否被销毁
+     */
+    private _isDestroyed;
     constructor(tag: string, userId: string, kind: 'audio' | 'video', track: MediaStreamTrack);
     /**
      * @override 重写 RCTrack 父类方法
      * @param bool
      */
-    _setLocalMuted(bool: boolean): void;
+    _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     private _isPublished;
     __innerSetPublished(bool: boolean): void;
     /**
@@ -33,6 +37,10 @@ export declare abstract class RCLocalTrack extends RCTrack {
      * 销毁本地流
      */
     destroy(): void;
+    /**
+     * 判断 track 是否被销毁
+     */
+    isDestroyed(): boolean;
     private _bitrateInfo?;
     /**
      * 为本地流设定上行码率，仅视频流有效，音频默认 15 kbps，不支持修改
@@ -112,7 +120,7 @@ export declare class RCLocalFileVideoTrack extends RCLocalFileTrack {
 }
 export declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     constructor(tag: string, userId: string, track: MediaStreamTrack, element: HTMLVideoElement);
-    _setLocalMuted(bool: boolean): void;
+    _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     play(): Promise<{
         code: RCRTCCode;
     }>;

package/dist/core/tracks/RCTrack.d.ts

@@ -47,15 +47,15 @@ export declare abstract class RCTrack extends EventEmitter {
      */
     isReady(): boolean;
     __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
-    protected _setLocalMuted(bool: boolean): void;
+    protected _setLocalMuted(bool: boolean): void | Promise<RCRTCCode>;
     /**
      * 禁用
      */
-    mute(): void;
+    mute(): void | Promise<RCRTCCode>;
     /**
      * 启用
      */
-    unmute(): void;
+    unmute(): void | Promise<RCRTCCode>;
     /**
      * 本端是否已禁用该轨道数据
      */

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,7 @@ export default abstract class ASdpBuilder {
     protected SDPHeader: string;
     protected videoStreams: string[];
     protected audioStreams: string[];
+    static KBitrate: number;
     get videoSdps(): string[];
     get audioSdps(): string[];
     constructor(SDP: string, type: ISdpSemantics);
@@ -108,5 +109,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/SDPUtils.d.ts

@@ -0,0 +1,60 @@
+interface ssrcMedia {
+    ssrc: number;
+    attribute?: string;
+    value?: string;
+}
+interface Msid {
+    stream: string;
+    track: string;
+}
+interface mline {
+    kind: string;
+    port: number;
+    protocol: string;
+    fmt: string;
+}
+export default class SDPUtils {
+    static splitSections(blob: string): string[];
+    /**
+     * 它需要一个 SDP 文本块并返回一个仅包含媒体部分的 SDP 文本数组
+     * @param {string} blob - 您要解析的 SDP 字符串。
+     * @returns 字符串数组。
+     */
+    static getMediaSections(blob: string): string[];
+    static parseExtmap(line: string): {
+        id: number;
+        direction: string;
+        uri: string;
+    };
+    static splitLines(blob: string): string[];
+    /**
+     * 它接受一个媒体部分并返回一个对象，其中包含媒体部分的种类、端口、协议和格式
+     * @param {string} mediaSection - SDP的媒体部分。
+     * @returns 具有以下属性的对象：
+     *   kind：媒体的类型（音频、视频等）
+     *   端口：端口号
+     *   协议：使用的协议
+     *   fmt：媒体的格式
+     */
+    static parseMLine(mediaSection: string): mline;
+    static matchPrefix(blob: string, prefix: string): string[];
+    /**
+     * 它从 SDP 媒体部分解析 msid 属性
+     * @param {string} mediaSection - SDP的媒体部分。
+     * @returns 具有两个属性的对象：流和轨道。
+     */
+    static parseMsid(mediaSection: string): Msid;
+    /**
+     * 它接受一个字符串并返回一个对象
+     * @param {string} line - 我们正在解析的 SDP 行。
+     */
+    static parseSsrcMedia(line: string): ssrcMedia;
+    /**
+     * 它从 SDP 的媒体部分返回中间值
+     * @param {string} mediaSection - SDP的媒体部分。
+     * @returns 媒体部分的中间。
+     */
+    static getMid(mediaSection: string): string | undefined;
+}
+export {};
+//# sourceMappingURL=SDPUtils.d.ts.map

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

@@ -19,7 +19,7 @@ export declare class UnifiedPlanStrategy extends ASdpStrategy {
     };
     createOffer(iceRestart: boolean): Promise<IOfferInfo>;
     setRemoteAnswer(sdp: string): Promise<RCRTCCode>;
-    protected pickupMidFromOfferSDP(sdp: string): void;
+    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.5
- * CommitId - 4521b431e1c004931d7e115e501f6ac1fe320d34
- * Wed Aug 17 2022 09:32:01 GMT+0800 (China Standard Time)
+ * RCRTC - v5.4.7-alpha.1
+ * CommitId - 1379fbc027ed59d4c014e63771b9606d8810a217
+ * Tue Aug 30 2022 21:58:03 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';
@@ -92,7 +92,9 @@ declare enum RCRTCCode {
     /** electron 中 mac 系统暂不支持屏幕共享采集声音 */
     MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO = 53032,
     /** 获取媒体资源时，无系统权限 */
-    SYSTEM_PERMISSION_DENIED = 53033
+    SYSTEM_PERMISSION_DENIED = 53033,
+    /** 发布时无有效资源，如 track 已被销毁 */
+    PUBLISH_TRACKS_IS_INVALID = 53034
 }
 
 /**
@@ -133,7 +135,12 @@ declare enum RCResolution {
     W640_H480 = "W640_H480",
     W720_H480 = "W720_H480",
     W1280_H720 = "W1280_H720",
-    W1920_H1080 = "W1920_H1080"
+    W1920_H1080 = "W1920_H1080",
+    W180_H180 = "W180_H180",
+    W240_H180 = "W240_H180",
+    W360_H360 = "W360_H360",
+    W848_H480 = "W848_H480",
+    W960_H720 = "W960_H720"
 }
 
 /**
@@ -193,15 +200,15 @@ declare abstract class RCTrack extends EventEmitter {
      */
     isReady(): boolean;
     __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
-    protected _setLocalMuted(bool: boolean): void;
+    protected _setLocalMuted(bool: boolean): void | Promise<RCRTCCode>;
     /**
      * 禁用
      */
-    mute(): void;
+    mute(): void | Promise<RCRTCCode>;
     /**
      * 启用
      */
-    unmute(): void;
+    unmute(): void | Promise<RCRTCCode>;
     /**
      * 本端是否已禁用该轨道数据
      */
@@ -295,12 +302,16 @@ declare abstract class RCLocalTrack extends RCTrack {
      * 本地流已销毁
      */
     static __INNER_EVENT_DESTROY__: string;
+    /**
+     * track 是否被销毁
+     */
+    private _isDestroyed;
     constructor(tag: string, userId: string, kind: 'audio' | 'video', track: MediaStreamTrack);
     /**
      * @override 重写 RCTrack 父类方法
      * @param bool
      */
-    _setLocalMuted(bool: boolean): void;
+    _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     private _isPublished;
     __innerSetPublished(bool: boolean): void;
     /**
@@ -311,6 +322,10 @@ declare abstract class RCLocalTrack extends RCTrack {
      * 销毁本地流
      */
     destroy(): void;
+    /**
+     * 判断 track 是否被销毁
+     */
+    isDestroyed(): boolean;
     private _bitrateInfo?;
     /**
      * 为本地流设定上行码率，仅视频流有效，音频默认 15 kbps，不支持修改
@@ -390,7 +405,7 @@ declare class RCLocalFileVideoTrack extends RCLocalFileTrack {
 }
 declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     constructor(tag: string, userId: string, track: MediaStreamTrack, element: HTMLVideoElement);
-    _setLocalMuted(bool: boolean): void;
+    _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     play(): Promise<{
         code: RCRTCCode;
     }>;