tencentcloud-sdk-nodejs-trtc 4.0.608 → 4.0.619
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.
- package/CHANGELOG.md +2541 -0
- package/SERVICE_CHANGELOG.md +2238 -68
- package/package.json +1 -1
- package/products.md +70 -70
- package/src/services/trtc/v20190722/trtc_models.ts +140 -539
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +140 -138
|
@@ -40,9 +40,9 @@ export interface DescribeRelayUsageRequest {
|
|
|
40
40
|
*/
|
|
41
41
|
StartTime: string;
|
|
42
42
|
/**
|
|
43
|
-
|
|
43
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
44
44
|
单次查询统计区间最多不能超过31天。
|
|
45
|
-
|
|
45
|
+
*/
|
|
46
46
|
EndTime: string;
|
|
47
47
|
/**
|
|
48
48
|
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
@@ -54,9 +54,9 @@ export interface DescribeRelayUsageRequest {
|
|
|
54
54
|
*/
|
|
55
55
|
export interface DescribeTRTCMarketQualityMetricDataResponse {
|
|
56
56
|
/**
|
|
57
|
-
|
|
57
|
+
* TRTC监控数据出参
|
|
58
58
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
59
|
-
|
|
59
|
+
*/
|
|
60
60
|
Data: TRTCDataResp;
|
|
61
61
|
/**
|
|
62
62
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -92,20 +92,20 @@ export interface MixLayout {
|
|
|
92
92
|
*/
|
|
93
93
|
Alpha?: number;
|
|
94
94
|
/**
|
|
95
|
-
|
|
95
|
+
* 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
|
|
96
96
|
|
|
97
97
|
1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
|
|
98
98
|
|
|
99
99
|
2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
|
|
100
100
|
|
|
101
101
|
3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
|
|
102
|
-
|
|
102
|
+
*/
|
|
103
103
|
RenderMode?: number;
|
|
104
104
|
/**
|
|
105
|
-
|
|
105
|
+
* 对应订阅流的主辅路标识:
|
|
106
106
|
0:主流(默认);
|
|
107
107
|
1:辅流;
|
|
108
|
-
|
|
108
|
+
*/
|
|
109
109
|
MediaId?: number;
|
|
110
110
|
/**
|
|
111
111
|
* 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
|
|
@@ -129,7 +129,7 @@ export interface McuVideoParams {
|
|
|
129
129
|
*/
|
|
130
130
|
LayoutParams?: McuLayoutParams;
|
|
131
131
|
/**
|
|
132
|
-
|
|
132
|
+
* 整个画布背景颜色,常用的颜色有:
|
|
133
133
|
红色:0xcc0033。
|
|
134
134
|
黄色:0xcc9900。
|
|
135
135
|
绿色:0xcccc33。
|
|
@@ -137,7 +137,7 @@ export interface McuVideoParams {
|
|
|
137
137
|
黑色:0x000000。
|
|
138
138
|
白色:0xFFFFFF。
|
|
139
139
|
灰色:0x999999。
|
|
140
|
-
|
|
140
|
+
*/
|
|
141
141
|
BackGroundColor?: string;
|
|
142
142
|
/**
|
|
143
143
|
* 整个画布的背景图url,优先级高于BackGroundColor。
|
|
@@ -188,14 +188,14 @@ export interface DescribeUserEventRequest {
|
|
|
188
188
|
*/
|
|
189
189
|
CommId: string;
|
|
190
190
|
/**
|
|
191
|
-
|
|
191
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
192
192
|
注意:支持查询14天内的数据
|
|
193
|
-
|
|
193
|
+
*/
|
|
194
194
|
StartTime: number;
|
|
195
195
|
/**
|
|
196
|
-
|
|
196
|
+
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
197
197
|
注意:查询时间大于房间结束时间,以房间结束时间为准。
|
|
198
|
-
|
|
198
|
+
*/
|
|
199
199
|
EndTime: number;
|
|
200
200
|
/**
|
|
201
201
|
* 用户UserId
|
|
@@ -282,9 +282,9 @@ export interface AbnormalEvent {
|
|
|
282
282
|
*/
|
|
283
283
|
AbnormalEventId: number;
|
|
284
284
|
/**
|
|
285
|
-
|
|
285
|
+
* 远端用户ID,"":表示异常事件不是由远端用户产生
|
|
286
286
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
287
|
-
|
|
287
|
+
*/
|
|
288
288
|
PeerId: string;
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
@@ -296,19 +296,19 @@ export interface ScaleInfomation {
|
|
|
296
296
|
*/
|
|
297
297
|
Time: number;
|
|
298
298
|
/**
|
|
299
|
-
|
|
299
|
+
* 房间人数,用户重复进入同一个房间为1次
|
|
300
300
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
301
|
-
|
|
301
|
+
*/
|
|
302
302
|
UserNumber: number;
|
|
303
303
|
/**
|
|
304
|
-
|
|
304
|
+
* 房间人次,用户每次进入房间为一次
|
|
305
305
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
306
|
-
|
|
306
|
+
*/
|
|
307
307
|
UserCount: number;
|
|
308
308
|
/**
|
|
309
|
-
|
|
309
|
+
* sdkappid下一天内的房间数
|
|
310
310
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
311
|
-
|
|
311
|
+
*/
|
|
312
312
|
RoomNumbers: number;
|
|
313
313
|
}
|
|
314
314
|
/**
|
|
@@ -417,14 +417,14 @@ export interface DescribeCallDetailInfoRequest {
|
|
|
417
417
|
*/
|
|
418
418
|
CommId: string;
|
|
419
419
|
/**
|
|
420
|
-
|
|
420
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
|
|
421
421
|
注意:支持查询14天内的数据。
|
|
422
|
-
|
|
422
|
+
*/
|
|
423
423
|
StartTime: number;
|
|
424
424
|
/**
|
|
425
|
-
|
|
425
|
+
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
426
426
|
注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
|
|
427
|
-
|
|
427
|
+
*/
|
|
428
428
|
EndTime: number;
|
|
429
429
|
/**
|
|
430
430
|
* 用户SdkAppId(如:1400xxxxxx)。
|
|
@@ -435,7 +435,7 @@ export interface DescribeCallDetailInfoRequest {
|
|
|
435
435
|
*/
|
|
436
436
|
UserIds?: Array<string>;
|
|
437
437
|
/**
|
|
438
|
-
|
|
438
|
+
* 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
|
|
439
439
|
appCpu:APP CPU使用率;
|
|
440
440
|
sysCpu:系统 CPU使用率;
|
|
441
441
|
aBit:上/下行音频码率;单位:bps
|
|
@@ -449,19 +449,19 @@ export interface DescribeCallDetailInfoRequest {
|
|
|
449
449
|
bigvLoss:上/下行视频丢包率;
|
|
450
450
|
bigvWidth:上/下行分辨率宽;
|
|
451
451
|
bigvHeight:上/下行分辨率高
|
|
452
|
-
|
|
452
|
+
*/
|
|
453
453
|
DataType?: Array<string>;
|
|
454
454
|
/**
|
|
455
|
-
|
|
455
|
+
* 当前页数,默认为0,
|
|
456
456
|
注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
|
|
457
|
-
|
|
457
|
+
*/
|
|
458
458
|
PageNumber?: number;
|
|
459
459
|
/**
|
|
460
|
-
|
|
460
|
+
* 每页个数,默认为6,
|
|
461
461
|
范围:[1,100]
|
|
462
462
|
注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
|
|
463
463
|
DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
|
|
464
|
-
|
|
464
|
+
*/
|
|
465
465
|
PageSize?: number;
|
|
466
466
|
}
|
|
467
467
|
/**
|
|
@@ -502,33 +502,33 @@ export interface DescribeUserInfoRequest {
|
|
|
502
502
|
*/
|
|
503
503
|
CommId: string;
|
|
504
504
|
/**
|
|
505
|
-
|
|
505
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
506
506
|
注意:支持查询14天内的数据
|
|
507
|
-
|
|
507
|
+
*/
|
|
508
508
|
StartTime: number;
|
|
509
509
|
/**
|
|
510
|
-
|
|
510
|
+
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
511
511
|
注意:与StartTime间隔时间不超过4小时。
|
|
512
|
-
|
|
512
|
+
*/
|
|
513
513
|
EndTime: number;
|
|
514
514
|
/**
|
|
515
515
|
* 用户SdkAppId(如:1400xxxxxx)
|
|
516
516
|
*/
|
|
517
517
|
SdkAppId: number;
|
|
518
518
|
/**
|
|
519
|
-
|
|
519
|
+
* 需查询的用户数组,不填默认返回6个用户
|
|
520
520
|
范围:[1,100]。
|
|
521
|
-
|
|
521
|
+
*/
|
|
522
522
|
UserIds?: Array<string>;
|
|
523
523
|
/**
|
|
524
|
-
|
|
524
|
+
* 当前页数,默认为0,
|
|
525
525
|
注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
|
|
526
|
-
|
|
526
|
+
*/
|
|
527
527
|
PageNumber?: number;
|
|
528
528
|
/**
|
|
529
|
-
|
|
529
|
+
* 每页个数,默认为6,
|
|
530
530
|
范围:[1,100]。
|
|
531
|
-
|
|
531
|
+
*/
|
|
532
532
|
PageSize?: number;
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
@@ -587,9 +587,9 @@ export interface StartMCUMixTranscodeByStrRoomIdResponse {
|
|
|
587
587
|
*/
|
|
588
588
|
export interface CloudStorage {
|
|
589
589
|
/**
|
|
590
|
-
|
|
590
|
+
* 第三方云储存的供应商:
|
|
591
591
|
0:腾讯云存储 COS,暂不支持其他家。
|
|
592
|
-
|
|
592
|
+
*/
|
|
593
593
|
Vendor: number;
|
|
594
594
|
/**
|
|
595
595
|
* 第三方云存储的地域信息。
|
|
@@ -601,10 +601,12 @@ export interface CloudStorage {
|
|
|
601
601
|
Bucket: string;
|
|
602
602
|
/**
|
|
603
603
|
* 第三方存储的access_key账号信息。
|
|
604
|
+
若存储至腾讯云COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建
|
|
604
605
|
*/
|
|
605
606
|
AccessKey: string;
|
|
606
607
|
/**
|
|
607
608
|
* 第三方存储的secret_key账号信息。
|
|
609
|
+
若存储至腾讯云COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建
|
|
608
610
|
*/
|
|
609
611
|
SecretKey: string;
|
|
610
612
|
/**
|
|
@@ -672,10 +674,10 @@ export interface DescribeTRTCMarketQualityMetricDataRequest {
|
|
|
672
674
|
*/
|
|
673
675
|
EndTime: string;
|
|
674
676
|
/**
|
|
675
|
-
|
|
677
|
+
* 返回数据的粒度,支持设为以下值:
|
|
676
678
|
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
677
679
|
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
678
|
-
|
|
680
|
+
*/
|
|
679
681
|
Period: string;
|
|
680
682
|
}
|
|
681
683
|
/**
|
|
@@ -683,12 +685,12 @@ export interface DescribeTRTCMarketQualityMetricDataRequest {
|
|
|
683
685
|
*/
|
|
684
686
|
export interface EventMessage {
|
|
685
687
|
/**
|
|
686
|
-
|
|
688
|
+
* 视频流类型:
|
|
687
689
|
0:与视频无关的事件;
|
|
688
690
|
2:视频为大画面;
|
|
689
691
|
3:视频为小画面;
|
|
690
692
|
7:视频为旁路画面;
|
|
691
|
-
|
|
693
|
+
*/
|
|
692
694
|
Type: number;
|
|
693
695
|
/**
|
|
694
696
|
* 事件上报的时间戳,unix时间(1589891188801ms)
|
|
@@ -716,9 +718,9 @@ export interface DescribeRecordStatisticRequest {
|
|
|
716
718
|
*/
|
|
717
719
|
StartTime: string;
|
|
718
720
|
/**
|
|
719
|
-
|
|
721
|
+
* 查询结束日期,格式为YYYY-MM-DD。
|
|
720
722
|
单次查询统计区间最多不能超过31天。
|
|
721
|
-
|
|
723
|
+
*/
|
|
722
724
|
EndTime: string;
|
|
723
725
|
/**
|
|
724
726
|
* 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
|
|
@@ -734,28 +736,28 @@ export interface DescribeRoomInfoRequest {
|
|
|
734
736
|
*/
|
|
735
737
|
SdkAppId: number;
|
|
736
738
|
/**
|
|
737
|
-
|
|
739
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
738
740
|
注意:支持查询14天内的数据
|
|
739
|
-
|
|
741
|
+
*/
|
|
740
742
|
StartTime: number;
|
|
741
743
|
/**
|
|
742
|
-
|
|
744
|
+
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
743
745
|
注意:与StartTime间隔时间不超过24小时。
|
|
744
|
-
|
|
746
|
+
*/
|
|
745
747
|
EndTime: number;
|
|
746
748
|
/**
|
|
747
749
|
* 房间号(如:223)
|
|
748
750
|
*/
|
|
749
751
|
RoomId?: string;
|
|
750
752
|
/**
|
|
751
|
-
|
|
753
|
+
* 当前页数,默认为0,
|
|
752
754
|
注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
|
|
753
|
-
|
|
755
|
+
*/
|
|
754
756
|
PageNumber?: number;
|
|
755
757
|
/**
|
|
756
|
-
|
|
758
|
+
* 每页个数,默认为10,
|
|
757
759
|
范围:[1,100]
|
|
758
|
-
|
|
760
|
+
*/
|
|
759
761
|
PageSize?: number;
|
|
760
762
|
}
|
|
761
763
|
/**
|
|
@@ -834,7 +836,7 @@ export interface EncodeParams {
|
|
|
834
836
|
*/
|
|
835
837
|
VideoGop?: number;
|
|
836
838
|
/**
|
|
837
|
-
|
|
839
|
+
* 混流-输出流背景色,取值是十进制整数。常用的颜色有:
|
|
838
840
|
红色:0xff0000,对应的十进制整数是16724736。
|
|
839
841
|
黄色:0xffff00。对应的十进制整数是16776960。
|
|
840
842
|
绿色:0x33cc00。对应的十进制整数是3394560。
|
|
@@ -842,7 +844,7 @@ export interface EncodeParams {
|
|
|
842
844
|
黑色:0x000000。对应的十进制整数是0。
|
|
843
845
|
白色:0xFFFFFF。对应的十进制整数是16777215。
|
|
844
846
|
灰色:0x999999。对应的十进制整数是10066329。
|
|
845
|
-
|
|
847
|
+
*/
|
|
846
848
|
BackgroundColor?: number;
|
|
847
849
|
/**
|
|
848
850
|
* 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
|
|
@@ -866,14 +868,14 @@ export interface DescribeCallDetailInfoResponse {
|
|
|
866
868
|
*/
|
|
867
869
|
Total: number;
|
|
868
870
|
/**
|
|
869
|
-
|
|
871
|
+
* 用户信息列表
|
|
870
872
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
871
|
-
|
|
873
|
+
*/
|
|
872
874
|
UserList: Array<UserInformation>;
|
|
873
875
|
/**
|
|
874
|
-
|
|
876
|
+
* 质量数据
|
|
875
877
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
876
|
-
|
|
878
|
+
*/
|
|
877
879
|
Data: Array<QualityData>;
|
|
878
880
|
/**
|
|
879
881
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -955,9 +957,9 @@ export interface DescribeMixTranscodingUsageRequest {
|
|
|
955
957
|
*/
|
|
956
958
|
StartTime: string;
|
|
957
959
|
/**
|
|
958
|
-
|
|
960
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
959
961
|
单次查询统计区间最多不能超过31天。
|
|
960
|
-
|
|
962
|
+
*/
|
|
961
963
|
EndTime: string;
|
|
962
964
|
/**
|
|
963
965
|
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
@@ -1096,9 +1098,9 @@ export interface DescribeTrtcUsageRequest {
|
|
|
1096
1098
|
*/
|
|
1097
1099
|
StartTime: string;
|
|
1098
1100
|
/**
|
|
1099
|
-
|
|
1101
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1100
1102
|
单次查询统计区间最多不能超过31天。
|
|
1101
|
-
|
|
1103
|
+
*/
|
|
1102
1104
|
EndTime: string;
|
|
1103
1105
|
/**
|
|
1104
1106
|
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
@@ -1231,7 +1233,7 @@ export interface McuLayout {
|
|
|
1231
1233
|
*/
|
|
1232
1234
|
RenderMode?: number;
|
|
1233
1235
|
/**
|
|
1234
|
-
|
|
1236
|
+
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1235
1237
|
红色:0xcc0033。
|
|
1236
1238
|
黄色:0xcc9900。
|
|
1237
1239
|
绿色:0xcccc33。
|
|
@@ -1239,7 +1241,7 @@ export interface McuLayout {
|
|
|
1239
1241
|
黑色:0x000000。
|
|
1240
1242
|
白色:0xFFFFFF。
|
|
1241
1243
|
灰色:0x999999。
|
|
1242
|
-
|
|
1244
|
+
*/
|
|
1243
1245
|
BackGroundColor?: string;
|
|
1244
1246
|
/**
|
|
1245
1247
|
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。
|
|
@@ -1259,9 +1261,9 @@ export interface DescribeUserInfoResponse {
|
|
|
1259
1261
|
*/
|
|
1260
1262
|
Total: number;
|
|
1261
1263
|
/**
|
|
1262
|
-
|
|
1264
|
+
* 用户信息列表
|
|
1263
1265
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1264
|
-
|
|
1266
|
+
*/
|
|
1265
1267
|
UserList: Array<UserInformation>;
|
|
1266
1268
|
/**
|
|
1267
1269
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1273,9 +1275,9 @@ export interface DescribeUserInfoResponse {
|
|
|
1273
1275
|
*/
|
|
1274
1276
|
export interface DescribeTRTCRealTimeScaleMetricDataResponse {
|
|
1275
1277
|
/**
|
|
1276
|
-
|
|
1278
|
+
* TRTC监控数据出参
|
|
1277
1279
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1278
|
-
|
|
1280
|
+
*/
|
|
1279
1281
|
Data?: TRTCDataResp;
|
|
1280
1282
|
/**
|
|
1281
1283
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1383,10 +1385,10 @@ export interface DescribeTRTCMarketScaleMetricDataRequest {
|
|
|
1383
1385
|
*/
|
|
1384
1386
|
EndTime: string;
|
|
1385
1387
|
/**
|
|
1386
|
-
|
|
1388
|
+
* 返回数据的粒度,支持设为以下值:
|
|
1387
1389
|
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
1388
1390
|
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
1389
|
-
|
|
1391
|
+
*/
|
|
1390
1392
|
Period: string;
|
|
1391
1393
|
}
|
|
1392
1394
|
/**
|
|
@@ -1454,9 +1456,9 @@ export interface DescribeRecordingUsageRequest {
|
|
|
1454
1456
|
*/
|
|
1455
1457
|
StartTime: string;
|
|
1456
1458
|
/**
|
|
1457
|
-
|
|
1459
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1458
1460
|
单次查询统计区间最多不能超过31天。
|
|
1459
|
-
|
|
1461
|
+
*/
|
|
1460
1462
|
EndTime: string;
|
|
1461
1463
|
/**
|
|
1462
1464
|
* 查询单流录制或合流录制,值为"single"或"multi"。
|
|
@@ -1472,21 +1474,21 @@ export interface DescribeRecordingUsageRequest {
|
|
|
1472
1474
|
*/
|
|
1473
1475
|
export interface StorageFile {
|
|
1474
1476
|
/**
|
|
1475
|
-
|
|
1477
|
+
* 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
|
|
1476
1478
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1477
|
-
|
|
1479
|
+
*/
|
|
1478
1480
|
UserId: string;
|
|
1479
1481
|
/**
|
|
1480
1482
|
* 录制索引文件名。
|
|
1481
1483
|
*/
|
|
1482
1484
|
FileName: string;
|
|
1483
1485
|
/**
|
|
1484
|
-
|
|
1486
|
+
* 录制文件流信息。
|
|
1485
1487
|
video:视频录制文件
|
|
1486
1488
|
audio:音频录制文件
|
|
1487
1489
|
audio_video:音视频录制文件
|
|
1488
1490
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1489
|
-
|
|
1491
|
+
*/
|
|
1490
1492
|
TrackType: string;
|
|
1491
1493
|
/**
|
|
1492
1494
|
* 录制文件开始Unix时间戳。
|
|
@@ -1523,9 +1525,9 @@ export interface DescribeScaleInfoResponse {
|
|
|
1523
1525
|
*/
|
|
1524
1526
|
Total?: number;
|
|
1525
1527
|
/**
|
|
1526
|
-
|
|
1528
|
+
* 返回的数据
|
|
1527
1529
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1528
|
-
|
|
1530
|
+
*/
|
|
1529
1531
|
ScaleList?: Array<ScaleInfomation>;
|
|
1530
1532
|
/**
|
|
1531
1533
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1537,7 +1539,7 @@ export interface DescribeScaleInfoResponse {
|
|
|
1537
1539
|
*/
|
|
1538
1540
|
export interface MixLayoutParams {
|
|
1539
1541
|
/**
|
|
1540
|
-
|
|
1542
|
+
* 布局模式:
|
|
1541
1543
|
1:悬浮布局;
|
|
1542
1544
|
2:屏幕分享布局;
|
|
1543
1545
|
3:九宫格布局(默认);
|
|
@@ -1550,7 +1552,7 @@ export interface MixLayoutParams {
|
|
|
1550
1552
|
九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
|
|
1551
1553
|
|
|
1552
1554
|
自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
|
|
1553
|
-
|
|
1555
|
+
*/
|
|
1554
1556
|
MixLayoutMode: number;
|
|
1555
1557
|
/**
|
|
1556
1558
|
* 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
|
|
@@ -1565,11 +1567,11 @@ export interface MixLayoutParams {
|
|
|
1565
1567
|
*/
|
|
1566
1568
|
MaxResolutionUserId?: string;
|
|
1567
1569
|
/**
|
|
1568
|
-
|
|
1570
|
+
* 主辅路标识,
|
|
1569
1571
|
0:主流(默认);
|
|
1570
1572
|
1:辅流(屏幕分享);
|
|
1571
1573
|
这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
|
|
1572
|
-
|
|
1574
|
+
*/
|
|
1573
1575
|
MediaId?: number;
|
|
1574
1576
|
/**
|
|
1575
1577
|
* 图片的url地址, 只支持jpg, png,大小限制不超过5M,url不可包含中文。
|
|
@@ -1720,9 +1722,9 @@ export interface DescribeUnusualEventRequest {
|
|
|
1720
1722
|
*/
|
|
1721
1723
|
SdkAppId: number;
|
|
1722
1724
|
/**
|
|
1723
|
-
|
|
1725
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
1724
1726
|
注意:支持查询14天内的数据
|
|
1725
|
-
|
|
1727
|
+
*/
|
|
1726
1728
|
StartTime: number;
|
|
1727
1729
|
/**
|
|
1728
1730
|
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
|
|
@@ -1763,9 +1765,9 @@ export interface TencentVod {
|
|
|
1763
1765
|
*/
|
|
1764
1766
|
StorageRegion?: string;
|
|
1765
1767
|
/**
|
|
1766
|
-
|
|
1768
|
+
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
|
|
1767
1769
|
默认值:0,表示其他分类。
|
|
1768
|
-
|
|
1770
|
+
*/
|
|
1769
1771
|
ClassId?: number;
|
|
1770
1772
|
/**
|
|
1771
1773
|
* 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
|
|
@@ -1818,9 +1820,9 @@ export interface McuPassThrough {
|
|
|
1818
1820
|
*/
|
|
1819
1821
|
export interface DescribeTRTCRealTimeQualityMetricDataResponse {
|
|
1820
1822
|
/**
|
|
1821
|
-
|
|
1823
|
+
* TRTC监控数据出参
|
|
1822
1824
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1823
|
-
|
|
1825
|
+
*/
|
|
1824
1826
|
Data: TRTCDataResp;
|
|
1825
1827
|
/**
|
|
1826
1828
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1930,10 +1932,10 @@ export interface CreateCloudRecordingRequest {
|
|
|
1930
1932
|
*/
|
|
1931
1933
|
StorageParams: StorageParams;
|
|
1932
1934
|
/**
|
|
1933
|
-
|
|
1935
|
+
* TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同:
|
|
1934
1936
|
0: 字符串类型的RoomId
|
|
1935
1937
|
1: 32位整型的RoomId(默认)
|
|
1936
|
-
|
|
1938
|
+
*/
|
|
1937
1939
|
RoomIdType?: number;
|
|
1938
1940
|
/**
|
|
1939
1941
|
* 混流的转码参数,录制模式为混流的时候可以设置。
|
|
@@ -1965,9 +1967,9 @@ export interface OutputParams {
|
|
|
1965
1967
|
*/
|
|
1966
1968
|
PureAudioStream?: number;
|
|
1967
1969
|
/**
|
|
1968
|
-
|
|
1970
|
+
* 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768。
|
|
1969
1971
|
【注意】该方式仅对旧版云端录制功能的应用生效,新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见:https://cloud.tencent.com/document/product/647/50768#record
|
|
1970
|
-
|
|
1972
|
+
*/
|
|
1971
1973
|
RecordId?: string;
|
|
1972
1974
|
/**
|
|
1973
1975
|
* 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。
|
|
@@ -2013,9 +2015,9 @@ export interface QualityData {
|
|
|
2013
2015
|
*/
|
|
2014
2016
|
UserId: string;
|
|
2015
2017
|
/**
|
|
2016
|
-
|
|
2018
|
+
* 对端Id,为空时表示上行数据
|
|
2017
2019
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2018
|
-
|
|
2020
|
+
*/
|
|
2019
2021
|
PeerId: string;
|
|
2020
2022
|
/**
|
|
2021
2023
|
* 数据类型
|
|
@@ -2230,19 +2232,19 @@ export interface DescribePictureRequest {
|
|
|
2230
2232
|
*/
|
|
2231
2233
|
export interface TRTCDataResp {
|
|
2232
2234
|
/**
|
|
2233
|
-
|
|
2235
|
+
* StatementID值,监控仪表盘下固定为0。
|
|
2234
2236
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2235
|
-
|
|
2237
|
+
*/
|
|
2236
2238
|
StatementID: number;
|
|
2237
2239
|
/**
|
|
2238
|
-
|
|
2240
|
+
* 查询结果数据,以Columns-Values形式返回。
|
|
2239
2241
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2240
|
-
|
|
2242
|
+
*/
|
|
2241
2243
|
Series: Array<SeriesInfo>;
|
|
2242
2244
|
/**
|
|
2243
|
-
|
|
2245
|
+
* Total值,监控仪表盘功能下固定为1。
|
|
2244
2246
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2245
|
-
|
|
2247
|
+
*/
|
|
2246
2248
|
Total: number;
|
|
2247
2249
|
}
|
|
2248
2250
|
/**
|
|
@@ -2309,9 +2311,9 @@ export interface DescribeTrtcMcuTranscodeTimeRequest {
|
|
|
2309
2311
|
*/
|
|
2310
2312
|
StartTime: string;
|
|
2311
2313
|
/**
|
|
2312
|
-
|
|
2314
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
2313
2315
|
单次查询统计区间最多不能超过31天。
|
|
2314
|
-
|
|
2316
|
+
*/
|
|
2315
2317
|
EndTime: string;
|
|
2316
2318
|
/**
|
|
2317
2319
|
* 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
|
|
@@ -2364,14 +2366,14 @@ export interface DescribeScaleInfoRequest {
|
|
|
2364
2366
|
*/
|
|
2365
2367
|
SdkAppId: number;
|
|
2366
2368
|
/**
|
|
2367
|
-
|
|
2369
|
+
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
2368
2370
|
注意:支持查询14天内的数据。
|
|
2369
|
-
|
|
2371
|
+
*/
|
|
2370
2372
|
StartTime: number;
|
|
2371
2373
|
/**
|
|
2372
|
-
|
|
2374
|
+
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
|
|
2373
2375
|
注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。
|
|
2374
|
-
|
|
2376
|
+
*/
|
|
2375
2377
|
EndTime: number;
|
|
2376
2378
|
}
|
|
2377
2379
|
/**
|
|
@@ -2388,9 +2390,9 @@ export interface DismissRoomByStrRoomIdResponse {
|
|
|
2388
2390
|
*/
|
|
2389
2391
|
export interface DescribeUnusualEventResponse {
|
|
2390
2392
|
/**
|
|
2391
|
-
|
|
2393
|
+
* 返回的数据总条数
|
|
2392
2394
|
范围:[0,20]
|
|
2393
|
-
|
|
2395
|
+
*/
|
|
2394
2396
|
Total: number;
|
|
2395
2397
|
/**
|
|
2396
2398
|
* 异常体验列表
|
|
@@ -2452,16 +2454,16 @@ export interface DescribeCloudRecordingResponse {
|
|
|
2452
2454
|
*/
|
|
2453
2455
|
TaskId: string;
|
|
2454
2456
|
/**
|
|
2455
|
-
|
|
2457
|
+
* 云端录制任务的状态信息。
|
|
2456
2458
|
Idle:表示当前录制任务空闲中
|
|
2457
2459
|
InProgress:表示当前录制任务正在进行中。
|
|
2458
2460
|
Exited:表示当前录制任务正在退出的过程中。
|
|
2459
|
-
|
|
2461
|
+
*/
|
|
2460
2462
|
Status: string;
|
|
2461
2463
|
/**
|
|
2462
|
-
|
|
2464
|
+
* 录制文件信息。
|
|
2463
2465
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2464
|
-
|
|
2466
|
+
*/
|
|
2465
2467
|
StorageFileList: Array<StorageFile>;
|
|
2466
2468
|
/**
|
|
2467
2469
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2680,21 +2682,21 @@ export interface RemoveUserByStrRoomIdRequest {
|
|
|
2680
2682
|
*/
|
|
2681
2683
|
export interface RecordParams {
|
|
2682
2684
|
/**
|
|
2683
|
-
|
|
2685
|
+
* 录制模式:
|
|
2684
2686
|
1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件上传至云存储;
|
|
2685
2687
|
2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储;
|
|
2686
|
-
|
|
2688
|
+
*/
|
|
2687
2689
|
RecordMode: number;
|
|
2688
2690
|
/**
|
|
2689
2691
|
* 房间内持续没有用户(主播)上行推流的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
|
|
2690
2692
|
*/
|
|
2691
2693
|
MaxIdleTime?: number;
|
|
2692
2694
|
/**
|
|
2693
|
-
|
|
2695
|
+
* 录制的媒体流类型:
|
|
2694
2696
|
0:录制音频+视频流(默认);
|
|
2695
2697
|
1:仅录制音频流;
|
|
2696
2698
|
2:仅录制视频流,
|
|
2697
|
-
|
|
2699
|
+
*/
|
|
2698
2700
|
StreamType?: number;
|
|
2699
2701
|
/**
|
|
2700
2702
|
* 指定订阅流白名单或者黑名单。
|
|
@@ -2709,9 +2711,9 @@ export interface RecordParams {
|
|
|
2709
2711
|
*/
|
|
2710
2712
|
AvMerge?: number;
|
|
2711
2713
|
/**
|
|
2712
|
-
|
|
2714
|
+
* 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】
|
|
2713
2715
|
Hls 格式录制此参数不生效。
|
|
2714
|
-
|
|
2716
|
+
*/
|
|
2715
2717
|
MaxMediaFileDuration?: number;
|
|
2716
2718
|
/**
|
|
2717
2719
|
* 指定录制主辅流,0:主流+辅流(默认);1:主流;2:辅流。
|
|
@@ -2723,9 +2725,9 @@ export interface RecordParams {
|
|
|
2723
2725
|
*/
|
|
2724
2726
|
export interface DescribeTRTCMarketScaleMetricDataResponse {
|
|
2725
2727
|
/**
|
|
2726
|
-
|
|
2728
|
+
* TRTC监控数据出参
|
|
2727
2729
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2728
|
-
|
|
2730
|
+
*/
|
|
2729
2731
|
Data: TRTCDataResp;
|
|
2730
2732
|
/**
|
|
2731
2733
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2741,14 +2743,14 @@ export interface McuAudioParams {
|
|
|
2741
2743
|
*/
|
|
2742
2744
|
AudioEncode?: AudioEncode;
|
|
2743
2745
|
/**
|
|
2744
|
-
|
|
2746
|
+
* 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。
|
|
2745
2747
|
使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。
|
|
2746
|
-
|
|
2748
|
+
*/
|
|
2747
2749
|
SubscribeAudioList?: Array<McuUserInfoParams>;
|
|
2748
2750
|
/**
|
|
2749
|
-
|
|
2751
|
+
* 音频用户黑名单,为空或不填表示无黑名单,填具体值表示不混指定主播音频。update时,不填表示不更新,为空表示更新为清空黑名单,填具体值表示更新为不混指定主播音频。
|
|
2750
2752
|
使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。
|
|
2751
|
-
|
|
2753
|
+
*/
|
|
2752
2754
|
UnSubscribeAudioList?: Array<McuUserInfoParams>;
|
|
2753
2755
|
}
|
|
2754
2756
|
/**
|
|
@@ -2814,17 +2816,17 @@ export interface McuPublishCdnParam {
|
|
|
2814
2816
|
*/
|
|
2815
2817
|
export interface AudioParams {
|
|
2816
2818
|
/**
|
|
2817
|
-
|
|
2819
|
+
* 音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ)
|
|
2818
2820
|
1:48000Hz(默认);
|
|
2819
2821
|
2:44100Hz
|
|
2820
2822
|
3:16000Hz。
|
|
2821
|
-
|
|
2823
|
+
*/
|
|
2822
2824
|
SampleRate: number;
|
|
2823
2825
|
/**
|
|
2824
|
-
|
|
2826
|
+
* 声道数枚举值:
|
|
2825
2827
|
1:单声道;
|
|
2826
2828
|
2:双声道(默认)。
|
|
2827
|
-
|
|
2829
|
+
*/
|
|
2828
2830
|
Channel: number;
|
|
2829
2831
|
/**
|
|
2830
2832
|
* 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。
|
|
@@ -2836,14 +2838,14 @@ export interface AudioParams {
|
|
|
2836
2838
|
*/
|
|
2837
2839
|
export interface SeriesInfo {
|
|
2838
2840
|
/**
|
|
2839
|
-
|
|
2841
|
+
* 数据列
|
|
2840
2842
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2841
|
-
|
|
2843
|
+
*/
|
|
2842
2844
|
Columns: Array<string>;
|
|
2843
2845
|
/**
|
|
2844
|
-
|
|
2846
|
+
* 数据值
|
|
2845
2847
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2846
|
-
|
|
2848
|
+
*/
|
|
2847
2849
|
Values: Array<number>;
|
|
2848
2850
|
}
|
|
2849
2851
|
/**
|