@rongcloud/plugin-rtc 5.4.2 → 5.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/dist/async-task-queue.d.ts +9 -0
  2. package/dist/core/Invoker.d.ts +46 -0
  3. package/dist/core/PolarisReporter.d.ts +35 -0
  4. package/dist/core/RCAudienceClient.d.ts +89 -0
  5. package/dist/core/RCMediaStreamCapture.d.ts +124 -0
  6. package/dist/core/RCRTCClient.d.ts +126 -0
  7. package/dist/core/Store.d.ts +80 -0
  8. package/dist/core/command/BaseCommand.d.ts +22 -0
  9. package/dist/core/command/EnabelInnerCDNCommand.d.ts +16 -0
  10. package/dist/core/command/ExchangeCommand.d.ts +18 -0
  11. package/dist/core/command/ExchangeWithPushOtherRoomCommand.d.ts +22 -0
  12. package/dist/core/command/JoinRoomCommand.d.ts +26 -0
  13. package/dist/core/command/LeaveOtherRoomCommand.d.ts +30 -0
  14. package/dist/core/command/LocalTrackMuteCommand.d.ts +10 -0
  15. package/dist/core/command/MCUConfigFlushCommand.d.ts +18 -0
  16. package/dist/core/command/OnRemoteUserUnpubCommand.d.ts +13 -0
  17. package/dist/core/command/OnSignalReconnectedCommand.d.ts +38 -0
  18. package/dist/core/command/ParseRemoteResCommand.d.ts +38 -0
  19. package/dist/core/command/ParseUserStateCommand.d.ts +57 -0
  20. package/dist/core/command/PubCommand.d.ts +34 -0
  21. package/dist/core/command/RTCIdentityChangeCommand.d.ts +17 -0
  22. package/dist/core/command/RetryExchangeCommand.d.ts +18 -0
  23. package/dist/core/command/SubCommand.d.ts +21 -0
  24. package/dist/core/command/UnpubCommand.d.ts +20 -0
  25. package/dist/core/command/UnpubPrevCommand.d.ts +6 -0
  26. package/dist/core/command/UnsubCommand.d.ts +20 -0
  27. package/dist/core/command/UpdateSubListCommand.d.ts +28 -0
  28. package/dist/core/command/helper.d.ts +20 -0
  29. package/dist/core/constants.d.ts +2 -0
  30. package/dist/core/enums/BackgroundPictureFillMode.d.ts +14 -0
  31. package/dist/core/enums/MixLayoutMode.d.ts +18 -0
  32. package/dist/core/enums/MixVideoRenderMode.d.ts +14 -0
  33. package/dist/core/enums/RCBitrate.d.ts +48 -0
  34. package/dist/core/enums/RCFrameRate.d.ts +7 -0
  35. package/dist/core/enums/RCInnerCDNBroadcast.d.ts +5 -0
  36. package/dist/core/enums/RCInnerCDNModel.d.ts +5 -0
  37. package/dist/core/enums/RCInnerCDNPullIsHttps.d.ts +5 -0
  38. package/dist/core/enums/RCInnerCDNPullKind.d.ts +6 -0
  39. package/dist/core/enums/RCInnerCDNPushMode.d.ts +5 -0
  40. package/dist/core/enums/RCKickType.d.ts +11 -0
  41. package/dist/core/enums/RCLivingType.d.ts +14 -0
  42. package/dist/core/enums/RCLoggerTag.d.ts +629 -0
  43. package/dist/core/enums/RCMediaType.d.ts +18 -0
  44. package/dist/core/enums/RCMixInputFilterMode.d.ts +35 -0
  45. package/dist/core/enums/RCRTCCode.d.ts +86 -0
  46. package/dist/core/enums/RCRTCLiveRole.d.ts +14 -0
  47. package/dist/core/enums/RCRTCPingResult.d.ts +5 -0
  48. package/dist/core/enums/RCRTCResolution.d.ts +102 -0
  49. package/dist/core/enums/RCResolution.d.ts +16 -0
  50. package/dist/core/enums/inner/PolarisRole.d.ts +14 -0
  51. package/dist/core/enums/inner/R2Action.d.ts +14 -0
  52. package/dist/core/enums/inner/R2Status.d.ts +11 -0
  53. package/dist/core/enums/inner/RCRTCMessageType.d.ts +66 -0
  54. package/dist/core/enums/inner/RCStreamType.d.ts +14 -0
  55. package/dist/core/enums/inner/TrackState.d.ts +14 -0
  56. package/dist/core/interfaces.d.ts +912 -0
  57. package/dist/core/room/Pinger.d.ts +35 -0
  58. package/dist/core/room/RCAbstractRoom.d.ts +327 -0
  59. package/dist/core/room/RCAudienceLivingRoom.d.ts +321 -0
  60. package/dist/core/room/RCAudioLevelReport.d.ts +16 -0
  61. package/dist/core/room/RCLivingPKHandler.d.ts +164 -0
  62. package/dist/core/room/RCLivingRoom.d.ts +108 -0
  63. package/dist/core/room/RCLocalMediaStream.d.ts +8 -0
  64. package/dist/core/room/RCMCUConfigBuilder.d.ts +211 -0
  65. package/dist/core/room/RCRTCRoom.d.ts +15 -0
  66. package/dist/core/service/RCMediaService.d.ts +96 -0
  67. package/dist/core/service/helper.d.ts +8 -0
  68. package/dist/core/service/index.d.ts +6 -0
  69. package/dist/core/service/interface.d.ts +323 -0
  70. package/dist/core/service/mcu-interface.d.ts +293 -0
  71. package/dist/core/tracks/RCLocalTrack.d.ts +121 -0
  72. package/dist/core/tracks/RCRemoteTrack.d.ts +23 -0
  73. package/dist/core/tracks/RCTrack.d.ts +91 -0
  74. package/dist/core/webrtc/RCRTCPeerCManager.d.ts +159 -0
  75. package/dist/core/webrtc/RCRTCPeerConnection.d.ts +110 -0
  76. package/dist/core/webrtc/helper.d.ts +26 -0
  77. package/dist/core/webrtc/sdp/ASdpBuilder.d.ts +98 -0
  78. package/dist/core/webrtc/sdp/ASdpStrategy.d.ts +48 -0
  79. package/dist/core/webrtc/sdp/PlanBSdpBuilder.d.ts +20 -0
  80. package/dist/core/webrtc/sdp/PlanBStrategy.d.ts +26 -0
  81. package/dist/core/webrtc/sdp/UnifiedPlanSdpBuilder.d.ts +11 -0
  82. package/dist/core/webrtc/sdp/UnifiedPlanStrategy.d.ts +21 -0
  83. package/dist/core/webrtc/stat-parser/AbstractStatParser.d.ts +117 -0
  84. package/dist/core/webrtc/stat-parser/ChromeStatParser.d.ts +14 -0
  85. package/dist/core/webrtc/stat-parser/FirefoxStatParser.d.ts +14 -0
  86. package/dist/core/webrtc/stat-parser/IStatParser.d.ts +24 -0
  87. package/dist/core/webrtc/stat-parser/SafariStatParser.d.ts +14 -0
  88. package/dist/device.d.ts +6 -0
  89. package/dist/helper.d.ts +189 -0
  90. package/dist/index.d.ts +193 -155
  91. package/dist/index.esm.js +2 -2
  92. package/dist/index.js +1 -1
  93. package/dist/index.umd.js +1 -1
  94. package/dist/logger.d.ts +4 -0
  95. package/package.json +3 -3
@@ -0,0 +1,86 @@
1
+ /**
2
+ * 错误码,与移动端对齐
3
+ * @description
4
+ * 1. `51000 - 51999` 为 Android 专用段
5
+ * 2. `52000 - 52999` 为 iOS 专用段
6
+ * 3. `53000 - 53199` 为 Web RTC 专用段
7
+ * 4. `53200 - 53499` 为 Web Call 专用段
8
+ * 5. `53500 - 53999` 为 Web 保留段
9
+ */
10
+ export declare enum RCRTCCode {
11
+ /** 成功 */
12
+ SUCCESS = 10000,
13
+ /** IM 服务未连接 */
14
+ SIGNAL_DISCONNECTED = 50000,
15
+ /** 参数错误 */
16
+ PARAMS_ERROR = 50001,
17
+ /** 加入房间错误,重复加入 RTC 房间内 */
18
+ REPERT_JOIN_ROOM = 50002,
19
+ /** 当前不在房间内 */
20
+ NOT_IN_ROOM = 50003,
21
+ /** MediaServer 未开启 */
22
+ SERVICE_INVALID = 50004,
23
+ /** RTC Token 无效 */
24
+ RTC_TOKEN_INVALID = 50006,
25
+ /** 底层信令调用错误 */
26
+ SIGNAL_ERROR = 53001,
27
+ /** 创建 Offer 失败 */
28
+ CREATE_OFFER_FAILED = 53003,
29
+ /** 网络请求失败 */
30
+ REQUEST_FAILED = 53004,
31
+ /** MCU 地址不可为空 */
32
+ MCU_SERVER_NOT_FOUND = 53005,
33
+ /** 直播订阅失败,当前存在已订阅资源 */
34
+ BROADCAST_SUB_LIST_NOT_EMPTY = 53007,
35
+ /** 房间已被销毁,需重新加入房间获取 Room 实例 */
36
+ ROOM_HAS_BEEN_DESTROYED = 53008,
37
+ /** 没有可用的音视频服务器地址 */
38
+ NOT_OPEN_VIDEO_AUDIO_SERVER = 53009,
39
+ /** 获取用户媒体资源流失败 */
40
+ GET_USER_MEDIA_FAILED = 53010,
41
+ /** 获取屏幕共享流失败 */
42
+ GET_DISPLAY_MEDIA_FAILED = 53011,
43
+ /** 权限问题导致获取媒体流被拒绝 */
44
+ PERMISSION_DENIED = 53012,
45
+ /** 创建自定义流失败 */
46
+ CREATE_CUSTOM_TRACK_FAILED = 53013,
47
+ /** 无效的 TAG 定义 */
48
+ INVALID_TAGS = 53014,
49
+ /** IM 连接无效,无法识别当前登录的用户身份 */
50
+ INVALID_USER_ID = 53015,
51
+ /** 创建文件流失败 */
52
+ CREATE_FILE_TRACK_FAILED = 53016,
53
+ /** 无效的 File 实例 */
54
+ INVALID_FILE_INSTANCE = 53017,
55
+ /** setRemoteDescription failed */
56
+ SET_REMOTE_DESCRIPTION_FAILED = 53018,
57
+ /** 浏览器不支持此方法 */
58
+ BROWSER_NOT_SUPPORT = 53019,
59
+ /** 媒体流无法播放,可能是远端流未订阅或本地流已销毁 */
60
+ TRACK_NOT_READY = 53020,
61
+ /** 视频流播放需时需传参 HTMLVideoElement 作为显示组件 */
62
+ VIDEO_TRACK_MISS_MEDIA_ELEMENT = 53021,
63
+ /** 媒体流播放失败 */
64
+ TRACK_PLAY_ERROR = 53022,
65
+ /** 观众加入直播房间信令错误 */
66
+ SIGNAL_AUDIENCE_JOIN_ROOM_FAILED = 53023,
67
+ /** 直播房间切换身份错误 */
68
+ SIGNAL_ROOM_CHANGE_IDENTITY_FAILED = 53024,
69
+ /** 公有云 SDK 包不允许使用私有云环境 */
70
+ PACKAGE_ENVIRONMENT_ERROR = 53025,
71
+ /** 单个用户发布资源超过限制 ( MediaServer 限制最多 10 个 track ) */
72
+ PUBLISH_TRACK_LIMIT_EXCEEDED = 53026,
73
+ /** 房间内无主播推 CDN */
74
+ CDN_RESOURCE_IS_EMPTY = 53027,
75
+ /** 加入 RTC 房间 joinTYype 为 1 时,当前有其他端在房间时的应答码 */
76
+ SIGNAL_JOIN_RTC_ROOM_REFUSED = 53028,
77
+ /** 设置音频输出设备时,无权限使用请求的设备 */
78
+ NO_PERMISSION_TO_USE_REQUESTED_DEVICE = 53029,
79
+ /** 方法在 PK 房间上不可用 */
80
+ THE_FUNCTION_IS_DISABLED_IN_PKROOM = 53030,
81
+ /** 资源没有全部发成功 */
82
+ SOME_TRACKS_PUBLISH_FAILED = 53031,
83
+ /** electron 中 mac 系统暂不支持屏幕共享采集声音 */
84
+ MAC_IN_ELECTRON_NOT_SUPPORT_SCREEN_SHARE_WITH_AUDIO = 53032
85
+ }
86
+ //# sourceMappingURL=RCRTCCode.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 直播角色
3
+ */
4
+ export declare enum RCRTCLiveRole {
5
+ /**
6
+ * 主播
7
+ */
8
+ ANCHOR = 1,
9
+ /**
10
+ * 观众
11
+ */
12
+ AUDIENCE = 2
13
+ }
14
+ //# sourceMappingURL=RCRTCLiveRole.d.ts.map
@@ -0,0 +1,5 @@
1
+ export declare enum RCRTCPingResult {
2
+ SUCCESS = "Success",
3
+ FAIL = "Fail"
4
+ }
5
+ //# sourceMappingURL=RCRTCPingResult.d.ts.map
@@ -0,0 +1,102 @@
1
+ declare type BitrateConf = {
2
+ width: number;
3
+ height: number;
4
+ maxBitrate: number;
5
+ minBitrate: number;
6
+ };
7
+ export declare const RongRTCVideoBitrate: {
8
+ W176_H132: {
9
+ width: number;
10
+ height: number;
11
+ maxBitrate: number;
12
+ minBitrate: number;
13
+ };
14
+ W176_H144: {
15
+ width: number;
16
+ height: number;
17
+ maxBitrate: number;
18
+ minBitrate: number;
19
+ };
20
+ W256_H144: {
21
+ width: number;
22
+ height: number;
23
+ maxBitrate: number;
24
+ minBitrate: number;
25
+ };
26
+ W320_H180: {
27
+ width: number;
28
+ height: number;
29
+ maxBitrate: number;
30
+ minBitrate: number;
31
+ };
32
+ W240_H240: {
33
+ width: number;
34
+ height: number;
35
+ maxBitrate: number;
36
+ minBitrate: number;
37
+ };
38
+ W320_H240: {
39
+ width: number;
40
+ height: number;
41
+ maxBitrate: number;
42
+ minBitrate: number;
43
+ };
44
+ W480_H360: {
45
+ width: number;
46
+ height: number;
47
+ maxBitrate: number;
48
+ minBitrate: number;
49
+ };
50
+ W640_H360: {
51
+ width: number;
52
+ height: number;
53
+ maxBitrate: number;
54
+ minBitrate: number;
55
+ };
56
+ W480_H480: {
57
+ width: number;
58
+ height: number;
59
+ maxBitrate: number;
60
+ minBitrate: number;
61
+ };
62
+ W640_H480: {
63
+ width: number;
64
+ height: number;
65
+ maxBitrate: number;
66
+ minBitrate: number;
67
+ };
68
+ W720_H480: {
69
+ width: number;
70
+ height: number;
71
+ maxBitrate: number;
72
+ minBitrate: number;
73
+ };
74
+ W1280_H720: {
75
+ width: number;
76
+ height: number;
77
+ maxBitrate: number;
78
+ minBitrate: number;
79
+ };
80
+ W1920_H1080: {
81
+ width: number;
82
+ height: number;
83
+ maxBitrate: number;
84
+ minBitrate: number;
85
+ };
86
+ };
87
+ /**
88
+ * 向上取最接近的视频分辨率配置
89
+ * @param {number} width
90
+ * @param {number} height
91
+ */
92
+ export declare const getNearestResolution: (width: number, height: number) => BitrateConf;
93
+ export declare const Multiplier: {
94
+ [key: number]: number;
95
+ };
96
+ /**
97
+ * 根据帧率获取码率倍数
98
+ * @param frameRate
99
+ */
100
+ export declare const getBitrateMultiple: (frameRate: number) => number;
101
+ export {};
102
+ //# sourceMappingURL=RCRTCResolution.d.ts.map
@@ -0,0 +1,16 @@
1
+ export declare enum RCResolution {
2
+ W176_H132 = "W176_H132",
3
+ W176_H144 = "W176_H144",
4
+ W256_H144 = "W256_H144",
5
+ W320_H180 = "W320_H180",
6
+ W240_H240 = "W240_H240",
7
+ W320_H240 = "W320_H240",
8
+ W480_H360 = "W480_H360",
9
+ W640_H360 = "W640_H360",
10
+ W480_H480 = "W480_H480",
11
+ W640_H480 = "W640_H480",
12
+ W720_H480 = "W720_H480",
13
+ W1280_H720 = "W1280_H720",
14
+ W1920_H1080 = "W1920_H1080"
15
+ }
16
+ //# sourceMappingURL=RCResolution.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 北极星上报角色
3
+ */
4
+ export declare enum PolarisRole {
5
+ /**
6
+ * 会议参会者、主播
7
+ */
8
+ MeetingOrAnchor = 1,
9
+ /**
10
+ * 观众
11
+ */
12
+ Audience = 2
13
+ }
14
+ //# sourceMappingURL=PolarisRole.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 北极星上报 R2 参数
3
+ */
4
+ export declare enum R2Action {
5
+ /**
6
+ * 发布
7
+ */
8
+ PUBLISH = "publish",
9
+ /**
10
+ * 订阅
11
+ */
12
+ SUBSCRIBE = "subscribe"
13
+ }
14
+ //# sourceMappingURL=R2Action.d.ts.map
@@ -0,0 +1,11 @@
1
+ export declare enum R2Status {
2
+ /**
3
+ * 开始
4
+ */
5
+ BEGIN = "begin",
6
+ /**
7
+ * 结束
8
+ */
9
+ END = "end"
10
+ }
11
+ //# sourceMappingURL=R2Status.d.ts.map
@@ -0,0 +1,66 @@
1
+ /**
2
+ * RTC 消息类型常量
3
+ * @private
4
+ */
5
+ export declare enum RCRTCMessageType {
6
+ /**
7
+ * 增量资源发布消息
8
+ * @deprecated
9
+ */
10
+ PUBLISH = "RCRTC:PublishResource",
11
+ /**
12
+ * 增量资源取消发布消息
13
+ * @deprecated
14
+ */
15
+ UNPUBLISH = "RCRTC:UnpublishResource",
16
+ /**
17
+ * 增量资源状态变更消息
18
+ * @deprecated
19
+ */
20
+ MODIFY = "RCRTC:ModifyResource",
21
+ /**
22
+ * 全量资源变更消息
23
+ */
24
+ TOTAL_CONTENT_RESOURCE = "RCRTC:TotalContentResources",
25
+ /**
26
+ * 房间人员变更
27
+ */
28
+ STATE = "RCRTC:state",
29
+ /**
30
+ * 房间属性变更
31
+ */
32
+ ROOM_NOTIFY = "RCRTC:RoomNtf",
33
+ /**
34
+ * 房间用户属性变更
35
+ */
36
+ USER_NOTIFY = "RCRTC:UserNtf",
37
+ /**
38
+ * 被服务踢出房间
39
+ */
40
+ KICK = "RCRTC:kick",
41
+ /**
42
+ * 跨房间连麦 PK 请求消息
43
+ */
44
+ PK_INVITE = "RCRTC:invite",
45
+ /**
46
+ * 连麦请求超时
47
+ */
48
+ PK_INVITE_TIMEOUT = "RCRTC:inviteTimeout",
49
+ /**
50
+ * 跨房间连麦 PK 取消请求消息
51
+ */
52
+ PK_CANCEL_INVITE = "RCRTC:cancelInvite",
53
+ /**
54
+ * 跨房间连麦 PK 请求响应消息
55
+ */
56
+ PK_INVITE_ANSWER = "RCRTC:answerInvite",
57
+ /**
58
+ * 结束跨房间连麦 PK 消息
59
+ */
60
+ PK_END = "RCRTC:endInvite",
61
+ /**
62
+ * 连麦的房间不再了或离线了,主直播房间会收到的消息通知
63
+ */
64
+ OTHER_ROOM_OFFLINE = "RCRTC:otherRoomOffline"
65
+ }
66
+ //# sourceMappingURL=RCRTCMessageType.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 资源大小流标识枚举
3
+ */
4
+ export declare enum RCStreamType {
5
+ /**
6
+ * 普通流(大流)
7
+ */
8
+ NORMAL = 1,
9
+ /**
10
+ * 小流
11
+ */
12
+ TINY = 2
13
+ }
14
+ //# sourceMappingURL=RCStreamType.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 流状态
3
+ */
4
+ export declare enum TrackState {
5
+ /**
6
+ * 不可用
7
+ */
8
+ DISABLE = 0,
9
+ /**
10
+ * 可用
11
+ */
12
+ ENABLE = 1
13
+ }
14
+ //# sourceMappingURL=TrackState.d.ts.map