tencentcloud-sdk-nodejs 4.0.397 → 4.0.398

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