tencentcloud-sdk-nodejs-trtc 4.0.371 → 4.0.372

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