@rongcloud/plugin-rtc 5.2.4 → 5.2.5

package/dist/core/room/RCLivingRoom.d.ts

@@ -0,0 +1,93 @@
+import { IJoinRTCRoomData, RTCPluginContext, IRuntime } from '@rongcloud/engine';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IRCRTCInitOptions, IPublishedResource } from '../interfaces';
+import { RCMediaService, ICDNUris, IExchangeReqBody } from '../service';
+import RCAbstractRoom from './RCAbstractRoom';
+import RCMCUConfigBuilder from './RCMCUConfigBuilder';
+import { RCLivingType } from '../enums/RCLivingType';
+import { RCInnerCDNPushMode } from '../enums/RCInnerCDNPushMode';
+/**
+ * 直播房间
+ */
+export default class RCLivingRoom extends RCAbstractRoom {
+    private _livingType;
+    readonly _mcuConfigBuilder: RCMCUConfigBuilder;
+    /**
+     * cdn_uris 信令扩散数据
+     */
+    private _CDNUris;
+    private _CDNEnable;
+    constructor(context: RTCPluginContext, runtime: IRuntime, roomId: string, data: IJoinRTCRoomData, service: RCMediaService, initOptions: IRCRTCInitOptions, clientEvent: Function, _livingType: RCLivingType, isUpgrage?: boolean);
+    getLivingType(): RCLivingType;
+    /**
+     * 获取 MCU 配置构建对象
+     */
+    getMCUConfigBuilder(): RCMCUConfigBuilder;
+    /**
+     * 接收 MCU 配置并向 MediaServer 提交
+     * @param data
+     */
+    private _onMCUConfigFlush;
+    /**
+     * 主播端断线重连后，需更新内存中的 CDN 数据
+     * 判断房间内 CDN 状态是否和内存数据一致，不一致时需通知到客户端
+     */
+    __onReconnected(): Promise<void>;
+    /**
+     * 开启/停用推 CDN
+     */
+    enableInnerCDN(enable: boolean): Promise<{
+        code: RCRTCCode;
+    }>;
+    /**
+     * 开启、停用 CDN 推资源后发信令
+     */
+    private _sendCDNInfoSignal;
+    /**
+     * 扩散 cdn_uris 资源
+     */
+    private _spreadCDNInfo;
+    /**
+     * 给房间设置 CDN 数据
+     */
+    private _setRoomCDNInfo;
+    /**
+     * 资源变化时触发
+     * 直播房间需单独处理 cdn_uris
+     */
+    protected _resourceHandle(content: {
+        /**
+         * 旧版本兼容参数，当收到非 `RTCMessageName.TOTAL_CONTENT_RESOURCE` 时：
+         * * ignore 值为 `true` 表示该消息由 signal server 向旧版本 RTCLib 提供的兼容消息，无需处理
+         * * 否则认为该消息是由旧版本 RTCLib 主动发出的增量变更消息，需要处理
+         */
+        ignore?: boolean;
+        /**
+         * 发布到房间内的资源列表，`RTCMessageName.TOTAL_CONTENT_RESOURCE` 消息携带全量数据，否则为增量数据
+         */
+        uris: IPublishedResource[];
+        cdn_uris?: ICDNUris[];
+    }, messageType: string, userId: string): Promise<void>;
+    /**
+     * 重写父类 _exchangeHandle 方法
+     */
+    protected _exchangeHandle(body: IExchangeReqBody): Promise<{
+        code: RCRTCCode;
+        data?: import("../service").IExchangeResponse | undefined;
+    }>;
+    /**
+     * 观众切换为主播后直接处理人员变更及资源变更
+     */
+    protected _afterChangedRole(data: IJoinRTCRoomData): void;
+    /**
+     * 返回 CDN 是否可用
+     * @returns boolean
+     */
+    __getCDNEnable(): boolean | undefined;
+    /**
+     * 返回 CDN 推送模式: 自动 or 手动
+     * @returns boolean
+     */
+    __getCDNPushMode(): RCInnerCDNPushMode | undefined;
+}
+//# sourceMappingURL=RCLivingRoom.d.ts.map

package/dist/core/room/RCLocalMediaStream.d.ts

@@ -0,0 +1,8 @@
+export default class RCLocalMediaStream {
+    readonly msid: string;
+    readonly mediaStream: MediaStream;
+    readonly tinyStream: MediaStream;
+    readonly tag: string;
+    constructor(msid: string);
+}
+//# sourceMappingURL=RCLocalMediaStream.d.ts.map

package/dist/core/room/RCMCUConfigBuilder.d.ts

@@ -0,0 +1,163 @@
+import { BackgroundPictureFillMode } from '../enums/BackgroundPictureFillMode';
+import { MixLayoutMode } from '../enums/MixLayoutMode';
+import { MixVideoRenderMode } from '../enums/MixVideoRenderMode';
+import { RCFrameRate } from '../enums/RCFrameRate';
+import { RCResolution } from '../enums/RCResolution';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IMCUConfig } from '../service';
+export default class RCMCUConfigBuilder {
+    /**
+     * flush 提交回调
+     */
+    private readonly _onFlush;
+    /**
+     * trackId 有效性验证方法
+     */
+    private readonly _isValidTrackId;
+    /**
+     * 扩散 cdn_uris
+     */
+    private readonly _sendCDNInfoSignal;
+    /**
+     * mcu 配置数据，每次向服务器提交全量数据
+     */
+    private _values;
+    constructor(
+    /**
+     * flush 提交回调
+     */
+    _onFlush: (config: IMCUConfig) => Promise<{
+        code: RCRTCCode;
+    }>, 
+    /**
+     * trackId 有效性验证方法
+     */
+    _isValidTrackId: (trackId: string) => boolean, 
+    /**
+     * 扩散 cdn_uris
+     */
+    _sendCDNInfoSignal: () => void);
+    /**
+     * 设置合流后的主位置显示的视频流
+     * @param videoTrackId 视频流资源 Id
+     */
+    setHostVideoTrack(videoTrackId: string): RCMCUConfigBuilder;
+    /**
+     * 设置合流布局模式，当使用 `MixLayoutMode.CUSTOMIZE` 模式时，需自定义合流结构
+     * @param mode
+     * * `MixLayoutMode.CUSTOMIZE`: 自定义布局，需用户设置布局结构
+     * * `MixLayoutMode.SUSPENSION`: 悬浮布局（默认）
+     * * `MixLayoutMode.ADAPTATION`: 自适应布局
+     */
+    setMixLayoutMode(mode: MixLayoutMode): RCMCUConfigBuilder;
+    private _addOutputValue;
+    /**
+     * 设置合流输出视频流的分辨率
+     * @param resulution 有效值为 `RCResolution` 定义的枚举值
+     */
+    setOutputVideoResolution(resolution: RCResolution): RCMCUConfigBuilder;
+    /**
+     * 设置合流输出视频流的帧率
+     * @param fps 其有效值为 `RCFrameRate` 中定义的枚举值
+     */
+    setOutputVideoFPS(fps: RCFrameRate): RCMCUConfigBuilder;
+    /**
+     * 设置合流输出视频流的码率（不推荐主动修改）
+     * @param bitrate
+     */
+    setOutputVideoBitrate(bitrate: number): RCMCUConfigBuilder;
+    /**
+     * 设置合流后输出视频流小流的分辨率
+     * @param resulution 有效值为 `RCResolution` 定义的枚举值
+     */
+    setOutputTinyVideoResolution(resolution: RCResolution): RCMCUConfigBuilder;
+    /**
+     * 设置合流输出视频流小流的帧率
+     * @param fps 其有效值为 `RCFrameRate` 中定义的枚举值
+     */
+    setOutputTinyVideoFPS(fps: RCFrameRate): RCMCUConfigBuilder;
+    /**
+     * 设置合流输出视频流小流的码率（不推荐主动修改）
+     * @param bitrate
+     */
+    setOutputTinyVideoBitrate(bitrate: number): RCMCUConfigBuilder;
+    /**
+     * 设置合流后的视频流渲染方式
+     * @param renderMode
+     */
+    setOutputVideoRenderMode(renderMode: MixVideoRenderMode): RCMCUConfigBuilder;
+    /**
+     * 设置合流后音频流的编码参数（不推荐主动修改）
+     * @param bitrate 音频码率
+     */
+    setOutputAudioBitrate(bitrate: number): RCMCUConfigBuilder;
+    /**
+     * 设置合流后的视频流的背景色，默认为 `0x000000`
+     * @param color 颜色参数，为 16 进制标识法，如 '0x000000'
+     */
+    setOutputBackgroundColor(color: string): RCMCUConfigBuilder;
+    /**
+     * 向合流后的视频流中增加背景图片
+     * @param uri 图片资源的完整下载地址
+     * @param x 相对于整体画布的起始位置 x 坐标（百分比），有效值 `0.0` - `1.0`
+     * @param y 相对于整体画布的起始位置 y 坐标（百分比），有效值 `0.0` - `1.0`
+     * @param w 相对于整体画布的宽（百分比），有效值 `0.0` - `1.0`
+     * @param h 相对于整体画布的高（百分比），有效值 `0.0` - `1.0`
+     */
+    addOutputBackgroundPicture(uri: string, x: number, y: number, w: number, h: number): RCMCUConfigBuilder;
+    /**
+     * 移除对合流后的视频流中添加的指定背景图片
+     * @param uri
+     */
+    removeOutputBackgroundPicture(uri: string): RCMCUConfigBuilder;
+    /**
+     * 清理对合流后的视频流中添加的所有背景图片
+     */
+    clearOutputBackgroundPicture(): RCMCUConfigBuilder;
+    /**
+     * 设置合流后的视频流中添加的背景图片的填充方式：
+     * 1. 按比例裁剪
+     * 2. 不裁剪，按比例压缩
+     * @param fillMode
+     */
+    setOutputBackgroundPictureFillMode(fillMode: BackgroundPictureFillMode): RCMCUConfigBuilder;
+    /**
+     * 设置直播 CDN 旁路推流地址，最多支持 5 个推流地址
+     * @param urls 地址列表
+     */
+    addPublishStreamUrls(urls: string[]): RCMCUConfigBuilder;
+    /**
+     * 移除直播 CDN 旁路推流地址
+     * @param urls
+     */
+    removePublishStreamUrls(urls: string[]): RCMCUConfigBuilder;
+    /**
+     * 清理已添加的 CDN 旁路推流地址
+     */
+    clearPublishStreamUrls(): RCMCUConfigBuilder;
+    /**
+     * 在自定义布局中增加视频流配置
+     * @param trackId 资源 Id
+     * @param x 在画布中的坐标 x
+     * @param y 在画布中的坐标 y
+     * @param width 分辨率宽度
+     * @param height 分辨率高度
+     */
+    addCustomizeLayoutVideo(trackId: string, x: number, y: number, width: number, height: number): RCMCUConfigBuilder;
+    /**
+     * 移除自定义布局中的视频流配置
+     * @param trackId
+     */
+    removeCustomizeLayoutVideo(trackId: string): RCMCUConfigBuilder;
+    /**
+     * 清除已添加的自定义布局中的视频流配置
+     */
+    clearCustomizeLayoutVideo(): RCMCUConfigBuilder;
+    /**
+     * 使已修改的配置生效，在调用该方法前，所有数据只会对本地配置进行修改，不会产生实际效果
+     */
+    flush(): Promise<{
+        code: RCRTCCode;
+    }>;
+}
+//# sourceMappingURL=RCMCUConfigBuilder.d.ts.map

package/dist/core/room/RCRTCRoom.d.ts

@@ -0,0 +1,11 @@
+import { IJoinRTCRoomData, RTCPluginContext, IRuntime } from '@rongcloud/engine';
+import { IRCRTCInitOptions } from '../interfaces';
+import RCMediaService from '../service/RCMediaService';
+import RCAbstractRoom from './RCAbstractRoom';
+/**
+ * 普通音视频房间
+ */
+export default class RCRTCRoom extends RCAbstractRoom {
+    constructor(context: RTCPluginContext, runtime: IRuntime, roomId: string, data: IJoinRTCRoomData, service: RCMediaService, initOptions: IRCRTCInitOptions, clientEvent: Function);
+}
+//# sourceMappingURL=RCRTCRoom.d.ts.map

package/dist/core/service/RCMediaService.d.ts

@@ -0,0 +1,96 @@
+import { IRuntime, RTCPluginContext } from '@rongcloud/engine';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IRTCReqHeader, IExchangeReqBody, IExchangeResponse, IMCUReqHeaders, IBroadcastSubReqBody, IBroadcastSubRespBody, ICDNPlayUrlReqHeaders, ICDNPlayUrlResponse } from './interface';
+import { IMCUConfig, ISetEnableCDN } from './mcu-interface';
+export default class RCMediaService {
+    private readonly _runtime;
+    private readonly _context;
+    /**
+     * 自定义 MediaServer 地址，当有值时，不再使用导航内的地址
+     */
+    private readonly _msUrl?;
+    /**
+     * 请求超时时长
+     */
+    private readonly _timeout;
+    /**
+     * navi 中获取的媒体服务地址
+     */
+    private readonly _msInNavi;
+    /**
+     * 已失败的请求地址
+     */
+    private readonly _failedMs;
+    /**
+     * 服务器指纹数据，客户端不得修改，直接透传
+     */
+    private _rtcFinger;
+    /**
+     * 服务器接口返回的 clusterId 数据，当此数据有值时，后续所有请求向此服务发送
+     */
+    private _clusterId;
+    /**
+     * MCU 服务地址
+     */
+    private _configUrl;
+    constructor(_runtime: IRuntime, _context: RTCPluginContext, 
+    /**
+     * 自定义 MediaServer 地址，当有值时，不再使用导航内的地址
+     */
+    _msUrl?: string | undefined, 
+    /**
+     * 请求超时时长
+     */
+    _timeout?: number);
+    getNaviMS(): string[];
+    /**
+     * 发送请求，请求发送若失败，会继续尝试使用后续可用地址直到无地址可用，此时认为请求失败
+     * @param path
+     * @param header
+     * @param body
+     */
+    private _request;
+    /**
+     * 资源协商接口，订阅、发布、变更资源均可以使用此接口。该接口通过 sdp 字段交换 SDP 信息，
+     * 并通过 subscribeList 和 publishList 表明最终发布和订阅的资源。本端产出 offer，服务器产出 answer
+     * 每次接口调用，都会全量覆盖发布和订阅的资源。
+     * @param header
+     * @param body
+     */
+    exchange(headers: IRTCReqHeader, body: IExchangeReqBody): Promise<{
+        code: RCRTCCode;
+        data?: IExchangeResponse | undefined;
+    }>;
+    /**
+     * 退出房间
+     */
+    exit(headers: IRTCReqHeader): Promise<RCRTCCode>;
+    /**
+     * 观众端订阅主播资源
+     */
+    broadcastSubscribe(headers: IRTCReqHeader, body: IBroadcastSubReqBody): Promise<{
+        code: RCRTCCode;
+        data?: IBroadcastSubRespBody | undefined;
+    }>;
+    /**
+     * 观众端退出订阅
+     */
+    broadcastExit(headers: IRTCReqHeader): Promise<{
+        code: RCRTCCode;
+    }>;
+    /**
+     * 直播推流、自定义布局配置
+     */
+    setMcuConfig(headers: IMCUReqHeaders, body: IMCUConfig | ISetEnableCDN): Promise<{
+        code: RCRTCCode;
+        res?: any;
+    }>;
+    /**
+     * 房间内观众获取 CDN 资源信息、拉流地址
+     */
+    getCDNResourceInfo(headers: ICDNPlayUrlReqHeaders, url: string): Promise<{
+        code: RCRTCCode;
+        res?: ICDNPlayUrlResponse;
+    }>;
+}
+//# sourceMappingURL=RCMediaService.d.ts.map

package/dist/core/service/helper.d.ts

@@ -0,0 +1,8 @@
+import { INaviInfo } from '@rongcloud/engine';
+export declare const getUUID: () => string;
+/**
+ * 解析导航数据获取 RTC Server 地址
+ * @param info
+ */
+export declare const parseNaviInfo: (info: INaviInfo | null) => string[];
+//# sourceMappingURL=helper.d.ts.map

package/dist/core/service/index.d.ts

@@ -0,0 +1,6 @@
+import RCMediaService from './RCMediaService';
+export { RCMediaService };
+export * from './helper';
+export * from './interface';
+export * from './mcu-interface';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/service/interface.d.ts

@@ -0,0 +1,311 @@
+import { RTCMode } from '@rongcloud/engine';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { RCMediaType } from '../enums/RCMediaType';
+import { RCStreamType } from '../enums/inner/RCStreamType';
+import { IResource } from '../interfaces';
+import { IOfferInfo } from '../webrtc/ASdpStrategy';
+import { RCInnerCDNPushMode } from '../enums/RCInnerCDNPushMode';
+import { RCInnerCDNBroadcast } from '../enums/RCInnerCDNBroadcast';
+/**
+ * 与 MediaServer 交互所需的 Request Header 信息
+ */
+export interface IRTCReqHeader {
+    /**
+     * RTC Token
+     * @todo 有效期问题处理
+     */
+    Token: string;
+    /**
+     * 房间 Id
+     */
+    RoomId: string;
+    /**
+     * 用户 Id
+     */
+    UserId: string;
+    /**
+     * 仅在直播模式下需要
+     */
+    RoomType?: RTCMode;
+    /**
+     * 开发者的 AppKey
+     */
+    'App-Key': string;
+    /**
+     * signal 会话 session id
+     */
+    'Session-Id'?: string;
+}
+export interface IMCUReqHeaders {
+    'App-Key': string;
+    Token: string;
+    RoomId: string;
+    UserId: string;
+    SessionId: string;
+}
+/**
+ * exchange 接口的请求体结构
+ */
+export interface IExchangeReqBody {
+    /**
+     * local description
+     */
+    sdp: IOfferInfo;
+    /**
+     * 订阅列表
+     */
+    subscribeList: {
+        /**
+         * 流资源 uri
+         */
+        uri: string;
+        /**
+         * 大小流订阅，`1` 为大流，`2` 为小流，默认使用大流
+         */
+        simulcast: RCStreamType;
+        /**
+         * 分辨率信息
+         */
+        resolution: string;
+    }[];
+    /**
+     * 透传参数，一般用于传递参数给其他服务，如 MCU/Record 等，MediaServer 仅透传不处理
+     * @example `{"resolutionInfo":[{"trackId":"021ad6e8-a50c-479c-96c8-5f3f09d2352d","simulcast":1,"resolution":"640x480"}]}`
+     */
+    extend: string;
+    /**
+     * 跨房间连麦时其他房间的推流信息
+     */
+    pushOtherRooms?: {
+        /**
+         * 房间 Id
+         */
+        roomId: string;
+        /**
+         * 是否默认合流
+         */
+        automix: boolean;
+        /**
+         * 房间 Id 对应的 SessionId
+         */
+        sessionId: string;
+    }[];
+    /**
+     * server 根据网络动态切换大小流开关，默认为 `false`
+     */
+    switchstream: boolean;
+}
+export interface ILiveUrls {
+    /**
+     * MCU 服务地址，直播模式中用于向 MCU 服务提交 CDN 及合流配置
+     */
+    configUrl: string;
+    /**
+     * 观众端订阅地址，由业务层分发
+     */
+    liveUrl: string;
+    /**
+     * 自动推 CDN 模式下，发布资源后返回的 CDN 信息
+     */
+    pull_url?: string;
+}
+export interface IRTCResponse {
+    /**
+     * 请求响应码，只有在 resultCode 值为 `10000` 时才为正常响应
+     */
+    resultCode: RCRTCCode;
+    /**
+   * 与 resultCode 相应的可读性文字信息
+   */
+    message: string;
+    /**
+     * 客户端发送的 Request-Id
+     */
+    'Request-Id': string;
+}
+/**
+ * /exchange 响应结果
+ */
+export interface IExchangeResponse extends IRTCResponse {
+    /**
+     * 数据中心地址，当存在此值时，后续所有请求发送到该地址。该地址不携带协议头，故需要补全 `https://` 协议头
+     */
+    clusterId: string;
+    /**
+     * 发布的资源列表
+     */
+    publishList: IResource[];
+    /**
+     * @deprecated 目前并未使用，服务器返回值为 ''
+     */
+    roomId: '';
+    /**
+     * 远端 SDP 数据
+     */
+    sdp: {
+        type: 'answer';
+        sdp: string;
+    };
+    /**
+     * 直播模式推流数据，仅在直播模式有值
+     */
+    urls?: ILiveUrls;
+    /**
+     * 跨房间连麦响应数据
+     */
+    otherRoomsRes?: {
+        [roomId: string]: ILiveUrls;
+    };
+    /**
+     * 直播 mcu 资源
+     * 主播发布为具体资源，会议模式为空数组
+     */
+    mcuPublishList?: IResource[];
+    /**
+     * 订阅成功的资源
+     */
+    subscribedList?: {
+        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
+        msid: string;
+        userId: string;
+        simulcast?: RCStreamType;
+    }[];
+}
+export interface ICallEngine3 {
+    engineType: 3;
+    vendorKey: string;
+    signKey: string;
+    blinkSnifferServer: string;
+    blinkCMPServer: string;
+}
+export interface ICallEngine4 {
+    engineType: 4;
+    /**
+     * 房间所有人发布的最大流数量总上限，当前未启用
+     */
+    maxStreamCount?: number;
+    mediaServer: string;
+    backupMediaServer?: string[];
+    /**
+     * 到 mediaServer 的请求超时时限，默认 10，有效值 10 - 30。单位：秒
+     */
+    timeOut?: number;
+}
+export interface IBroadcastSubReqBody {
+    /**
+     * 客户端 offer
+     */
+    sdp: {
+        type: 'offer';
+        sdp: string;
+    };
+    /**
+     * 直播信息
+     */
+    liveUrl?: string;
+    /**
+     * 订阅的资源类型，默认为 `RCMediaType.AUDIO_VIDEO`
+     */
+    mediaType?: RCMediaType;
+    /**
+     * 订阅大/小流，默认订阅大流
+     */
+    simulcast?: RCStreamType;
+    /**
+     * 允许 server 根据网络状况动态切换大小流，默认为 false
+     */
+    switchstream: boolean;
+    /**
+     * 订阅列表
+     */
+    subscribeList?: {
+        /**
+         * 流资源 uri
+         */
+        uri: string;
+        /**
+         * 大小流订阅，`1` 为大流，`2` 为小流，默认使用大流
+         */
+        simulcast: RCStreamType;
+        /**
+         * 分辨率信息
+         */
+        resolution: string;
+    }[];
+    /**
+     * 是否采用新版本模式，加入房间
+     */
+    newVersionFlag?: boolean;
+}
+export interface IBroadcastSubRespBody extends IRTCResponse {
+    /**
+     * 已订阅的资源列表
+     */
+    subscribedList: IResource[];
+    /**
+     * 远端 SDP
+     */
+    sdp: {
+        type: 'answer';
+        sdp: string;
+    };
+}
+/**
+ * 获取 CDN 资源拉流地址请求 headers
+ */
+export interface ICDNPlayUrlReqHeaders extends IMCUReqHeaders {
+}
+/**
+ * 获取 CDN 拉流地址的请求参数
+ */
+export interface ICDNPlayUrlReq {
+    w?: number;
+    h?: number;
+    fps?: number;
+}
+/**
+ * 获取 CDN 资源拉流地址响应
+ */
+export interface ICDNPlayUrlResponse extends IRTCResponse {
+    data: {
+        fps: number;
+        h: number;
+        'pull_url': string;
+        w: number;
+    };
+}
+/**
+ * cdn_uris 里面包含的字段
+ */
+export interface ICDNUris {
+    /**
+     * 是否扩散
+     */
+    broadcast: RCInnerCDNBroadcast;
+    /**
+     * 拉流资源的宽度
+     */
+    w?: number;
+    /**
+     * 拉流资源的高度
+     */
+    h?: number;
+    /**
+    * 帧率
+    */
+    fps?: number;
+    /**
+     * 获取拉流地址的 url
+     */
+    url: string;
+    /**
+     * 开启、停用 CDN
+     */
+    enableInnerCDN?: boolean;
+    /**
+     * 推送模式，手动 or 自动
+     */
+    'push_mode': RCInnerCDNPushMode;
+    'pull_safe': boolean;
+}
+//# sourceMappingURL=interface.d.ts.map