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