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