tencentcloud-sdk-nodejs-trtc 4.0.459 → 4.0.461

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.
@@ -55,6 +55,27 @@ export interface CreatePictureRequest {
55
55
  YPosition: number
56
56
  }
57
57
 
58
+ /**
59
+ * DescribeRelayUsage请求参数结构体
60
+ */
61
+ export interface DescribeRelayUsageRequest {
62
+ /**
63
+ * 查询开始时间,格式为YYYY-MM-DD。
64
+ */
65
+ StartTime: string
66
+
67
+ /**
68
+ * 查询结束时间,格式为YYYY-MM-DD。
69
+ 单次查询统计区间最多不能超过31天。
70
+ */
71
+ EndTime: string
72
+
73
+ /**
74
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
75
+ */
76
+ SdkAppId?: number
77
+ }
78
+
58
79
  /**
59
80
  * 用户自定义混流布局参数列表。
60
81
  */
@@ -119,48 +140,66 @@ export interface MixLayout {
119
140
  }
120
141
 
121
142
  /**
122
- * RemoveUserByStrRoomId返回参数结构体
143
+ * 混流转推的视频相关参数。
123
144
  */
124
- export interface RemoveUserByStrRoomIdResponse {
145
+ export interface McuVideoParams {
125
146
  /**
126
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
147
+ * 输出流视频编码参数。
127
148
  */
128
- RequestId?: string
129
- }
149
+ VideoEncode?: VideoEncode
130
150
 
131
- /**
132
- * StartMCUMixTranscode请求参数结构体
133
- */
134
- export interface StartMCUMixTranscodeRequest {
135
151
  /**
136
- * TRTC的SDKAppId。
152
+ * 混流布局参数。
137
153
  */
138
- SdkAppId: number
154
+ LayoutParams?: McuLayoutParams
139
155
 
140
156
  /**
141
- * 房间号。
157
+ * 整个画布背景颜色,常用的颜色有:
158
+ 红色:0xcc0033。
159
+ 黄色:0xcc9900。
160
+ 绿色:0xcccc33。
161
+ 蓝色:0x99CCFF。
162
+ 黑色:0x000000。
163
+ 白色:0xFFFFFF。
164
+ 灰色:0x999999。
165
+ */
166
+ BackGroundColor?: string
167
+
168
+ /**
169
+ * 整个画布的背景图url,优先级高于BackGroundColor。
142
170
  */
143
- RoomId: number
171
+ BackgroundImageUrl?: string
144
172
 
145
173
  /**
146
- * 混流输出控制参数。
174
+ * 混流布局的水印参数。
147
175
  */
148
- OutputParams: OutputParams
176
+ WaterMarkList?: Array<McuWaterMarkParams>
177
+ }
149
178
 
179
+ /**
180
+ * RemoveUserByStrRoomId返回参数结构体
181
+ */
182
+ export interface RemoveUserByStrRoomIdResponse {
150
183
  /**
151
- * 混流输出编码参数。
184
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
152
185
  */
153
- EncodeParams: EncodeParams
186
+ RequestId?: string
187
+ }
154
188
 
189
+ /**
190
+ * 音量布局SEI参数,可以自定义AppData和PayloadType类型。
191
+ 该参数内容可以为空,表示携带默认的音量布局SEI。
192
+ */
193
+ export interface McuLayoutVolume {
155
194
  /**
156
- * 混流输出布局参数。
195
+ * AppData的内容,会被写入自定义SEI中的app_data字段,长度需小于4096。
157
196
  */
158
- LayoutParams: LayoutParams
197
+ AppData?: string
159
198
 
160
199
  /**
161
- * 第三方CDN转推参数。
200
+ * SEI消息的payload_type,默认值100,取值范围100-254(244除外,244为我们内部自定义的时间戳SEI)
162
201
  */
163
- PublishCdnParams?: PublishCdnParams
202
+ PayloadType?: number
164
203
  }
165
204
 
166
205
  /**
@@ -201,38 +240,34 @@ export interface DescribeUserEventRequest {
201
240
  }
202
241
 
203
242
  /**
204
- * StartMCUMixTranscodeByStrRoomId请求参数结构体
243
+ * StopPublishCdnStream返回参数结构体
205
244
  */
206
- export interface StartMCUMixTranscodeByStrRoomIdRequest {
245
+ export interface StopPublishCdnStreamResponse {
207
246
  /**
208
- * TRTC的SDKAppId。
247
+ * 转推任务唯一的String Id
209
248
  */
210
- SdkAppId: number
211
-
212
- /**
213
- * 字符串房间号。
214
- */
215
- StrRoomId: string
216
-
217
- /**
218
- * 混流输出控制参数。
219
- */
220
- OutputParams: OutputParams
249
+ TaskId: string
221
250
 
222
251
  /**
223
- * 混流输出编码参数。
252
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
224
253
  */
225
- EncodeParams: EncodeParams
254
+ RequestId?: string
255
+ }
226
256
 
257
+ /**
258
+ * 造成异常体验可能的异常事件类型
259
+ */
260
+ export interface AbnormalEvent {
227
261
  /**
228
- * 混流输出布局参数。
262
+ * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
229
263
  */
230
- LayoutParams: LayoutParams
264
+ AbnormalEventId: number
231
265
 
232
266
  /**
233
- * 第三方CDN转推参数。
234
- */
235
- PublishCdnParams?: PublishCdnParams
267
+ * 远端用户ID,"":表示异常事件不是由远端用户产生
268
+ 注意:此字段可能返回 null,表示取不到有效值。
269
+ */
270
+ PeerId: string
236
271
  }
237
272
 
238
273
  /**
@@ -263,6 +298,26 @@ export interface ScaleInfomation {
263
298
  RoomNumbers: number
264
299
  }
265
300
 
301
+ /**
302
+ * 转推服务加入TRTC房间的机器人参数。
303
+ */
304
+ export interface AgentParams {
305
+ /**
306
+ * 转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
307
+ */
308
+ UserId: string
309
+
310
+ /**
311
+ * 转推服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
312
+ */
313
+ UserSig?: string
314
+
315
+ /**
316
+ * 所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
317
+ */
318
+ MaxIdleTime?: number
319
+ }
320
+
266
321
  /**
267
322
  * DescribeUserEvent返回参数结构体
268
323
  */
@@ -278,6 +333,36 @@ export interface DescribeUserEventResponse {
278
333
  RequestId?: string
279
334
  }
280
335
 
336
+ /**
337
+ * 视频编码参数。
338
+ */
339
+ export interface VideoEncode {
340
+ /**
341
+ * 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
342
+ */
343
+ Width: number
344
+
345
+ /**
346
+ * 输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
347
+ */
348
+ Height: number
349
+
350
+ /**
351
+ * 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
352
+ */
353
+ Fps: number
354
+
355
+ /**
356
+ * 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
357
+ */
358
+ BitRate: number
359
+
360
+ /**
361
+ * 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
362
+ */
363
+ Gop: number
364
+ }
365
+
281
366
  /**
282
367
  * StopMCUMixTranscodeByStrRoomId返回参数结构体
283
368
  */
@@ -543,6 +628,26 @@ export interface CloudStorage {
543
628
  FileNamePrefix?: Array<string>
544
629
  }
545
630
 
631
+ /**
632
+ * DescribeTrtcUsage返回参数结构体
633
+ */
634
+ export interface DescribeTrtcUsageResponse {
635
+ /**
636
+ * 用量类型,与UsageValue中各个位置的值对应。
637
+ */
638
+ UsageKey: Array<string>
639
+
640
+ /**
641
+ * 各个时间点用量明细。
642
+ */
643
+ UsageList: Array<TrtcUsage>
644
+
645
+ /**
646
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
647
+ */
648
+ RequestId?: string
649
+ }
650
+
546
651
  /**
547
652
  * 返回的质量数据,时间:值
548
653
  */
@@ -692,6 +797,26 @@ export interface CloudVod {
692
797
  TencentVod?: TencentVod
693
798
  }
694
799
 
800
+ /**
801
+ * SdkAppId级别实时音视频的用量数据
802
+ */
803
+ export interface SdkAppIdNewTrtcTimeUsage {
804
+ /**
805
+ * SdkAppId的值。
806
+ */
807
+ SdkAppId: string
808
+
809
+ /**
810
+ * 统计的时间点数据。
811
+ */
812
+ TrtcTimeUsages: Array<TrtcTimeNewUsage>
813
+
814
+ /**
815
+ * 统计的麦下用量的时间点数据。
816
+ */
817
+ AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>
818
+ }
819
+
695
820
  /**
696
821
  * MCU混流输出流编码参数
697
822
  */
@@ -791,6 +916,31 @@ export interface DescribeCallDetailInfoResponse {
791
916
  RequestId?: string
792
917
  }
793
918
 
919
+ /**
920
+ * 混流自定义裁剪参数
921
+ */
922
+ export interface McuCustomCrop {
923
+ /**
924
+ * 自定义裁剪起始位置的X偏移,单位为像素值,大于等于0。
925
+ */
926
+ LocationX: number
927
+
928
+ /**
929
+ * 自定义裁剪起始位置的Y偏移,单位为像素值,大于等于0。
930
+ */
931
+ LocationY: number
932
+
933
+ /**
934
+ * 自定义裁剪画面的宽度,单位为像素值,大于0,且LocationX+Width不超过10000
935
+ */
936
+ Width: number
937
+
938
+ /**
939
+ * 自定义裁剪画面的高度,单位为像素值,大于0,且LocationY+Height不超过10000
940
+ */
941
+ Height: number
942
+ }
943
+
794
944
  /**
795
945
  * 实时音视频用量的某一时间段的统计信息.
796
946
  */
@@ -846,6 +996,27 @@ export interface TrtcTimeNewUsage {
846
996
  Video4KTime: number
847
997
  }
848
998
 
999
+ /**
1000
+ * DescribeMixTranscodingUsage请求参数结构体
1001
+ */
1002
+ export interface DescribeMixTranscodingUsageRequest {
1003
+ /**
1004
+ * 查询开始时间,格式为YYYY-MM-DD。
1005
+ */
1006
+ StartTime: string
1007
+
1008
+ /**
1009
+ * 查询结束时间,格式为YYYY-MM-DD。
1010
+ 单次查询统计区间最多不能超过31天。
1011
+ */
1012
+ EndTime: string
1013
+
1014
+ /**
1015
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
1016
+ */
1017
+ SdkAppId?: number
1018
+ }
1019
+
849
1020
  /**
850
1021
  * ModifyPicture请求参数结构体
851
1022
  */
@@ -971,6 +1142,31 @@ export interface WaterMarkImage {
971
1142
  Height: number
972
1143
  }
973
1144
 
1145
+ /**
1146
+ * 混流用户参数
1147
+ */
1148
+ export interface McuUserInfoParams {
1149
+ /**
1150
+ * 用户参数。
1151
+ */
1152
+ UserInfo: MixUserInfo
1153
+ }
1154
+
1155
+ /**
1156
+ * 用户媒体流参数。
1157
+ */
1158
+ export interface UserMediaStream {
1159
+ /**
1160
+ * TRTC用户参数。
1161
+ */
1162
+ UserInfo?: MixUserInfo
1163
+
1164
+ /**
1165
+ * 主辅路流类型,0为摄像头,1为屏幕分享,不填默认为0。
1166
+ */
1167
+ StreamType?: number
1168
+ }
1169
+
974
1170
  /**
975
1171
  * sdk或webrtc的事件列表。
976
1172
  */
@@ -986,6 +1182,27 @@ export interface EventList {
986
1182
  PeerId: string
987
1183
  }
988
1184
 
1185
+ /**
1186
+ * DescribeTrtcUsage请求参数结构体
1187
+ */
1188
+ export interface DescribeTrtcUsageRequest {
1189
+ /**
1190
+ * 查询开始时间,格式为YYYY-MM-DD。
1191
+ */
1192
+ StartTime: string
1193
+
1194
+ /**
1195
+ * 查询结束时间,格式为YYYY-MM-DD。
1196
+ 单次查询统计区间最多不能超过31天。
1197
+ */
1198
+ EndTime: string
1199
+
1200
+ /**
1201
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
1202
+ */
1203
+ SdkAppId?: number
1204
+ }
1205
+
989
1206
  /**
990
1207
  * DescribeRoomInfo返回参数结构体
991
1208
  */
@@ -1007,50 +1224,332 @@ export interface DescribeRoomInfoResponse {
1007
1224
  }
1008
1225
 
1009
1226
  /**
1010
- * 查询旁路转码计费时长。
1011
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
1227
+ * 混流布局参数。
1228
+ */
1229
+ export interface McuLayoutParams {
1230
+ /**
1231
+ * 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
1232
+ */
1233
+ MixLayoutMode?: number
1234
+
1235
+ /**
1236
+ * 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频占布局位置,1表示纯音频不占布局位置,不填默认为0。
1237
+ */
1238
+ PureAudioHoldPlaceMode?: number
1239
+
1240
+ /**
1241
+ * 自定义模板中有效,指定用户视频在混合画面中的位置。
1242
+ */
1243
+ MixLayoutList?: Array<McuLayout>
1244
+
1245
+ /**
1246
+ * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
1247
+ */
1248
+ MaxVideoUser?: MaxVideoUser
1249
+ }
1250
+
1251
+ /**
1252
+ * UpdatePublishCdnStream请求参数结构体
1253
+ */
1254
+ export interface UpdatePublishCdnStreamRequest {
1255
+ /**
1256
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
1257
+ */
1258
+ SdkAppId: number
1259
+
1260
+ /**
1261
+ * 唯一标识转推任务。
1262
+ */
1263
+ TaskId: string
1264
+
1265
+ /**
1266
+ * 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。
1267
+ */
1268
+ SequenceNumber: number
1269
+
1270
+ /**
1271
+ * 是否转码,0表示无需转码,1表示需要转码。
1272
+ */
1273
+ WithTranscoding: number
1274
+
1275
+ /**
1276
+ * 更新相关参数,只支持更新参与混音的主播列表参数。不填表示不更新此参数。
1277
+ */
1278
+ AudioParams?: McuAudioParams
1279
+
1280
+ /**
1281
+ * 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。
1282
+ */
1283
+ VideoParams?: McuVideoParams
1284
+
1285
+ /**
1286
+ * 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。
1287
+ */
1288
+ SingleSubscribeParams?: SingleSubscribeParams
1289
+
1290
+ /**
1291
+ * 更新转推的CDN参数。不填表示不更新此参数。
1292
+ */
1293
+ PublishCdnParams?: Array<McuPublishCdnParam>
1294
+
1295
+ /**
1296
+ * 混流SEI参数
1297
+ */
1298
+ SeiParams?: McuSeiParams
1299
+ }
1300
+
1301
+ /**
1302
+ * 查询旁路转码计费时长。
1303
+ 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
1304
+ */
1305
+ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
1306
+ /**
1307
+ * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
1308
+ */
1309
+ TimeKey: string
1310
+
1311
+ /**
1312
+ * 语音时长,单位:秒。
1313
+ */
1314
+ AudioTime: number
1315
+
1316
+ /**
1317
+ * 视频时长-标清SD,单位:秒。
1318
+ */
1319
+ VideoTimeSd: number
1320
+
1321
+ /**
1322
+ * 视频时长-高清HD,单位:秒。
1323
+ */
1324
+ VideoTimeHd: number
1325
+
1326
+ /**
1327
+ * 视频时长-全高清FHD,单位:秒。
1328
+ */
1329
+ VideoTimeFhd: number
1330
+
1331
+ /**
1332
+ * 带宽,单位:Mbps。
1333
+ */
1334
+ Flux: number
1335
+ }
1336
+
1337
+ /**
1338
+ * 混流布局参数。
1339
+ */
1340
+ export interface McuLayout {
1341
+ /**
1342
+ * 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
1343
+ */
1344
+ UserMediaStream?: UserMediaStream
1345
+
1346
+ /**
1347
+ * 子画面在输出时的宽度,单位为像素值,不填默认为0。
1348
+ */
1349
+ ImageWidth?: number
1350
+
1351
+ /**
1352
+ * 子画面在输出时的高度,单位为像素值,不填默认为0。
1353
+ */
1354
+ ImageHeight?: number
1355
+
1356
+ /**
1357
+ * 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
1358
+ */
1359
+ LocationX?: number
1360
+
1361
+ /**
1362
+ * 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
1363
+ */
1364
+ LocationY?: number
1365
+
1366
+ /**
1367
+ * 子画面在输出时的层级,不填默认为0。
1368
+ */
1369
+ ZOrder?: number
1370
+
1371
+ /**
1372
+ * 子画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
1373
+ */
1374
+ RenderMode?: number
1375
+
1376
+ /**
1377
+ * 子画面的背景颜色,常用的颜色有:
1378
+ 红色:0xcc0033。
1379
+ 黄色:0xcc9900。
1380
+ 绿色:0xcccc33。
1381
+ 蓝色:0x99CCFF。
1382
+ 黑色:0x000000。
1383
+ 白色:0xFFFFFF。
1384
+ 灰色:0x999999。
1385
+ */
1386
+ BackGroundColor?: string
1387
+
1388
+ /**
1389
+ * 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。
1390
+ */
1391
+ BackgroundImageUrl?: string
1392
+
1393
+ /**
1394
+ * 客户自定义裁剪,针对原始输入流裁剪
1395
+ */
1396
+ CustomCrop?: McuCustomCrop
1397
+ }
1398
+
1399
+ /**
1400
+ * DescribeUserInfo返回参数结构体
1401
+ */
1402
+ export interface DescribeUserInfoResponse {
1403
+ /**
1404
+ * 返回的用户总条数
1405
+ */
1406
+ Total: number
1407
+
1408
+ /**
1409
+ * 用户信息列表
1410
+ 注意:此字段可能返回 null,表示取不到有效值。
1411
+ */
1412
+ UserList: Array<UserInformation>
1413
+
1414
+ /**
1415
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1416
+ */
1417
+ RequestId?: string
1418
+ }
1419
+
1420
+ /**
1421
+ * StartMCUMixTranscode请求参数结构体
1422
+ */
1423
+ export interface StartMCUMixTranscodeRequest {
1424
+ /**
1425
+ * TRTC的SDKAppId。
1426
+ */
1427
+ SdkAppId: number
1428
+
1429
+ /**
1430
+ * 房间号。
1431
+ */
1432
+ RoomId: number
1433
+
1434
+ /**
1435
+ * 混流输出控制参数。
1436
+ */
1437
+ OutputParams: OutputParams
1438
+
1439
+ /**
1440
+ * 混流输出编码参数。
1441
+ */
1442
+ EncodeParams: EncodeParams
1443
+
1444
+ /**
1445
+ * 混流输出布局参数。
1446
+ */
1447
+ LayoutParams: LayoutParams
1448
+
1449
+ /**
1450
+ * 第三方CDN转推参数。
1451
+ */
1452
+ PublishCdnParams?: PublishCdnParams
1453
+ }
1454
+
1455
+ /**
1456
+ * 图片水印参数。
1457
+ */
1458
+ export interface McuWaterMarkImage {
1459
+ /**
1460
+ * 水印图片URL地址,支持png、jpg、jpeg格式。图片大小限制不超过5MB。
1461
+ */
1462
+ WaterMarkUrl: string
1463
+
1464
+ /**
1465
+ * 水印在输出时的宽。单位为像素值。
1466
+ */
1467
+ WaterMarkWidth: number
1468
+
1469
+ /**
1470
+ * 水印在输出时的高。单位为像素值。
1471
+ */
1472
+ WaterMarkHeight: number
1473
+
1474
+ /**
1475
+ * 水印在输出时的X偏移。单位为像素值。
1476
+ */
1477
+ LocationX: number
1478
+
1479
+ /**
1480
+ * 水印在输出时的Y偏移。单位为像素值。
1481
+ */
1482
+ LocationY: number
1483
+
1484
+ /**
1485
+ * 水印在输出时的层级,不填默认为0。
1486
+ */
1487
+ ZOrder?: number
1488
+ }
1489
+
1490
+ /**
1491
+ * StartPublishCdnStream返回参数结构体
1492
+ */
1493
+ export interface StartPublishCdnStreamResponse {
1494
+ /**
1495
+ * 用于唯一标识转推任务,由腾讯云服务端生成,后续更新和停止请求都需要携带TaskiD参数。
1496
+ */
1497
+ TaskId: string
1498
+
1499
+ /**
1500
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1501
+ */
1502
+ RequestId?: string
1503
+ }
1504
+
1505
+ /**
1506
+ * 实时音视频用量在某一时间段的统计信息。
1012
1507
  */
1013
- export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
1508
+ export interface TrtcUsage {
1014
1509
  /**
1015
- * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05
1510
+ * 时间点,格式为YYYY-MM-DD HH:mm:ss。多天查询时,HH:mm:ss为00:00:00
1016
1511
  */
1017
1512
  TimeKey: string
1018
1513
 
1019
1514
  /**
1020
- * 语音时长,单位:秒。
1515
+ * 用量数组。每个数值含义与UsageKey对应。单位:分钟。
1021
1516
  */
1022
- AudioTime: number
1517
+ UsageValue: Array<number>
1518
+ }
1023
1519
 
1520
+ /**
1521
+ * DescribeRelayUsage返回参数结构体
1522
+ */
1523
+ export interface DescribeRelayUsageResponse {
1024
1524
  /**
1025
- * 视频时长-标清SD,单位:秒。
1525
+ * 用量类型,与UsageValue中各个位置的值对应。
1026
1526
  */
1027
- VideoTimeSd: number
1527
+ UsageKey: Array<string>
1028
1528
 
1029
1529
  /**
1030
- * 视频时长-高清HD,单位:秒。
1530
+ * 各个时间点用量明细。
1031
1531
  */
1032
- VideoTimeHd: number
1532
+ UsageList: Array<TrtcUsage>
1033
1533
 
1034
1534
  /**
1035
- * 视频时长-全高清FHD,单位:秒。
1535
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1036
1536
  */
1037
- VideoTimeFhd: number
1537
+ RequestId?: string
1038
1538
  }
1039
1539
 
1040
1540
  /**
1041
- * DescribeUserInfo返回参数结构体
1541
+ * DescribeRecordingUsage返回参数结构体
1042
1542
  */
1043
- export interface DescribeUserInfoResponse {
1543
+ export interface DescribeRecordingUsageResponse {
1044
1544
  /**
1045
- * 返回的用户总条数
1545
+ * 用量类型,与UsageValue中各个位置的值对应。
1046
1546
  */
1047
- Total: number
1547
+ UsageKey: Array<string>
1048
1548
 
1049
1549
  /**
1050
- * 用户信息列表
1051
- 注意:此字段可能返回 null,表示取不到有效值。
1052
- */
1053
- UserList: Array<UserInformation>
1550
+ * 各个时间点用量明细。
1551
+ */
1552
+ UsageList: Array<TrtcUsage>
1054
1553
 
1055
1554
  /**
1056
1555
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1058,6 +1557,21 @@ export interface DescribeUserInfoResponse {
1058
1557
  RequestId?: string
1059
1558
  }
1060
1559
 
1560
+ /**
1561
+ * StopMCUMixTranscode请求参数结构体
1562
+ */
1563
+ export interface StopMCUMixTranscodeRequest {
1564
+ /**
1565
+ * TRTC的SDKAppId。
1566
+ */
1567
+ SdkAppId: number
1568
+
1569
+ /**
1570
+ * 房间号。
1571
+ */
1572
+ RoomId: number
1573
+ }
1574
+
1061
1575
  /**
1062
1576
  * ModifyPicture返回参数结构体
1063
1577
  */
@@ -1068,6 +1582,32 @@ export interface ModifyPictureResponse {
1068
1582
  RequestId?: string
1069
1583
  }
1070
1584
 
1585
+ /**
1586
+ * DescribeRecordingUsage请求参数结构体
1587
+ */
1588
+ export interface DescribeRecordingUsageRequest {
1589
+ /**
1590
+ * 查询开始时间,格式为YYYY-MM-DD。
1591
+ */
1592
+ StartTime: string
1593
+
1594
+ /**
1595
+ * 查询结束时间,格式为YYYY-MM-DD。
1596
+ 单次查询统计区间最多不能超过31天。
1597
+ */
1598
+ EndTime: string
1599
+
1600
+ /**
1601
+ * 查询单流录制或合流录制,值为"single"或"multi"。
1602
+ */
1603
+ MixType: string
1604
+
1605
+ /**
1606
+ * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
1607
+ */
1608
+ SdkAppId?: number
1609
+ }
1610
+
1071
1611
  /**
1072
1612
  * 云端录制查询接口,录制文件的信息
1073
1613
  */
@@ -1216,23 +1756,48 @@ export interface StopMCUMixTranscodeResponse {
1216
1756
  }
1217
1757
 
1218
1758
  /**
1219
- * SdkAppId级别实时音视频的用量数据
1759
+ * DescribeMixTranscodingUsage返回参数结构体
1220
1760
  */
1221
- export interface SdkAppIdNewTrtcTimeUsage {
1761
+ export interface DescribeMixTranscodingUsageResponse {
1222
1762
  /**
1223
- * SdkAppId的值。
1763
+ * 用量类型,与UsageValue中各个位置的值对应。
1224
1764
  */
1225
- SdkAppId: string
1765
+ UsageKey: Array<string>
1226
1766
 
1227
1767
  /**
1228
- * 统计的时间点数据。
1768
+ * 各个时间点用量明细。
1229
1769
  */
1230
- TrtcTimeUsages: Array<TrtcTimeNewUsage>
1770
+ UsageList: Array<TrtcUsage>
1231
1771
 
1232
1772
  /**
1233
- * 统计的麦下用量的时间点数据。
1773
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1234
1774
  */
1235
- AudienceTrtcTimeUsages: Array<TrtcTimeNewUsage>
1775
+ RequestId?: string
1776
+ }
1777
+
1778
+ /**
1779
+ * 音频编码参数。
1780
+ */
1781
+ export interface AudioEncode {
1782
+ /**
1783
+ * 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
1784
+ */
1785
+ SampleRate: number
1786
+
1787
+ /**
1788
+ * 输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
1789
+ */
1790
+ Channel: number
1791
+
1792
+ /**
1793
+ * 输出流音频码率。取值范围[8,500],单位为kbps。
1794
+ */
1795
+ BitRate: number
1796
+
1797
+ /**
1798
+ * 输出流音频编码类型,取值范围[0, 1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。
1799
+ */
1800
+ Codec?: number
1236
1801
  }
1237
1802
 
1238
1803
  /**
@@ -1358,18 +1923,23 @@ export interface TencentVod {
1358
1923
  }
1359
1924
 
1360
1925
  /**
1361
- * StopMCUMixTranscode请求参数结构体
1926
+ * 自定义透传SEI
1362
1927
  */
1363
- export interface StopMCUMixTranscodeRequest {
1928
+ export interface McuPassThrough {
1364
1929
  /**
1365
- * TRTCSDKAppId。
1930
+ * 透传SEIpayload内容。
1366
1931
  */
1367
- SdkAppId: number
1932
+ PayloadContent: string
1368
1933
 
1369
1934
  /**
1370
- * 房间号。
1935
+ * SEI消息的payload_type,取值范围5、100-254(244除外,244为我们内部自定义的时间戳SEI)。
1371
1936
  */
1372
- RoomId: number
1937
+ PayloadType: number
1938
+
1939
+ /**
1940
+ * PayloadType为5,PayloadUuid必须填写。PayloadType不是5时,不需要填写,填写会被后台忽略。该值必须是32长度的十六进制。
1941
+ */
1942
+ PayloadUuid?: string
1373
1943
  }
1374
1944
 
1375
1945
  /**
@@ -1601,6 +2171,21 @@ export interface QualityData {
1601
2171
  DataType: string
1602
2172
  }
1603
2173
 
2174
+ /**
2175
+ * StopPublishCdnStream请求参数结构体
2176
+ */
2177
+ export interface StopPublishCdnStreamRequest {
2178
+ /**
2179
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
2180
+ */
2181
+ SdkAppId: number
2182
+
2183
+ /**
2184
+ * 唯一标识转推任务。
2185
+ */
2186
+ TaskId: string
2187
+ }
2188
+
1604
2189
  /**
1605
2190
  * DeletePicture返回参数结构体
1606
2191
  */
@@ -1666,6 +2251,61 @@ export interface VideoParams {
1666
2251
  Gop: number
1667
2252
  }
1668
2253
 
2254
+ /**
2255
+ * StartPublishCdnStream请求参数结构体
2256
+ */
2257
+ export interface StartPublishCdnStreamRequest {
2258
+ /**
2259
+ * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
2260
+ */
2261
+ SdkAppId: number
2262
+
2263
+ /**
2264
+ * 主房间信息RoomId,转推的TRTC房间所对应的RoomId。
2265
+ */
2266
+ RoomId: string
2267
+
2268
+ /**
2269
+ * 主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整形房间号,1为字符串房间号。
2270
+ */
2271
+ RoomIdType: number
2272
+
2273
+ /**
2274
+ * 转推服务加入TRTC房间的机器人参数。
2275
+ */
2276
+ AgentParams: AgentParams
2277
+
2278
+ /**
2279
+ * 是否转码,0表示无需转码,1表示需要转码。
2280
+ */
2281
+ WithTranscoding: number
2282
+
2283
+ /**
2284
+ * 转推流的音频编码参数。
2285
+ */
2286
+ AudioParams?: McuAudioParams
2287
+
2288
+ /**
2289
+ * 转推流的视频编码参数,不填表示纯音频转推。
2290
+ */
2291
+ VideoParams?: McuVideoParams
2292
+
2293
+ /**
2294
+ * 需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。
2295
+ */
2296
+ SingleSubscribeParams?: SingleSubscribeParams
2297
+
2298
+ /**
2299
+ * 转推的CDN参数。
2300
+ */
2301
+ PublishCdnParams?: Array<McuPublishCdnParam>
2302
+
2303
+ /**
2304
+ * 混流SEI参数
2305
+ */
2306
+ SeiParams?: McuSeiParams
2307
+ }
2308
+
1669
2309
  /**
1670
2310
  * 旁路转码时长的查询结果
1671
2311
  */
@@ -1946,19 +2586,38 @@ export interface ModifyCloudRecordingResponse {
1946
2586
  }
1947
2587
 
1948
2588
  /**
1949
- * 造成异常体验可能的异常事件类型
2589
+ * StartMCUMixTranscodeByStrRoomId请求参数结构体
1950
2590
  */
1951
- export interface AbnormalEvent {
2591
+ export interface StartMCUMixTranscodeByStrRoomIdRequest {
1952
2592
  /**
1953
- * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
2593
+ * TRTC的SDKAppId。
1954
2594
  */
1955
- AbnormalEventId: number
2595
+ SdkAppId: number
1956
2596
 
1957
2597
  /**
1958
- * 远端用户ID,"":表示异常事件不是由远端用户产生
1959
- 注意:此字段可能返回 null,表示取不到有效值。
1960
- */
1961
- PeerId: string
2598
+ * 字符串房间号。
2599
+ */
2600
+ StrRoomId: string
2601
+
2602
+ /**
2603
+ * 混流输出控制参数。
2604
+ */
2605
+ OutputParams: OutputParams
2606
+
2607
+ /**
2608
+ * 混流输出编码参数。
2609
+ */
2610
+ EncodeParams: EncodeParams
2611
+
2612
+ /**
2613
+ * 混流输出布局参数。
2614
+ */
2615
+ LayoutParams: LayoutParams
2616
+
2617
+ /**
2618
+ * 第三方CDN转推参数。
2619
+ */
2620
+ PublishCdnParams?: PublishCdnParams
1962
2621
  }
1963
2622
 
1964
2623
  /**
@@ -1990,6 +2649,26 @@ Exited:表示当前录制任务正在退出的过程中。
1990
2649
  RequestId?: string
1991
2650
  }
1992
2651
 
2652
+ /**
2653
+ * TRTC用户参数。
2654
+ */
2655
+ export interface MixUserInfo {
2656
+ /**
2657
+ * 用户ID。
2658
+ */
2659
+ UserId: string
2660
+
2661
+ /**
2662
+ * 动态布局时房间信息必须和主房间信息保持一致,自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致,不填时默认与主房间信息一致。
2663
+ */
2664
+ RoomId?: string
2665
+
2666
+ /**
2667
+ * 房间号类型,0为整形房间号,1为字符串房间号。
2668
+ */
2669
+ RoomIdType?: number
2670
+ }
2671
+
1993
2672
  /**
1994
2673
  * DismissRoom返回参数结构体
1995
2674
  */
@@ -2000,6 +2679,16 @@ export interface DismissRoomResponse {
2000
2679
  RequestId?: string
2001
2680
  }
2002
2681
 
2682
+ /**
2683
+ * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
2684
+ */
2685
+ export interface MaxVideoUser {
2686
+ /**
2687
+ * 用户媒体流参数。
2688
+ */
2689
+ UserMediaStream: UserMediaStream
2690
+ }
2691
+
2003
2692
  /**
2004
2693
  * DeletePicture请求参数结构体
2005
2694
  */
@@ -2015,6 +2704,21 @@ export interface DeletePictureRequest {
2015
2704
  SdkAppId: number
2016
2705
  }
2017
2706
 
2707
+ /**
2708
+ * 混流SEI参数
2709
+ */
2710
+ export interface McuSeiParams {
2711
+ /**
2712
+ * 音量布局SEI
2713
+ */
2714
+ LayoutVolume?: McuLayoutVolume
2715
+
2716
+ /**
2717
+ * 透传SEI
2718
+ */
2719
+ PassThrough?: McuPassThrough
2720
+ }
2721
+
2018
2722
  /**
2019
2723
  * DescribeExternalTrtcMeasure请求参数结构体
2020
2724
  */
@@ -2035,6 +2739,21 @@ export interface DescribeExternalTrtcMeasureRequest {
2035
2739
  SdkAppId?: number
2036
2740
  }
2037
2741
 
2742
+ /**
2743
+ * UpdatePublishCdnStream返回参数结构体
2744
+ */
2745
+ export interface UpdatePublishCdnStreamResponse {
2746
+ /**
2747
+ * 转推任务唯一的String Id
2748
+ */
2749
+ TaskId: string
2750
+
2751
+ /**
2752
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2753
+ */
2754
+ RequestId?: string
2755
+ }
2756
+
2038
2757
  /**
2039
2758
  * RemoveUserByStrRoomId请求参数结构体
2040
2759
  */
@@ -2110,6 +2829,21 @@ export interface SdkAppIdRecordUsage {
2110
2829
  Usages: Array<RecordUsage>
2111
2830
  }
2112
2831
 
2832
+ /**
2833
+ * 混流转推的音频相关参数。
2834
+ */
2835
+ export interface McuAudioParams {
2836
+ /**
2837
+ * 音频编码参数。
2838
+ */
2839
+ AudioEncode?: AudioEncode
2840
+
2841
+ /**
2842
+ * 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。
2843
+ */
2844
+ SubscribeAudioList?: Array<McuUserInfoParams>
2845
+ }
2846
+
2113
2847
  /**
2114
2848
  * 自定义模板中有效,指定用户视频在混合画面中的位置。
2115
2849
  */
@@ -2165,6 +2899,21 @@ export interface PresetLayoutConfig {
2165
2899
  PlaceImageId?: number
2166
2900
  }
2167
2901
 
2902
+ /**
2903
+ * 转推参数。
2904
+ */
2905
+ export interface McuPublishCdnParam {
2906
+ /**
2907
+ * CDN转推URL。
2908
+ */
2909
+ PublishCdnUrl: string
2910
+
2911
+ /**
2912
+ * 是否是腾讯云CDN,0为转推非腾讯云CDN,1为转推腾讯CDN。注意:为避免默认值误产生转推费用,该参数建议明确填写。转推非腾讯云CDN时会产生转推费用,详情参见接口文档说明。
2913
+ */
2914
+ IsTencentCdn?: number
2915
+ }
2916
+
2168
2917
  /**
2169
2918
  * 录制音频转码参数。
2170
2919
  */
@@ -2190,6 +2939,16 @@ export interface AudioParams {
2190
2939
  BitRate: number
2191
2940
  }
2192
2941
 
2942
+ /**
2943
+ * 单流旁路转推的用户上行信息。
2944
+ */
2945
+ export interface SingleSubscribeParams {
2946
+ /**
2947
+ * 用户媒体流参数。
2948
+ */
2949
+ UserMediaStream: UserMediaStream
2950
+ }
2951
+
2193
2952
  /**
2194
2953
  * 第三方CDN转推参数
2195
2954
  */
@@ -2205,6 +2964,21 @@ export interface PublishCdnParams {
2205
2964
  PublishCdnUrls: Array<string>
2206
2965
  }
2207
2966
 
2967
+ /**
2968
+ * 水印参数。
2969
+ */
2970
+ export interface McuWaterMarkParams {
2971
+ /**
2972
+ * 水印类型,0为图片(默认)。
2973
+ */
2974
+ WaterMarkType?: number
2975
+
2976
+ /**
2977
+ * 图片水印参数。WaterMarkType为0指定。
2978
+ */
2979
+ WaterMarkImage?: McuWaterMarkImage
2980
+ }
2981
+
2208
2982
  /**
2209
2983
  * 用户的异常体验及可能的原因
2210
2984
  */