@rongcloud/plugin-rtc 5.4.2 → 5.4.3

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

@@ -0,0 +1,323 @@
+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/sdp/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;
+    /**
+     * peerConnection Id
+     */
+    'Peer-Connection-Id'?: string;
+    /**
+     * client-session-id 标识一个端用户进入房间后的唯一标识
+     */
+    'Client-Session-Id'?: string;
+}
+export interface IMCUReqHeaders {
+    'App-Key': string;
+    Token: string;
+    RoomId: string;
+    UserId: string;
+    SessionId: string;
+}
+/**
+ * exchange 接口中 pushOtherRooms 字段接口
+ */
+export interface IPushOtherRooms {
+    /**
+     * 房间 Id
+     */
+    roomId: string;
+    /**
+    * 是否默认合流
+    */
+    autoMix: boolean;
+    /**
+    * 房间 Id 对应的 SessionId
+    */
+    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?: IPushOtherRooms[];
+    /**
+     * 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

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

@@ -0,0 +1,293 @@
+import { MixLayoutMode } from '../enums/MixLayoutMode';
+import { MixVideoRenderMode } from '../enums/MixVideoRenderMode';
+import { RCInnerCDNModel } from '../enums/RCInnerCDNModel';
+import { RCMixInputFilterMode } from '../enums/RCMixInputFilterMode';
+/**
+ * 合流后的 video 输出编码配置，包含分辨率、帧率、码率配置项
+ */
+export interface IMCUOutputVideoAttrs {
+    /**
+     * 视频分辨率宽度
+     */
+    width?: number;
+    /**
+     * 视频分辨率高度
+     */
+    height?: number;
+    /**
+     * 帧率
+     */
+    fps?: number;
+    /**
+     * 码率
+     */
+    bitrate?: number;
+}
+/**
+ * 合并入 MCU 的音频流
+ */
+export interface IMCUInputAudio {
+    user_id: string;
+    stream_id: string;
+}
+/**
+ * 自定义布局中的单一视频流布局
+ */
+export interface IMCUInputVideoLayout {
+    user_id: string;
+    stream_id: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * 图片配置，用于水印、视频流背景图
+ */
+export interface IPictureAttrs {
+    /**
+     * 资源下载地址，需包含协议
+     */
+    uri: string;
+    /**
+     * 相对于整体画布的起始位置 x 坐标
+     */
+    x: number;
+    /**
+     * 相对于整体画布的起始位置 y 坐标
+     */
+    y: number;
+    /**
+     * 相对于整体画布的宽（百分比），有效值 `0.0` - `1.0`
+     */
+    w: number;
+    /**
+     * 相对于整体画布的高（百分比），有效值 `0.0` - `1.0`
+     */
+    h: number;
+}
+/**
+ * 合流后的 Video 输出配置，包含背景图、背景色、大小流编码等配置项
+ */
+export interface IMCUOutputVideoConfig {
+    /**
+     * 标准流输出定义
+     */
+    normal?: IMCUOutputVideoAttrs;
+    /**
+     * 小流输出定义
+     */
+    tiny?: IMCUOutputVideoAttrs;
+    exparams?: {
+        /**
+         * 合流布局时，对视频流的填充方式
+         */
+        renderMode: MixVideoRenderMode;
+    };
+    /**
+     * 背景色，如 `'0xf1a2c3'`
+     */
+    backgroundColor?: string;
+    /**
+     * 背景图
+     */
+    backgroundPicture?: {
+        /**
+         * 填充模式：
+         * 1. 按比例裁剪
+         * 2. 不裁剪，按比例压缩
+         */
+        fillMode: 1 | 2;
+        /**
+         * 资源列表
+         */
+        picture: IPictureAttrs[];
+    };
+}
+/**
+ * 合流后的媒体输出定义
+ */
+export interface IMCUOutputConfig {
+    /**
+     * 输出视频配置
+     */
+    video: IMCUOutputVideoConfig;
+    /**
+     * 输出音频配置
+     */
+    audio?: {
+        /**
+         * 音频码率
+         */
+        bitrate: number;
+    };
+    /**
+     * CDN 推流地址列表
+     */
+    cdn?: {
+        /**
+         * 推流地址，如：`'rtmp://xxxx'`
+         */
+        pushurl: string;
+    }[];
+}
+/**
+ * 时间戳参数，用于水印
+ */
+export 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;
+}
+/**
+ * 文本参数，用于水印
+ */
+export 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;
+}
+/**
+ * 屏幕水印配置
+ */
+export interface IWaterMarkConfig {
+    /**
+     * 时间戳水印配置
+     */
+    timestamp?: ITimestampAttrs;
+    /**
+     * 图片水印配置
+     */
+    picture?: IPictureAttrs[];
+    /**
+     * 文字水印配置
+     */
+    text: ITextAttrs[];
+}
+/**
+ * 合流前的单一视频流水印配置
+ *【客户端仅提供图片水印设置】
+ */
+export interface IMCUSignalScreenWaterMarkConfig {
+    /**
+     * 媒体流的 msid
+     */
+    streamId: string;
+    picture: IPictureAttrs[];
+}
+export interface IMCUWaterMarkConfig {
+    enable: 'on' | 'off';
+    /**
+     * 合流后的屏幕水印配置
+     *【客户端暂不提供合流水印设置】
+     */
+    /**
+     * 合流前的单人视频流水印配置
+     */
+    singleScreen: IMCUSignalScreenWaterMarkConfig[];
+}
+/**
+ * 发布到服务器的 MCU 配置数据
+ */
+export interface IMCUConfig {
+    /**
+     * 为向后兼容，当前为常量 1
+     */
+    version: 2;
+    /**
+     * 布局模式，在只配置推流 CDN 时，该值不存在
+     */
+    mode: MixLayoutMode;
+    /**
+     * 渲染到主位置上的流 Id，当该值为空时，输出到主位置的流按发布时间顺序优先选择最早发布的流
+     */
+    host_stream_id?: string;
+    /**
+     * 自定义布局输入定义，只有在 mode 值为 `MixLayoutMode.CUSTOMIZE` 时需传值
+     */
+    input?: {
+        video?: IMCUInputVideoLayout[];
+        audio?: IMCUInputAudio[];
+    };
+    /**
+     * 合流后的媒体输出配置
+     */
+    output?: IMCUOutputConfig;
+    /**
+     * 水印配置
+     */
+    waterMark?: IMCUWaterMarkConfig;
+    /**
+     * MCU 拉流配置，决定 MCU 从 MediaServer 拉流的方式
+     */
+    inputFilterMode?: RCMixInputFilterMode;
+    /**
+     * MCU 混入列表中房间内的资源
+     */
+    mixRooms?: string[];
+}
+/**
+ * 设置开启、停用内置 CDN 数据
+ */
+export interface ISetEnableCDN {
+    version: 2;
+    output: {
+        /**
+         * 手动开启/停用内置 CDN
+         */
+        inCDNModel: RCInnerCDNModel;
+    };
+}
+/**
+ * 业务层传入的 input video 数据
+ */
+export interface ICustomInputVideo {
+    trackId: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+//# sourceMappingURL=mcu-interface.d.ts.map