tencentcloud-sdk-nodejs-trtc 4.0.673 → 4.0.674
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 +145 -0
- package/SERVICE_CHANGELOG.md +452 -729
- package/package.json +1 -1
- package/products.md +13 -13
- package/src/services/trtc/v20190722/trtc_client.ts +84 -6
- package/src/services/trtc/v20190722/trtc_models.ts +292 -92
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +44 -1
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +51 -0
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +281 -92
|
@@ -175,13 +175,49 @@ export interface McuVideoParams {
|
|
|
175
175
|
}
|
|
176
176
|
|
|
177
177
|
/**
|
|
178
|
-
*
|
|
178
|
+
* DescribeTRTCRealTimeScaleData请求参数结构体
|
|
179
179
|
*/
|
|
180
|
-
export interface
|
|
180
|
+
export interface DescribeTRTCRealTimeScaleDataRequest {
|
|
181
181
|
/**
|
|
182
|
-
*
|
|
182
|
+
* 用户SdkAppId(如:1400xxxxxx)
|
|
183
183
|
*/
|
|
184
|
-
|
|
184
|
+
SdkAppId: string
|
|
185
|
+
/**
|
|
186
|
+
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
187
|
+
*/
|
|
188
|
+
StartTime: number
|
|
189
|
+
/**
|
|
190
|
+
* 结束时间,unix时间戳,单位:秒
|
|
191
|
+
*/
|
|
192
|
+
EndTime: number
|
|
193
|
+
/**
|
|
194
|
+
* 房间ID
|
|
195
|
+
*/
|
|
196
|
+
RoomId?: string
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* DescribeTRTCMarketScaleData请求参数结构体
|
|
201
|
+
*/
|
|
202
|
+
export interface DescribeTRTCMarketScaleDataRequest {
|
|
203
|
+
/**
|
|
204
|
+
* 用户SdkAppId
|
|
205
|
+
*/
|
|
206
|
+
SdkAppId: string
|
|
207
|
+
/**
|
|
208
|
+
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
209
|
+
*/
|
|
210
|
+
StartTime: string
|
|
211
|
+
/**
|
|
212
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
213
|
+
*/
|
|
214
|
+
EndTime: string
|
|
215
|
+
/**
|
|
216
|
+
* 返回数据的粒度,支持设为以下值:
|
|
217
|
+
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
218
|
+
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
219
|
+
*/
|
|
220
|
+
Period: string
|
|
185
221
|
}
|
|
186
222
|
|
|
187
223
|
/**
|
|
@@ -407,6 +443,56 @@ export interface VideoEncode {
|
|
|
407
443
|
Gop: number
|
|
408
444
|
}
|
|
409
445
|
|
|
446
|
+
/**
|
|
447
|
+
* MCU混流布局参数
|
|
448
|
+
*/
|
|
449
|
+
export interface LayoutParams {
|
|
450
|
+
/**
|
|
451
|
+
* 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
|
|
452
|
+
*/
|
|
453
|
+
Template?: number
|
|
454
|
+
/**
|
|
455
|
+
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
|
|
456
|
+
*/
|
|
457
|
+
MainVideoUserId?: string
|
|
458
|
+
/**
|
|
459
|
+
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
|
|
460
|
+
*/
|
|
461
|
+
MainVideoStreamType?: number
|
|
462
|
+
/**
|
|
463
|
+
* 画中画模板中有效,代表小画面的布局参数。
|
|
464
|
+
*/
|
|
465
|
+
SmallVideoLayoutParams?: SmallVideoLayoutParams
|
|
466
|
+
/**
|
|
467
|
+
* 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
|
|
468
|
+
*/
|
|
469
|
+
MainVideoRightAlign?: number
|
|
470
|
+
/**
|
|
471
|
+
* 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
|
|
472
|
+
*/
|
|
473
|
+
MixVideoUids?: Array<string>
|
|
474
|
+
/**
|
|
475
|
+
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
476
|
+
*/
|
|
477
|
+
PresetLayoutConfig?: Array<PresetLayoutConfig>
|
|
478
|
+
/**
|
|
479
|
+
* 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
|
|
480
|
+
*/
|
|
481
|
+
PlaceHolderMode?: number
|
|
482
|
+
/**
|
|
483
|
+
* 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
|
|
484
|
+
*/
|
|
485
|
+
PureAudioHoldPlaceMode?: number
|
|
486
|
+
/**
|
|
487
|
+
* 水印参数。
|
|
488
|
+
*/
|
|
489
|
+
WaterMarkParams?: WaterMarkParams
|
|
490
|
+
/**
|
|
491
|
+
* 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
|
|
492
|
+
*/
|
|
493
|
+
RenderMode?: number
|
|
494
|
+
}
|
|
495
|
+
|
|
410
496
|
/**
|
|
411
497
|
* StopMCUMixTranscodeByStrRoomId返回参数结构体
|
|
412
498
|
*/
|
|
@@ -504,6 +590,21 @@ DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
|
|
|
504
590
|
PageSize?: number
|
|
505
591
|
}
|
|
506
592
|
|
|
593
|
+
/**
|
|
594
|
+
* DescribeTRTCMarketScaleData返回参数结构体
|
|
595
|
+
*/
|
|
596
|
+
export interface DescribeTRTCMarketScaleDataResponse {
|
|
597
|
+
/**
|
|
598
|
+
* TRTC监控数据出参
|
|
599
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
600
|
+
*/
|
|
601
|
+
Data?: TRTCDataResult
|
|
602
|
+
/**
|
|
603
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
604
|
+
*/
|
|
605
|
+
RequestId?: string
|
|
606
|
+
}
|
|
607
|
+
|
|
507
608
|
/**
|
|
508
609
|
* ModifyPicture请求参数结构体
|
|
509
610
|
*/
|
|
@@ -731,33 +832,18 @@ h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数
|
|
|
731
832
|
}
|
|
732
833
|
|
|
733
834
|
/**
|
|
734
|
-
*
|
|
835
|
+
* DescribeTRTCRealTimeScaleData返回参数结构体
|
|
735
836
|
*/
|
|
736
|
-
export interface
|
|
737
|
-
/**
|
|
738
|
-
* 视频流类型:
|
|
739
|
-
0:与视频无关的事件;
|
|
740
|
-
2:视频为大画面;
|
|
741
|
-
3:视频为小画面;
|
|
742
|
-
7:视频为旁路画面;
|
|
743
|
-
*/
|
|
744
|
-
Type: number
|
|
745
|
-
/**
|
|
746
|
-
* 事件上报的时间戳,unix时间(1589891188801ms)
|
|
747
|
-
*/
|
|
748
|
-
Time: number
|
|
837
|
+
export interface DescribeTRTCRealTimeScaleDataResponse {
|
|
749
838
|
/**
|
|
750
|
-
*
|
|
751
|
-
|
|
752
|
-
EventId: number
|
|
753
|
-
/**
|
|
754
|
-
* 事件的第一个参数,如视频分辨率宽
|
|
839
|
+
* TRTC监控数据出参
|
|
840
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
755
841
|
*/
|
|
756
|
-
|
|
842
|
+
Data?: TRTCDataResult
|
|
757
843
|
/**
|
|
758
|
-
*
|
|
844
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
759
845
|
*/
|
|
760
|
-
|
|
846
|
+
RequestId?: string
|
|
761
847
|
}
|
|
762
848
|
|
|
763
849
|
/**
|
|
@@ -922,6 +1008,21 @@ export interface DescribeCallDetailInfoResponse {
|
|
|
922
1008
|
RequestId?: string
|
|
923
1009
|
}
|
|
924
1010
|
|
|
1011
|
+
/**
|
|
1012
|
+
* DescribeTRTCRealTimeQualityData返回参数结构体
|
|
1013
|
+
*/
|
|
1014
|
+
export interface DescribeTRTCRealTimeQualityDataResponse {
|
|
1015
|
+
/**
|
|
1016
|
+
* TRTC监控数据出参
|
|
1017
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1018
|
+
*/
|
|
1019
|
+
Data?: TRTCDataResult
|
|
1020
|
+
/**
|
|
1021
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1022
|
+
*/
|
|
1023
|
+
RequestId?: string
|
|
1024
|
+
}
|
|
1025
|
+
|
|
925
1026
|
/**
|
|
926
1027
|
* 混流自定义裁剪参数
|
|
927
1028
|
*/
|
|
@@ -977,6 +1078,21 @@ export interface MixTranscodeParams {
|
|
|
977
1078
|
AudioParams?: AudioParams
|
|
978
1079
|
}
|
|
979
1080
|
|
|
1081
|
+
/**
|
|
1082
|
+
* DescribeTRTCMarketQualityData返回参数结构体
|
|
1083
|
+
*/
|
|
1084
|
+
export interface DescribeTRTCMarketQualityDataResponse {
|
|
1085
|
+
/**
|
|
1086
|
+
* TRTC监控数据出参
|
|
1087
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1088
|
+
*/
|
|
1089
|
+
Data?: TRTCDataResult
|
|
1090
|
+
/**
|
|
1091
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1092
|
+
*/
|
|
1093
|
+
RequestId?: string
|
|
1094
|
+
}
|
|
1095
|
+
|
|
980
1096
|
/**
|
|
981
1097
|
* 画中画模板中有效,代表小画面的布局参数
|
|
982
1098
|
*/
|
|
@@ -1131,29 +1247,17 @@ export interface DescribeRoomInfoResponse {
|
|
|
1131
1247
|
}
|
|
1132
1248
|
|
|
1133
1249
|
/**
|
|
1134
|
-
*
|
|
1250
|
+
* DismissRoom请求参数结构体
|
|
1135
1251
|
*/
|
|
1136
|
-
export interface
|
|
1137
|
-
/**
|
|
1138
|
-
* 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
|
|
1139
|
-
*/
|
|
1140
|
-
MixLayoutMode?: number
|
|
1141
|
-
/**
|
|
1142
|
-
* 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
|
|
1143
|
-
*/
|
|
1144
|
-
PureAudioHoldPlaceMode?: number
|
|
1145
|
-
/**
|
|
1146
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
1147
|
-
*/
|
|
1148
|
-
MixLayoutList?: Array<McuLayout>
|
|
1252
|
+
export interface DismissRoomRequest {
|
|
1149
1253
|
/**
|
|
1150
|
-
*
|
|
1254
|
+
* TRTC的SDKAppId。
|
|
1151
1255
|
*/
|
|
1152
|
-
|
|
1256
|
+
SdkAppId: number
|
|
1153
1257
|
/**
|
|
1154
|
-
*
|
|
1258
|
+
* 房间号。
|
|
1155
1259
|
*/
|
|
1156
|
-
|
|
1260
|
+
RoomId: number
|
|
1157
1261
|
}
|
|
1158
1262
|
|
|
1159
1263
|
/**
|
|
@@ -1285,6 +1389,16 @@ export interface DescribeUserInfoResponse {
|
|
|
1285
1389
|
RequestId?: string
|
|
1286
1390
|
}
|
|
1287
1391
|
|
|
1392
|
+
/**
|
|
1393
|
+
* RemoveUserByStrRoomId返回参数结构体
|
|
1394
|
+
*/
|
|
1395
|
+
export interface RemoveUserByStrRoomIdResponse {
|
|
1396
|
+
/**
|
|
1397
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1398
|
+
*/
|
|
1399
|
+
RequestId?: string
|
|
1400
|
+
}
|
|
1401
|
+
|
|
1288
1402
|
/**
|
|
1289
1403
|
* DescribeTRTCRealTimeScaleMetricData返回参数结构体
|
|
1290
1404
|
*/
|
|
@@ -1737,17 +1851,50 @@ export interface RemoveUserRequest {
|
|
|
1737
1851
|
}
|
|
1738
1852
|
|
|
1739
1853
|
/**
|
|
1740
|
-
*
|
|
1854
|
+
* TRTC数据大盘/实时监控 API接口数据出参
|
|
1741
1855
|
*/
|
|
1742
|
-
export interface
|
|
1856
|
+
export interface TRTCDataResult {
|
|
1743
1857
|
/**
|
|
1744
|
-
*
|
|
1858
|
+
* StatementID值,监控仪表盘下固定为0。
|
|
1859
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1745
1860
|
*/
|
|
1746
|
-
|
|
1861
|
+
StatementID?: number
|
|
1747
1862
|
/**
|
|
1748
|
-
*
|
|
1863
|
+
* 查询结果数据,以Columns-Values形式返回。
|
|
1864
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1749
1865
|
*/
|
|
1750
|
-
|
|
1866
|
+
Series?: Array<SeriesInfos>
|
|
1867
|
+
/**
|
|
1868
|
+
* Total值,监控仪表盘功能下固定为1。
|
|
1869
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1870
|
+
*/
|
|
1871
|
+
Total?: number
|
|
1872
|
+
}
|
|
1873
|
+
|
|
1874
|
+
/**
|
|
1875
|
+
* 混流布局参数。
|
|
1876
|
+
*/
|
|
1877
|
+
export interface McuLayoutParams {
|
|
1878
|
+
/**
|
|
1879
|
+
* 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
|
|
1880
|
+
*/
|
|
1881
|
+
MixLayoutMode?: number
|
|
1882
|
+
/**
|
|
1883
|
+
* 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
|
|
1884
|
+
*/
|
|
1885
|
+
PureAudioHoldPlaceMode?: number
|
|
1886
|
+
/**
|
|
1887
|
+
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
1888
|
+
*/
|
|
1889
|
+
MixLayoutList?: Array<McuLayout>
|
|
1890
|
+
/**
|
|
1891
|
+
* 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
|
|
1892
|
+
*/
|
|
1893
|
+
MaxVideoUser?: MaxVideoUser
|
|
1894
|
+
/**
|
|
1895
|
+
* 屏幕分享模板、悬浮模板、九宫格模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底
|
|
1896
|
+
*/
|
|
1897
|
+
RenderMode?: number
|
|
1751
1898
|
}
|
|
1752
1899
|
|
|
1753
1900
|
/**
|
|
@@ -1872,53 +2019,25 @@ export interface DescribeTRTCRealTimeQualityMetricDataResponse {
|
|
|
1872
2019
|
}
|
|
1873
2020
|
|
|
1874
2021
|
/**
|
|
1875
|
-
*
|
|
2022
|
+
* DescribeTRTCRealTimeQualityData请求参数结构体
|
|
1876
2023
|
*/
|
|
1877
|
-
export interface
|
|
1878
|
-
/**
|
|
1879
|
-
* 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
|
|
1880
|
-
*/
|
|
1881
|
-
Template?: number
|
|
1882
|
-
/**
|
|
1883
|
-
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
|
|
1884
|
-
*/
|
|
1885
|
-
MainVideoUserId?: string
|
|
1886
|
-
/**
|
|
1887
|
-
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
|
|
1888
|
-
*/
|
|
1889
|
-
MainVideoStreamType?: number
|
|
1890
|
-
/**
|
|
1891
|
-
* 画中画模板中有效,代表小画面的布局参数。
|
|
1892
|
-
*/
|
|
1893
|
-
SmallVideoLayoutParams?: SmallVideoLayoutParams
|
|
1894
|
-
/**
|
|
1895
|
-
* 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
|
|
1896
|
-
*/
|
|
1897
|
-
MainVideoRightAlign?: number
|
|
1898
|
-
/**
|
|
1899
|
-
* 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
|
|
1900
|
-
*/
|
|
1901
|
-
MixVideoUids?: Array<string>
|
|
1902
|
-
/**
|
|
1903
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
1904
|
-
*/
|
|
1905
|
-
PresetLayoutConfig?: Array<PresetLayoutConfig>
|
|
2024
|
+
export interface DescribeTRTCRealTimeQualityDataRequest {
|
|
1906
2025
|
/**
|
|
1907
|
-
*
|
|
2026
|
+
* 用户SdkAppId(如:1400xxxxxx)
|
|
1908
2027
|
*/
|
|
1909
|
-
|
|
2028
|
+
SdkAppId: string
|
|
1910
2029
|
/**
|
|
1911
|
-
*
|
|
2030
|
+
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
1912
2031
|
*/
|
|
1913
|
-
|
|
2032
|
+
StartTime: number
|
|
1914
2033
|
/**
|
|
1915
|
-
*
|
|
2034
|
+
* 结束时间,unix时间戳,单位:秒
|
|
1916
2035
|
*/
|
|
1917
|
-
|
|
2036
|
+
EndTime: number
|
|
1918
2037
|
/**
|
|
1919
|
-
*
|
|
2038
|
+
* 房间ID
|
|
1920
2039
|
*/
|
|
1921
|
-
|
|
2040
|
+
RoomId?: string
|
|
1922
2041
|
}
|
|
1923
2042
|
|
|
1924
2043
|
/**
|
|
@@ -2195,6 +2314,17 @@ export interface StartPublishCdnStreamRequest {
|
|
|
2195
2314
|
FeedBackRoomParams?: Array<McuFeedBackRoomParams>
|
|
2196
2315
|
}
|
|
2197
2316
|
|
|
2317
|
+
/**
|
|
2318
|
+
* SeriesInfo类型的二维数组
|
|
2319
|
+
*/
|
|
2320
|
+
export interface RowValues {
|
|
2321
|
+
/**
|
|
2322
|
+
* 数据值
|
|
2323
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2324
|
+
*/
|
|
2325
|
+
RowValue?: Array<number | bigint>
|
|
2326
|
+
}
|
|
2327
|
+
|
|
2198
2328
|
/**
|
|
2199
2329
|
* 旁路转码时长的查询结果
|
|
2200
2330
|
*/
|
|
@@ -2520,6 +2650,16 @@ Exited:表示当前录制任务正在退出的过程中。
|
|
|
2520
2650
|
RequestId?: string
|
|
2521
2651
|
}
|
|
2522
2652
|
|
|
2653
|
+
/**
|
|
2654
|
+
* DismissRoom返回参数结构体
|
|
2655
|
+
*/
|
|
2656
|
+
export interface DismissRoomResponse {
|
|
2657
|
+
/**
|
|
2658
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2659
|
+
*/
|
|
2660
|
+
RequestId?: string
|
|
2661
|
+
}
|
|
2662
|
+
|
|
2523
2663
|
/**
|
|
2524
2664
|
* TRTC用户参数。
|
|
2525
2665
|
*/
|
|
@@ -2539,13 +2679,57 @@ export interface MixUserInfo {
|
|
|
2539
2679
|
}
|
|
2540
2680
|
|
|
2541
2681
|
/**
|
|
2542
|
-
*
|
|
2682
|
+
* 事件信息,包括,事件时间戳,事件ID,
|
|
2543
2683
|
*/
|
|
2544
|
-
export interface
|
|
2684
|
+
export interface EventMessage {
|
|
2545
2685
|
/**
|
|
2546
|
-
*
|
|
2686
|
+
* 视频流类型:
|
|
2687
|
+
0:与视频无关的事件;
|
|
2688
|
+
2:视频为大画面;
|
|
2689
|
+
3:视频为小画面;
|
|
2690
|
+
7:视频为旁路画面;
|
|
2547
2691
|
*/
|
|
2548
|
-
|
|
2692
|
+
Type: number
|
|
2693
|
+
/**
|
|
2694
|
+
* 事件上报的时间戳,unix时间(1589891188801ms)
|
|
2695
|
+
*/
|
|
2696
|
+
Time: number
|
|
2697
|
+
/**
|
|
2698
|
+
* 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
|
|
2699
|
+
*/
|
|
2700
|
+
EventId: number
|
|
2701
|
+
/**
|
|
2702
|
+
* 事件的第一个参数,如视频分辨率宽
|
|
2703
|
+
*/
|
|
2704
|
+
ParamOne: number
|
|
2705
|
+
/**
|
|
2706
|
+
* 事件的第二个参数,如视频分辨率高
|
|
2707
|
+
*/
|
|
2708
|
+
ParamTwo: number
|
|
2709
|
+
}
|
|
2710
|
+
|
|
2711
|
+
/**
|
|
2712
|
+
* DescribeTRTCMarketQualityData请求参数结构体
|
|
2713
|
+
*/
|
|
2714
|
+
export interface DescribeTRTCMarketQualityDataRequest {
|
|
2715
|
+
/**
|
|
2716
|
+
* 用户SdkAppId(如:1400xxxxxx)
|
|
2717
|
+
*/
|
|
2718
|
+
SdkAppId: string
|
|
2719
|
+
/**
|
|
2720
|
+
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
2721
|
+
*/
|
|
2722
|
+
StartTime: string
|
|
2723
|
+
/**
|
|
2724
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
2725
|
+
*/
|
|
2726
|
+
EndTime: string
|
|
2727
|
+
/**
|
|
2728
|
+
* 返回数据的粒度,支持设为以下值:
|
|
2729
|
+
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
2730
|
+
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
2731
|
+
*/
|
|
2732
|
+
Period: string
|
|
2549
2733
|
}
|
|
2550
2734
|
|
|
2551
2735
|
/**
|
|
@@ -2702,6 +2886,22 @@ export interface McuWaterMarkText {
|
|
|
2702
2886
|
BackGroundColor?: string
|
|
2703
2887
|
}
|
|
2704
2888
|
|
|
2889
|
+
/**
|
|
2890
|
+
* SeriesInfos类型
|
|
2891
|
+
*/
|
|
2892
|
+
export interface SeriesInfos {
|
|
2893
|
+
/**
|
|
2894
|
+
* 数据列
|
|
2895
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2896
|
+
*/
|
|
2897
|
+
Columns?: Array<string>
|
|
2898
|
+
/**
|
|
2899
|
+
* 数据值
|
|
2900
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2901
|
+
*/
|
|
2902
|
+
Values?: Array<RowValues>
|
|
2903
|
+
}
|
|
2904
|
+
|
|
2705
2905
|
/**
|
|
2706
2906
|
* RemoveUserByStrRoomId请求参数结构体
|
|
2707
2907
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreatePictureRequest, DescribeRelayUsageRequest, DescribeTRTCMarketQualityMetricDataResponse,
|
|
2
|
+
import { CreatePictureRequest, DescribeRelayUsageRequest, DescribeTRTCMarketQualityMetricDataResponse, DescribeTRTCRealTimeScaleDataRequest, DescribeTRTCMarketScaleDataRequest, DescribeUserEventRequest, DescribeTrtcRoomUsageResponse, StopPublishCdnStreamResponse, DescribeTRTCRealTimeScaleMetricDataRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeTRTCMarketScaleDataResponse, ModifyPictureRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeTRTCRealTimeScaleDataResponse, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeMixTranscodingUsageRequest, DescribeTRTCMarketQualityDataResponse, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DismissRoomRequest, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeUserInfoResponse, RemoveUserByStrRoomIdResponse, DescribeTRTCRealTimeScaleMetricDataResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, DescribeRecordingUsageResponse, StopMCUMixTranscodeRequest, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, DescribeTRTCRealTimeQualityMetricDataResponse, DescribeTRTCRealTimeQualityDataRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopPublishCdnStreamRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StartPublishCdnStreamRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribePictureResponse, DescribeTrtcRoomUsageRequest, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, DescribeCloudRecordingResponse, DismissRoomResponse, DescribeTRTCMarketQualityDataRequest, UpdatePublishCdnStreamRequest, DeletePictureRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, DescribeTRTCMarketScaleMetricDataResponse, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
|
|
3
3
|
/**
|
|
4
4
|
* trtc client
|
|
5
5
|
* @class
|
|
@@ -196,6 +196,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
196
196
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
197
197
|
*/
|
|
198
198
|
CreatePicture(req: CreatePictureRequest, cb?: (error: string, rep: CreatePictureResponse) => void): Promise<CreatePictureResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
201
|
+
-userCount(在线用户数)
|
|
202
|
+
-roomCount(在线房间数)
|
|
203
|
+
注意:
|
|
204
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
205
|
+
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
206
|
+
xa0
|
|
207
|
+
3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/category
|
|
208
|
+
*/
|
|
209
|
+
DescribeTRTCRealTimeScaleData(req: DescribeTRTCRealTimeScaleDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeScaleDataResponse) => void): Promise<DescribeTRTCRealTimeScaleDataResponse>;
|
|
199
210
|
/**
|
|
200
211
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
201
212
|
*/
|
|
@@ -232,6 +243,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
232
243
|
3、客户端混流和服务端混流不能混用。
|
|
233
244
|
*/
|
|
234
245
|
StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
|
|
246
|
+
/**
|
|
247
|
+
* 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
|
|
248
|
+
userCount:通话人数,
|
|
249
|
+
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
250
|
+
peakCurrentChannels:峰值同时在线频道数。
|
|
251
|
+
peakCurrentUsers:峰值同时在线人数。
|
|
252
|
+
注意:
|
|
253
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
254
|
+
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
|
|
255
|
+
*/
|
|
256
|
+
DescribeTRTCMarketScaleData(req: DescribeTRTCMarketScaleDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleDataResponse) => void): Promise<DescribeTRTCMarketScaleDataResponse>;
|
|
235
257
|
/**
|
|
236
258
|
* 接口说明:
|
|
237
259
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
|
|
@@ -340,6 +362,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
340
362
|
注:请参见启动转推任务的接口说明和使用说明。
|
|
341
363
|
*/
|
|
342
364
|
UpdatePublishCdnStream(req: UpdatePublishCdnStreamRequest, cb?: (error: string, rep: UpdatePublishCdnStreamResponse) => void): Promise<UpdatePublishCdnStreamResponse>;
|
|
365
|
+
/**
|
|
366
|
+
* 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
|
|
367
|
+
-视频卡顿率
|
|
368
|
+
-音频卡顿率
|
|
369
|
+
注意:
|
|
370
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
371
|
+
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
372
|
+
*/
|
|
373
|
+
DescribeTRTCRealTimeQualityData(req: DescribeTRTCRealTimeQualityDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeQualityDataResponse) => void): Promise<DescribeTRTCRealTimeQualityDataResponse>;
|
|
343
374
|
/**
|
|
344
375
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
345
376
|
*/
|
|
@@ -348,6 +379,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
348
379
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
|
|
349
380
|
*/
|
|
350
381
|
DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
|
|
382
|
+
/**
|
|
383
|
+
* 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
384
|
+
joinSuccessRate:加入频道成功率。
|
|
385
|
+
joinSuccessIn5sRate:5s内加入频道成功率。
|
|
386
|
+
audioFreezeRate:音频卡顿率。
|
|
387
|
+
videoFreezeRate:视频卡顿率。
|
|
388
|
+
networkDelay :网络延迟率。
|
|
389
|
+
注意:
|
|
390
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
391
|
+
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
|
|
392
|
+
*/
|
|
393
|
+
DescribeTRTCMarketQualityData(req: DescribeTRTCMarketQualityDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityDataResponse) => void): Promise<DescribeTRTCMarketQualityDataResponse>;
|
|
351
394
|
/**
|
|
352
395
|
* 停止转推任务。
|
|
353
396
|
*/
|
|
@@ -239,6 +239,19 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
239
239
|
async CreatePicture(req, cb) {
|
|
240
240
|
return this.request("CreatePicture", req, cb);
|
|
241
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* 查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
244
|
+
-userCount(在线用户数)
|
|
245
|
+
-roomCount(在线房间数)
|
|
246
|
+
注意:
|
|
247
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
248
|
+
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
249
|
+
xa0
|
|
250
|
+
3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/category
|
|
251
|
+
*/
|
|
252
|
+
async DescribeTRTCRealTimeScaleData(req, cb) {
|
|
253
|
+
return this.request("DescribeTRTCRealTimeScaleData", req, cb);
|
|
254
|
+
}
|
|
242
255
|
/**
|
|
243
256
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
244
257
|
*/
|
|
@@ -283,6 +296,19 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
283
296
|
async StartMCUMixTranscode(req, cb) {
|
|
284
297
|
return this.request("StartMCUMixTranscode", req, cb);
|
|
285
298
|
}
|
|
299
|
+
/**
|
|
300
|
+
* 查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
|
|
301
|
+
userCount:通话人数,
|
|
302
|
+
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
303
|
+
peakCurrentChannels:峰值同时在线频道数。
|
|
304
|
+
peakCurrentUsers:峰值同时在线人数。
|
|
305
|
+
注意:
|
|
306
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
307
|
+
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
|
|
308
|
+
*/
|
|
309
|
+
async DescribeTRTCMarketScaleData(req, cb) {
|
|
310
|
+
return this.request("DescribeTRTCMarketScaleData", req, cb);
|
|
311
|
+
}
|
|
286
312
|
/**
|
|
287
313
|
* 接口说明:
|
|
288
314
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
|
|
@@ -423,6 +449,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
423
449
|
async UpdatePublishCdnStream(req, cb) {
|
|
424
450
|
return this.request("UpdatePublishCdnStream", req, cb);
|
|
425
451
|
}
|
|
452
|
+
/**
|
|
453
|
+
* 查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
|
|
454
|
+
-视频卡顿率
|
|
455
|
+
-音频卡顿率
|
|
456
|
+
注意:
|
|
457
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
458
|
+
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
459
|
+
*/
|
|
460
|
+
async DescribeTRTCRealTimeQualityData(req, cb) {
|
|
461
|
+
return this.request("DescribeTRTCRealTimeQualityData", req, cb);
|
|
462
|
+
}
|
|
426
463
|
/**
|
|
427
464
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
428
465
|
*/
|
|
@@ -435,6 +472,20 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
435
472
|
async DescribePicture(req, cb) {
|
|
436
473
|
return this.request("DescribePicture", req, cb);
|
|
437
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
477
|
+
joinSuccessRate:加入频道成功率。
|
|
478
|
+
joinSuccessIn5sRate:5s内加入频道成功率。
|
|
479
|
+
audioFreezeRate:音频卡顿率。
|
|
480
|
+
videoFreezeRate:视频卡顿率。
|
|
481
|
+
networkDelay :网络延迟率。
|
|
482
|
+
注意:
|
|
483
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
|
|
484
|
+
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
|
|
485
|
+
*/
|
|
486
|
+
async DescribeTRTCMarketQualityData(req, cb) {
|
|
487
|
+
return this.request("DescribeTRTCMarketQualityData", req, cb);
|
|
488
|
+
}
|
|
438
489
|
/**
|
|
439
490
|
* 停止转推任务。
|
|
440
491
|
*/
|