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