@rongcloud/plugin-rtc 5.5.4-alpha.2 → 5.5.4

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

@@ -0,0 +1,93 @@
+/**
+ * 错误码，与移动端对齐
+ * @description
+ * 1. `51000 - 51999` 为 Android 专用段
+ * 2. `52000 - 52999` 为 iOS 专用段
+ * 3. `53000 - 53199` 为 Web RTC 专用段
+ * 4. `53200 - 53499` 为 Web Call 专用段
+ * 5. `53500 - 53999` 为 Web 保留段
+ * 6. 1004 jwt token 过期
+ */
+export declare enum RCRTCCode {
+    /** 成功 */
+    SUCCESS = 10000,
+    /** IM 服务未连接 */
+    SIGNAL_DISCONNECTED = 50000,
+    /** 参数错误 */
+    PARAMS_ERROR = 50001,
+    /** 加入房间错误，重复加入 RTC 房间内 */
+    REPERT_JOIN_ROOM = 50002,
+    /** 当前不在房间内 */
+    NOT_IN_ROOM = 50003,
+    /** MediaServer 未开启 */
+    SERVICE_INVALID = 50004,
+    /** RTC Token 无效 */
+    RTC_TOKEN_INVALID = 50006,
+    /** 底层信令调用错误 */
+    SIGNAL_ERROR = 53001,
+    /** 创建 Offer 失败 */
+    CREATE_OFFER_FAILED = 53003,
+    /** 网络请求失败 */
+    REQUEST_FAILED = 53004,
+    /** MCU 地址不可为空 */
+    MCU_SERVER_NOT_FOUND = 53005,
+    /** 直播订阅失败，当前存在已订阅资源 */
+    BROADCAST_SUB_LIST_NOT_EMPTY = 53007,
+    /** 房间已被销毁，需重新加入房间获取 Room 实例 */
+    ROOM_HAS_BEEN_DESTROYED = 53008,
+    /** 没有可用的音视频服务器地址 */
+    NOT_OPEN_VIDEO_AUDIO_SERVER = 53009,
+    /** 获取用户媒体资源流失败 */
+    GET_USER_MEDIA_FAILED = 53010,
+    /** 获取屏幕共享流失败 */
+    GET_DISPLAY_MEDIA_FAILED = 53011,
+    /** 权限问题导致获取媒体流被拒绝 */
+    BROWSER_PERMISSION_DENIED = 53012,
+    /** 创建自定义流失败 */
+    CREATE_CUSTOM_TRACK_FAILED = 53013,
+    /** 无效的 TAG 定义 */
+    INVALID_TAGS = 53014,
+    /** IM 连接无效，无法识别当前登录的用户身份 */
+    INVALID_USER_ID = 53015,
+    /** 创建文件流失败 */
+    CREATE_FILE_TRACK_FAILED = 53016,
+    /** 无效的 File 实例 */
+    INVALID_FILE_INSTANCE = 53017,
+    /** setRemoteDescription failed */
+    SET_REMOTE_DESCRIPTION_FAILED = 53018,
+    /** 浏览器不支持此方法 */
+    BROWSER_NOT_SUPPORT = 53019,
+    /** 媒体流无法播放，可能是远端流未订阅或本地流已销毁 */
+    TRACK_NOT_READY = 53020,
+    /** 视频流播放需时需传参 HTMLVideoElement 作为显示组件 */
+    VIDEO_TRACK_MISS_MEDIA_ELEMENT = 53021,
+    /** 媒体流播放失败 */
+    TRACK_PLAY_ERROR = 53022,
+    /** 观众加入直播房间信令错误 */
+    SIGNAL_AUDIENCE_JOIN_ROOM_FAILED = 53023,
+    /** 直播房间切换身份错误 */
+    SIGNAL_ROOM_CHANGE_IDENTITY_FAILED = 53024,
+    /** 公有云 SDK 包不允许使用私有云环境 */
+    PACKAGE_ENVIRONMENT_ERROR = 53025,
+    /** 单个用户发布资源超过限制 （ MediaServer 限制最多 10 个 track ） */
+    PUBLISH_TRACK_LIMIT_EXCEEDED = 53026,
+    /** 房间内无主播推 CDN */
+    CDN_RESOURCE_IS_EMPTY = 53027,
+    /** 加入 RTC 房间 joinTYype 为 1 时，当前有其他端在房间时的应答码 */
+    SIGNAL_JOIN_RTC_ROOM_REFUSED = 53028,
+    /** 设置音频输出设备时，无权限使用请求的设备 */
+    NO_PERMISSION_TO_USE_REQUESTED_DEVICE = 53029,
+    /** 方法在 PK 房间上不可用 */
+    THE_FUNCTION_IS_DISABLED_IN_PKROOM = 53030,
+    /** 资源没有全部发成功 */
+    SOME_TRACKS_PUBLISH_FAILED = 53031,
+    /** electron 中 mac 系统暂不支持屏幕共享采集声音 */
+    MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO = 53032,
+    /** JWT token 解析超时，需要刷新 navi 重新获取 */
+    JWT_TIME_OUT = 1004,
+    /** 获取媒体资源时，无系统权限 */
+    SYSTEM_PERMISSION_DENIED = 53033,
+    /** 发布时无有效资源，如 track 已被销毁 */
+    PUBLISH_TRACKS_IS_INVALID = 53034
+}
+//# sourceMappingURL=RCRTCCode.d.ts.map

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

@@ -0,0 +1,14 @@
+/**
+ * 直播角色
+ */
+export declare enum RCRTCLiveRole {
+    /**
+     * 主播
+     */
+    ANCHOR = 1,
+    /**
+     * 观众
+     */
+    AUDIENCE = 2
+}
+//# sourceMappingURL=RCRTCLiveRole.d.ts.map

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

@@ -0,0 +1,5 @@
+export declare enum RCRTCPingResult {
+    SUCCESS = "Success",
+    FAIL = "Fail"
+}
+//# sourceMappingURL=RCRTCPingResult.d.ts.map

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

@@ -0,0 +1,132 @@
+declare type BitrateConf = {
+    width: number;
+    height: number;
+    maxBitrate: number;
+    minBitrate: number;
+};
+export declare const RongRTCVideoBitrate: {
+    W176_H132: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W176_H144: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W180_H180: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W240_H180: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W240_H240: {
+        width: number;
+        height: number;
+        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;
+    };
+    W360_H360: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W480_H360: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W480_H480: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W640_H360: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W640_H480: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W720_H480: {
+        width: number;
+        height: number;
+        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;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+    W1920_H1080: {
+        width: number;
+        height: number;
+        maxBitrate: number;
+        minBitrate: number;
+    };
+};
+/**
+* 向上取最接近的视频分辨率配置
+* @param {number} width
+* @param {number} height
+*/
+export declare const getNearestResolution: (width: number, height: number) => BitrateConf;
+export declare const Multiplier: {
+    [key: number]: number;
+};
+/**
+ * 根据帧率获取码率倍数
+ * @param frameRate
+ */
+export declare const getBitrateMultiple: (frameRate: number) => number;
+export {};
+//# sourceMappingURL=RCRTCResolution.d.ts.map

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

@@ -0,0 +1,21 @@
+export declare enum RCResolution {
+    W176_H132 = "W176_H132",
+    W176_H144 = "W176_H144",
+    W180_H180 = "W180_H180",
+    W240_H180 = "W240_H180",
+    W240_H240 = "W240_H240",
+    W256_H144 = "W256_H144",
+    W320_H180 = "W320_H180",
+    W320_H240 = "W320_H240",
+    W360_H360 = "W360_H360",
+    W480_H360 = "W480_H360",
+    W480_H480 = "W480_H480",
+    W640_H360 = "W640_H360",
+    W640_H480 = "W640_H480",
+    W720_H480 = "W720_H480",
+    W848_H480 = "W848_H480",
+    W960_H720 = "W960_H720",
+    W1280_H720 = "W1280_H720",
+    W1920_H1080 = "W1920_H1080"
+}
+//# sourceMappingURL=RCResolution.d.ts.map

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

@@ -0,0 +1,18 @@
+/**
+ * RTC 房间加入类型
+ */
+export declare enum RTCJoinType {
+    /**
+     * 踢前一个设备
+     */
+    KICK = 0,
+    /**
+     * 当前加入拒绝
+     */
+    REFUSE = 1,
+    /**
+     * 两个设备共存
+     */
+    COEXIST = 2
+}
+//# sourceMappingURL=RTCJoinType.d.ts.map

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

@@ -0,0 +1,22 @@
+/**
+ * 音视频模式
+ */
+export declare enum RTCMode {
+    /**
+     * 普通音视频模式
+     */
+    RTC = 0,
+    /**
+     * 直播模式
+     */
+    LIVE = 2,
+    /**
+     * 跨应用多人房间
+     */
+    CROSS_MUTI = 7,
+    /**
+    * 跨应用直播
+    */
+    CROSS_LIVE = 8
+}
+//# sourceMappingURL=RTCMode.d.ts.map

package/dist/core/enums/inner/LiveRole.d.ts

@@ -0,0 +1,11 @@
+export declare enum LiveRole {
+    /**
+     * 主播身份
+     */
+    ANCHOR = 1,
+    /**
+     * 观众身份
+     */
+    AUDIENCE = 2
+}
+//# sourceMappingURL=LiveRole.d.ts.map

package/dist/core/enums/inner/LiveType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 直播类型
+ */
+export declare enum LiveType {
+    /**
+     * 音视频直播
+     */
+    AUDIO_AND_VIDEO = 0,
+    /**
+     * 音频直播
+     */
+    AUDIO = 1
+}
+//# sourceMappingURL=LiveType.d.ts.map

package/dist/core/enums/inner/PolarisRole.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 北极星上报角色
+ */
+export declare enum PolarisRole {
+    /**
+     * 会议参会者、主播
+     */
+    MeetingOrAnchor = 1,
+    /**
+     * 观众
+     */
+    Audience = 2
+}
+//# sourceMappingURL=PolarisRole.d.ts.map

package/dist/core/enums/inner/R2Action.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 北极星上报 R2 参数
+ */
+export declare enum R2Action {
+    /**
+     * 发布
+     */
+    PUBLISH = "publish",
+    /**
+     * 订阅
+     */
+    SUBSCRIBE = "subscribe"
+}
+//# sourceMappingURL=R2Action.d.ts.map

package/dist/core/enums/inner/R2Status.d.ts

@@ -0,0 +1,11 @@
+export declare enum R2Status {
+    /**
+     * 开始
+     */
+    BEGIN = "begin",
+    /**
+     * 结束
+     */
+    END = "end"
+}
+//# sourceMappingURL=R2Status.d.ts.map

package/dist/core/enums/inner/RCRTCMessageType.d.ts

@@ -0,0 +1,70 @@
+/**
+ * RTC 消息类型常量
+ * @private
+ */
+export declare enum RCRTCMessageType {
+    /**
+     * 增量资源发布消息
+     * @deprecated
+     */
+    PUBLISH = "RCRTC:PublishResource",
+    /**
+     * 增量资源取消发布消息
+     * @deprecated
+     */
+    UNPUBLISH = "RCRTC:UnpublishResource",
+    /**
+     * 增量资源状态变更消息
+     * @deprecated
+     */
+    MODIFY = "RCRTC:ModifyResource",
+    /**
+     * 全量资源变更消息
+     */
+    TOTAL_CONTENT_RESOURCE = "RCRTC:TotalContentResources",
+    /**
+     * 房间人员变更
+     */
+    STATE = "RCRTC:state",
+    /**
+     * 房间属性变更
+     */
+    ROOM_NOTIFY = "RCRTC:RoomNtf",
+    /**
+     * 房间用户属性变更
+     */
+    USER_NOTIFY = "RCRTC:UserNtf",
+    /**
+     * 被服务踢出房间
+     */
+    KICK = "RCRTC:kick",
+    /**
+     * 跨房间连麦 PK 请求消息
+     */
+    PK_INVITE = "RCRTC:invite",
+    /**
+     * 连麦请求超时
+     */
+    PK_INVITE_TIMEOUT = "RCRTC:inviteTimeout",
+    /**
+     * 跨房间连麦 PK 取消请求消息
+     */
+    PK_CANCEL_INVITE = "RCRTC:cancelInvite",
+    /**
+     * 跨房间连麦 PK 请求响应消息
+     */
+    PK_INVITE_ANSWER = "RCRTC:answerInvite",
+    /**
+     * 结束跨房间连麦 PK 消息
+     */
+    PK_END = "RCRTC:endInvite",
+    /**
+     * 连麦的房间不再了或离线了，主直播房间会收到的消息通知
+     */
+    OTHER_ROOM_OFFLINE = "RCRTC:otherRoomOffline",
+    /**
+     * 订阅、取消订阅动作成功
+     */
+    ROOM_TASK_FINISH = "RCRTC:roomTaskFinish"
+}
+//# sourceMappingURL=RCRTCMessageType.d.ts.map

package/dist/core/enums/inner/RCStreamType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 资源大小流标识枚举
+ */
+export declare enum RCStreamType {
+    /**
+     * 普通流（大流）
+     */
+    NORMAL = 1,
+    /**
+     * 小流
+     */
+    TINY = 2
+}
+//# sourceMappingURL=RCStreamType.d.ts.map

package/dist/core/enums/inner/RTCApiType.d.ts

@@ -0,0 +1,5 @@
+export declare enum RTCApiType {
+    ROOM = 1,
+    PERSON = 2
+}
+//# sourceMappingURL=RTCApiType.d.ts.map

package/dist/core/enums/inner/RTCIdentityChangeType.d.ts

@@ -0,0 +1,5 @@
+export declare enum RTCIdentityChangeType {
+    AnchorToViewer = 1,
+    ViewerToAnchor = 2
+}
+//# sourceMappingURL=RTCIdentityChangeType.d.ts.map

package/dist/core/enums/inner/TrackState.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 流状态
+ */
+export declare enum TrackState {
+    /**
+     * 不可用
+     */
+    DISABLE = 0,
+    /**
+     * 可用
+     */
+    ENABLE = 1
+}
+//# sourceMappingURL=TrackState.d.ts.map