tencentcloud-sdk-nodejs-trtc 4.0.816 → 4.0.818

Sign up to get free protection for your applications and to get access to all the features.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-trtc",
3
- "version": "4.0.816",
3
+ "version": "4.0.818",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -23,7 +23,7 @@
23
23
  | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2024-03-20 01:08:18 |
24
24
  | bda | [人体分析](https://cloud.tencent.com/document/product/1208) | 2024-03-20 01:08:23 |
25
25
  | bi | [商业智能分析 BI](https://cloud.tencent.com/document/product/590) | 2024-03-20 01:08:26 |
26
- | billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-03-20 01:08:31 |
26
+ | billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2024-03-21 01:08:21 |
27
27
  | bizlive | [商业直播](https://cloud.tencent.com/document/product) | 2020-03-10 01:08:07 |
28
28
  | bm | [黑石物理服务器CPM](https://cloud.tencent.com/document/product/386) | 2024-03-20 01:08:40 |
29
29
  | bma | [品牌经营管家](https://cloud.tencent.com/document/product/1296) | 2024-03-20 01:08:51 |
@@ -38,11 +38,11 @@
38
38
  | captcha | [验证码](https://cloud.tencent.com/document/product/1110) | 2024-03-20 01:09:24 |
39
39
  | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2024-03-20 01:09:27 |
40
40
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2024-03-20 01:09:28 |
41
- | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2024-03-20 01:09:30 |
41
+ | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2024-03-21 01:09:20 |
42
42
  | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-03-20 01:09:36 |
43
43
  | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-03-20 01:09:44 |
44
44
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2024-03-20 01:10:04 |
45
- | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-03-20 01:10:08 |
45
+ | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-03-21 01:09:58 |
46
46
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2024-03-20 01:10:22 |
47
47
  | cdwch | [云数据仓库 ClickHouse](https://cloud.tencent.com/document/product/1299) | 2024-03-20 01:10:23 |
48
48
  | cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2024-03-20 01:10:27 |
@@ -70,7 +70,7 @@
70
70
  | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-03-20 01:12:19 |
71
71
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2024-03-20 01:12:25 |
72
72
  | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-03-20 01:12:26 |
73
- | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-03-20 01:12:48 |
73
+ | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-03-22 01:11:57 |
74
74
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
75
75
  | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-03-20 01:13:46 |
76
76
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2024-03-20 01:14:04 |
@@ -80,7 +80,7 @@
80
80
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2024-03-20 01:14:24 |
81
81
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2024-03-20 01:14:27 |
82
82
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2024-03-20 01:14:30 |
83
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-03-20 01:14:40 |
83
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-03-21 01:14:28 |
84
84
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-03-20 01:14:57 |
85
85
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2024-03-20 01:15:06 |
86
86
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2024-03-20 01:15:11 |
@@ -96,10 +96,10 @@
96
96
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
97
97
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-03-20 01:16:19 |
98
98
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-03-20 01:16:27 |
99
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-20 01:16:36 |
99
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-03-22 01:15:20 |
100
100
  | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-03-20 01:16:49 |
101
101
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2024-03-20 01:17:05 |
102
- | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-03-20 01:17:06 |
102
+ | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-03-22 01:15:45 |
103
103
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2024-03-20 01:17:11 |
104
104
  | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2024-03-20 01:17:13 |
105
105
  | gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2024-03-20 01:17:14 |
@@ -109,7 +109,7 @@
109
109
  | gs | [云游戏](https://cloud.tencent.com/document/product/1162) | 2024-03-20 01:17:33 |
110
110
  | gse | [游戏服务器伸缩](https://cloud.tencent.com/document/product/1165) | 2022-07-11 06:12:44 |
111
111
  | habo | [](https://cloud.tencent.com/document/product) | 2019-05-09 19:37:22 |
112
- | hai | [高性能应用服务](https://cloud.tencent.com/document/product/1721) | 2024-03-20 01:17:34 |
112
+ | hai | [高性能应用服务](https://cloud.tencent.com/document/product/1721) | 2024-03-22 01:16:13 |
113
113
  | hasim | [高可用物联网卡](https://cloud.tencent.com/document/product/1482) | 2023-05-18 01:29:47 |
114
114
  | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2024-03-20 01:17:36 |
115
115
  | hunyuan | [腾讯混元大模型](https://cloud.tencent.com/document/product/1729) | 2024-03-20 01:17:37 |
@@ -132,9 +132,9 @@
132
132
  | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2024-03-20 01:19:17 |
133
133
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2024-03-20 01:19:20 |
134
134
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2024-03-20 01:19:25 |
135
- | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-03-20 01:19:31 |
135
+ | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2024-03-21 01:19:23 |
136
136
  | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2024-03-20 01:19:40 |
137
- | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-03-20 01:19:52 |
137
+ | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2024-03-21 01:19:47 |
138
138
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
139
139
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
140
140
  | mall | [商场客留大数据](https://cloud.tencent.com/document/product/1707) | 2024-03-20 01:20:11 |
@@ -183,8 +183,8 @@
183
183
  | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2024-03-20 01:24:04 |
184
184
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-03-20 01:24:08 |
185
185
  | svp | [节省计划](https://cloud.tencent.com/document/product/1761) | 2024-03-20 01:24:09 |
186
- | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2024-03-20 01:24:09 |
187
- | tag | [标签](https://cloud.tencent.com/document/product/651) | 2024-03-20 01:24:10 |
186
+ | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2024-03-21 01:24:01 |
187
+ | tag | [标签](https://cloud.tencent.com/document/product/651) | 2024-03-22 01:21:43 |
188
188
  | tan | [碳引擎](https://cloud.tencent.com/document/product/1498) | 2024-03-20 01:24:15 |
189
189
  | tat | [自动化助手](https://cloud.tencent.com/document/product/1340) | 2024-03-20 01:24:15 |
190
190
  | tav | [文件检测](https://cloud.tencent.com/document/product) | 2019-11-28 22:10:04 |
@@ -205,7 +205,7 @@
205
205
  | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-03-20 01:25:54 |
206
206
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2024-03-20 01:26:12 |
207
207
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2024-03-20 01:26:14 |
208
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-20 01:26:23 |
208
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-03-22 01:23:38 |
209
209
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-03-20 01:27:05 |
210
210
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
211
211
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
@@ -224,8 +224,8 @@
224
224
  | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-03-20 01:29:00 |
225
225
  | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2024-03-20 01:29:06 |
226
226
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-03-20 01:29:13 |
227
- | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-20 01:29:16 |
228
- | tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-03-20 01:29:24 |
227
+ | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-03-22 01:25:05 |
228
+ | tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-03-21 01:28:04 |
229
229
  | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-03-20 01:29:39 |
230
230
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2024-03-20 01:30:06 |
231
231
  | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2024-03-20 01:30:07 |
@@ -32,16 +32,18 @@ import {
32
32
  AbnormalEvent,
33
33
  ScaleInfomation,
34
34
  DescribeTRTCRealTimeScaleMetricDataRequest,
35
+ StopWebRecordRequest,
35
36
  VideoEncodeParams,
36
37
  DescribeUserEventResponse,
37
38
  VideoEncode,
38
- LayoutParams,
39
39
  StopMCUMixTranscodeByStrRoomIdResponse,
40
40
  PictureInfo,
41
41
  DescribeCallDetailInfoRequest,
42
42
  DescribeTRTCMarketScaleDataResponse,
43
43
  ModifyPictureRequest,
44
+ DescribeWebRecordResponse,
44
45
  DescribeUserInfoRequest,
46
+ DescribeTRTCMarketQualityDataResponse,
45
47
  DescribeRelayUsageRequest,
46
48
  WaterMarkParams,
47
49
  DescribeRecordStatisticResponse,
@@ -51,6 +53,7 @@ import {
51
53
  TimeValue,
52
54
  DismissRoomByStrRoomIdRequest,
53
55
  DescribeTRTCMarketQualityMetricDataRequest,
56
+ DescribeWebRecordRequest,
54
57
  DescribeTRTCRealTimeScaleDataResponse,
55
58
  DescribeRecordStatisticRequest,
56
59
  DescribeRoomInfoRequest,
@@ -64,7 +67,7 @@ import {
64
67
  DescribeStreamIngestResponse,
65
68
  MixTranscodeParams,
66
69
  StopStreamIngestRequest,
67
- DescribeTRTCMarketQualityDataResponse,
70
+ DescribeTRTCRealTimeQualityDataRequest,
68
71
  SmallVideoLayoutParams,
69
72
  SubscribeStreamUserIds,
70
73
  WaterMarkImage,
@@ -81,6 +84,7 @@ import {
81
84
  RemoveUserByStrRoomIdResponse,
82
85
  DescribeTRTCRealTimeScaleMetricDataResponse,
83
86
  StartMCUMixTranscodeRequest,
87
+ WebRecordVideoParams,
84
88
  McuWaterMarkImage,
85
89
  StartPublishCdnStreamResponse,
86
90
  TrtcUsage,
@@ -108,7 +112,8 @@ import {
108
112
  TencentVod,
109
113
  McuPassThrough,
110
114
  DescribeTRTCRealTimeQualityMetricDataResponse,
111
- DescribeTRTCRealTimeQualityDataRequest,
115
+ LayoutParams,
116
+ StartWebRecordResponse,
112
117
  RecordUsage,
113
118
  CreateCloudRecordingRequest,
114
119
  OutputParams,
@@ -145,8 +150,10 @@ import {
145
150
  EventMessage,
146
151
  DescribeTRTCMarketQualityDataRequest,
147
152
  UpdatePublishCdnStreamRequest,
153
+ StartWebRecordRequest,
148
154
  MaxVideoUser,
149
155
  AgentParams,
156
+ StopWebRecordResponse,
150
157
  DeletePictureRequest,
151
158
  McuSeiParams,
152
159
  UpdatePublishCdnStreamResponse,
@@ -226,6 +233,16 @@ networkDelay :网络延迟率。
226
233
  return this.request("DescribeTRTCMarketQualityMetricData", req, cb)
227
234
  }
228
235
 
236
+ /**
237
+ * 查询页面录制任务
238
+ */
239
+ async DescribeWebRecord(
240
+ req: DescribeWebRecordRequest,
241
+ cb?: (error: string, rep: DescribeWebRecordResponse) => void
242
+ ): Promise<DescribeWebRecordResponse> {
243
+ return this.request("DescribeWebRecord", req, cb)
244
+ }
245
+
229
246
  /**
230
247
  * TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。
231
248
 
@@ -514,6 +531,17 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
514
531
  return this.request("DescribeUserEvent", req, cb)
515
532
  }
516
533
 
534
+ /**
535
+ * 通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
536
+ 因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
537
+ */
538
+ async StartWebRecord(
539
+ req: StartWebRecordRequest,
540
+ cb?: (error: string, rep: StartWebRecordResponse) => void
541
+ ): Promise<StartWebRecordResponse> {
542
+ return this.request("StartWebRecord", req, cb)
543
+ }
544
+
517
545
  /**
518
546
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
519
547
 
@@ -561,6 +589,16 @@ peakCurrentUsers:峰值同时在线人数。
561
589
  return this.request("DescribeTRTCMarketScaleData", req, cb)
562
590
  }
563
591
 
592
+ /**
593
+ * 停止页面录制任务
594
+ */
595
+ async StopWebRecord(
596
+ req: StopWebRecordRequest,
597
+ cb?: (error: string, rep: StopWebRecordResponse) => void
598
+ ): Promise<StopWebRecordResponse> {
599
+ return this.request("StopWebRecord", req, cb)
600
+ }
601
+
564
602
  /**
565
603
  * 接口说明:
566
604
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
@@ -413,6 +413,16 @@ export interface DescribeTRTCRealTimeScaleMetricDataRequest {
413
413
  RoomId?: string
414
414
  }
415
415
 
416
+ /**
417
+ * StopWebRecord请求参数结构体
418
+ */
419
+ export interface StopWebRecordRequest {
420
+ /**
421
+ * 需要停止的任务Id
422
+ */
423
+ TaskId: string
424
+ }
425
+
416
426
  /**
417
427
  * 视频转码参数
418
428
  */
@@ -479,56 +489,6 @@ export interface VideoEncode {
479
489
  Gop: number
480
490
  }
481
491
 
482
- /**
483
- * MCU混流布局参数
484
- */
485
- export interface LayoutParams {
486
- /**
487
- * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
488
- */
489
- Template?: number
490
- /**
491
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
492
- */
493
- MainVideoUserId?: string
494
- /**
495
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
496
- */
497
- MainVideoStreamType?: number
498
- /**
499
- * 画中画模板中有效,代表小画面的布局参数。
500
- */
501
- SmallVideoLayoutParams?: SmallVideoLayoutParams
502
- /**
503
- * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
504
- */
505
- MainVideoRightAlign?: number
506
- /**
507
- * 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
508
- */
509
- MixVideoUids?: Array<string>
510
- /**
511
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
512
- */
513
- PresetLayoutConfig?: Array<PresetLayoutConfig>
514
- /**
515
- * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
516
- */
517
- PlaceHolderMode?: number
518
- /**
519
- * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
520
- */
521
- PureAudioHoldPlaceMode?: number
522
- /**
523
- * 水印参数。
524
- */
525
- WaterMarkParams?: WaterMarkParams
526
- /**
527
- * 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
528
- */
529
- RenderMode?: number
530
- }
531
-
532
492
  /**
533
493
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
534
494
  */
@@ -674,6 +634,21 @@ export interface ModifyPictureRequest {
674
634
  YPosition?: number
675
635
  }
676
636
 
637
+ /**
638
+ * DescribeWebRecord返回参数结构体
639
+ */
640
+ export interface DescribeWebRecordResponse {
641
+ /**
642
+ * 1: 正在录制中
643
+ 2: 任务不存在
644
+ */
645
+ Status?: number
646
+ /**
647
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
648
+ */
649
+ RequestId?: string
650
+ }
651
+
677
652
  /**
678
653
  * DescribeUserInfo请求参数结构体
679
654
  */
@@ -713,6 +688,21 @@ export interface DescribeUserInfoRequest {
713
688
  PageSize?: number
714
689
  }
715
690
 
691
+ /**
692
+ * DescribeTRTCMarketQualityData返回参数结构体
693
+ */
694
+ export interface DescribeTRTCMarketQualityDataResponse {
695
+ /**
696
+ * TRTC监控数据出参
697
+ 注意:此字段可能返回 null,表示取不到有效值。
698
+ */
699
+ Data?: TRTCDataResult
700
+ /**
701
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
702
+ */
703
+ RequestId?: string
704
+ }
705
+
716
706
  /**
717
707
  * DescribeRelayUsage请求参数结构体
718
708
  */
@@ -891,6 +881,16 @@ h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数
891
881
  Period: string
892
882
  }
893
883
 
884
+ /**
885
+ * DescribeWebRecord请求参数结构体
886
+ */
887
+ export interface DescribeWebRecordRequest {
888
+ /**
889
+ * 开始页面录制时返回的任务id
890
+ */
891
+ TaskId: string
892
+ }
893
+
894
894
  /**
895
895
  * DescribeTRTCRealTimeScaleData返回参数结构体
896
896
  */
@@ -1170,18 +1170,25 @@ export interface StopStreamIngestRequest {
1170
1170
  }
1171
1171
 
1172
1172
  /**
1173
- * DescribeTRTCMarketQualityData返回参数结构体
1173
+ * DescribeTRTCRealTimeQualityData请求参数结构体
1174
1174
  */
1175
- export interface DescribeTRTCMarketQualityDataResponse {
1175
+ export interface DescribeTRTCRealTimeQualityDataRequest {
1176
1176
  /**
1177
- * TRTC监控数据出参
1178
- 注意:此字段可能返回 null,表示取不到有效值。
1177
+ * 用户SdkAppId(如:1400xxxxxx)
1179
1178
  */
1180
- Data?: TRTCDataResult
1179
+ SdkAppId: string
1181
1180
  /**
1182
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1181
+ * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
1183
1182
  */
1184
- RequestId?: string
1183
+ StartTime: number
1184
+ /**
1185
+ * 结束时间,unix时间戳,单位:秒
1186
+ */
1187
+ EndTime: number
1188
+ /**
1189
+ * 房间ID
1190
+ */
1191
+ RoomId?: string
1185
1192
  }
1186
1193
 
1187
1194
  /**
@@ -1541,6 +1548,25 @@ export interface StartMCUMixTranscodeRequest {
1541
1548
  PublishCdnParams?: PublishCdnParams
1542
1549
  }
1543
1550
 
1551
+ /**
1552
+ * 页面录制视频参数
1553
+ */
1554
+ export interface WebRecordVideoParams {
1555
+ /**
1556
+ * 录制画面宽度,默认为1280,取值范围[0, 1920]
1557
+ */
1558
+ Width?: number
1559
+ /**
1560
+ * 录制画面高度,默认为720,取值范围[0, 1080]
1561
+ */
1562
+ Height?: number
1563
+ /**
1564
+ * 指定输出格式,可选hls,mp4
1565
+
1566
+ */
1567
+ Format?: string
1568
+ }
1569
+
1544
1570
  /**
1545
1571
  * 图片水印参数。
1546
1572
  */
@@ -2124,7 +2150,7 @@ export interface TencentVod {
2124
2150
  */
2125
2151
  MediaType?: number
2126
2152
  /**
2127
- * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。
2153
+ * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。
2128
2154
  */
2129
2155
  UserDefineRecordId?: string
2130
2156
  }
@@ -2171,25 +2197,67 @@ export interface DescribeTRTCRealTimeQualityMetricDataResponse {
2171
2197
  }
2172
2198
 
2173
2199
  /**
2174
- * DescribeTRTCRealTimeQualityData请求参数结构体
2200
+ * MCU混流布局参数
2175
2201
  */
2176
- export interface DescribeTRTCRealTimeQualityDataRequest {
2202
+ export interface LayoutParams {
2177
2203
  /**
2178
- * 用户SdkAppId(如:1400xxxxxx)
2204
+ * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
2179
2205
  */
2180
- SdkAppId: string
2206
+ Template?: number
2181
2207
  /**
2182
- * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
2208
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
2183
2209
  */
2184
- StartTime: number
2210
+ MainVideoUserId?: string
2185
2211
  /**
2186
- * 结束时间,unix时间戳,单位:秒
2212
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
2187
2213
  */
2188
- EndTime: number
2214
+ MainVideoStreamType?: number
2189
2215
  /**
2190
- * 房间ID
2216
+ * 画中画模板中有效,代表小画面的布局参数。
2191
2217
  */
2192
- RoomId?: string
2218
+ SmallVideoLayoutParams?: SmallVideoLayoutParams
2219
+ /**
2220
+ * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
2221
+ */
2222
+ MainVideoRightAlign?: number
2223
+ /**
2224
+ * 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
2225
+ */
2226
+ MixVideoUids?: Array<string>
2227
+ /**
2228
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
2229
+ */
2230
+ PresetLayoutConfig?: Array<PresetLayoutConfig>
2231
+ /**
2232
+ * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
2233
+ */
2234
+ PlaceHolderMode?: number
2235
+ /**
2236
+ * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
2237
+ */
2238
+ PureAudioHoldPlaceMode?: number
2239
+ /**
2240
+ * 水印参数。
2241
+ */
2242
+ WaterMarkParams?: WaterMarkParams
2243
+ /**
2244
+ * 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
2245
+ */
2246
+ RenderMode?: number
2247
+ }
2248
+
2249
+ /**
2250
+ * StartWebRecord返回参数结构体
2251
+ */
2252
+ export interface StartWebRecordResponse {
2253
+ /**
2254
+ * 录制任务的唯一Id
2255
+ */
2256
+ TaskId?: string
2257
+ /**
2258
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2259
+ */
2260
+ RequestId?: string
2193
2261
  }
2194
2262
 
2195
2263
  /**
@@ -2956,6 +3024,39 @@ export interface UpdatePublishCdnStreamRequest {
2956
3024
  FeedBackRoomParams?: Array<McuFeedBackRoomParams>
2957
3025
  }
2958
3026
 
3027
+ /**
3028
+ * StartWebRecord请求参数结构体
3029
+ */
3030
+ export interface StartWebRecordRequest {
3031
+ /**
3032
+ * 需要录制的网页URL
3033
+
3034
+ */
3035
+ RecordUrl: string
3036
+ /**
3037
+ * 录制最大时长限制, 单位 s, 合法取值范围[0, 36000], 默认 36000s(10 小时)
3038
+
3039
+ */
3040
+ MaxDurationLimit?: number
3041
+ /**
3042
+ * 云存储相关的参数,目前支持腾讯云对象存储,不支持第三方云存储以及VOD
3043
+ */
3044
+ StorageParams?: StorageParams
3045
+ /**
3046
+ * 页面录制视频参数
3047
+ */
3048
+ WebRecordVideoParams?: WebRecordVideoParams
3049
+ /**
3050
+ * TRTC的SdkAppId
3051
+ */
3052
+ SdkAppId?: number
3053
+ /**
3054
+ * 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复
3055
+ 传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。
3056
+ */
3057
+ RecordId?: string
3058
+ }
3059
+
2959
3060
  /**
2960
3061
  * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
2961
3062
  */
@@ -2984,6 +3085,16 @@ export interface AgentParams {
2984
3085
  MaxIdleTime?: number
2985
3086
  }
2986
3087
 
3088
+ /**
3089
+ * StopWebRecord返回参数结构体
3090
+ */
3091
+ export interface StopWebRecordResponse {
3092
+ /**
3093
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3094
+ */
3095
+ RequestId?: string
3096
+ }
3097
+
2987
3098
  /**
2988
3099
  * DeletePicture请求参数结构体
2989
3100
  */
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { CreatePictureRequest, DescribeTRTCMarketQualityMetricDataResponse, DescribeTRTCRealTimeScaleDataRequest, DescribeTRTCMarketScaleDataRequest, DescribeUserEventRequest, DescribeTrtcRoomUsageResponse, StopPublishCdnStreamResponse, DescribeTRTCRealTimeScaleMetricDataRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeTRTCMarketScaleDataResponse, ModifyPictureRequest, DescribeUserInfoRequest, DescribeRelayUsageRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeTRTCRealTimeScaleDataResponse, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeMixTranscodingUsageRequest, DescribeStreamIngestResponse, StopStreamIngestRequest, DescribeTRTCMarketQualityDataResponse, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DismissRoomRequest, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeUserInfoResponse, RemoveUserByStrRoomIdResponse, DescribeTRTCRealTimeScaleMetricDataResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest, DescribeRecordingUsageResponse, StopMCUMixTranscodeRequest, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, DescribeTRTCRealTimeQualityMetricDataResponse, DescribeTRTCRealTimeQualityDataRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopPublishCdnStreamRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StartPublishCdnStreamRequest, CreateCloudRecordingResponse, StartStreamIngestResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribePictureResponse, DescribeTrtcRoomUsageRequest, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, DescribeCloudRecordingResponse, DismissRoomResponse, StopStreamIngestResponse, DescribeTRTCMarketQualityDataRequest, UpdatePublishCdnStreamRequest, DeletePictureRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, DescribeStreamIngestRequest, DescribeTRTCMarketScaleMetricDataResponse, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
2
+ import { CreatePictureRequest, DescribeTRTCMarketQualityMetricDataResponse, DescribeTRTCRealTimeScaleDataRequest, DescribeTRTCMarketScaleDataRequest, DescribeUserEventRequest, DescribeTrtcRoomUsageResponse, StopPublishCdnStreamResponse, DescribeTRTCRealTimeScaleMetricDataRequest, StopWebRecordRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeTRTCMarketScaleDataResponse, ModifyPictureRequest, DescribeWebRecordResponse, DescribeUserInfoRequest, DescribeTRTCMarketQualityDataResponse, DescribeRelayUsageRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeWebRecordRequest, DescribeTRTCRealTimeScaleDataResponse, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeMixTranscodingUsageRequest, DescribeStreamIngestResponse, StopStreamIngestRequest, DescribeTRTCRealTimeQualityDataRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DismissRoomRequest, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeUserInfoResponse, RemoveUserByStrRoomIdResponse, DescribeTRTCRealTimeScaleMetricDataResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest, DescribeRecordingUsageResponse, StopMCUMixTranscodeRequest, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, DescribeTRTCRealTimeQualityMetricDataResponse, StartWebRecordResponse, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopPublishCdnStreamRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StartPublishCdnStreamRequest, CreateCloudRecordingResponse, StartStreamIngestResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribePictureResponse, DescribeTrtcRoomUsageRequest, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, DescribeCloudRecordingResponse, DismissRoomResponse, StopStreamIngestResponse, DescribeTRTCMarketQualityDataRequest, UpdatePublishCdnStreamRequest, StartWebRecordRequest, StopWebRecordResponse, DeletePictureRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, DescribeStreamIngestRequest, DescribeTRTCMarketScaleMetricDataResponse, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
3
3
  /**
4
4
  * trtc client
5
5
  * @class
@@ -34,6 +34,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
34
34
  2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
35
35
  */
36
36
  DescribeTRTCMarketQualityMetricData(req: DescribeTRTCMarketQualityMetricDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityMetricDataResponse) => void): Promise<DescribeTRTCMarketQualityMetricDataResponse>;
37
+ /**
38
+ * 查询页面录制任务
39
+ */
40
+ DescribeWebRecord(req: DescribeWebRecordRequest, cb?: (error: string, rep: DescribeWebRecordResponse) => void): Promise<DescribeWebRecordResponse>;
37
41
  /**
38
42
  * TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。
39
43
 
@@ -232,6 +236,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
232
236
  * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
233
237
  */
234
238
  DescribeUserEvent(req: DescribeUserEventRequest, cb?: (error: string, rep: DescribeUserEventResponse) => void): Promise<DescribeUserEventResponse>;
239
+ /**
240
+ * 通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
241
+ 因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
242
+ */
243
+ StartWebRecord(req: StartWebRecordRequest, cb?: (error: string, rep: StartWebRecordResponse) => void): Promise<StartWebRecordResponse>;
235
244
  /**
236
245
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
237
246
 
@@ -267,6 +276,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
267
276
  2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
268
277
  */
269
278
  DescribeTRTCMarketScaleData(req: DescribeTRTCMarketScaleDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleDataResponse) => void): Promise<DescribeTRTCMarketScaleDataResponse>;
279
+ /**
280
+ * 停止页面录制任务
281
+ */
282
+ StopWebRecord(req: StopWebRecordRequest, cb?: (error: string, rep: StopWebRecordResponse) => void): Promise<StopWebRecordResponse>;
270
283
  /**
271
284
  * 接口说明:
272
285
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
@@ -61,6 +61,12 @@ class Client extends TencentCloudCommon.AbstractClient {
61
61
  async DescribeTRTCMarketQualityMetricData(req, cb) {
62
62
  return this.request("DescribeTRTCMarketQualityMetricData", req, cb);
63
63
  }
64
+ /**
65
+ * 查询页面录制任务
66
+ */
67
+ async DescribeWebRecord(req, cb) {
68
+ return this.request("DescribeWebRecord", req, cb);
69
+ }
64
70
  /**
65
71
  * TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。
66
72
 
@@ -289,6 +295,13 @@ class Client extends TencentCloudCommon.AbstractClient {
289
295
  async DescribeUserEvent(req, cb) {
290
296
  return this.request("DescribeUserEvent", req, cb);
291
297
  }
298
+ /**
299
+ * 通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
300
+ 因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
301
+ */
302
+ async StartWebRecord(req, cb) {
303
+ return this.request("StartWebRecord", req, cb);
304
+ }
292
305
  /**
293
306
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
294
307
 
@@ -328,6 +341,12 @@ class Client extends TencentCloudCommon.AbstractClient {
328
341
  async DescribeTRTCMarketScaleData(req, cb) {
329
342
  return this.request("DescribeTRTCMarketScaleData", req, cb);
330
343
  }
344
+ /**
345
+ * 停止页面录制任务
346
+ */
347
+ async StopWebRecord(req, cb) {
348
+ return this.request("StopWebRecord", req, cb);
349
+ }
331
350
  /**
332
351
  * 接口说明:
333
352
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
@@ -381,6 +381,15 @@ export interface DescribeTRTCRealTimeScaleMetricDataRequest {
381
381
  */
382
382
  RoomId?: string;
383
383
  }
384
+ /**
385
+ * StopWebRecord请求参数结构体
386
+ */
387
+ export interface StopWebRecordRequest {
388
+ /**
389
+ * 需要停止的任务Id
390
+ */
391
+ TaskId: string;
392
+ }
384
393
  /**
385
394
  * 视频转码参数
386
395
  */
@@ -444,55 +453,6 @@ export interface VideoEncode {
444
453
  */
445
454
  Gop: number;
446
455
  }
447
- /**
448
- * MCU混流布局参数
449
- */
450
- export interface LayoutParams {
451
- /**
452
- * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
453
- */
454
- Template?: number;
455
- /**
456
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
457
- */
458
- MainVideoUserId?: string;
459
- /**
460
- * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
461
- */
462
- MainVideoStreamType?: number;
463
- /**
464
- * 画中画模板中有效,代表小画面的布局参数。
465
- */
466
- SmallVideoLayoutParams?: SmallVideoLayoutParams;
467
- /**
468
- * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
469
- */
470
- MainVideoRightAlign?: number;
471
- /**
472
- * 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
473
- */
474
- MixVideoUids?: Array<string>;
475
- /**
476
- * 自定义模板中有效,指定用户视频在混合画面中的位置。
477
- */
478
- PresetLayoutConfig?: Array<PresetLayoutConfig>;
479
- /**
480
- * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
481
- */
482
- PlaceHolderMode?: number;
483
- /**
484
- * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
485
- */
486
- PureAudioHoldPlaceMode?: number;
487
- /**
488
- * 水印参数。
489
- */
490
- WaterMarkParams?: WaterMarkParams;
491
- /**
492
- * 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
493
- */
494
- RenderMode?: number;
495
- }
496
456
  /**
497
457
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
498
458
  */
@@ -633,6 +593,20 @@ export interface ModifyPictureRequest {
633
593
  */
634
594
  YPosition?: number;
635
595
  }
596
+ /**
597
+ * DescribeWebRecord返回参数结构体
598
+ */
599
+ export interface DescribeWebRecordResponse {
600
+ /**
601
+ * 1: 正在录制中
602
+ 2: 任务不存在
603
+ */
604
+ Status?: number;
605
+ /**
606
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
607
+ */
608
+ RequestId?: string;
609
+ }
636
610
  /**
637
611
  * DescribeUserInfo请求参数结构体
638
612
  */
@@ -671,6 +645,20 @@ export interface DescribeUserInfoRequest {
671
645
  */
672
646
  PageSize?: number;
673
647
  }
648
+ /**
649
+ * DescribeTRTCMarketQualityData返回参数结构体
650
+ */
651
+ export interface DescribeTRTCMarketQualityDataResponse {
652
+ /**
653
+ * TRTC监控数据出参
654
+ 注意:此字段可能返回 null,表示取不到有效值。
655
+ */
656
+ Data?: TRTCDataResult;
657
+ /**
658
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
659
+ */
660
+ RequestId?: string;
661
+ }
674
662
  /**
675
663
  * DescribeRelayUsage请求参数结构体
676
664
  */
@@ -840,6 +828,15 @@ export interface DescribeTRTCMarketQualityMetricDataRequest {
840
828
  */
841
829
  Period: string;
842
830
  }
831
+ /**
832
+ * DescribeWebRecord请求参数结构体
833
+ */
834
+ export interface DescribeWebRecordRequest {
835
+ /**
836
+ * 开始页面录制时返回的任务id
837
+ */
838
+ TaskId: string;
839
+ }
843
840
  /**
844
841
  * DescribeTRTCRealTimeScaleData返回参数结构体
845
842
  */
@@ -1106,18 +1103,25 @@ export interface StopStreamIngestRequest {
1106
1103
  TaskId: string;
1107
1104
  }
1108
1105
  /**
1109
- * DescribeTRTCMarketQualityData返回参数结构体
1106
+ * DescribeTRTCRealTimeQualityData请求参数结构体
1110
1107
  */
1111
- export interface DescribeTRTCMarketQualityDataResponse {
1108
+ export interface DescribeTRTCRealTimeQualityDataRequest {
1112
1109
  /**
1113
- * TRTC监控数据出参
1114
- 注意:此字段可能返回 null,表示取不到有效值。
1110
+ * 用户SdkAppId(如:1400xxxxxx)
1115
1111
  */
1116
- Data?: TRTCDataResult;
1112
+ SdkAppId: string;
1117
1113
  /**
1118
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1114
+ * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
1119
1115
  */
1120
- RequestId?: string;
1116
+ StartTime: number;
1117
+ /**
1118
+ * 结束时间,unix时间戳,单位:秒
1119
+ */
1120
+ EndTime: number;
1121
+ /**
1122
+ * 房间ID
1123
+ */
1124
+ RoomId?: string;
1121
1125
  }
1122
1126
  /**
1123
1127
  * 画中画模板中有效,代表小画面的布局参数
@@ -1460,6 +1464,24 @@ export interface StartMCUMixTranscodeRequest {
1460
1464
  */
1461
1465
  PublishCdnParams?: PublishCdnParams;
1462
1466
  }
1467
+ /**
1468
+ * 页面录制视频参数
1469
+ */
1470
+ export interface WebRecordVideoParams {
1471
+ /**
1472
+ * 录制画面宽度,默认为1280,取值范围[0, 1920]
1473
+ */
1474
+ Width?: number;
1475
+ /**
1476
+ * 录制画面高度,默认为720,取值范围[0, 1080]
1477
+ */
1478
+ Height?: number;
1479
+ /**
1480
+ * 指定输出格式,可选hls,mp4
1481
+
1482
+ */
1483
+ Format?: string;
1484
+ }
1463
1485
  /**
1464
1486
  * 图片水印参数。
1465
1487
  */
@@ -2019,7 +2041,7 @@ export interface TencentVod {
2019
2041
  */
2020
2042
  MediaType?: number;
2021
2043
  /**
2022
- * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。
2044
+ * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。
2023
2045
  */
2024
2046
  UserDefineRecordId?: string;
2025
2047
  }
@@ -2063,25 +2085,66 @@ export interface DescribeTRTCRealTimeQualityMetricDataResponse {
2063
2085
  RequestId?: string;
2064
2086
  }
2065
2087
  /**
2066
- * DescribeTRTCRealTimeQualityData请求参数结构体
2088
+ * MCU混流布局参数
2067
2089
  */
2068
- export interface DescribeTRTCRealTimeQualityDataRequest {
2090
+ export interface LayoutParams {
2069
2091
  /**
2070
- * 用户SdkAppId(如:1400xxxxxx)
2092
+ * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
2071
2093
  */
2072
- SdkAppId: string;
2094
+ Template?: number;
2073
2095
  /**
2074
- * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
2096
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
2075
2097
  */
2076
- StartTime: number;
2098
+ MainVideoUserId?: string;
2077
2099
  /**
2078
- * 结束时间,unix时间戳,单位:秒
2100
+ * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
2079
2101
  */
2080
- EndTime: number;
2102
+ MainVideoStreamType?: number;
2081
2103
  /**
2082
- * 房间ID
2104
+ * 画中画模板中有效,代表小画面的布局参数。
2083
2105
  */
2084
- RoomId?: string;
2106
+ SmallVideoLayoutParams?: SmallVideoLayoutParams;
2107
+ /**
2108
+ * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
2109
+ */
2110
+ MainVideoRightAlign?: number;
2111
+ /**
2112
+ * 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
2113
+ */
2114
+ MixVideoUids?: Array<string>;
2115
+ /**
2116
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
2117
+ */
2118
+ PresetLayoutConfig?: Array<PresetLayoutConfig>;
2119
+ /**
2120
+ * 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
2121
+ */
2122
+ PlaceHolderMode?: number;
2123
+ /**
2124
+ * 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
2125
+ */
2126
+ PureAudioHoldPlaceMode?: number;
2127
+ /**
2128
+ * 水印参数。
2129
+ */
2130
+ WaterMarkParams?: WaterMarkParams;
2131
+ /**
2132
+ * 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
2133
+ */
2134
+ RenderMode?: number;
2135
+ }
2136
+ /**
2137
+ * StartWebRecord返回参数结构体
2138
+ */
2139
+ export interface StartWebRecordResponse {
2140
+ /**
2141
+ * 录制任务的唯一Id
2142
+ */
2143
+ TaskId?: string;
2144
+ /**
2145
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2146
+ */
2147
+ RequestId?: string;
2085
2148
  }
2086
2149
  /**
2087
2150
  * 录制的使用信息。
@@ -2811,6 +2874,38 @@ export interface UpdatePublishCdnStreamRequest {
2811
2874
  */
2812
2875
  FeedBackRoomParams?: Array<McuFeedBackRoomParams>;
2813
2876
  }
2877
+ /**
2878
+ * StartWebRecord请求参数结构体
2879
+ */
2880
+ export interface StartWebRecordRequest {
2881
+ /**
2882
+ * 需要录制的网页URL
2883
+
2884
+ */
2885
+ RecordUrl: string;
2886
+ /**
2887
+ * 录制最大时长限制, 单位 s, 合法取值范围[0, 36000], 默认 36000s(10 小时)
2888
+
2889
+ */
2890
+ MaxDurationLimit?: number;
2891
+ /**
2892
+ * 云存储相关的参数,目前支持腾讯云对象存储,不支持第三方云存储以及VOD
2893
+ */
2894
+ StorageParams?: StorageParams;
2895
+ /**
2896
+ * 页面录制视频参数
2897
+ */
2898
+ WebRecordVideoParams?: WebRecordVideoParams;
2899
+ /**
2900
+ * TRTC的SdkAppId
2901
+ */
2902
+ SdkAppId?: number;
2903
+ /**
2904
+ * 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复
2905
+ 传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。
2906
+ */
2907
+ RecordId?: string;
2908
+ }
2814
2909
  /**
2815
2910
  * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
2816
2911
  */
@@ -2837,6 +2932,15 @@ export interface AgentParams {
2837
2932
  */
2838
2933
  MaxIdleTime?: number;
2839
2934
  }
2935
+ /**
2936
+ * StopWebRecord返回参数结构体
2937
+ */
2938
+ export interface StopWebRecordResponse {
2939
+ /**
2940
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2941
+ */
2942
+ RequestId?: string;
2943
+ }
2840
2944
  /**
2841
2945
  * DeletePicture请求参数结构体
2842
2946
  */