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