tencentcloud-sdk-nodejs-trtc 4.0.354 → 4.0.355

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