tencentcloud-sdk-nodejs 4.0.397 → 4.0.400

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 (85) hide show
  1. package/CHANGELOG.md +235 -0
  2. package/SERVICE_CHANGELOG.md +180 -90
  3. package/package.json +1 -1
  4. package/products.md +10 -10
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/bma/v20210624/bma_client.ts +181 -57
  7. package/src/services/bma/v20210624/bma_models.ts +650 -20
  8. package/src/services/btoe/index.ts +2 -2
  9. package/src/services/cat/v20180409/cat_client.ts +15 -2
  10. package/src/services/cat/v20180409/cat_models.ts +222 -90
  11. package/src/services/cfw/v20190904/cfw_client.ts +1 -1
  12. package/src/services/chdfs/index.ts +2 -2
  13. package/src/services/cii/index.ts +2 -2
  14. package/src/services/eis/index.ts +2 -2
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +22 -7
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +103 -3
  17. package/src/services/iai/index.ts +2 -2
  18. package/src/services/iotvideo/index.ts +4 -4
  19. package/src/services/irp/v20220324/irp_models.ts +18 -2
  20. package/src/services/mongodb/index.ts +2 -2
  21. package/src/services/organization/index.ts +2 -2
  22. package/src/services/sms/index.ts +2 -2
  23. package/src/services/tcbr/v20220217/tcbr_models.ts +5 -0
  24. package/src/services/tem/index.ts +2 -2
  25. package/src/services/tem/v20210701/tem_client.ts +17 -2
  26. package/src/services/tem/v20210701/tem_models.ts +536 -33
  27. package/src/services/tione/index.ts +2 -2
  28. package/src/services/tke/v20180525/tke_models.ts +27 -4
  29. package/src/services/trtc/v20190722/trtc_client.ts +130 -57
  30. package/src/services/trtc/v20190722/trtc_models.ts +1532 -900
  31. package/src/services/tsw/index.ts +2 -2
  32. package/src/services/yunsou/index.ts +2 -2
  33. package/tencentcloud/common/sdk_version.d.ts +1 -1
  34. package/tencentcloud/common/sdk_version.js +1 -1
  35. package/tencentcloud/services/bma/v20210624/bma_client.d.ts +61 -21
  36. package/tencentcloud/services/bma/v20210624/bma_client.js +90 -30
  37. package/tencentcloud/services/bma/v20210624/bma_models.d.ts +533 -6
  38. package/tencentcloud/services/btoe/index.d.ts +4 -4
  39. package/tencentcloud/services/btoe/index.js +2 -2
  40. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +5 -1
  41. package/tencentcloud/services/cat/v20180409/cat_client.js +6 -0
  42. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +193 -79
  43. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +1 -1
  44. package/tencentcloud/services/cfw/v20190904/cfw_client.js +1 -1
  45. package/tencentcloud/services/chdfs/index.d.ts +4 -4
  46. package/tencentcloud/services/chdfs/index.js +2 -2
  47. package/tencentcloud/services/cii/index.d.ts +4 -4
  48. package/tencentcloud/services/cii/index.js +2 -2
  49. package/tencentcloud/services/eis/index.d.ts +4 -4
  50. package/tencentcloud/services/eis/index.js +2 -2
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +8 -3
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +10 -3
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +87 -3
  54. package/tencentcloud/services/iai/index.d.ts +4 -4
  55. package/tencentcloud/services/iai/index.js +2 -2
  56. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  57. package/tencentcloud/services/iotvideo/index.js +4 -4
  58. package/tencentcloud/services/irp/v20220324/irp_models.d.ts +17 -1
  59. package/tencentcloud/services/mongodb/index.d.ts +4 -4
  60. package/tencentcloud/services/mongodb/index.js +2 -2
  61. package/tencentcloud/services/organization/index.d.ts +4 -4
  62. package/tencentcloud/services/organization/index.js +2 -2
  63. package/tencentcloud/services/sms/index.d.ts +4 -4
  64. package/tencentcloud/services/sms/index.js +2 -2
  65. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +4 -0
  66. package/tencentcloud/services/tem/index.d.ts +4 -4
  67. package/tencentcloud/services/tem/index.js +2 -2
  68. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +5 -1
  69. package/tencentcloud/services/tem/v20210701/tem_client.js +6 -0
  70. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +448 -29
  71. package/tencentcloud/services/tione/index.d.ts +4 -4
  72. package/tencentcloud/services/tione/index.js +2 -2
  73. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +23 -4
  74. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +28 -1
  75. package/tencentcloud/services/trtc/v20190722/trtc_client.js +35 -0
  76. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1365 -828
  77. package/tencentcloud/services/tsw/index.d.ts +4 -4
  78. package/tencentcloud/services/tsw/index.js +2 -2
  79. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  80. package/tencentcloud/services/yunsou/index.js +2 -2
  81. package/test/bma.v20210624.test.js +120 -20
  82. package/test/cat.v20180409.test.js +10 -0
  83. package/test/essbasic.v20210526.test.js +12 -2
  84. package/test/tem.v20210701.test.js +10 -0
  85. package/test/trtc.v20190722.test.js +40 -0
@@ -16,140 +16,209 @@ export interface DescribeAbnormalEventResponse {
16
16
  RequestId?: string;
17
17
  }
18
18
  /**
19
- * SdkAppId级别录制时长数据。
19
+ * DescribeAbnormalEvent请求参数结构体
20
20
  */
21
- export interface SdkAppIdRecordUsage {
21
+ export interface DescribeAbnormalEventRequest {
22
22
  /**
23
- * SdkAppId的值。
23
+ * 用户SdkAppId(如:1400xxxxxx)
24
24
  */
25
25
  SdkAppId: string;
26
26
  /**
27
- * 统计的时间点数据。
27
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
28
+ 注意:支持查询14天内的数据
28
29
  */
29
- Usages: Array<RecordUsage>;
30
+ StartTime: number;
31
+ /**
32
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
33
+ */
34
+ EndTime: number;
35
+ /**
36
+ * 房间号,查询房间内任意20条以内异常体验事件
37
+ */
38
+ RoomId?: string;
30
39
  }
31
40
  /**
32
- * MCU混流输出流编码参数
41
+ * CreatePicture请求参数结构体
33
42
  */
34
- export interface EncodeParams {
43
+ export interface CreatePictureRequest {
35
44
  /**
36
- * 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
45
+ * 应用id
37
46
  */
38
- AudioSampleRate: number;
47
+ SdkAppId: number;
39
48
  /**
40
- * 混流-输出流音频码率。取值范围[8,500],单位为kbps。
49
+ * 图片内容经base64编码后的string格式
41
50
  */
42
- AudioBitrate: number;
51
+ Content: string;
43
52
  /**
44
- * 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
53
+ * 图片后缀名
45
54
  */
46
- AudioChannels: number;
55
+ Suffix: string;
47
56
  /**
48
- * 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
57
+ * 图片长度
49
58
  */
50
- VideoWidth?: number;
59
+ Height: number;
51
60
  /**
52
- * 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
61
+ * 图片宽度
53
62
  */
54
- VideoHeight?: number;
63
+ Width: number;
55
64
  /**
56
- * 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
65
+ * 显示位置x轴方向
57
66
  */
58
- VideoBitrate?: number;
67
+ XPosition: number;
59
68
  /**
60
- * 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
69
+ * 显示位置y轴方向
61
70
  */
62
- VideoFramerate?: number;
71
+ YPosition: number;
72
+ }
73
+ /**
74
+ * 用户自定义混流布局参数列表。
75
+ */
76
+ export interface MixLayout {
63
77
  /**
64
- * 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
78
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。
65
79
  */
66
- VideoGop?: number;
80
+ Top: number;
67
81
  /**
68
- * 混流-输出流背景色,取值是十进制整数。常用的颜色有:
69
- 红色:0xff0000,对应的十进制整数是16724736。
70
- 黄色:0xffff00。对应的十进制整数是16776960。
71
- 绿色:0x33cc00。对应的十进制整数是3394560。
72
- 蓝色:0x0066ff。对应的十进制整数是26367。
73
- 黑色:0x000000。对应的十进制整数是0。
74
- 白色:0xFFFFFF。对应的十进制整数是16777215。
75
- 灰色:0x999999。对应的十进制整数是10066329。
82
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。
76
83
  */
77
- BackgroundColor?: number;
84
+ Left: number;
78
85
  /**
79
- * 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
86
+ * 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。
80
87
  */
81
- BackgroundImageId?: number;
88
+ Width: number;
82
89
  /**
83
- * 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]
90
+ * 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。
84
91
  */
85
- AudioCodec?: number;
92
+ Height: number;
86
93
  /**
87
- * 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。
94
+ * 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。
88
95
  */
89
- BackgroundImageUrl?: string;
96
+ UserId?: string;
97
+ /**
98
+ * 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。
99
+ */
100
+ Alpha?: number;
101
+ /**
102
+ * 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
103
+
104
+ 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
105
+
106
+ 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
107
+
108
+ 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
109
+ */
110
+ RenderMode?: number;
111
+ /**
112
+ * 对应订阅流的主辅路标识:
113
+ 0:主流(默认);
114
+ 1:辅流;
115
+ */
116
+ MediaId?: number;
117
+ /**
118
+ * 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
119
+ */
120
+ ImageLayer?: number;
121
+ /**
122
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
123
+ */
124
+ SubBackgroundImage?: string;
90
125
  }
91
126
  /**
92
- * DescribeAbnormalEvent请求参数结构体
127
+ * DescribeHistoryScale请求参数结构体
93
128
  */
94
- export interface DescribeAbnormalEventRequest {
129
+ export interface DescribeHistoryScaleRequest {
95
130
  /**
96
131
  * 用户SdkAppId(如:1400xxxxxx)
97
132
  */
98
133
  SdkAppId: string;
99
134
  /**
100
135
  * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
101
- 注意:支持查询14天内的数据
136
+ 注意:支持查询14天内的数据。
102
137
  */
103
138
  StartTime: number;
104
139
  /**
105
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
140
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
141
+ 注意:按天统计,结束时间小于前一天,否则查询数据为空(如:需查询20号数据,结束时间需小于20号0点)。
106
142
  */
107
143
  EndTime: number;
108
- /**
109
- * 房间号,查询房间内任意20条以内异常体验事件
110
- */
111
- RoomId?: string;
112
144
  }
113
145
  /**
114
- * DescribeScaleInfo请求参数结构体
146
+ * DescribeCallDetail请求参数结构体
115
147
  */
116
- export interface DescribeScaleInfoRequest {
148
+ export interface DescribeCallDetailRequest {
117
149
  /**
118
- * 用户SdkAppId(如:1400xxxxxx)
150
+ * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
119
151
  */
120
- SdkAppId: number;
152
+ CommId: string;
121
153
  /**
122
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777
154
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
123
155
  注意:支持查询14天内的数据。
124
156
  */
125
157
  StartTime: number;
126
158
  /**
127
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
128
- 注意:按天统计,结束时间小于前一天,否则查询数据为空(如:需查询20号数据,结束时间需小于20号0点)。
159
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877
160
+ 注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
129
161
  */
130
162
  EndTime: number;
163
+ /**
164
+ * 用户SdkAppId(如:1400xxxxxx)。
165
+ */
166
+ SdkAppId: string;
167
+ /**
168
+ * 需查询的用户数组,默认不填返回6个用户。
169
+ */
170
+ UserIds?: Array<string>;
171
+ /**
172
+ * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
173
+ appCpu:APP CPU使用率;
174
+ sysCpu:系统 CPU使用率;
175
+ aBit:上/下行音频码率;单位:bps
176
+ aBlock:音频卡顿时长;单位:ms
177
+ bigvBit:上/下行视频码率;单位:bps
178
+ bigvCapFps:视频采集帧率;
179
+ bigvEncFps:视频发送帧率;
180
+ bigvDecFps:渲染帧率;
181
+ bigvBlock:视频卡顿时长;单位:ms
182
+ aLoss:上/下行音频丢包率;
183
+ bigvLoss:上/下行视频丢包率;
184
+ bigvWidth:上/下行分辨率宽;
185
+ bigvHeight:上/下行分辨率高
186
+ */
187
+ DataType?: Array<string>;
188
+ /**
189
+ * 当前页数,默认为0,
190
+ 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
191
+ */
192
+ PageNumber?: string;
193
+ /**
194
+ * 每页个数,默认为6,
195
+ 范围:[1,100]
196
+ 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
197
+ DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
198
+ */
199
+ PageSize?: string;
131
200
  }
132
201
  /**
133
- * ModifyPicture返回参数结构体
202
+ * RemoveUserByStrRoomId返回参数结构体
134
203
  */
135
- export interface ModifyPictureResponse {
204
+ export interface RemoveUserByStrRoomIdResponse {
136
205
  /**
137
206
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
138
207
  */
139
208
  RequestId?: string;
140
209
  }
141
210
  /**
142
- * StartMCUMixTranscodeByStrRoomId请求参数结构体
211
+ * StartMCUMixTranscode请求参数结构体
143
212
  */
144
- export interface StartMCUMixTranscodeByStrRoomIdRequest {
213
+ export interface StartMCUMixTranscodeRequest {
145
214
  /**
146
215
  * TRTC的SDKAppId。
147
216
  */
148
217
  SdkAppId: number;
149
218
  /**
150
- * 字符串房间号。
219
+ * 房间号。
151
220
  */
152
- StrRoomId: string;
221
+ RoomId: number;
153
222
  /**
154
223
  * 混流输出控制参数。
155
224
  */
@@ -168,84 +237,115 @@ export interface StartMCUMixTranscodeByStrRoomIdRequest {
168
237
  PublishCdnParams?: PublishCdnParams;
169
238
  }
170
239
  /**
171
- * MCU混流布局参数
240
+ * DescribeUserEvent请求参数结构体
172
241
  */
173
- export interface LayoutParams {
242
+ export interface DescribeUserEventRequest {
174
243
  /**
175
- * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
244
+ * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
176
245
  */
177
- Template?: number;
246
+ CommId: string;
178
247
  /**
179
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
248
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
249
+ 注意:支持查询14天内的数据
180
250
  */
181
- MainVideoUserId?: string;
251
+ StartTime: number;
182
252
  /**
183
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
253
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
254
+ 注意:查询时间大于房间结束时间,以房间结束时间为准。
184
255
  */
185
- MainVideoStreamType?: number;
256
+ EndTime: number;
186
257
  /**
187
- * 画中画模板中有效,代表小画面的布局参数。
258
+ * 用户UserId
188
259
  */
189
- SmallVideoLayoutParams?: SmallVideoLayoutParams;
260
+ UserId: string;
190
261
  /**
191
- * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
262
+ * 房间号(如:223)
192
263
  */
193
- MainVideoRightAlign?: number;
264
+ RoomId: string;
194
265
  /**
195
- * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
266
+ * 用户SdkAppId(如:1400xxxxxx)
196
267
  */
197
- MixVideoUids?: Array<string>;
268
+ SdkAppId: number;
269
+ }
270
+ /**
271
+ * StartMCUMixTranscodeByStrRoomId请求参数结构体
272
+ */
273
+ export interface StartMCUMixTranscodeByStrRoomIdRequest {
198
274
  /**
199
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
275
+ * TRTC的SDKAppId。
200
276
  */
201
- PresetLayoutConfig?: Array<PresetLayoutConfig>;
277
+ SdkAppId: number;
202
278
  /**
203
- * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
279
+ * 字符串房间号。
204
280
  */
205
- PlaceHolderMode?: number;
281
+ StrRoomId: string;
206
282
  /**
207
- * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
283
+ * 混流输出控制参数。
208
284
  */
209
- PureAudioHoldPlaceMode?: number;
285
+ OutputParams: OutputParams;
210
286
  /**
211
- * 水印参数。
287
+ * 混流输出编码参数。
212
288
  */
213
- WaterMarkParams?: WaterMarkParams;
289
+ EncodeParams: EncodeParams;
290
+ /**
291
+ * 混流输出布局参数。
292
+ */
293
+ LayoutParams: LayoutParams;
294
+ /**
295
+ * 第三方CDN转推参数。
296
+ */
297
+ PublishCdnParams?: PublishCdnParams;
214
298
  }
215
299
  /**
216
- * DescribeScaleInfo返回参数结构体
300
+ * 历史规模信息
217
301
  */
218
- export interface DescribeScaleInfoResponse {
302
+ export interface ScaleInfomation {
219
303
  /**
220
- * 返回的数据条数
304
+ * 每天开始的时间
221
305
  */
222
- Total: number;
306
+ Time: number;
223
307
  /**
224
- * 返回的数据
308
+ * 房间人数,用户重复进入同一个房间为1次
225
309
  注意:此字段可能返回 null,表示取不到有效值。
226
310
  */
227
- ScaleList: Array<ScaleInfomation>;
311
+ UserNumber: number;
228
312
  /**
229
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
313
+ * 房间人次,用户每次进入房间为一次
314
+ 注意:此字段可能返回 null,表示取不到有效值。
230
315
  */
231
- RequestId?: string;
316
+ UserCount: number;
317
+ /**
318
+ * sdkappid下一天内的房间数
319
+ 注意:此字段可能返回 null,表示取不到有效值。
320
+ */
321
+ RoomNumbers: number;
232
322
  }
233
323
  /**
234
- * CreatePicture请求参数结构体
324
+ * DescribeDetailEvent返回参数结构体
235
325
  */
236
- export interface CreatePictureRequest {
237
- /**
238
- * 应用id
239
- */
240
- SdkAppId: number;
326
+ export interface DescribeDetailEventResponse {
241
327
  /**
242
- * 图片内容经base64编码后的string格式
328
+ * 返回的事件列表,若没有数据,会返回空数组。
243
329
  */
244
- Content: string;
330
+ Data: Array<EventList>;
245
331
  /**
246
- * 图片后缀名
332
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
247
333
  */
248
- Suffix: string;
334
+ RequestId?: string;
335
+ }
336
+ /**
337
+ * StopMCUMixTranscodeByStrRoomId返回参数结构体
338
+ */
339
+ export interface StopMCUMixTranscodeByStrRoomIdResponse {
340
+ /**
341
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
342
+ */
343
+ RequestId?: string;
344
+ }
345
+ /**
346
+ * 图片列表信息
347
+ */
348
+ export interface PictureInfo {
249
349
  /**
250
350
  * 图片长度
251
351
  */
@@ -262,128 +362,121 @@ export interface CreatePictureRequest {
262
362
  * 显示位置y轴方向
263
363
  */
264
364
  YPosition: number;
265
- }
266
- /**
267
- * DescribeTrtcMcuTranscodeTime请求参数结构体
268
- */
269
- export interface DescribeTrtcMcuTranscodeTimeRequest {
270
- /**
271
- * 查询开始时间,格式为YYYY-MM-DD。
272
- */
273
- StartTime: string;
274
365
  /**
275
- * 查询结束时间,格式为YYYY-MM-DD。
276
- 单次查询统计区间最多不能超过31天。
366
+ * 应用id
277
367
  */
278
- EndTime: string;
368
+ SdkAppId: number;
279
369
  /**
280
- * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
370
+ * 图片id
281
371
  */
282
- SdkAppId?: number;
372
+ PictureId: number;
283
373
  }
284
374
  /**
285
- * 查询旁路转码计费时长。
286
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
375
+ * DescribeCallDetailInfo请求参数结构体
287
376
  */
288
- export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
377
+ export interface DescribeCallDetailInfoRequest {
289
378
  /**
290
- * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
379
+ * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
291
380
  */
292
- TimeKey: string;
381
+ CommId: string;
293
382
  /**
294
- * 语音时长,单位:秒。
383
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
384
+ 注意:支持查询14天内的数据。
295
385
  */
296
- AudioTime: number;
386
+ StartTime: number;
297
387
  /**
298
- * 视频时长-标清SD,单位:秒。
388
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
389
+ 注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
299
390
  */
300
- VideoTimeSd: number;
391
+ EndTime: number;
301
392
  /**
302
- * 视频时长-高清HD,单位:秒。
393
+ * 用户SdkAppId(如:1400xxxxxx)。
303
394
  */
304
- VideoTimeHd: number;
395
+ SdkAppId: number;
305
396
  /**
306
- * 视频时长-全高清FHD,单位:秒。
397
+ * 需查询的用户数组,默认不填返回6个用户。
307
398
  */
308
- VideoTimeFhd: number;
309
- }
310
- /**
311
- * RemoveUserByStrRoomId请求参数结构体
312
- */
313
- export interface RemoveUserByStrRoomIdRequest {
399
+ UserIds?: Array<string>;
314
400
  /**
315
- * TRTC的SDKAppId。
401
+ * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
402
+ appCpu:APP CPU使用率;
403
+ sysCpu:系统 CPU使用率;
404
+ aBit:上/下行音频码率;单位:bps
405
+ aBlock:音频卡顿时长;单位:ms
406
+ bigvBit:上/下行视频码率;单位:bps
407
+ bigvCapFps:视频采集帧率;
408
+ bigvEncFps:视频发送帧率;
409
+ bigvDecFps:渲染帧率;
410
+ bigvBlock:视频卡顿时长;单位:ms
411
+ aLoss:上/下行音频丢包率;
412
+ bigvLoss:上/下行视频丢包率;
413
+ bigvWidth:上/下行分辨率宽;
414
+ bigvHeight:上/下行分辨率高
316
415
  */
317
- SdkAppId: number;
416
+ DataType?: Array<string>;
318
417
  /**
319
- * 房间号。
418
+ * 当前页数,默认为0,
419
+ 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
320
420
  */
321
- RoomId: string;
421
+ PageNumber?: number;
322
422
  /**
323
- * 要移出的用户列表,最多10个。
423
+ * 每页个数,默认为6,
424
+ 范围:[1,100]
425
+ 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
426
+ DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
324
427
  */
325
- UserIds: Array<string>;
428
+ PageSize?: number;
326
429
  }
327
430
  /**
328
- * DismissRoom返回参数结构体
431
+ * 录制的音视频转码参数。
329
432
  */
330
- export interface DismissRoomResponse {
433
+ export interface MixTranscodeParams {
331
434
  /**
332
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
435
+ * 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
333
436
  */
334
- RequestId?: string;
437
+ VideoParams?: VideoParams;
438
+ /**
439
+ * 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
440
+ */
441
+ AudioParams?: AudioParams;
335
442
  }
336
443
  /**
337
- * 事件信息,包括,事件时间戳,事件ID,
444
+ * DescribeRoomInformation请求参数结构体
338
445
  */
339
- export interface EventMessage {
340
- /**
341
- * 视频流类型:
342
- 0:与视频无关的事件;
343
- 2:视频为大画面;
344
- 3:视频为小画面;
345
- 7:视频为旁路画面;
346
- */
347
- Type: number;
348
- /**
349
- * 事件上报的时间戳,unix时间(1589891188801ms)
350
- */
351
- Time: number;
446
+ export interface DescribeRoomInformationRequest {
352
447
  /**
353
- * 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
448
+ * 用户SdkAppId(如:1400xxxxxx)
354
449
  */
355
- EventId: number;
450
+ SdkAppId: string;
356
451
  /**
357
- * 事件的第一个参数,如视频分辨率宽
452
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
453
+ 注意:支持查询14天内的数据
358
454
  */
359
- ParamOne: number;
455
+ StartTime: number;
360
456
  /**
361
- * 事件的第二个参数,如视频分辨率高
457
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
458
+ 注意:与StartTime间隔时间不超过24小时。
362
459
  */
363
- ParamTwo: number;
364
- }
365
- /**
366
- * DescribeRecordStatistic请求参数结构体
367
- */
368
- export interface DescribeRecordStatisticRequest {
460
+ EndTime: number;
369
461
  /**
370
- * 查询开始日期,格式为YYYY-MM-DD。
462
+ * 房间号(如:223)
371
463
  */
372
- StartTime: string;
464
+ RoomId?: string;
373
465
  /**
374
- * 查询结束日期,格式为YYYY-MM-DD。
375
- 单次查询统计区间最多不能超过31天。
466
+ * 当前页数,默认为0,
467
+ 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
376
468
  */
377
- EndTime: string;
469
+ PageNumber?: string;
378
470
  /**
379
- * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
471
+ * 每页个数,默认为10,
472
+ 范围:[1,100]
380
473
  */
381
- SdkAppId?: number;
474
+ PageSize?: string;
382
475
  }
383
476
  /**
384
- * DescribeUserInformation请求参数结构体
477
+ * DescribeUserInfo请求参数结构体
385
478
  */
386
- export interface DescribeUserInformationRequest {
479
+ export interface DescribeUserInfoRequest {
387
480
  /**
388
481
  * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
389
482
  */
@@ -401,7 +494,7 @@ export interface DescribeUserInformationRequest {
401
494
  /**
402
495
  * 用户SdkAppId(如:1400xxxxxx)
403
496
  */
404
- SdkAppId: string;
497
+ SdkAppId: number;
405
498
  /**
406
499
  * 需查询的用户数组,不填默认返回6个用户
407
500
  范围:[1,100]。
@@ -411,369 +504,822 @@ export interface DescribeUserInformationRequest {
411
504
  * 当前页数,默认为0,
412
505
  注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
413
506
  */
414
- PageNumber?: string;
507
+ PageNumber?: number;
415
508
  /**
416
509
  * 每页个数,默认为6,
417
510
  范围:[1,100]。
418
511
  */
419
- PageSize?: string;
512
+ PageSize?: number;
420
513
  }
421
514
  /**
422
- * DescribeCallDetail请求参数结构体
515
+ * MCU混流水印参数
423
516
  */
424
- export interface DescribeCallDetailRequest {
517
+ export interface WaterMarkParams {
425
518
  /**
426
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
519
+ * 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。
427
520
  */
428
- CommId: string;
521
+ WaterMarkId: number;
429
522
  /**
430
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
431
- 注意:支持查询14天内的数据。
523
+ * 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。
432
524
  */
433
- StartTime: number;
525
+ WaterMarkWidth: number;
434
526
  /**
435
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
436
- 注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
527
+ * 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。
437
528
  */
438
- EndTime: number;
529
+ WaterMarkHeight: number;
439
530
  /**
440
- * 用户SdkAppId(如:1400xxxxxx)。
531
+ * 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。
441
532
  */
442
- SdkAppId: string;
533
+ LocationX: number;
443
534
  /**
444
- * 需查询的用户数组,默认不填返回6个用户。
535
+ * 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。
445
536
  */
446
- UserIds?: Array<string>;
537
+ LocationY: number;
447
538
  /**
448
- * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
449
- appCpu:APP CPU使用率;
450
- sysCpu:系统 CPU使用率;
451
- aBit:上/下行音频码率;单位:bps
452
- aBlock:音频卡顿时长;单位:ms
453
- bigvBit:上/下行视频码率;单位:bps
454
- bigvCapFps:视频采集帧率;
455
- bigvEncFps:视频发送帧率;
456
- bigvDecFps:渲染帧率;
457
- bigvBlock:视频卡顿时长;单位:ms
458
- aLoss:上/下行音频丢包率;
459
- bigvLoss:上/下行视频丢包率;
460
- bigvWidth:上/下行分辨率宽;
461
- bigvHeight:上/下行分辨率高
539
+ * 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。
462
540
  */
463
- DataType?: Array<string>;
541
+ WaterMarkUrl?: string;
542
+ }
543
+ /**
544
+ * DescribeRecordStatistic返回参数结构体
545
+ */
546
+ export interface DescribeRecordStatisticResponse {
464
547
  /**
465
- * 当前页数,默认为0,
466
- 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
548
+ * 应用的用量信息数组。
467
549
  */
468
- PageNumber?: string;
550
+ SdkAppIdUsages: Array<SdkAppIdRecordUsage>;
469
551
  /**
470
- * 每页个数,默认为6,
471
- 范围:[1,100]
472
- 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
473
- DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
552
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
474
553
  */
475
- PageSize?: string;
554
+ RequestId?: string;
476
555
  }
477
556
  /**
478
- * 历史规模信息
557
+ * StartMCUMixTranscodeByStrRoomId返回参数结构体
479
558
  */
480
- export interface ScaleInfomation {
559
+ export interface StartMCUMixTranscodeByStrRoomIdResponse {
481
560
  /**
482
- * 每天开始的时间
561
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
483
562
  */
484
- Time: number;
563
+ RequestId?: string;
564
+ }
565
+ /**
566
+ * 第三方云存储的账号信息。
567
+ */
568
+ export interface CloudStorage {
485
569
  /**
486
- * 房间人数,用户重复进入同一个房间为1次
487
- 注意:此字段可能返回 null,表示取不到有效值。
570
+ * 第三方云储存的供应商:
571
+ 0:腾讯云存储 COS,暂不支持其他家。
488
572
  */
489
- UserNumber: number;
573
+ Vendor: number;
490
574
  /**
491
- * 房间人次,用户每次进入房间为一次
492
- 注意:此字段可能返回 null,表示取不到有效值。
575
+ * 第三方云存储的地域信息。
493
576
  */
494
- UserCount: number;
577
+ Region: string;
495
578
  /**
496
- * sdkappid下一天内的房间数
497
- 注意:此字段可能返回 null,表示取不到有效值。
579
+ * 第三方存储桶信息。
498
580
  */
499
- RoomNumbers: number;
500
- }
501
- /**
502
- * DescribeUserInformation返回参数结构体
503
- */
504
- export interface DescribeUserInformationResponse {
581
+ Bucket: string;
505
582
  /**
506
- * 返回的用户总条数
583
+ * 第三方存储的access_key账号信息。
507
584
  */
508
- Total: number;
585
+ AccessKey: string;
509
586
  /**
510
- * 用户信息列表
511
- 注意:此字段可能返回 null,表示取不到有效值。
587
+ * 第三方存储的secret_key账号信息。
512
588
  */
513
- UserList: Array<UserInformation>;
589
+ SecretKey: string;
514
590
  /**
515
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
591
+ * 第三方云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围a~z,A~Z,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8
516
592
  */
517
- RequestId?: string;
593
+ FileNamePrefix?: Array<string>;
518
594
  }
519
595
  /**
520
- * SdkAppId级别实时音视频的用量数据
596
+ * 返回的质量数据,时间:值
521
597
  */
522
- export interface SdkAppIdNewTrtcTimeUsage {
598
+ export interface TimeValue {
599
+ /**
600
+ * 时间,unix时间戳(1590065877s)
601
+ */
602
+ Time: number;
603
+ /**
604
+ * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
605
+ */
606
+ Value: number;
607
+ }
608
+ /**
609
+ * DismissRoomByStrRoomId请求参数结构体
610
+ */
611
+ export interface DismissRoomByStrRoomIdRequest {
612
+ /**
613
+ * TRTC的SDKAppId。
614
+ */
615
+ SdkAppId: number;
616
+ /**
617
+ * 房间号。
618
+ */
619
+ RoomId: string;
620
+ }
621
+ /**
622
+ * 事件信息,包括,事件时间戳,事件ID,
623
+ */
624
+ export interface EventMessage {
625
+ /**
626
+ * 视频流类型:
627
+ 0:与视频无关的事件;
628
+ 2:视频为大画面;
629
+ 3:视频为小画面;
630
+ 7:视频为旁路画面;
631
+ */
632
+ Type: number;
633
+ /**
634
+ * 事件上报的时间戳,unix时间(1589891188801ms)
635
+ */
636
+ Time: number;
637
+ /**
638
+ * 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
639
+ */
640
+ EventId: number;
641
+ /**
642
+ * 事件的第一个参数,如视频分辨率宽
643
+ */
644
+ ParamOne: number;
645
+ /**
646
+ * 事件的第二个参数,如视频分辨率高
647
+ */
648
+ ParamTwo: number;
649
+ }
650
+ /**
651
+ * DescribeRecordStatistic请求参数结构体
652
+ */
653
+ export interface DescribeRecordStatisticRequest {
654
+ /**
655
+ * 查询开始日期,格式为YYYY-MM-DD。
656
+ */
657
+ StartTime: string;
658
+ /**
659
+ * 查询结束日期,格式为YYYY-MM-DD。
660
+ 单次查询统计区间最多不能超过31天。
661
+ */
662
+ EndTime: string;
663
+ /**
664
+ * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
665
+ */
666
+ SdkAppId?: number;
667
+ }
668
+ /**
669
+ * DescribeRoomInfo请求参数结构体
670
+ */
671
+ export interface DescribeRoomInfoRequest {
672
+ /**
673
+ * 用户SdkAppId(如:1400xxxxxx)
674
+ */
675
+ SdkAppId: number;
676
+ /**
677
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
678
+ 注意:支持查询14天内的数据
679
+ */
680
+ StartTime: number;
681
+ /**
682
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
683
+ 注意:与StartTime间隔时间不超过24小时。
684
+ */
685
+ EndTime: number;
686
+ /**
687
+ * 房间号(如:223)
688
+ */
689
+ RoomId?: string;
690
+ /**
691
+ * 当前页数,默认为0,
692
+ 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
693
+ */
694
+ PageNumber?: number;
695
+ /**
696
+ * 每页个数,默认为10,
697
+ 范围:[1,100]
698
+ */
699
+ PageSize?: number;
700
+ }
701
+ /**
702
+ * 第三方存储参数。
703
+ */
704
+ export interface StorageParams {
705
+ /**
706
+ * 第三方云存储的账号信息。
707
+ */
708
+ CloudStorage?: CloudStorage;
709
+ /**
710
+ * 第三方云点播的账号信息。
711
+ */
712
+ CloudVod?: CloudVod;
713
+ }
714
+ /**
715
+ * 点播相关参数。
716
+ */
717
+ export interface CloudVod {
718
+ /**
719
+ * 腾讯云点播相关参数。
720
+ */
721
+ TencentVod?: TencentVod;
722
+ }
723
+ /**
724
+ * MCU混流输出流编码参数
725
+ */
726
+ export interface EncodeParams {
727
+ /**
728
+ * 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
729
+ */
730
+ AudioSampleRate: number;
731
+ /**
732
+ * 混流-输出流音频码率。取值范围[8,500],单位为kbps。
733
+ */
734
+ AudioBitrate: number;
735
+ /**
736
+ * 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
737
+ */
738
+ AudioChannels: number;
739
+ /**
740
+ * 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
741
+ */
742
+ VideoWidth?: number;
743
+ /**
744
+ * 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
745
+ */
746
+ VideoHeight?: number;
747
+ /**
748
+ * 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
749
+ */
750
+ VideoBitrate?: number;
751
+ /**
752
+ * 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
753
+ */
754
+ VideoFramerate?: number;
755
+ /**
756
+ * 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
757
+ */
758
+ VideoGop?: number;
759
+ /**
760
+ * 混流-输出流背景色,取值是十进制整数。常用的颜色有:
761
+ 红色:0xff0000,对应的十进制整数是16724736。
762
+ 黄色:0xffff00。对应的十进制整数是16776960。
763
+ 绿色:0x33cc00。对应的十进制整数是3394560。
764
+ 蓝色:0x0066ff。对应的十进制整数是26367。
765
+ 黑色:0x000000。对应的十进制整数是0。
766
+ 白色:0xFFFFFF。对应的十进制整数是16777215。
767
+ 灰色:0x999999。对应的十进制整数是10066329。
768
+ */
769
+ BackgroundColor?: number;
770
+ /**
771
+ * 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
772
+ */
773
+ BackgroundImageId?: number;
774
+ /**
775
+ * 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]
776
+ */
777
+ AudioCodec?: number;
778
+ /**
779
+ * 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。
780
+ */
781
+ BackgroundImageUrl?: string;
782
+ }
783
+ /**
784
+ * DescribeCallDetailInfo返回参数结构体
785
+ */
786
+ export interface DescribeCallDetailInfoResponse {
787
+ /**
788
+ * 返回的用户总条数
789
+ */
790
+ Total: number;
791
+ /**
792
+ * 用户信息列表
793
+ 注意:此字段可能返回 null,表示取不到有效值。
794
+ */
795
+ UserList: Array<UserInformation>;
796
+ /**
797
+ * 质量数据
798
+ 注意:此字段可能返回 null,表示取不到有效值。
799
+ */
800
+ Data: Array<QualityData>;
801
+ /**
802
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
803
+ */
804
+ RequestId?: string;
805
+ }
806
+ /**
807
+ * DescribeUserInformation请求参数结构体
808
+ */
809
+ export interface DescribeUserInformationRequest {
810
+ /**
811
+ * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
812
+ */
813
+ CommId: string;
814
+ /**
815
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
816
+ 注意:支持查询14天内的数据
817
+ */
818
+ StartTime: number;
819
+ /**
820
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
821
+ 注意:与StartTime间隔时间不超过4小时。
822
+ */
823
+ EndTime: number;
824
+ /**
825
+ * 用户SdkAppId(如:1400xxxxxx)
826
+ */
827
+ SdkAppId: string;
828
+ /**
829
+ * 需查询的用户数组,不填默认返回6个用户
830
+ 范围:[1,100]。
831
+ */
832
+ UserIds?: Array<string>;
833
+ /**
834
+ * 当前页数,默认为0,
835
+ 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
836
+ */
837
+ PageNumber?: string;
838
+ /**
839
+ * 每页个数,默认为6,
840
+ 范围:[1,100]。
841
+ */
842
+ PageSize?: string;
843
+ }
844
+ /**
845
+ * 实时音视频用量的某一时间段的统计信息.
846
+ */
847
+ export interface TrtcTimeNewUsage {
848
+ /**
849
+ * 时间点。
850
+ */
851
+ TimeKey: string;
852
+ /**
853
+ * 通话人数。仅供参考。在线人数以仪表盘查询结果为准。
854
+ */
855
+ VoiceUserNum: number;
856
+ /**
857
+ * 音视频通话时长。单位:秒。
858
+ */
859
+ VideoTime: number;
860
+ /**
861
+ * 标清视频通话时长。单位:秒。
862
+ */
863
+ Class1VideoTime: number;
864
+ /**
865
+ * 高清视频通话时长。单位:秒。
866
+ */
867
+ Class2VideoTime: number;
868
+ /**
869
+ * 超高清视频通话时长。单位:秒。
870
+ */
871
+ Class3VideoTime: number;
872
+ /**
873
+ * 音频通话时长。单位:秒。
874
+ */
875
+ AudioTime: number;
876
+ /**
877
+ * 带宽。单位:Mbps。
878
+ */
879
+ Bandwidth: number;
880
+ /**
881
+ * 2k视频通话时长。单位:秒。
882
+ */
883
+ Video2KTime: number;
884
+ /**
885
+ * 4k视频通话时长。单位:秒。
886
+ */
887
+ Video4KTime: number;
888
+ }
889
+ /**
890
+ * ModifyPicture请求参数结构体
891
+ */
892
+ export interface ModifyPictureRequest {
893
+ /**
894
+ * 图片id
895
+ */
896
+ PictureId: number;
897
+ /**
898
+ * 应用id
899
+ */
900
+ SdkAppId: number;
901
+ /**
902
+ * 图片长度
903
+ */
904
+ Height?: number;
905
+ /**
906
+ * 图片宽度
907
+ */
908
+ Width?: number;
909
+ /**
910
+ * 显示位置x轴方向
911
+ */
912
+ XPosition?: number;
913
+ /**
914
+ * 显示位置y轴方向
915
+ */
916
+ YPosition?: number;
917
+ }
918
+ /**
919
+ * 画中画模板中有效,代表小画面的布局参数
920
+ */
921
+ export interface SmallVideoLayoutParams {
922
+ /**
923
+ * 代表小画面对应的用户ID。
924
+ */
925
+ UserId: string;
926
+ /**
927
+ * 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
928
+ */
929
+ StreamType: number;
930
+ /**
931
+ * 小画面在输出时的宽度,单位为像素值,不填默认为0。
932
+ */
933
+ ImageWidth?: number;
934
+ /**
935
+ * 小画面在输出时的高度,单位为像素值,不填默认为0。
936
+ */
937
+ ImageHeight?: number;
938
+ /**
939
+ * 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
940
+ */
941
+ LocationX?: number;
942
+ /**
943
+ * 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
944
+ */
945
+ LocationY?: number;
946
+ }
947
+ /**
948
+ * 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。支持通过设置".*$"通配符,来前缀匹配黑白名单的UserId,注意房间里不能有和通配符规则相同的用户,否则将视为订阅具体用户,前缀规则会失效。
949
+ */
950
+ export interface SubscribeStreamUserIds {
951
+ /**
952
+ * 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流;["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。
953
+ */
954
+ SubscribeAudioUserIds?: Array<string>;
955
+ /**
956
+ * 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅列表用户数不超过32。
957
+ */
958
+ UnSubscribeAudioUserIds?: Array<string>;
959
+ /**
960
+ * 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
961
+ */
962
+ SubscribeVideoUserIds?: Array<string>;
963
+ /**
964
+ * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
965
+ */
966
+ UnSubscribeVideoUserIds?: Array<string>;
967
+ }
968
+ /**
969
+ * 水印类型为图片的参数列表
970
+ */
971
+ export interface WaterMarkImage {
972
+ /**
973
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
974
+ */
975
+ WaterMarkUrl: string;
976
+ /**
977
+ * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
978
+ */
979
+ Top: number;
980
+ /**
981
+ * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
982
+ */
983
+ Left: number;
984
+ /**
985
+ * 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
986
+ */
987
+ Width: number;
988
+ /**
989
+ * 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
990
+ */
991
+ Height: number;
992
+ }
993
+ /**
994
+ * sdk或webrtc的事件列表。
995
+ */
996
+ export interface EventList {
997
+ /**
998
+ * 数据内容
999
+ */
1000
+ Content: Array<EventMessage>;
1001
+ /**
1002
+ * 发送端的userId
1003
+ */
1004
+ PeerId: string;
1005
+ }
1006
+ /**
1007
+ * DescribeRoomInfo返回参数结构体
1008
+ */
1009
+ export interface DescribeRoomInfoResponse {
1010
+ /**
1011
+ * 返回当页数据总数
1012
+ */
1013
+ Total: number;
1014
+ /**
1015
+ * 房间信息列表
1016
+ */
1017
+ RoomList: Array<RoomState>;
1018
+ /**
1019
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1020
+ */
1021
+ RequestId?: string;
1022
+ }
1023
+ /**
1024
+ * 查询旁路转码计费时长。
1025
+ 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
1026
+ */
1027
+ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
1028
+ /**
1029
+ * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
1030
+ */
1031
+ TimeKey: string;
1032
+ /**
1033
+ * 语音时长,单位:秒。
1034
+ */
1035
+ AudioTime: number;
523
1036
  /**
524
- * SdkAppId的值。
1037
+ * 视频时长-标清SD,单位:秒。
525
1038
  */
526
- SdkAppId: string;
1039
+ VideoTimeSd: number;
527
1040
  /**
528
- * 统计的时间点数据。
1041
+ * 视频时长-高清HD,单位:秒。
529
1042
  */
530
- TrtcTimeUsages: Array<TrtcTimeNewUsage>;
1043
+ VideoTimeHd: number;
531
1044
  /**
532
- * 统计的麦下用量的时间点数据。
1045
+ * 视频时长-全高清FHD,单位:秒。
533
1046
  */
534
- AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>;
1047
+ VideoTimeFhd: number;
535
1048
  }
536
1049
  /**
537
- * DescribeTrtcMcuTranscodeTime返回参数结构体
1050
+ * DescribeUserInfo返回参数结构体
538
1051
  */
539
- export interface DescribeTrtcMcuTranscodeTimeResponse {
1052
+ export interface DescribeUserInfoResponse {
540
1053
  /**
541
- * 应用的用量信息数组。
1054
+ * 返回的用户总条数
542
1055
  */
543
- Usages: Array<OneSdkAppIdTranscodeTimeUsagesInfo>;
1056
+ Total: number;
1057
+ /**
1058
+ * 用户信息列表
1059
+ 注意:此字段可能返回 null,表示取不到有效值。
1060
+ */
1061
+ UserList: Array<UserInformation>;
544
1062
  /**
545
1063
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
546
1064
  */
547
1065
  RequestId?: string;
548
1066
  }
549
1067
  /**
550
- * RemoveUserByStrRoomId返回参数结构体
1068
+ * ModifyPicture返回参数结构体
551
1069
  */
552
- export interface RemoveUserByStrRoomIdResponse {
1070
+ export interface ModifyPictureResponse {
553
1071
  /**
554
1072
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
555
1073
  */
556
1074
  RequestId?: string;
557
1075
  }
558
1076
  /**
559
- * StartMCUMixTranscode请求参数结构体
1077
+ * 云端录制查询接口,录制文件的信息
560
1078
  */
561
- export interface StartMCUMixTranscodeRequest {
562
- /**
563
- * TRTC的SDKAppId。
564
- */
565
- SdkAppId: number;
566
- /**
567
- * 房间号。
568
- */
569
- RoomId: number;
1079
+ export interface StorageFile {
570
1080
  /**
571
- * 混流输出控制参数。
1081
+ * 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
1082
+ 注意:此字段可能返回 null,表示取不到有效值。
572
1083
  */
573
- OutputParams: OutputParams;
1084
+ UserId: string;
574
1085
  /**
575
- * 混流输出编码参数。
1086
+ * 录制索引文件名。
576
1087
  */
577
- EncodeParams: EncodeParams;
1088
+ FileName: string;
578
1089
  /**
579
- * 混流输出布局参数。
1090
+ * 录制文件流信息。
1091
+ video:视频录制文件
1092
+ audio:音频录制文件
1093
+ audio_video:音视频录制文件
1094
+ 注意:此字段可能返回 null,表示取不到有效值。
580
1095
  */
581
- LayoutParams: LayoutParams;
1096
+ TrackType: string;
582
1097
  /**
583
- * 第三方CDN转推参数。
1098
+ * 录制文件开始Unix时间戳。
584
1099
  */
585
- PublishCdnParams?: PublishCdnParams;
1100
+ BeginTimeStamp: number;
586
1101
  }
587
1102
  /**
588
- * StopMCUMixTranscode请求参数结构体
1103
+ * 水印布局参数
589
1104
  */
590
- export interface StopMCUMixTranscodeRequest {
1105
+ export interface WaterMark {
591
1106
  /**
592
- * TRTC的SDKAppId。
1107
+ * 水印类型,0为图片(默认),1为文字(暂不支持)。
593
1108
  */
594
- SdkAppId: number;
1109
+ WaterMarkType?: number;
595
1110
  /**
596
- * 房间号。
1111
+ * 水印为图片时的参数列表,水印为图片时校验必填。
597
1112
  */
598
- RoomId: number;
1113
+ WaterMarkImage?: WaterMarkImage;
599
1114
  }
600
1115
  /**
601
- * DescribeCallDetailInfo返回参数结构体
1116
+ * DescribeScaleInfo返回参数结构体
602
1117
  */
603
- export interface DescribeCallDetailInfoResponse {
1118
+ export interface DescribeScaleInfoResponse {
604
1119
  /**
605
- * 返回的用户总条数
1120
+ * 返回的数据条数
606
1121
  */
607
1122
  Total: number;
608
1123
  /**
609
- * 用户信息列表
610
- 注意:此字段可能返回 null,表示取不到有效值。
611
- */
612
- UserList: Array<UserInformation>;
613
- /**
614
- * 质量数据
1124
+ * 返回的数据
615
1125
  注意:此字段可能返回 null,表示取不到有效值。
616
1126
  */
617
- Data: Array<QualityData>;
1127
+ ScaleList: Array<ScaleInfomation>;
618
1128
  /**
619
1129
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
620
1130
  */
621
1131
  RequestId?: string;
622
1132
  }
623
1133
  /**
624
- * DescribeUserEvent请求参数结构体
1134
+ * 录制的混流布局参数。
1135
+
625
1136
  */
626
- export interface DescribeUserEventRequest {
1137
+ export interface MixLayoutParams {
627
1138
  /**
628
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
1139
+ * 布局模式:
1140
+ 1:悬浮布局;
1141
+ 2:屏幕分享布局;
1142
+ 3:九宫格布局(默认);
1143
+ 4:自定义布局;
1144
+
1145
+ 悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。
1146
+
1147
+ 屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。
1148
+
1149
+ 九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
1150
+
1151
+ 自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
629
1152
  */
630
- CommId: string;
1153
+ MixLayoutMode: number;
631
1154
  /**
632
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
633
- 注意:支持查询14天内的数据
1155
+ * 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
634
1156
  */
635
- StartTime: number;
1157
+ MixLayoutList?: Array<MixLayout>;
636
1158
  /**
637
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
638
- 注意:查询时间大于房间结束时间,以房间结束时间为准。
1159
+ * 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值
639
1160
  */
640
- EndTime: number;
1161
+ BackGroundColor?: string;
641
1162
  /**
642
- * 用户UserId
1163
+ * 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色
643
1164
  */
644
- UserId: string;
1165
+ MaxResolutionUserId?: string;
645
1166
  /**
646
- * 房间号(如:223)
1167
+ * 主辅路标识,
1168
+ 0:主流(默认);
1169
+ 1:辅流(屏幕分享);
1170
+ 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
647
1171
  */
648
- RoomId: string;
1172
+ MediaId?: number;
649
1173
  /**
650
- * 用户SdkAppId(如:1400xxxxxx)
1174
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M。
651
1175
  */
652
- SdkAppId: number;
653
- }
654
- /**
655
- * DescribeHistoryScale请求参数结构体
656
- */
657
- export interface DescribeHistoryScaleRequest {
1176
+ BackgroundImageUrl?: string;
658
1177
  /**
659
- * 用户SdkAppId(如:1400xxxxxx)
1178
+ * 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
660
1179
  */
661
- SdkAppId: string;
1180
+ PlaceHolderMode?: number;
662
1181
  /**
663
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
664
- 注意:支持查询14天内的数据。
1182
+ * 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。
665
1183
  */
666
- StartTime: number;
1184
+ BackgroundImageRenderMode?: number;
667
1185
  /**
668
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
669
- 注意:按天统计,结束时间小于前一天,否则查询数据为空(如:需查询20号数据,结束时间需小于20号0点)。
1186
+ * 下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。
670
1187
  */
671
- EndTime: number;
1188
+ DefaultSubBackgroundImage?: string;
1189
+ /**
1190
+ * 水印布局参数, 最多支持25个。
1191
+ */
1192
+ WaterMarkList?: Array<WaterMark>;
672
1193
  }
673
1194
  /**
674
- * DeletePicture请求参数结构体
1195
+ * StopMCUMixTranscode返回参数结构体
675
1196
  */
676
- export interface DeletePictureRequest {
677
- /**
678
- * 图片id
679
- */
680
- PictureId: number;
1197
+ export interface StopMCUMixTranscodeResponse {
681
1198
  /**
682
- * 应用id
1199
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
683
1200
  */
684
- SdkAppId: number;
1201
+ RequestId?: string;
685
1202
  }
686
1203
  /**
687
- * 实时音视频用量的某一时间段的统计信息.
1204
+ * SdkAppId级别实时音视频的用量数据
688
1205
  */
689
- export interface TrtcTimeNewUsage {
1206
+ export interface SdkAppIdNewTrtcTimeUsage {
690
1207
  /**
691
- * 时间点。
1208
+ * SdkAppId的值。
692
1209
  */
693
- TimeKey: string;
1210
+ SdkAppId: string;
694
1211
  /**
695
- * 通话人数。仅供参考。在线人数以仪表盘查询结果为准。
1212
+ * 统计的时间点数据。
696
1213
  */
697
- VoiceUserNum: number;
1214
+ TrtcTimeUsages: Array<TrtcTimeNewUsage>;
698
1215
  /**
699
- * 音视频通话时长。单位:秒。
1216
+ * 统计的麦下用量的时间点数据。
700
1217
  */
701
- VideoTime: number;
1218
+ AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>;
1219
+ }
1220
+ /**
1221
+ * RemoveUser请求参数结构体
1222
+ */
1223
+ export interface RemoveUserRequest {
702
1224
  /**
703
- * 标清视频通话时长。单位:秒。
1225
+ * TRTC的SDKAppId。
704
1226
  */
705
- Class1VideoTime: number;
1227
+ SdkAppId: number;
706
1228
  /**
707
- * 高清视频通话时长。单位:秒。
1229
+ * 房间号。
708
1230
  */
709
- Class2VideoTime: number;
1231
+ RoomId: number;
710
1232
  /**
711
- * 超高清视频通话时长。单位:秒。
1233
+ * 要移出的用户列表,最多10个。
712
1234
  */
713
- Class3VideoTime: number;
1235
+ UserIds: Array<string>;
1236
+ }
1237
+ /**
1238
+ * DismissRoom请求参数结构体
1239
+ */
1240
+ export interface DismissRoomRequest {
714
1241
  /**
715
- * 音频通话时长。单位:秒。
1242
+ * TRTC的SDKAppId。
716
1243
  */
717
- AudioTime: number;
1244
+ SdkAppId: number;
718
1245
  /**
719
- * 带宽。单位:Mbps。
1246
+ * 房间号。
720
1247
  */
721
- Bandwidth: number;
1248
+ RoomId: number;
1249
+ }
1250
+ /**
1251
+ * DescribeUnusualEvent请求参数结构体
1252
+ */
1253
+ export interface DescribeUnusualEventRequest {
722
1254
  /**
723
- * 2k视频通话时长。单位:秒。
1255
+ * 用户SdkAppId(如:1400xxxxxx)
724
1256
  */
725
- Video2KTime: number;
1257
+ SdkAppId: number;
726
1258
  /**
727
- * 4k视频通话时长。单位:秒。
1259
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1260
+ 注意:支持查询14天内的数据
728
1261
  */
729
- Video4KTime: number;
1262
+ StartTime: number;
1263
+ /**
1264
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
1265
+ */
1266
+ EndTime: number;
1267
+ /**
1268
+ * 房间号,查询房间内任意20条以内异常体验事件
1269
+ */
1270
+ RoomId?: string;
730
1271
  }
731
1272
  /**
732
- * DescribeRoomInformation返回参数结构体
1273
+ * DescribeCloudRecording请求参数结构体
733
1274
  */
734
- export interface DescribeRoomInformationResponse {
735
- /**
736
- * 返回当页数据总数
737
- */
738
- Total: number;
1275
+ export interface DescribeCloudRecordingRequest {
739
1276
  /**
740
- * 房间信息列表
1277
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
741
1278
  */
742
- RoomList: Array<RoomState>;
1279
+ SdkAppId: number;
743
1280
  /**
744
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1281
+ * 录制任务的唯一Id,在启动录制成功后会返回。
745
1282
  */
746
- RequestId?: string;
1283
+ TaskId: string;
747
1284
  }
748
1285
  /**
749
- * 录制的使用信息。
1286
+ * 腾讯云点播相关参数。
750
1287
  */
751
- export interface RecordUsage {
1288
+ export interface TencentVod {
752
1289
  /**
753
- * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
1290
+ * 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
754
1291
  */
755
- TimeKey: string;
1292
+ Procedure?: string;
756
1293
  /**
757
- * 视频时长-标清SD,单位:秒。
1294
+ * 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
758
1295
  */
759
- Class1VideoTime: number;
1296
+ ExpireTime?: number;
760
1297
  /**
761
- * 视频时长-高清HD,单位:秒。
1298
+ * 指定上传园区,仅适用于对上传地域有特殊需求的用户。
762
1299
  */
763
- Class2VideoTime: number;
1300
+ StorageRegion?: string;
764
1301
  /**
765
- * 视频时长-超清HD,单位:秒。
1302
+ * 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
1303
+ 默认值:0,表示其他分类。
766
1304
  */
767
- Class3VideoTime: number;
1305
+ ClassId?: number;
768
1306
  /**
769
- * 语音时长,单位:秒。
1307
+ * 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
770
1308
  */
771
- AudioTime: number;
1309
+ SubAppId?: number;
1310
+ /**
1311
+ * 任务流上下文,任务完成回调时透传。
1312
+ */
1313
+ SessionContext?: string;
1314
+ /**
1315
+ * 上传上下文,上传完成回调时透传。
1316
+ */
1317
+ SourceContext?: string;
772
1318
  }
773
1319
  /**
774
- * RemoveUser请求参数结构体
1320
+ * StopMCUMixTranscode请求参数结构体
775
1321
  */
776
- export interface RemoveUserRequest {
1322
+ export interface StopMCUMixTranscodeRequest {
777
1323
  /**
778
1324
  * TRTC的SDKAppId。
779
1325
  */
@@ -782,115 +1328,127 @@ export interface RemoveUserRequest {
782
1328
  * 房间号。
783
1329
  */
784
1330
  RoomId: number;
785
- /**
786
- * 要移出的用户列表,最多10个。
787
- */
788
- UserIds: Array<string>;
789
1331
  }
790
1332
  /**
791
- * DescribeRoomInfo请求参数结构体
1333
+ * MCU混流布局参数
792
1334
  */
793
- export interface DescribeRoomInfoRequest {
1335
+ export interface LayoutParams {
794
1336
  /**
795
- * 用户SdkAppId(如:1400xxxxxx)
1337
+ * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
796
1338
  */
797
- SdkAppId: number;
1339
+ Template?: number;
798
1340
  /**
799
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
800
- 注意:支持查询14天内的数据
1341
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
801
1342
  */
802
- StartTime: number;
1343
+ MainVideoUserId?: string;
803
1344
  /**
804
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
805
- 注意:与StartTime间隔时间不超过24小时。
1345
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
806
1346
  */
807
- EndTime: number;
1347
+ MainVideoStreamType?: number;
1348
+ /**
1349
+ * 画中画模板中有效,代表小画面的布局参数。
1350
+ */
1351
+ SmallVideoLayoutParams?: SmallVideoLayoutParams;
1352
+ /**
1353
+ * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
1354
+ */
1355
+ MainVideoRightAlign?: number;
1356
+ /**
1357
+ * 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。
1358
+ */
1359
+ MixVideoUids?: Array<string>;
1360
+ /**
1361
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
1362
+ */
1363
+ PresetLayoutConfig?: Array<PresetLayoutConfig>;
808
1364
  /**
809
- * 房间号(如:223)
1365
+ * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
810
1366
  */
811
- RoomId?: string;
1367
+ PlaceHolderMode?: number;
812
1368
  /**
813
- * 当前页数,默认为0
814
- 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
1369
+ * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
815
1370
  */
816
- PageNumber?: number;
1371
+ PureAudioHoldPlaceMode?: number;
817
1372
  /**
818
- * 每页个数,默认为10,
819
- 范围:[1,100]
1373
+ * 水印参数。
820
1374
  */
821
- PageSize?: number;
1375
+ WaterMarkParams?: WaterMarkParams;
822
1376
  }
823
1377
  /**
824
- * DescribeExternalTrtcMeasure请求参数结构体
1378
+ * 录制的使用信息。
825
1379
  */
826
- export interface DescribeExternalTrtcMeasureRequest {
1380
+ export interface RecordUsage {
827
1381
  /**
828
- * 查询开始日期。
1382
+ * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
829
1383
  */
830
- StartTime: string;
1384
+ TimeKey: string;
831
1385
  /**
832
- * 查询结束日期。
1386
+ * 视频时长-标清SD,单位:秒。
833
1387
  */
834
- EndTime: string;
1388
+ Class1VideoTime: number;
835
1389
  /**
836
- * 对应的应用。如果没有这个参数,表示获取用户名下全部实时音视频应用的汇总。
1390
+ * 视频时长-高清HD,单位:秒。
837
1391
  */
838
- SdkAppId?: number;
1392
+ Class2VideoTime: number;
1393
+ /**
1394
+ * 视频时长-超清HD,单位:秒。
1395
+ */
1396
+ Class3VideoTime: number;
1397
+ /**
1398
+ * 语音时长,单位:秒。
1399
+ */
1400
+ AudioTime: number;
839
1401
  }
840
1402
  /**
841
- * ModifyPicture请求参数结构体
1403
+ * CreateCloudRecording请求参数结构体
842
1404
  */
843
- export interface ModifyPictureRequest {
1405
+ export interface CreateCloudRecordingRequest {
844
1406
  /**
845
- * 图片id
1407
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
846
1408
  */
847
- PictureId: number;
1409
+ SdkAppId: number;
848
1410
  /**
849
- * 应用id
1411
+ * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
850
1412
  */
851
- SdkAppId: number;
1413
+ RoomId: string;
852
1414
  /**
853
- * 图片长度
1415
+ * 录制服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
854
1416
  */
855
- Height?: number;
1417
+ UserId: string;
856
1418
  /**
857
- * 图片宽度
1419
+ * 云端录制加入房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
858
1420
  */
859
- Width?: number;
1421
+ UserSig: string;
860
1422
  /**
861
- * 显示位置x轴方向
1423
+ * 云端录制控制参数。
862
1424
  */
863
- XPosition?: number;
1425
+ RecordParams: RecordParams;
864
1426
  /**
865
- * 显示位置y轴方向
1427
+ * 云端录制文件上传到云存储的参数。
866
1428
  */
867
- YPosition?: number;
868
- }
869
- /**
870
- * 返回的质量数据,时间:值
871
- */
872
- export interface TimeValue {
1429
+ StorageParams: StorageParams;
873
1430
  /**
874
- * 时间,unix时间戳(1590065877s)
1431
+ * TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同:
1432
+ 0: 字符串类型的RoomId
1433
+ 1: 32位整型的RoomId(默认)
875
1434
  */
876
- Time: number;
1435
+ RoomIdType?: number;
877
1436
  /**
878
- * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
1437
+ * 混流的转码参数,录制模式为混流的时候可以设置。
879
1438
  */
880
- Value: number;
881
- }
882
- /**
883
- * StopMCUMixTranscodeByStrRoomId请求参数结构体
884
- */
885
- export interface StopMCUMixTranscodeByStrRoomIdRequest {
1439
+ MixTranscodeParams?: MixTranscodeParams;
886
1440
  /**
887
- * TRTC的SDKAppId。
1441
+ * 混流的布局参数,录制模式为混流的时候可以设置。
888
1442
  */
889
- SdkAppId: number;
1443
+ MixLayoutParams?: MixLayoutParams;
890
1444
  /**
891
- * 字符串房间号。
1445
+ * 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
892
1446
  */
893
- StrRoomId: string;
1447
+ ResourceExpiredHour?: number;
1448
+ /**
1449
+ * TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey](https://cloud.tencent.com/document/product/647/32240) 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
1450
+ */
1451
+ PrivateMapKey?: string;
894
1452
  }
895
1453
  /**
896
1454
  * MCU混流的输出参数
@@ -913,6 +1471,32 @@ export interface OutputParams {
913
1471
  */
914
1472
  RecordAudioOnly?: number;
915
1473
  }
1474
+ /**
1475
+ * DeleteCloudRecording返回参数结构体
1476
+ */
1477
+ export interface DeleteCloudRecordingResponse {
1478
+ /**
1479
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
1480
+ */
1481
+ TaskId: string;
1482
+ /**
1483
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1484
+ */
1485
+ RequestId?: string;
1486
+ }
1487
+ /**
1488
+ * StopMCUMixTranscodeByStrRoomId请求参数结构体
1489
+ */
1490
+ export interface StopMCUMixTranscodeByStrRoomIdRequest {
1491
+ /**
1492
+ * TRTC的SDKAppId。
1493
+ */
1494
+ SdkAppId: number;
1495
+ /**
1496
+ * 字符串房间号。
1497
+ */
1498
+ StrRoomId: string;
1499
+ }
916
1500
  /**
917
1501
  * Es返回的质量数据
918
1502
  */
@@ -936,103 +1520,226 @@ export interface QualityData {
936
1520
  DataType: string;
937
1521
  }
938
1522
  /**
939
- * 造成异常体验可能的异常事件类型
1523
+ * DeletePicture返回参数结构体
940
1524
  */
941
- export interface AbnormalEvent {
1525
+ export interface DeletePictureResponse {
942
1526
  /**
943
- * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
1527
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
944
1528
  */
945
- AbnormalEventId: number;
1529
+ RequestId?: string;
1530
+ }
1531
+ /**
1532
+ * ModifyCloudRecording请求参数结构体
1533
+ */
1534
+ export interface ModifyCloudRecordingRequest {
946
1535
  /**
947
- * 远端用户ID,"":表示异常事件不是由远端用户产生
948
- 注意:此字段可能返回 null,表示取不到有效值。
1536
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
949
1537
  */
950
- PeerId: string;
1538
+ SdkAppId: number;
1539
+ /**
1540
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1541
+ */
1542
+ TaskId: string;
1543
+ /**
1544
+ * 需要更新的混流的布局参数。
1545
+ */
1546
+ MixLayoutParams?: MixLayoutParams;
1547
+ /**
1548
+ * 指定订阅流白名单或者黑名单。
1549
+ */
1550
+ SubscribeStreamUserIds?: SubscribeStreamUserIds;
951
1551
  }
952
1552
  /**
953
- * StopMCUMixTranscodeByStrRoomId返回参数结构体
1553
+ * 录制视频转码参数。
954
1554
  */
955
- export interface StopMCUMixTranscodeByStrRoomIdResponse {
1555
+ export interface VideoParams {
1556
+ /**
1557
+ * 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
1558
+ */
1559
+ Width: number;
1560
+ /**
1561
+ * 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
1562
+ */
1563
+ Height: number;
1564
+ /**
1565
+ * 视频的帧率,范围[1, 60],默认15。
1566
+ */
1567
+ Fps: number;
1568
+ /**
1569
+ * 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
1570
+ */
1571
+ BitRate: number;
1572
+ /**
1573
+ * 视频关键帧时间间隔,单位秒,默认值10秒。
1574
+ */
1575
+ Gop: number;
1576
+ }
1577
+ /**
1578
+ * 旁路转码时长的查询结果
1579
+ */
1580
+ export interface OneSdkAppIdTranscodeTimeUsagesInfo {
1581
+ /**
1582
+ * 旁路转码时长查询结果数组
1583
+ */
1584
+ SdkAppIdTranscodeTimeUsages: Array<SdkAppIdTrtcMcuTranscodeTimeUsage>;
1585
+ /**
1586
+ * 查询记录数量
1587
+ */
1588
+ TotalNum: number;
1589
+ /**
1590
+ * 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
1591
+ */
1592
+ SdkAppId: string;
1593
+ }
1594
+ /**
1595
+ * CreateCloudRecording返回参数结构体
1596
+ */
1597
+ export interface CreateCloudRecordingResponse {
1598
+ /**
1599
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。
1600
+ */
1601
+ TaskId: string;
956
1602
  /**
957
1603
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
958
1604
  */
959
1605
  RequestId?: string;
960
1606
  }
961
1607
  /**
962
- * DeletePicture返回参数结构体
1608
+ * StartMCUMixTranscode返回参数结构体
963
1609
  */
964
- export interface DeletePictureResponse {
1610
+ export interface StartMCUMixTranscodeResponse {
965
1611
  /**
966
1612
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
967
1613
  */
968
1614
  RequestId?: string;
969
1615
  }
970
1616
  /**
971
- * sdk或webrtc的事件列表。
1617
+ * DescribeTrtcMcuTranscodeTime返回参数结构体
972
1618
  */
973
- export interface EventList {
1619
+ export interface DescribeTrtcMcuTranscodeTimeResponse {
974
1620
  /**
975
- * 数据内容
1621
+ * 应用的用量信息数组。
976
1622
  */
977
- Content: Array<EventMessage>;
1623
+ Usages: Array<OneSdkAppIdTranscodeTimeUsagesInfo>;
978
1624
  /**
979
- * 发送端的userId
1625
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
980
1626
  */
981
- PeerId: string;
1627
+ RequestId?: string;
982
1628
  }
983
1629
  /**
984
- * DescribeRoomInfo返回参数结构体
1630
+ * DeleteCloudRecording请求参数结构体
985
1631
  */
986
- export interface DescribeRoomInfoResponse {
1632
+ export interface DeleteCloudRecordingRequest {
987
1633
  /**
988
- * 返回当页数据总数
1634
+ * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
1635
+ */
1636
+ SdkAppId: number;
1637
+ /**
1638
+ * 录制任务的唯一Id,在启动录制成功后会返回。
1639
+ */
1640
+ TaskId: string;
1641
+ }
1642
+ /**
1643
+ * DescribePicture请求参数结构体
1644
+ */
1645
+ export interface DescribePictureRequest {
1646
+ /**
1647
+ * 应用ID
1648
+ */
1649
+ SdkAppId: number;
1650
+ /**
1651
+ * 图片ID,不填时返回该应用下所有图片
1652
+ */
1653
+ PictureId?: number;
1654
+ /**
1655
+ * 每页数量,不填时默认为10
1656
+ */
1657
+ PageSize?: number;
1658
+ /**
1659
+ * 页码,不填时默认为1
1660
+ */
1661
+ PageNo?: number;
1662
+ }
1663
+ /**
1664
+ * DescribeExternalTrtcMeasure返回参数结构体
1665
+ */
1666
+ export interface DescribeExternalTrtcMeasureResponse {
1667
+ /**
1668
+ * 每个SdkAppId的时长使用信息
1669
+ */
1670
+ SdkAppIdTrtrTimeUsages: Array<SdkAppIdNewTrtcTimeUsage>;
1671
+ /**
1672
+ * 主播的用量统计方式。取值"InRoomTime":房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽
1673
+ */
1674
+ AnchorUsageMode: string;
1675
+ /**
1676
+ * 观众的用量统计方式。取值"InRoomTime":在房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽,"MergeWithAnchor":"不区分麦上麦下"
1677
+ */
1678
+ AudienceUsageMode: string;
1679
+ /**
1680
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1681
+ */
1682
+ RequestId?: string;
1683
+ }
1684
+ /**
1685
+ * DescribePicture返回参数结构体
1686
+ */
1687
+ export interface DescribePictureResponse {
1688
+ /**
1689
+ * 返回的图片记录数
989
1690
  */
990
1691
  Total: number;
991
1692
  /**
992
- * 房间信息列表
1693
+ * 图片信息列表
993
1694
  */
994
- RoomList: Array<RoomState>;
1695
+ PictureInfo: Array<PictureInfo>;
995
1696
  /**
996
1697
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
997
1698
  */
998
1699
  RequestId?: string;
999
1700
  }
1000
1701
  /**
1001
- * DismissRoom请求参数结构体
1702
+ * DescribeTrtcMcuTranscodeTime请求参数结构体
1002
1703
  */
1003
- export interface DismissRoomRequest {
1704
+ export interface DescribeTrtcMcuTranscodeTimeRequest {
1004
1705
  /**
1005
- * TRTC的SDKAppId
1706
+ * 查询开始时间,格式为YYYY-MM-DD
1006
1707
  */
1007
- SdkAppId: number;
1708
+ StartTime: string;
1008
1709
  /**
1009
- * 房间号。
1710
+ * 查询结束时间,格式为YYYY-MM-DD。
1711
+ 单次查询统计区间最多不能超过31天。
1010
1712
  */
1011
- RoomId: number;
1713
+ EndTime: string;
1714
+ /**
1715
+ * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
1716
+ */
1717
+ SdkAppId?: number;
1012
1718
  }
1013
1719
  /**
1014
- * DescribeDetailEvent返回参数结构体
1720
+ * DescribeDetailEvent请求参数结构体
1015
1721
  */
1016
- export interface DescribeDetailEventResponse {
1722
+ export interface DescribeDetailEventRequest {
1017
1723
  /**
1018
- * 返回的事件列表,若没有数据,会返回空数组。
1724
+ * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
1725
+ */
1726
+ CommId: string;
1727
+ /**
1728
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1729
+ 注意:支持查询14天内的数据
1019
1730
  */
1020
- Data: Array<EventList>;
1731
+ StartTime: number;
1021
1732
  /**
1022
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1733
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1734
+ 注意:查询时间大于房间结束时间,以房间结束时间为准。
1023
1735
  */
1024
- RequestId?: string;
1025
- }
1026
- /**
1027
- * DismissRoomByStrRoomId请求参数结构体
1028
- */
1029
- export interface DismissRoomByStrRoomIdRequest {
1736
+ EndTime: number;
1030
1737
  /**
1031
- * TRTC的SDKAppId。
1738
+ * 用户UserId
1032
1739
  */
1033
- SdkAppId: number;
1740
+ UserId: string;
1034
1741
  /**
1035
- * 房间号。
1742
+ * 房间号(如:223)
1036
1743
  */
1037
1744
  RoomId: string;
1038
1745
  }
@@ -1074,142 +1781,116 @@ export interface UserInformation {
1074
1781
  Finished: boolean;
1075
1782
  }
1076
1783
  /**
1077
- * DescribeExternalTrtcMeasure返回参数结构体
1784
+ * DescribeScaleInfo请求参数结构体
1078
1785
  */
1079
- export interface DescribeExternalTrtcMeasureResponse {
1080
- /**
1081
- * 每个SdkAppId的时长使用信息
1082
- */
1083
- SdkAppIdTrtrTimeUsages: Array<SdkAppIdNewTrtcTimeUsage>;
1786
+ export interface DescribeScaleInfoRequest {
1084
1787
  /**
1085
- * 主播的用量统计方式。取值"InRoomTime":房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽
1788
+ * 用户SdkAppId(如:1400xxxxxx)
1086
1789
  */
1087
- AnchorUsageMode: string;
1790
+ SdkAppId: number;
1088
1791
  /**
1089
- * 观众的用量统计方式。取值"InRoomTime":在房间时长,"SubscribeTime":"订阅时长","Bandwidth":带宽,"MergeWithAnchor":"不区分麦上麦下"
1792
+ * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1793
+ 注意:支持查询14天内的数据。
1090
1794
  */
1091
- AudienceUsageMode: string;
1795
+ StartTime: number;
1092
1796
  /**
1093
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1797
+ * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
1798
+ 注意:按天统计,结束时间小于前一天,否则查询数据为空(如:需查询20号数据,结束时间需小于20号0点)。
1094
1799
  */
1095
- RequestId?: string;
1800
+ EndTime: number;
1096
1801
  }
1097
1802
  /**
1098
- * DescribeUserEvent返回参数结构体
1803
+ * DismissRoomByStrRoomId返回参数结构体
1099
1804
  */
1100
- export interface DescribeUserEventResponse {
1101
- /**
1102
- * 返回的事件列表,若没有数据,会返回空数组。
1103
- */
1104
- Data: Array<EventList>;
1805
+ export interface DismissRoomByStrRoomIdResponse {
1105
1806
  /**
1106
1807
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1107
1808
  */
1108
1809
  RequestId?: string;
1109
1810
  }
1110
1811
  /**
1111
- * DescribeCallDetailInfo请求参数结构体
1812
+ * DescribeUnusualEvent返回参数结构体
1112
1813
  */
1113
- export interface DescribeCallDetailInfoRequest {
1114
- /**
1115
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
1116
- */
1117
- CommId: string;
1814
+ export interface DescribeUnusualEventResponse {
1118
1815
  /**
1119
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
1120
- 注意:支持查询14天内的数据。
1816
+ * 返回的数据总条数
1817
+ 范围:[0,20]
1121
1818
  */
1122
- StartTime: number;
1819
+ Total: number;
1123
1820
  /**
1124
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1125
- 注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
1821
+ * 异常体验列表
1126
1822
  */
1127
- EndTime: number;
1823
+ AbnormalExperienceList: Array<AbnormalExperience>;
1128
1824
  /**
1129
- * 用户SdkAppId(如:1400xxxxxx)。
1825
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1130
1826
  */
1131
- SdkAppId: number;
1827
+ RequestId?: string;
1828
+ }
1829
+ /**
1830
+ * ModifyCloudRecording返回参数结构体
1831
+ */
1832
+ export interface ModifyCloudRecordingResponse {
1132
1833
  /**
1133
- * 需查询的用户数组,默认不填返回6个用户。
1834
+ * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
1134
1835
  */
1135
- UserIds?: Array<string>;
1836
+ TaskId: string;
1136
1837
  /**
1137
- * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
1138
- appCpu:APP CPU使用率;
1139
- sysCpu:系统 CPU使用率;
1140
- aBit:上/下行音频码率;单位:bps
1141
- aBlock:音频卡顿时长;单位:ms
1142
- bigvBit:上/下行视频码率;单位:bps
1143
- bigvCapFps:视频采集帧率;
1144
- bigvEncFps:视频发送帧率;
1145
- bigvDecFps:渲染帧率;
1146
- bigvBlock:视频卡顿时长;单位:ms
1147
- aLoss:上/下行音频丢包率;
1148
- bigvLoss:上/下行视频丢包率;
1149
- bigvWidth:上/下行分辨率宽;
1150
- bigvHeight:上/下行分辨率高
1838
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1151
1839
  */
1152
- DataType?: Array<string>;
1840
+ RequestId?: string;
1841
+ }
1842
+ /**
1843
+ * 造成异常体验可能的异常事件类型
1844
+ */
1845
+ export interface AbnormalEvent {
1153
1846
  /**
1154
- * 当前页数,默认为0,
1155
- 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
1847
+ * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
1156
1848
  */
1157
- PageNumber?: number;
1849
+ AbnormalEventId: number;
1158
1850
  /**
1159
- * 每页个数,默认为6,
1160
- 范围:[1,100]
1161
- 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
1162
- DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
1851
+ * 远端用户ID,"":表示异常事件不是由远端用户产生
1852
+ 注意:此字段可能返回 null,表示取不到有效值。
1163
1853
  */
1164
- PageSize?: number;
1854
+ PeerId: string;
1165
1855
  }
1166
1856
  /**
1167
- * DescribePicture请求参数结构体
1857
+ * DescribeCloudRecording返回参数结构体
1168
1858
  */
1169
- export interface DescribePictureRequest {
1859
+ export interface DescribeCloudRecordingResponse {
1170
1860
  /**
1171
- * 应用ID
1861
+ * 录制任务的唯一Id。
1172
1862
  */
1173
- SdkAppId: number;
1863
+ TaskId: string;
1174
1864
  /**
1175
- * 图片ID,不填时返回该应用下所有图片
1865
+ * 云端录制任务的状态信息。
1866
+ Idle:表示当前录制任务空闲中
1867
+ InProgress:表示当前录制任务正在进行中。
1868
+ Exited:表示当前录制任务正在退出的过程中。
1176
1869
  */
1177
- PictureId?: number;
1870
+ Status: string;
1178
1871
  /**
1179
- * 每页数量,不填时默认为10
1872
+ * 录制文件信息。
1873
+ 注意:此字段可能返回 null,表示取不到有效值。
1180
1874
  */
1181
- PageSize?: number;
1875
+ StorageFileList: Array<StorageFile>;
1182
1876
  /**
1183
- * 页码,不填时默认为1
1877
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1184
1878
  */
1185
- PageNo?: number;
1879
+ RequestId?: string;
1186
1880
  }
1187
1881
  /**
1188
- * DescribeUnusualEvent请求参数结构体
1882
+ * DismissRoom返回参数结构体
1189
1883
  */
1190
- export interface DescribeUnusualEventRequest {
1191
- /**
1192
- * 用户SdkAppId(如:1400xxxxxx)
1193
- */
1194
- SdkAppId: number;
1195
- /**
1196
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1197
- 注意:支持查询14天内的数据
1198
- */
1199
- StartTime: number;
1200
- /**
1201
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
1202
- */
1203
- EndTime: number;
1884
+ export interface DismissRoomResponse {
1204
1885
  /**
1205
- * 房间号,查询房间内任意20条以内异常体验事件
1886
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1206
1887
  */
1207
- RoomId?: string;
1888
+ RequestId?: string;
1208
1889
  }
1209
1890
  /**
1210
- * DescribeUserInfo返回参数结构体
1891
+ * DescribeUserInformation返回参数结构体
1211
1892
  */
1212
- export interface DescribeUserInfoResponse {
1893
+ export interface DescribeUserInformationResponse {
1213
1894
  /**
1214
1895
  * 返回的用户总条数
1215
1896
  */
@@ -1225,264 +1906,227 @@ export interface DescribeUserInfoResponse {
1225
1906
  RequestId?: string;
1226
1907
  }
1227
1908
  /**
1228
- * 画中画模板中有效,代表小画面的布局参数
1909
+ * DescribeCallDetail返回参数结构体
1229
1910
  */
1230
- export interface SmallVideoLayoutParams {
1231
- /**
1232
- * 代表小画面对应的用户ID。
1233
- */
1234
- UserId: string;
1235
- /**
1236
- * 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
1237
- */
1238
- StreamType: number;
1239
- /**
1240
- * 小画面在输出时的宽度,单位为像素值,不填默认为0。
1241
- */
1242
- ImageWidth?: number;
1911
+ export interface DescribeCallDetailResponse {
1243
1912
  /**
1244
- * 小画面在输出时的高度,单位为像素值,不填默认为0。
1913
+ * 返回的用户总条数
1245
1914
  */
1246
- ImageHeight?: number;
1915
+ Total: number;
1247
1916
  /**
1248
- * 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
1917
+ * 用户信息列表
1918
+ 注意:此字段可能返回 null,表示取不到有效值。
1249
1919
  */
1250
- LocationX?: number;
1920
+ UserList: Array<UserInformation>;
1251
1921
  /**
1252
- * 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
1922
+ * 质量数据
1923
+ 注意:此字段可能返回 null,表示取不到有效值。
1253
1924
  */
1254
- LocationY?: number;
1255
- }
1256
- /**
1257
- * RemoveUser返回参数结构体
1258
- */
1259
- export interface RemoveUserResponse {
1925
+ Data: Array<QualityData>;
1260
1926
  /**
1261
1927
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1262
1928
  */
1263
1929
  RequestId?: string;
1264
1930
  }
1265
1931
  /**
1266
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
1932
+ * DeletePicture请求参数结构体
1267
1933
  */
1268
- export interface PresetLayoutConfig {
1269
- /**
1270
- * 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
1271
- */
1272
- UserId?: string;
1273
- /**
1274
- * 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
1275
- */
1276
- StreamType?: number;
1277
- /**
1278
- * 该画面在输出时的宽度,单位为像素值,不填默认为0。
1279
- */
1280
- ImageWidth?: number;
1281
- /**
1282
- * 该画面在输出时的高度,单位为像素值,不填默认为0。
1283
- */
1284
- ImageHeight?: number;
1285
- /**
1286
- * 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
1287
- */
1288
- LocationX?: number;
1289
- /**
1290
- * 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
1291
- */
1292
- LocationY?: number;
1934
+ export interface DeletePictureRequest {
1293
1935
  /**
1294
- * 该画面在输出时的层级,不填默认为0。
1936
+ * 图片id
1295
1937
  */
1296
- ZOrder?: number;
1938
+ PictureId: number;
1297
1939
  /**
1298
- * 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
1940
+ * 应用id
1299
1941
  */
1300
- RenderMode?: number;
1942
+ SdkAppId: number;
1943
+ }
1944
+ /**
1945
+ * DescribeRoomInformation返回参数结构体
1946
+ */
1947
+ export interface DescribeRoomInformationResponse {
1301
1948
  /**
1302
- * 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。
1949
+ * 返回当页数据总数
1303
1950
  */
1304
- MixInputType?: number;
1951
+ Total: number;
1305
1952
  /**
1306
- * 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
1953
+ * 房间信息列表
1307
1954
  */
1308
- PlaceImageId?: number;
1309
- }
1310
- /**
1311
- * StopMCUMixTranscode返回参数结构体
1312
- */
1313
- export interface StopMCUMixTranscodeResponse {
1955
+ RoomList: Array<RoomState>;
1314
1956
  /**
1315
1957
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1316
1958
  */
1317
1959
  RequestId?: string;
1318
1960
  }
1319
1961
  /**
1320
- * DescribeCallDetail返回参数结构体
1962
+ * DescribeExternalTrtcMeasure请求参数结构体
1321
1963
  */
1322
- export interface DescribeCallDetailResponse {
1323
- /**
1324
- * 返回的用户总条数
1325
- */
1326
- Total: number;
1964
+ export interface DescribeExternalTrtcMeasureRequest {
1327
1965
  /**
1328
- * 用户信息列表
1329
- 注意:此字段可能返回 null,表示取不到有效值。
1966
+ * 查询开始日期。
1330
1967
  */
1331
- UserList: Array<UserInformation>;
1332
- /**
1333
- * 质量数据
1334
- 注意:此字段可能返回 null,表示取不到有效值。
1968
+ StartTime: string;
1969
+ /**
1970
+ * 查询结束日期。
1335
1971
  */
1336
- Data: Array<QualityData>;
1972
+ EndTime: string;
1337
1973
  /**
1338
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1974
+ * 对应的应用。如果没有这个参数,表示获取用户名下全部实时音视频应用的汇总。
1339
1975
  */
1340
- RequestId?: string;
1976
+ SdkAppId?: number;
1341
1977
  }
1342
1978
  /**
1343
- * 旁路转码时长的查询结果
1979
+ * RemoveUserByStrRoomId请求参数结构体
1344
1980
  */
1345
- export interface OneSdkAppIdTranscodeTimeUsagesInfo {
1981
+ export interface RemoveUserByStrRoomIdRequest {
1346
1982
  /**
1347
- * 旁路转码时长查询结果数组
1983
+ * TRTC的SDKAppId。
1348
1984
  */
1349
- SdkAppIdTranscodeTimeUsages: Array<SdkAppIdTrtcMcuTranscodeTimeUsage>;
1985
+ SdkAppId: number;
1350
1986
  /**
1351
- * 查询记录数量
1987
+ * 房间号。
1352
1988
  */
1353
- TotalNum: number;
1989
+ RoomId: string;
1354
1990
  /**
1355
- * 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
1991
+ * 要移出的用户列表,最多10个。
1356
1992
  */
1357
- SdkAppId: string;
1993
+ UserIds: Array<string>;
1358
1994
  }
1359
1995
  /**
1360
- * DescribePicture返回参数结构体
1996
+ * 云端录制控制参数。
1361
1997
  */
1362
- export interface DescribePictureResponse {
1998
+ export interface RecordParams {
1363
1999
  /**
1364
- * 返回的图片记录数
2000
+ * 录制模式:
2001
+ 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件(M3U8/TS)上传至云存储;
2002
+ 2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件[M3U8/TS]上传至云存储;
1365
2003
  */
1366
- Total: number;
2004
+ RecordMode: number;
1367
2005
  /**
1368
- * 图片信息列表
2006
+ * 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
1369
2007
  */
1370
- PictureInfo: Array<PictureInfo>;
2008
+ MaxIdleTime?: number;
1371
2009
  /**
1372
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2010
+ * 录制的媒体流类型:
2011
+ 0:录制音频+视频流(默认);
2012
+ 1:仅录制音频流;
2013
+ 2:仅录制视频流,
1373
2014
  */
1374
- RequestId?: string;
2015
+ StreamType?: number;
2016
+ /**
2017
+ * 指定订阅流白名单或者黑名单。
2018
+ */
2019
+ SubscribeStreamUserIds?: SubscribeStreamUserIds;
2020
+ /**
2021
+ * 输出文件的格式。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4(hls录制完成后转mp4文件)
2022
+ */
2023
+ OutputFormat?: number;
1375
2024
  }
1376
2025
  /**
1377
- * 第三方CDN转推参数
2026
+ * DescribeUserEvent返回参数结构体
1378
2027
  */
1379
- export interface PublishCdnParams {
2028
+ export interface DescribeUserEventResponse {
1380
2029
  /**
1381
- * 腾讯云直播BizId。
2030
+ * 返回的事件列表,若没有数据,会返回空数组。
1382
2031
  */
1383
- BizId: number;
2032
+ Data: Array<EventList>;
1384
2033
  /**
1385
- * 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。
2034
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1386
2035
  */
1387
- PublishCdnUrls: Array<string>;
2036
+ RequestId?: string;
1388
2037
  }
1389
2038
  /**
1390
- * DescribeRoomInformation请求参数结构体
2039
+ * SdkAppId级别录制时长数据。
1391
2040
  */
1392
- export interface DescribeRoomInformationRequest {
2041
+ export interface SdkAppIdRecordUsage {
1393
2042
  /**
1394
- * 用户SdkAppId(如:1400xxxxxx)
2043
+ * SdkAppId的值。
1395
2044
  */
1396
2045
  SdkAppId: string;
1397
2046
  /**
1398
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1399
- 注意:支持查询14天内的数据
1400
- */
1401
- StartTime: number;
1402
- /**
1403
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1404
- 注意:与StartTime间隔时间不超过24小时。
2047
+ * 统计的时间点数据。
1405
2048
  */
1406
- EndTime: number;
2049
+ Usages: Array<RecordUsage>;
2050
+ }
2051
+ /**
2052
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
2053
+ */
2054
+ export interface PresetLayoutConfig {
1407
2055
  /**
1408
- * 房间号(如:223)
2056
+ * 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
1409
2057
  */
1410
- RoomId?: string;
2058
+ UserId?: string;
1411
2059
  /**
1412
- * 当前页数,默认为0
1413
- 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
2060
+ * 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
1414
2061
  */
1415
- PageNumber?: string;
2062
+ StreamType?: number;
1416
2063
  /**
1417
- * 每页个数,默认为10,
1418
- 范围:[1,100]
2064
+ * 该画面在输出时的宽度,单位为像素值,不填默认为0。
1419
2065
  */
1420
- PageSize?: string;
1421
- }
1422
- /**
1423
- * DescribeUserInfo请求参数结构体
1424
- */
1425
- export interface DescribeUserInfoRequest {
2066
+ ImageWidth?: number;
1426
2067
  /**
1427
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
2068
+ * 该画面在输出时的高度,单位为像素值,不填默认为0。
1428
2069
  */
1429
- CommId: string;
2070
+ ImageHeight?: number;
1430
2071
  /**
1431
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1432
- 注意:支持查询14天内的数据
2072
+ * 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
1433
2073
  */
1434
- StartTime: number;
2074
+ LocationX?: number;
1435
2075
  /**
1436
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1437
- 注意:与StartTime间隔时间不超过4小时。
2076
+ * 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
1438
2077
  */
1439
- EndTime: number;
2078
+ LocationY?: number;
1440
2079
  /**
1441
- * 用户SdkAppId(如:1400xxxxxx)
2080
+ * 该画面在输出时的层级,不填默认为0。
1442
2081
  */
1443
- SdkAppId: number;
2082
+ ZOrder?: number;
1444
2083
  /**
1445
- * 需查询的用户数组,不填默认返回6个用户
1446
- 范围:[1,100]。
2084
+ * 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
1447
2085
  */
1448
- UserIds?: Array<string>;
2086
+ RenderMode?: number;
1449
2087
  /**
1450
- * 当前页数,默认为0
1451
- 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
2088
+ * 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。
1452
2089
  */
1453
- PageNumber?: number;
2090
+ MixInputType?: number;
1454
2091
  /**
1455
- * 每页个数,默认为6,
1456
- 范围:[1,100]。
2092
+ * 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
1457
2093
  */
1458
- PageSize?: number;
2094
+ PlaceImageId?: number;
1459
2095
  }
1460
2096
  /**
1461
- * DescribeDetailEvent请求参数结构体
2097
+ * 录制音频转码参数。
1462
2098
  */
1463
- export interface DescribeDetailEventRequest {
2099
+ export interface AudioParams {
1464
2100
  /**
1465
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
2101
+ * 音频采样率:
2102
+ 1:48000Hz(默认);
2103
+ 2:44100Hz
2104
+ 3:16000Hz。
1466
2105
  */
1467
- CommId: string;
2106
+ SampleRate: number;
1468
2107
  /**
1469
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1470
- 注意:支持查询14天内的数据
2108
+ * 声道数:
2109
+ 1:单声道;
2110
+ 2:双声道(默认)。
1471
2111
  */
1472
- StartTime: number;
2112
+ Channel: number;
1473
2113
  /**
1474
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1475
- 注意:查询时间大于房间结束时间,以房间结束时间为准。
2114
+ * 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。
1476
2115
  */
1477
- EndTime: number;
2116
+ BitRate: number;
2117
+ }
2118
+ /**
2119
+ * 第三方CDN转推参数
2120
+ */
2121
+ export interface PublishCdnParams {
1478
2122
  /**
1479
- * 用户UserId
2123
+ * 腾讯云直播BizId。
1480
2124
  */
1481
- UserId: string;
2125
+ BizId: number;
1482
2126
  /**
1483
- * 房间号(如:223)
2127
+ * 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。
1484
2128
  */
1485
- RoomId: string;
2129
+ PublishCdnUrls: Array<string>;
1486
2130
  }
1487
2131
  /**
1488
2132
  * 用户的异常体验及可能的原因
@@ -1509,15 +2153,6 @@ export interface AbnormalExperience {
1509
2153
  */
1510
2154
  EventTime: number;
1511
2155
  }
1512
- /**
1513
- * StartMCUMixTranscode返回参数结构体
1514
- */
1515
- export interface StartMCUMixTranscodeResponse {
1516
- /**
1517
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1518
- */
1519
- RequestId?: string;
1520
- }
1521
2156
  /**
1522
2157
  * 房间信息列表
1523
2158
  */
@@ -1561,51 +2196,9 @@ export interface CreatePictureResponse {
1561
2196
  RequestId?: string;
1562
2197
  }
1563
2198
  /**
1564
- * MCU混流水印参数
1565
- */
1566
- export interface WaterMarkParams {
1567
- /**
1568
- * 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。
1569
- */
1570
- WaterMarkId: number;
1571
- /**
1572
- * 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。
1573
- */
1574
- WaterMarkWidth: number;
1575
- /**
1576
- * 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。
1577
- */
1578
- WaterMarkHeight: number;
1579
- /**
1580
- * 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。
1581
- */
1582
- LocationX: number;
1583
- /**
1584
- * 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。
1585
- */
1586
- LocationY: number;
1587
- /**
1588
- * 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。
1589
- */
1590
- WaterMarkUrl?: string;
1591
- }
1592
- /**
1593
- * DescribeRecordStatistic返回参数结构体
1594
- */
1595
- export interface DescribeRecordStatisticResponse {
1596
- /**
1597
- * 应用的用量信息数组。
1598
- */
1599
- SdkAppIdUsages: Array<SdkAppIdRecordUsage>;
1600
- /**
1601
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1602
- */
1603
- RequestId?: string;
1604
- }
1605
- /**
1606
- * DismissRoomByStrRoomId返回参数结构体
2199
+ * RemoveUser返回参数结构体
1607
2200
  */
1608
- export interface DismissRoomByStrRoomIdResponse {
2201
+ export interface RemoveUserResponse {
1609
2202
  /**
1610
2203
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1611
2204
  */
@@ -1629,59 +2222,3 @@ export interface DescribeHistoryScaleResponse {
1629
2222
  */
1630
2223
  RequestId?: string;
1631
2224
  }
1632
- /**
1633
- * DescribeUnusualEvent返回参数结构体
1634
- */
1635
- export interface DescribeUnusualEventResponse {
1636
- /**
1637
- * 返回的数据总条数
1638
- 范围:[0,20]
1639
- */
1640
- Total: number;
1641
- /**
1642
- * 异常体验列表
1643
- */
1644
- AbnormalExperienceList: Array<AbnormalExperience>;
1645
- /**
1646
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1647
- */
1648
- RequestId?: string;
1649
- }
1650
- /**
1651
- * StartMCUMixTranscodeByStrRoomId返回参数结构体
1652
- */
1653
- export interface StartMCUMixTranscodeByStrRoomIdResponse {
1654
- /**
1655
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1656
- */
1657
- RequestId?: string;
1658
- }
1659
- /**
1660
- * 图片列表信息
1661
- */
1662
- export interface PictureInfo {
1663
- /**
1664
- * 图片长度
1665
- */
1666
- Height: number;
1667
- /**
1668
- * 图片宽度
1669
- */
1670
- Width: number;
1671
- /**
1672
- * 显示位置x轴方向
1673
- */
1674
- XPosition: number;
1675
- /**
1676
- * 显示位置y轴方向
1677
- */
1678
- YPosition: number;
1679
- /**
1680
- * 应用id
1681
- */
1682
- SdkAppId: number;
1683
- /**
1684
- * 图片id
1685
- */
1686
- PictureId: number;
1687
- }