tencentcloud-sdk-nodejs-trtc 4.0.1050 → 4.1.7
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/README.md +27 -5
- package/es/index.js +1 -0
- package/es/services/index.js +1 -0
- package/es/services/trtc/index.js +4 -0
- package/es/services/trtc/v20190722/index.js +6 -0
- package/es/services/trtc/v20190722/trtc_client.js +177 -0
- package/es/services/trtc/v20190722/trtc_models.js +0 -0
- package/package.json +18 -5
- package/tencentcloud/services/trtc/v20190722/index.js +2 -1
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +2 -1
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +8 -0
- package/index.d.ts +0 -2
- package/index.js +0 -6
- package/prettier.config.js +0 -38
- package/src/index.ts +0 -1
- package/src/services/index.ts +0 -1
- package/src/services/trtc/index.ts +0 -5
- package/src/services/trtc/v20190722/index.ts +0 -6
- package/src/services/trtc/v20190722/trtc_client.ts +0 -968
- package/src/services/trtc/v20190722/trtc_models.ts +0 -4589
- package/tsconfig.json +0 -33
- package/typings/index.d.ts +0 -2
|
@@ -1,4589 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing,
|
|
11
|
-
* software distributed under the License is distributed on an
|
|
12
|
-
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
13
|
-
* KIND, either express or implied. See the License for the
|
|
14
|
-
* specific language governing permissions and limitations
|
|
15
|
-
* under the License.
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* 返回的质量数据,时间:值
|
|
20
|
-
*/
|
|
21
|
-
export interface TimeValue {
|
|
22
|
-
/**
|
|
23
|
-
* 时间,unix时间戳(1590065877s)
|
|
24
|
-
*/
|
|
25
|
-
Time?: number
|
|
26
|
-
/**
|
|
27
|
-
* 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 )
|
|
28
|
-
*/
|
|
29
|
-
Value?: number
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
/**
|
|
33
|
-
* 机器人参数
|
|
34
|
-
*/
|
|
35
|
-
export interface AgentConfig {
|
|
36
|
-
/**
|
|
37
|
-
* 机器人的UserId,用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个任务时,机器人的UserId也不能相互重复,否则会中断前一个任务。需要保证机器人UserId在房间内唯一。
|
|
38
|
-
*/
|
|
39
|
-
UserId: string
|
|
40
|
-
/**
|
|
41
|
-
* 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
42
|
-
*/
|
|
43
|
-
UserSig: string
|
|
44
|
-
/**
|
|
45
|
-
* 机器人拉流的UserId, 填写后,机器人会拉取该UserId的流进行实时处理
|
|
46
|
-
*/
|
|
47
|
-
TargetUserId: string
|
|
48
|
-
/**
|
|
49
|
-
* 房间内超过MaxIdleTime 没有推流,后台自动关闭任务,默认值是60s。
|
|
50
|
-
*/
|
|
51
|
-
MaxIdleTime?: number
|
|
52
|
-
/**
|
|
53
|
-
* 机器人的欢迎语
|
|
54
|
-
*/
|
|
55
|
-
WelcomeMessage?: string
|
|
56
|
-
/**
|
|
57
|
-
* 智能打断模式,默认为0,0表示服务端自动打断,1表示服务端不打断,由端上发送打断信令进行打断
|
|
58
|
-
*/
|
|
59
|
-
InterruptMode?: number
|
|
60
|
-
/**
|
|
61
|
-
* InterruptMode为0时使用,单位为毫秒,默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。
|
|
62
|
-
*/
|
|
63
|
-
InterruptSpeechDuration?: number
|
|
64
|
-
/**
|
|
65
|
-
* 控制新一轮对话的触发方式,默认为0。
|
|
66
|
-
- 0表示当服务端语音识别检测出的完整一句话后,自动触发一轮新的对话。
|
|
67
|
-
- 1表示客户端在收到字幕消息后,自行决定是否手动发送聊天信令触发一轮新的对话。
|
|
68
|
-
*/
|
|
69
|
-
TurnDetectionMode?: number
|
|
70
|
-
/**
|
|
71
|
-
* 是否过滤掉用户只说了一个字的句子,true表示过滤,false表示不过滤,默认值为true
|
|
72
|
-
*/
|
|
73
|
-
FilterOneWord?: boolean
|
|
74
|
-
/**
|
|
75
|
-
* 欢迎消息优先级,0默认,1高优,高优不能被打断。
|
|
76
|
-
*/
|
|
77
|
-
WelcomeMessagePriority?: number
|
|
78
|
-
/**
|
|
79
|
-
* 用于过滤LLM返回内容,不播放括号中的内容。
|
|
80
|
-
1:中文括号()
|
|
81
|
-
2:英文括号()
|
|
82
|
-
3:中文方括号【】
|
|
83
|
-
4:英文方括号[]
|
|
84
|
-
5:英文花括号{}
|
|
85
|
-
默认值为空,表示不进行过滤。
|
|
86
|
-
*/
|
|
87
|
-
FilterBracketsContent?: number
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* CreatePicture请求参数结构体
|
|
92
|
-
*/
|
|
93
|
-
export interface CreatePictureRequest {
|
|
94
|
-
/**
|
|
95
|
-
* 应用id
|
|
96
|
-
*/
|
|
97
|
-
SdkAppId: number
|
|
98
|
-
/**
|
|
99
|
-
* 图片内容经base64编码后的string格式,最大长度为2M
|
|
100
|
-
*/
|
|
101
|
-
Content: string
|
|
102
|
-
/**
|
|
103
|
-
* 图片后缀名
|
|
104
|
-
*/
|
|
105
|
-
Suffix: string
|
|
106
|
-
/**
|
|
107
|
-
* 图片长度
|
|
108
|
-
*/
|
|
109
|
-
Height: number
|
|
110
|
-
/**
|
|
111
|
-
* 图片宽度
|
|
112
|
-
*/
|
|
113
|
-
Width: number
|
|
114
|
-
/**
|
|
115
|
-
* 显示位置x轴方向
|
|
116
|
-
*/
|
|
117
|
-
XPosition: number
|
|
118
|
-
/**
|
|
119
|
-
* 显示位置y轴方向
|
|
120
|
-
*/
|
|
121
|
-
YPosition: number
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* 音频转码参数
|
|
126
|
-
*/
|
|
127
|
-
export interface AudioEncodeParams {
|
|
128
|
-
/**
|
|
129
|
-
* 音频采样率,取值为[48000, 44100],单位是Hz。
|
|
130
|
-
*/
|
|
131
|
-
SampleRate?: number
|
|
132
|
-
/**
|
|
133
|
-
* 音频声道数,取值范围[1,2],1表示音频为单声道,2表示音频为双声道。
|
|
134
|
-
*/
|
|
135
|
-
Channel?: number
|
|
136
|
-
/**
|
|
137
|
-
* 音频码率,取值范围[8,500],单位为kbps。
|
|
138
|
-
*/
|
|
139
|
-
BitRate?: number
|
|
140
|
-
/**
|
|
141
|
-
* 音量,取值范围[0,300]。默认100,表示原始音量;0表示静音。
|
|
142
|
-
*/
|
|
143
|
-
Volume?: number
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* 服务端控制AI对话机器人播报指定文本
|
|
148
|
-
*/
|
|
149
|
-
export interface ServerPushText {
|
|
150
|
-
/**
|
|
151
|
-
* 服务端推送播报文本
|
|
152
|
-
*/
|
|
153
|
-
Text?: string
|
|
154
|
-
/**
|
|
155
|
-
* 是否允许该文本打断机器人说话
|
|
156
|
-
*/
|
|
157
|
-
Interrupt?: boolean
|
|
158
|
-
/**
|
|
159
|
-
* 播报完文本后,是否自动关闭对话任务
|
|
160
|
-
*/
|
|
161
|
-
StopAfterPlay?: boolean
|
|
162
|
-
/**
|
|
163
|
-
* 服务端推送播报音频
|
|
164
|
-
格式说明:音频以16KHz采样率的单声道格式提供,编码为Base64字符串。
|
|
165
|
-
输入规则:当提供Audio字段时,将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。
|
|
166
|
-
*/
|
|
167
|
-
Audio?: string
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* DescribeTRTCMarketQualityMetricData返回参数结构体
|
|
172
|
-
*/
|
|
173
|
-
export interface DescribeTRTCMarketQualityMetricDataResponse {
|
|
174
|
-
/**
|
|
175
|
-
* TRTC监控数据出参
|
|
176
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
177
|
-
*/
|
|
178
|
-
Data: TRTCDataResp
|
|
179
|
-
/**
|
|
180
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
181
|
-
*/
|
|
182
|
-
RequestId?: string
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* 用户自定义混流布局参数列表。
|
|
187
|
-
*/
|
|
188
|
-
export interface MixLayout {
|
|
189
|
-
/**
|
|
190
|
-
* 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。
|
|
191
|
-
*/
|
|
192
|
-
Top: number
|
|
193
|
-
/**
|
|
194
|
-
* 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。
|
|
195
|
-
*/
|
|
196
|
-
Left: number
|
|
197
|
-
/**
|
|
198
|
-
* 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。
|
|
199
|
-
*/
|
|
200
|
-
Width: number
|
|
201
|
-
/**
|
|
202
|
-
* 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。
|
|
203
|
-
*/
|
|
204
|
-
Height: number
|
|
205
|
-
/**
|
|
206
|
-
* 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。
|
|
207
|
-
*/
|
|
208
|
-
UserId?: string
|
|
209
|
-
/**
|
|
210
|
-
* 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。
|
|
211
|
-
*/
|
|
212
|
-
Alpha?: number
|
|
213
|
-
/**
|
|
214
|
-
* 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;
|
|
215
|
-
|
|
216
|
-
1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;
|
|
217
|
-
|
|
218
|
-
2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;
|
|
219
|
-
|
|
220
|
-
3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;
|
|
221
|
-
*/
|
|
222
|
-
RenderMode?: number
|
|
223
|
-
/**
|
|
224
|
-
* 对应订阅流的主辅路标识:
|
|
225
|
-
0:主流(默认);
|
|
226
|
-
1:辅流;
|
|
227
|
-
*/
|
|
228
|
-
MediaId?: number
|
|
229
|
-
/**
|
|
230
|
-
* 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
|
|
231
|
-
*/
|
|
232
|
-
ImageLayer?: number
|
|
233
|
-
/**
|
|
234
|
-
* 图片的url地址, 只支持jpg, png, jpeg,大小限制不超过5M。注意,url必须携带格式后缀,url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='
|
|
235
|
-
*/
|
|
236
|
-
SubBackgroundImage?: string
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* 混流转推的视频相关参数。
|
|
241
|
-
*/
|
|
242
|
-
export interface McuVideoParams {
|
|
243
|
-
/**
|
|
244
|
-
* 输出流视频编码参数。
|
|
245
|
-
*/
|
|
246
|
-
VideoEncode?: VideoEncode
|
|
247
|
-
/**
|
|
248
|
-
* 混流布局参数。
|
|
249
|
-
*/
|
|
250
|
-
LayoutParams?: McuLayoutParams
|
|
251
|
-
/**
|
|
252
|
-
* 整个画布背景颜色,常用的颜色有:
|
|
253
|
-
红色:0xcc0033。
|
|
254
|
-
黄色:0xcc9900。
|
|
255
|
-
绿色:0xcccc33。
|
|
256
|
-
蓝色:0x99CCFF。
|
|
257
|
-
黑色:0x000000。
|
|
258
|
-
白色:0xFFFFFF。
|
|
259
|
-
灰色:0x999999。
|
|
260
|
-
*/
|
|
261
|
-
BackGroundColor?: string
|
|
262
|
-
/**
|
|
263
|
-
* 整个画布的背景图url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。
|
|
264
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。
|
|
265
|
-
*/
|
|
266
|
-
BackgroundImageUrl?: string
|
|
267
|
-
/**
|
|
268
|
-
* 混流布局的水印参数。
|
|
269
|
-
*/
|
|
270
|
-
WaterMarkList?: Array<McuWaterMarkParams>
|
|
271
|
-
/**
|
|
272
|
-
* 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。
|
|
273
|
-
*/
|
|
274
|
-
BackgroundRenderMode?: number
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
/**
|
|
278
|
-
* DescribeTRTCRealTimeScaleData请求参数结构体
|
|
279
|
-
*/
|
|
280
|
-
export interface DescribeTRTCRealTimeScaleDataRequest {
|
|
281
|
-
/**
|
|
282
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
283
|
-
*/
|
|
284
|
-
SdkAppId: string
|
|
285
|
-
/**
|
|
286
|
-
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
287
|
-
*/
|
|
288
|
-
StartTime: number
|
|
289
|
-
/**
|
|
290
|
-
* 结束时间,unix时间戳,单位:秒
|
|
291
|
-
*/
|
|
292
|
-
EndTime: number
|
|
293
|
-
/**
|
|
294
|
-
* 房间ID
|
|
295
|
-
*/
|
|
296
|
-
RoomId?: string
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* StartAIConversation返回参数结构体
|
|
301
|
-
*/
|
|
302
|
-
export interface StartAIConversationResponse {
|
|
303
|
-
/**
|
|
304
|
-
* 用于唯一标识对话任务。
|
|
305
|
-
*/
|
|
306
|
-
TaskId?: string
|
|
307
|
-
/**
|
|
308
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
309
|
-
*/
|
|
310
|
-
RequestId?: string
|
|
311
|
-
}
|
|
312
|
-
|
|
313
|
-
/**
|
|
314
|
-
* 语音转文字参数
|
|
315
|
-
*/
|
|
316
|
-
export interface STTConfig {
|
|
317
|
-
/**
|
|
318
|
-
*
|
|
319
|
-
语音转文字支持识别的语言,默认是"zh" 中文
|
|
320
|
-
|
|
321
|
-
可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考:[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976)
|
|
322
|
-
|
|
323
|
-
语音转文本不同套餐版本支持的语言如下:
|
|
324
|
-
|
|
325
|
-
**基础版**:
|
|
326
|
-
- "zh": 中文(简体)
|
|
327
|
-
- "zh-TW": 中文(繁体)
|
|
328
|
-
- "en": 英语
|
|
329
|
-
|
|
330
|
-
**标准版:**
|
|
331
|
-
- "8k_zh_large": 普方大模型引擎. 当前模型同时支持中文等语言的识别,模型参数量极大,语言模型性能增强,针对电话音频中各类场景、各类中文方言的识别准确率极大提升.
|
|
332
|
-
- "16k_zh_large": 普方英大模型引擎. 当前模型同时支持中文、英文、多种中文方言等语言的识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升.
|
|
333
|
-
- "16k_multi_lang": 多语种大模型引擎. 当前模型同时支持英语、日语、韩语、阿拉伯语、菲律宾语、法语、印地语、印尼语、马来语、葡萄牙语、西班牙语、泰语、土耳其语、越南语、德语的识别,可实现15个语种的自动识别(句子/段落级别).
|
|
334
|
-
- "16k_zh_en": 中英大模型引擎. 当前模型同时支持中文、英语识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升.
|
|
335
|
-
|
|
336
|
-
**高级版:**
|
|
337
|
-
- "zh-dialect": 中国方言
|
|
338
|
-
- "zh-yue": 中国粤语
|
|
339
|
-
- "vi": 越南语
|
|
340
|
-
- "ja": 日语
|
|
341
|
-
- "ko": 韩语
|
|
342
|
-
- "id": 印度尼西亚语
|
|
343
|
-
- "th": 泰语
|
|
344
|
-
- "pt": 葡萄牙语
|
|
345
|
-
- "tr": 土耳其语
|
|
346
|
-
- "ar": 阿拉伯语
|
|
347
|
-
- "es": 西班牙语
|
|
348
|
-
- "hi": 印地语
|
|
349
|
-
- "fr": 法语
|
|
350
|
-
- "ms": 马来语
|
|
351
|
-
- "fil": 菲律宾语
|
|
352
|
-
- "de": 德语
|
|
353
|
-
- "it": 意大利语
|
|
354
|
-
- "ru": 俄语
|
|
355
|
-
- "sv": 瑞典语
|
|
356
|
-
- "da": 丹麦语
|
|
357
|
-
- "no": 挪威语
|
|
358
|
-
|
|
359
|
-
**注意:**
|
|
360
|
-
如果缺少满足您需求的语言,请联系我们技术人员。
|
|
361
|
-
*/
|
|
362
|
-
Language?: string
|
|
363
|
-
/**
|
|
364
|
-
* **发起模糊识别为高级版能力,默认按照高级版收费,仅支持填写基础版和高级版语言.**
|
|
365
|
-
注意:不支持填写"zh-dialect"
|
|
366
|
-
*/
|
|
367
|
-
AlternativeLanguage?: Array<string>
|
|
368
|
-
/**
|
|
369
|
-
* 自定义参数,联系后台使用
|
|
370
|
-
|
|
371
|
-
*/
|
|
372
|
-
CustomParam?: string
|
|
373
|
-
/**
|
|
374
|
-
* 语音识别vad的时间,范围为240-2000,默认为1000,单位为ms。更小的值会让语音识别分句更快。
|
|
375
|
-
*/
|
|
376
|
-
VadSilenceTime?: number
|
|
377
|
-
/**
|
|
378
|
-
* 热词表:该参数用于提升识别准确率。 单个热词限制:"热词|权重",单个热词不超过30个字符(最多10个汉字),权重[1-11]或者100,如:“腾讯云|5” 或 “ASR|11”; 热词表限制:多个热词用英文逗号分割,最多支持128个热词,如:“腾讯云|10,语音识别|5,ASR|11”;
|
|
379
|
-
*/
|
|
380
|
-
HotWordList?: string
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
/**
|
|
384
|
-
* DescribeTRTCMarketScaleData请求参数结构体
|
|
385
|
-
*/
|
|
386
|
-
export interface DescribeTRTCMarketScaleDataRequest {
|
|
387
|
-
/**
|
|
388
|
-
* 用户SdkAppId
|
|
389
|
-
*/
|
|
390
|
-
SdkAppId: string
|
|
391
|
-
/**
|
|
392
|
-
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
393
|
-
*/
|
|
394
|
-
StartTime: string
|
|
395
|
-
/**
|
|
396
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
397
|
-
*/
|
|
398
|
-
EndTime: string
|
|
399
|
-
/**
|
|
400
|
-
* 返回数据的粒度,支持设为以下值:
|
|
401
|
-
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
402
|
-
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
403
|
-
*/
|
|
404
|
-
Period: string
|
|
405
|
-
}
|
|
406
|
-
|
|
407
|
-
/**
|
|
408
|
-
* 音量布局SEI参数,可以自定义AppData和PayloadType类型。
|
|
409
|
-
该参数内容可以为空,表示携带默认的音量布局SEI。
|
|
410
|
-
*/
|
|
411
|
-
export interface McuLayoutVolume {
|
|
412
|
-
/**
|
|
413
|
-
* AppData的内容,会被写入自定义SEI中的app_data字段,长度需小于4096。
|
|
414
|
-
*/
|
|
415
|
-
AppData?: string
|
|
416
|
-
/**
|
|
417
|
-
* SEI消息的payload_type,默认值100,取值范围100-254(244除外,244为我们内部自定义的时间戳SEI)
|
|
418
|
-
*/
|
|
419
|
-
PayloadType?: number
|
|
420
|
-
/**
|
|
421
|
-
* SEI发送间隔,单位毫秒,默认值为1000。
|
|
422
|
-
*/
|
|
423
|
-
Interval?: number
|
|
424
|
-
/**
|
|
425
|
-
* 取值范围[0,1],填1:发送关键帧时会确保带SEI;填0:发送关键帧时不确保带SEI。默认值为0。
|
|
426
|
-
*/
|
|
427
|
-
FollowIdr?: number
|
|
428
|
-
}
|
|
429
|
-
|
|
430
|
-
/**
|
|
431
|
-
* DescribeUserEvent请求参数结构体
|
|
432
|
-
*/
|
|
433
|
-
export interface DescribeUserEventRequest {
|
|
434
|
-
/**
|
|
435
|
-
* 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
|
|
436
|
-
*/
|
|
437
|
-
CommId: string
|
|
438
|
-
/**
|
|
439
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
440
|
-
注意:支持查询14天内的数据
|
|
441
|
-
*/
|
|
442
|
-
StartTime: number
|
|
443
|
-
/**
|
|
444
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
445
|
-
注意:查询时间大于房间结束时间,以房间结束时间为准。
|
|
446
|
-
*/
|
|
447
|
-
EndTime: number
|
|
448
|
-
/**
|
|
449
|
-
* 用户UserId
|
|
450
|
-
*/
|
|
451
|
-
UserId: string
|
|
452
|
-
/**
|
|
453
|
-
* 房间号(如:223)
|
|
454
|
-
*/
|
|
455
|
-
RoomId: string
|
|
456
|
-
/**
|
|
457
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
458
|
-
*/
|
|
459
|
-
SdkAppId: number
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
/**
|
|
463
|
-
* 混流自定义渲染参数
|
|
464
|
-
*/
|
|
465
|
-
export interface McuBackgroundCustomRender {
|
|
466
|
-
/**
|
|
467
|
-
* 自定义渲染画面的宽度,单位为像素值,需大于0,且不能超过子布局的宽。
|
|
468
|
-
*/
|
|
469
|
-
Width: number
|
|
470
|
-
/**
|
|
471
|
-
* 自定义渲染画面的高度,单位为像素值,需大于0,且不能超过子布局的高。
|
|
472
|
-
*/
|
|
473
|
-
Height: number
|
|
474
|
-
/**
|
|
475
|
-
* 自定义渲染画面的圆角半径,单位为像素值,不能超过渲染画面Width和Height最小值的一半,不指定默认为0,表示直角。
|
|
476
|
-
*/
|
|
477
|
-
Radius?: number
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
/**
|
|
481
|
-
* 自定义文字水印数据结构
|
|
482
|
-
*/
|
|
483
|
-
export interface WaterMarkChar {
|
|
484
|
-
/**
|
|
485
|
-
* 文字水印的起始坐标Y值,从左上角开始
|
|
486
|
-
*/
|
|
487
|
-
Top: number
|
|
488
|
-
/**
|
|
489
|
-
* 文字水印的起始坐标X值,从左上角开始
|
|
490
|
-
*/
|
|
491
|
-
Left: number
|
|
492
|
-
/**
|
|
493
|
-
* 文字水印的宽度,单位像素值
|
|
494
|
-
*/
|
|
495
|
-
Width: number
|
|
496
|
-
/**
|
|
497
|
-
* 文字水印的高度,单位像素值
|
|
498
|
-
*/
|
|
499
|
-
Height: number
|
|
500
|
-
/**
|
|
501
|
-
* 水印文字的内容
|
|
502
|
-
*/
|
|
503
|
-
Chars: string
|
|
504
|
-
/**
|
|
505
|
-
* 水印文字的大小,单位像素,默认14
|
|
506
|
-
*/
|
|
507
|
-
FontSize?: number
|
|
508
|
-
/**
|
|
509
|
-
* 水印文字的颜色,默认白色
|
|
510
|
-
*/
|
|
511
|
-
FontColor?: string
|
|
512
|
-
/**
|
|
513
|
-
* 水印文字的背景色,为空代表背景透明,默认为空
|
|
514
|
-
*/
|
|
515
|
-
BackGroundColor?: string
|
|
516
|
-
/**
|
|
517
|
-
* 文字水印的字体,支持设置以下值:
|
|
518
|
-
1. Tencent (默认)
|
|
519
|
-
2. SourceHanSans
|
|
520
|
-
*/
|
|
521
|
-
Font?: string
|
|
522
|
-
}
|
|
523
|
-
|
|
524
|
-
/**
|
|
525
|
-
* DescribeTrtcRoomUsage返回参数结构体
|
|
526
|
-
*/
|
|
527
|
-
export interface DescribeTrtcRoomUsageResponse {
|
|
528
|
-
/**
|
|
529
|
-
* 房间维度用量数据,csv文件格式,单位:秒。
|
|
530
|
-
*/
|
|
531
|
-
Data?: string
|
|
532
|
-
/**
|
|
533
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
534
|
-
*/
|
|
535
|
-
RequestId?: string
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
/**
|
|
539
|
-
* StopPublishCdnStream返回参数结构体
|
|
540
|
-
*/
|
|
541
|
-
export interface StopPublishCdnStreamResponse {
|
|
542
|
-
/**
|
|
543
|
-
* 转推任务唯一的String Id
|
|
544
|
-
*/
|
|
545
|
-
TaskId?: string
|
|
546
|
-
/**
|
|
547
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
548
|
-
*/
|
|
549
|
-
RequestId?: string
|
|
550
|
-
}
|
|
551
|
-
|
|
552
|
-
/**
|
|
553
|
-
* 造成异常体验可能的异常事件类型
|
|
554
|
-
*/
|
|
555
|
-
export interface AbnormalEvent {
|
|
556
|
-
/**
|
|
557
|
-
* 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
|
|
558
|
-
*/
|
|
559
|
-
AbnormalEventId?: number
|
|
560
|
-
/**
|
|
561
|
-
* 远端用户ID,"":表示异常事件不是由远端用户产生
|
|
562
|
-
*/
|
|
563
|
-
PeerId?: string
|
|
564
|
-
}
|
|
565
|
-
|
|
566
|
-
/**
|
|
567
|
-
* 历史规模信息
|
|
568
|
-
*/
|
|
569
|
-
export interface ScaleInfomation {
|
|
570
|
-
/**
|
|
571
|
-
* 每天开始的时间
|
|
572
|
-
*/
|
|
573
|
-
Time?: number
|
|
574
|
-
/**
|
|
575
|
-
* 房间人数,用户重复进入同一个房间为1次
|
|
576
|
-
*/
|
|
577
|
-
UserNumber?: number
|
|
578
|
-
/**
|
|
579
|
-
* 房间人次,用户每次进入房间为一次
|
|
580
|
-
*/
|
|
581
|
-
UserCount?: number
|
|
582
|
-
/**
|
|
583
|
-
* sdkappid下一天内的房间数
|
|
584
|
-
*/
|
|
585
|
-
RoomNumbers?: number
|
|
586
|
-
}
|
|
587
|
-
|
|
588
|
-
/**
|
|
589
|
-
* DescribeTRTCRealTimeScaleMetricData请求参数结构体
|
|
590
|
-
*/
|
|
591
|
-
export interface DescribeTRTCRealTimeScaleMetricDataRequest {
|
|
592
|
-
/**
|
|
593
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
594
|
-
*/
|
|
595
|
-
SdkAppId: string
|
|
596
|
-
/**
|
|
597
|
-
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
598
|
-
*/
|
|
599
|
-
StartTime: number
|
|
600
|
-
/**
|
|
601
|
-
* 结束时间,unix时间戳,单位:秒
|
|
602
|
-
*/
|
|
603
|
-
EndTime: number
|
|
604
|
-
/**
|
|
605
|
-
* 房间ID
|
|
606
|
-
*/
|
|
607
|
-
RoomId?: string
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
/**
|
|
611
|
-
* ControlAIConversation返回参数结构体
|
|
612
|
-
*/
|
|
613
|
-
export interface ControlAIConversationResponse {
|
|
614
|
-
/**
|
|
615
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
616
|
-
*/
|
|
617
|
-
RequestId?: string
|
|
618
|
-
}
|
|
619
|
-
|
|
620
|
-
/**
|
|
621
|
-
* StopAITranscription请求参数结构体
|
|
622
|
-
*/
|
|
623
|
-
export interface StopAITranscriptionRequest {
|
|
624
|
-
/**
|
|
625
|
-
* 唯一标识转录任务。
|
|
626
|
-
*/
|
|
627
|
-
TaskId: string
|
|
628
|
-
}
|
|
629
|
-
|
|
630
|
-
/**
|
|
631
|
-
* 视频转码参数
|
|
632
|
-
*/
|
|
633
|
-
export interface VideoEncodeParams {
|
|
634
|
-
/**
|
|
635
|
-
* 宽。取值范围[0,1920],单位为像素值。
|
|
636
|
-
*/
|
|
637
|
-
Width?: number
|
|
638
|
-
/**
|
|
639
|
-
* 高。取值范围[0,1080],单位为像素值。
|
|
640
|
-
*/
|
|
641
|
-
Height?: number
|
|
642
|
-
/**
|
|
643
|
-
* 帧率。取值范围[1,60],表示帧率可选范围为1到60fps。
|
|
644
|
-
*/
|
|
645
|
-
Fps?: number
|
|
646
|
-
/**
|
|
647
|
-
* 码率。取值范围[1,10000],单位为kbps。
|
|
648
|
-
*/
|
|
649
|
-
BitRate?: number
|
|
650
|
-
/**
|
|
651
|
-
* gop。取值范围[1,2],单位为秒。
|
|
652
|
-
*/
|
|
653
|
-
Gop?: number
|
|
654
|
-
}
|
|
655
|
-
|
|
656
|
-
/**
|
|
657
|
-
* UpdateAIConversation返回参数结构体
|
|
658
|
-
*/
|
|
659
|
-
export interface UpdateAIConversationResponse {
|
|
660
|
-
/**
|
|
661
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
662
|
-
*/
|
|
663
|
-
RequestId?: string
|
|
664
|
-
}
|
|
665
|
-
|
|
666
|
-
/**
|
|
667
|
-
* DescribeUserEvent返回参数结构体
|
|
668
|
-
*/
|
|
669
|
-
export interface DescribeUserEventResponse {
|
|
670
|
-
/**
|
|
671
|
-
* 返回的事件列表,若没有数据,会返回空数组。
|
|
672
|
-
*/
|
|
673
|
-
Data: Array<EventList>
|
|
674
|
-
/**
|
|
675
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
676
|
-
*/
|
|
677
|
-
RequestId?: string
|
|
678
|
-
}
|
|
679
|
-
|
|
680
|
-
/**
|
|
681
|
-
* 视频编码参数。
|
|
682
|
-
*/
|
|
683
|
-
export interface VideoEncode {
|
|
684
|
-
/**
|
|
685
|
-
* 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
|
|
686
|
-
*/
|
|
687
|
-
Width: number
|
|
688
|
-
/**
|
|
689
|
-
* 输出流高,音视频输出时必填。取值范围[0,1920],单位为像素值。
|
|
690
|
-
*/
|
|
691
|
-
Height: number
|
|
692
|
-
/**
|
|
693
|
-
* 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
|
|
694
|
-
*/
|
|
695
|
-
Fps: number
|
|
696
|
-
/**
|
|
697
|
-
* 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
|
|
698
|
-
*/
|
|
699
|
-
BitRate: number
|
|
700
|
-
/**
|
|
701
|
-
* 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
|
|
702
|
-
*/
|
|
703
|
-
Gop: number
|
|
704
|
-
}
|
|
705
|
-
|
|
706
|
-
/**
|
|
707
|
-
* MCU混流布局参数
|
|
708
|
-
*/
|
|
709
|
-
export interface LayoutParams {
|
|
710
|
-
/**
|
|
711
|
-
* 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
|
|
712
|
-
*/
|
|
713
|
-
Template?: number
|
|
714
|
-
/**
|
|
715
|
-
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。
|
|
716
|
-
*/
|
|
717
|
-
MainVideoUserId?: string
|
|
718
|
-
/**
|
|
719
|
-
* 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。
|
|
720
|
-
*/
|
|
721
|
-
MainVideoStreamType?: number
|
|
722
|
-
/**
|
|
723
|
-
* 画中画模板中有效,代表小画面的布局参数。
|
|
724
|
-
*/
|
|
725
|
-
SmallVideoLayoutParams?: SmallVideoLayoutParams
|
|
726
|
-
/**
|
|
727
|
-
* 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
|
|
728
|
-
*/
|
|
729
|
-
MainVideoRightAlign?: number
|
|
730
|
-
/**
|
|
731
|
-
* 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。
|
|
732
|
-
*/
|
|
733
|
-
MixVideoUids?: Array<string>
|
|
734
|
-
/**
|
|
735
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
736
|
-
*/
|
|
737
|
-
PresetLayoutConfig?: Array<PresetLayoutConfig>
|
|
738
|
-
/**
|
|
739
|
-
* 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
|
|
740
|
-
*/
|
|
741
|
-
PlaceHolderMode?: number
|
|
742
|
-
/**
|
|
743
|
-
* 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。
|
|
744
|
-
*/
|
|
745
|
-
PureAudioHoldPlaceMode?: number
|
|
746
|
-
/**
|
|
747
|
-
* 水印参数。
|
|
748
|
-
*/
|
|
749
|
-
WaterMarkParams?: WaterMarkParams
|
|
750
|
-
/**
|
|
751
|
-
* 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底,不填采用后台的默认渲染方式(屏幕分享大画面为缩放,其他为裁剪)。若此参数不生效,请提交工单寻求帮助。
|
|
752
|
-
*/
|
|
753
|
-
RenderMode?: number
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* StopMCUMixTranscodeByStrRoomId返回参数结构体
|
|
758
|
-
*/
|
|
759
|
-
export interface StopMCUMixTranscodeByStrRoomIdResponse {
|
|
760
|
-
/**
|
|
761
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
762
|
-
*/
|
|
763
|
-
RequestId?: string
|
|
764
|
-
}
|
|
765
|
-
|
|
766
|
-
/**
|
|
767
|
-
* 图片列表信息
|
|
768
|
-
*/
|
|
769
|
-
export interface PictureInfo {
|
|
770
|
-
/**
|
|
771
|
-
* 图片长度
|
|
772
|
-
*/
|
|
773
|
-
Height?: number
|
|
774
|
-
/**
|
|
775
|
-
* 图片宽度
|
|
776
|
-
*/
|
|
777
|
-
Width?: number
|
|
778
|
-
/**
|
|
779
|
-
* 显示位置x轴方向
|
|
780
|
-
*/
|
|
781
|
-
XPosition?: number
|
|
782
|
-
/**
|
|
783
|
-
* 显示位置y轴方向
|
|
784
|
-
*/
|
|
785
|
-
YPosition?: number
|
|
786
|
-
/**
|
|
787
|
-
* 应用id
|
|
788
|
-
*/
|
|
789
|
-
SdkAppId?: number
|
|
790
|
-
/**
|
|
791
|
-
* 图片id
|
|
792
|
-
*/
|
|
793
|
-
PictureId?: number
|
|
794
|
-
}
|
|
795
|
-
|
|
796
|
-
/**
|
|
797
|
-
* DescribeCallDetailInfo请求参数结构体
|
|
798
|
-
*/
|
|
799
|
-
export interface DescribeCallDetailInfoRequest {
|
|
800
|
-
/**
|
|
801
|
-
* 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
|
|
802
|
-
*/
|
|
803
|
-
CommId: string
|
|
804
|
-
/**
|
|
805
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
|
|
806
|
-
注意:支持查询14天内的数据。
|
|
807
|
-
*/
|
|
808
|
-
StartTime: number
|
|
809
|
-
/**
|
|
810
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
811
|
-
注意:查询起止时间需小于1小时,超过则返回null,即与StartTime间隔时间不超过1小时。
|
|
812
|
-
*/
|
|
813
|
-
EndTime: number
|
|
814
|
-
/**
|
|
815
|
-
* 用户SdkAppId(如:1400xxxxxx)。
|
|
816
|
-
*/
|
|
817
|
-
SdkAppId: number
|
|
818
|
-
/**
|
|
819
|
-
* 需查询的用户数组,默认不填返回6个用户。
|
|
820
|
-
*/
|
|
821
|
-
UserIds?: Array<string>
|
|
822
|
-
/**
|
|
823
|
-
* 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
|
|
824
|
-
appCpu:APP CPU使用率;
|
|
825
|
-
sysCpu:系统 CPU使用率;
|
|
826
|
-
aBit:上/下行音频码率;单位:bps
|
|
827
|
-
aBlock:音频卡顿时长;单位:ms
|
|
828
|
-
bigvBit:上/下行视频码率;单位:bps
|
|
829
|
-
bigvCapFps:视频采集帧率;
|
|
830
|
-
bigvEncFps:视频发送帧率;
|
|
831
|
-
bigvDecFps:渲染帧率;
|
|
832
|
-
bigvBlock:视频卡顿时长;单位:ms
|
|
833
|
-
aLoss:上/下行音频丢包率;
|
|
834
|
-
bigvLoss:上/下行视频丢包率;
|
|
835
|
-
bigvWidth:上/下行分辨率宽;
|
|
836
|
-
bigvHeight:上/下行分辨率高;
|
|
837
|
-
aCapEnergy:音频采集能量;
|
|
838
|
-
aPlayEnergy:音频播放能量;
|
|
839
|
-
rtt:SDK到云端的往返延时;单位: ms
|
|
840
|
-
*/
|
|
841
|
-
DataType?: Array<string>
|
|
842
|
-
/**
|
|
843
|
-
* 当前页数,默认为0,
|
|
844
|
-
注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
|
|
845
|
-
*/
|
|
846
|
-
PageNumber?: number
|
|
847
|
-
/**
|
|
848
|
-
* 每页个数,默认为6,
|
|
849
|
-
范围:[1,100]
|
|
850
|
-
注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
|
|
851
|
-
DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
|
|
852
|
-
*/
|
|
853
|
-
PageSize?: number
|
|
854
|
-
}
|
|
855
|
-
|
|
856
|
-
/**
|
|
857
|
-
* DescribeTRTCMarketScaleData返回参数结构体
|
|
858
|
-
*/
|
|
859
|
-
export interface DescribeTRTCMarketScaleDataResponse {
|
|
860
|
-
/**
|
|
861
|
-
* TRTC监控数据出参
|
|
862
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
863
|
-
*/
|
|
864
|
-
Data?: TRTCDataResult
|
|
865
|
-
/**
|
|
866
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
867
|
-
*/
|
|
868
|
-
RequestId?: string
|
|
869
|
-
}
|
|
870
|
-
|
|
871
|
-
/**
|
|
872
|
-
* Mcu转推录制,腾讯云点播相关参数。
|
|
873
|
-
*/
|
|
874
|
-
export interface McuTencentVod {
|
|
875
|
-
/**
|
|
876
|
-
* 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
|
|
877
|
-
*/
|
|
878
|
-
Procedure?: string
|
|
879
|
-
/**
|
|
880
|
-
* 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
|
|
881
|
-
*/
|
|
882
|
-
ExpireTime?: number
|
|
883
|
-
/**
|
|
884
|
-
* 指定上传园区,仅适用于对上传地域有特殊需求的用户。
|
|
885
|
-
*/
|
|
886
|
-
StorageRegion?: string
|
|
887
|
-
/**
|
|
888
|
-
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
|
|
889
|
-
默认值:0,表示其他分类。
|
|
890
|
-
*/
|
|
891
|
-
ClassId?: number
|
|
892
|
-
/**
|
|
893
|
-
* 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
|
|
894
|
-
*/
|
|
895
|
-
SubAppId?: number
|
|
896
|
-
/**
|
|
897
|
-
* 任务流上下文,任务完成回调时透传。
|
|
898
|
-
*/
|
|
899
|
-
SessionContext?: string
|
|
900
|
-
/**
|
|
901
|
-
* 上传上下文,上传完成回调时透传。
|
|
902
|
-
*/
|
|
903
|
-
SourceContext?: string
|
|
904
|
-
}
|
|
905
|
-
|
|
906
|
-
/**
|
|
907
|
-
* ModifyPicture请求参数结构体
|
|
908
|
-
*/
|
|
909
|
-
export interface ModifyPictureRequest {
|
|
910
|
-
/**
|
|
911
|
-
* 图片id
|
|
912
|
-
*/
|
|
913
|
-
PictureId: number
|
|
914
|
-
/**
|
|
915
|
-
* 应用id
|
|
916
|
-
*/
|
|
917
|
-
SdkAppId: number
|
|
918
|
-
/**
|
|
919
|
-
* 图片长度
|
|
920
|
-
*/
|
|
921
|
-
Height?: number
|
|
922
|
-
/**
|
|
923
|
-
* 图片宽度
|
|
924
|
-
*/
|
|
925
|
-
Width?: number
|
|
926
|
-
/**
|
|
927
|
-
* 显示位置x轴方向
|
|
928
|
-
*/
|
|
929
|
-
XPosition?: number
|
|
930
|
-
/**
|
|
931
|
-
* 显示位置y轴方向
|
|
932
|
-
*/
|
|
933
|
-
YPosition?: number
|
|
934
|
-
}
|
|
935
|
-
|
|
936
|
-
/**
|
|
937
|
-
* DescribeWebRecord返回参数结构体
|
|
938
|
-
*/
|
|
939
|
-
export interface DescribeWebRecordResponse {
|
|
940
|
-
/**
|
|
941
|
-
* 1: 正在录制中
|
|
942
|
-
*/
|
|
943
|
-
Status?: number
|
|
944
|
-
/**
|
|
945
|
-
* 在使用RecordId查询时返回
|
|
946
|
-
*/
|
|
947
|
-
TaskId?: string
|
|
948
|
-
/**
|
|
949
|
-
* 在使用TaskId查询时返回
|
|
950
|
-
*/
|
|
951
|
-
RecordId?: string
|
|
952
|
-
/**
|
|
953
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
954
|
-
*/
|
|
955
|
-
RequestId?: string
|
|
956
|
-
}
|
|
957
|
-
|
|
958
|
-
/**
|
|
959
|
-
* DescribeUserInfo请求参数结构体
|
|
960
|
-
*/
|
|
961
|
-
export interface DescribeUserInfoRequest {
|
|
962
|
-
/**
|
|
963
|
-
* 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
|
|
964
|
-
*/
|
|
965
|
-
CommId: string
|
|
966
|
-
/**
|
|
967
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据
|
|
968
|
-
*/
|
|
969
|
-
StartTime: number
|
|
970
|
-
/**
|
|
971
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
972
|
-
注意:与StartTime间隔时间不超过4小时。
|
|
973
|
-
*/
|
|
974
|
-
EndTime: number
|
|
975
|
-
/**
|
|
976
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
977
|
-
*/
|
|
978
|
-
SdkAppId: number
|
|
979
|
-
/**
|
|
980
|
-
* 需查询的用户数组,不填默认返回6个用户
|
|
981
|
-
范围:[1,100]。
|
|
982
|
-
*/
|
|
983
|
-
UserIds?: Array<string>
|
|
984
|
-
/**
|
|
985
|
-
* 当前页数,默认为0,
|
|
986
|
-
注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
|
|
987
|
-
*/
|
|
988
|
-
PageNumber?: number
|
|
989
|
-
/**
|
|
990
|
-
* 每页个数,默认为6,
|
|
991
|
-
范围:[1,100]。
|
|
992
|
-
*/
|
|
993
|
-
PageSize?: number
|
|
994
|
-
}
|
|
995
|
-
|
|
996
|
-
/**
|
|
997
|
-
* DescribeRelayUsage请求参数结构体
|
|
998
|
-
*/
|
|
999
|
-
export interface DescribeRelayUsageRequest {
|
|
1000
|
-
/**
|
|
1001
|
-
* 查询开始时间,格式为YYYY-MM-DD。
|
|
1002
|
-
*/
|
|
1003
|
-
StartTime: string
|
|
1004
|
-
/**
|
|
1005
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1006
|
-
单次查询统计区间最多不能超过31天。
|
|
1007
|
-
*/
|
|
1008
|
-
EndTime: string
|
|
1009
|
-
/**
|
|
1010
|
-
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
1011
|
-
*/
|
|
1012
|
-
SdkAppId?: number
|
|
1013
|
-
}
|
|
1014
|
-
|
|
1015
|
-
/**
|
|
1016
|
-
* MCU混流水印参数
|
|
1017
|
-
*/
|
|
1018
|
-
export interface WaterMarkParams {
|
|
1019
|
-
/**
|
|
1020
|
-
* 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。
|
|
1021
|
-
*/
|
|
1022
|
-
WaterMarkId: number
|
|
1023
|
-
/**
|
|
1024
|
-
* 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。
|
|
1025
|
-
*/
|
|
1026
|
-
WaterMarkWidth: number
|
|
1027
|
-
/**
|
|
1028
|
-
* 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。
|
|
1029
|
-
*/
|
|
1030
|
-
WaterMarkHeight: number
|
|
1031
|
-
/**
|
|
1032
|
-
* 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。
|
|
1033
|
-
*/
|
|
1034
|
-
LocationX: number
|
|
1035
|
-
/**
|
|
1036
|
-
* 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。
|
|
1037
|
-
*/
|
|
1038
|
-
LocationY: number
|
|
1039
|
-
/**
|
|
1040
|
-
* 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。
|
|
1041
|
-
*/
|
|
1042
|
-
WaterMarkUrl?: string
|
|
1043
|
-
}
|
|
1044
|
-
|
|
1045
|
-
/**
|
|
1046
|
-
* DescribeRecordStatistic返回参数结构体
|
|
1047
|
-
*/
|
|
1048
|
-
export interface DescribeRecordStatisticResponse {
|
|
1049
|
-
/**
|
|
1050
|
-
* 应用的用量信息数组。
|
|
1051
|
-
*/
|
|
1052
|
-
SdkAppIdUsages: Array<SdkAppIdRecordUsage>
|
|
1053
|
-
/**
|
|
1054
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1055
|
-
*/
|
|
1056
|
-
RequestId?: string
|
|
1057
|
-
}
|
|
1058
|
-
|
|
1059
|
-
/**
|
|
1060
|
-
* StartMCUMixTranscodeByStrRoomId返回参数结构体
|
|
1061
|
-
*/
|
|
1062
|
-
export interface StartMCUMixTranscodeByStrRoomIdResponse {
|
|
1063
|
-
/**
|
|
1064
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1065
|
-
*/
|
|
1066
|
-
RequestId?: string
|
|
1067
|
-
}
|
|
1068
|
-
|
|
1069
|
-
/**
|
|
1070
|
-
* 腾讯云对象存储COS以及第三方云存储的账号信息
|
|
1071
|
-
*/
|
|
1072
|
-
export interface CloudStorage {
|
|
1073
|
-
/**
|
|
1074
|
-
* 腾讯云对象存储COS以及第三方云存储账号信息
|
|
1075
|
-
0:腾讯云对象存储 COS
|
|
1076
|
-
1:AWS
|
|
1077
|
-
【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中
|
|
1078
|
-
*/
|
|
1079
|
-
Vendor: number
|
|
1080
|
-
/**
|
|
1081
|
-
* 腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。
|
|
1082
|
-
示例值:cn-shanghai-1
|
|
1083
|
-
|
|
1084
|
-
AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions)
|
|
1085
|
-
*/
|
|
1086
|
-
Region: string
|
|
1087
|
-
/**
|
|
1088
|
-
* 云存储桶名称。
|
|
1089
|
-
*/
|
|
1090
|
-
Bucket: string
|
|
1091
|
-
/**
|
|
1092
|
-
* 云存储的access_key账号信息。
|
|
1093
|
-
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。
|
|
1094
|
-
*/
|
|
1095
|
-
AccessKey: string
|
|
1096
|
-
/**
|
|
1097
|
-
* 云存储的secret_key账号信息。
|
|
1098
|
-
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。
|
|
1099
|
-
*/
|
|
1100
|
-
SecretKey: string
|
|
1101
|
-
/**
|
|
1102
|
-
* 云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
|
|
1103
|
-
*/
|
|
1104
|
-
FileNamePrefix?: Array<string>
|
|
1105
|
-
}
|
|
1106
|
-
|
|
1107
|
-
/**
|
|
1108
|
-
* DescribeTrtcUsage返回参数结构体
|
|
1109
|
-
*/
|
|
1110
|
-
export interface DescribeTrtcUsageResponse {
|
|
1111
|
-
/**
|
|
1112
|
-
* 用量类型,与UsageValue中各个位置的值对应。
|
|
1113
|
-
*/
|
|
1114
|
-
UsageKey?: Array<string>
|
|
1115
|
-
/**
|
|
1116
|
-
* 各个时间点用量明细,单位:分钟
|
|
1117
|
-
*/
|
|
1118
|
-
UsageList?: Array<TrtcUsage>
|
|
1119
|
-
/**
|
|
1120
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1121
|
-
*/
|
|
1122
|
-
RequestId?: string
|
|
1123
|
-
}
|
|
1124
|
-
|
|
1125
|
-
/**
|
|
1126
|
-
* 转推录制参数
|
|
1127
|
-
*/
|
|
1128
|
-
export interface McuRecordParams {
|
|
1129
|
-
/**
|
|
1130
|
-
* 转推录制模式,
|
|
1131
|
-
0/不填: 暂不支持,行为未定义;
|
|
1132
|
-
1: 不开启录制;
|
|
1133
|
-
2: 开启录制(使用控制台自动录制模板参数,参考:[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88));
|
|
1134
|
-
3: 开启录制(使用API指定参数)。
|
|
1135
|
-
*/
|
|
1136
|
-
UniRecord?: number
|
|
1137
|
-
/**
|
|
1138
|
-
* 录制任务 key,标识一个录制任务;您可以通过该参数,将多个转推任务录制成一个文件。不指定该参数时,只录制当前转推任务。
|
|
1139
|
-
【限制长度为128字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线(_)和连词符(-)】
|
|
1140
|
-
*/
|
|
1141
|
-
RecordKey?: string
|
|
1142
|
-
/**
|
|
1143
|
-
* 【仅当UniRecord=3时此参数有效】
|
|
1144
|
-
续录等待时间,对应录制模板“续录等待时长”,单位:秒。该值需大于等于 5,且小于等于 86400(24小时),默认值为 30。启用续录时,录制任务空闲超过RecordWaitTime的时长,自动结束。
|
|
1145
|
-
*/
|
|
1146
|
-
RecordWaitTime?: number
|
|
1147
|
-
/**
|
|
1148
|
-
* 【仅当UniRecord=3时此参数有效】
|
|
1149
|
-
录制输出文件格式列表,对应录制模板“文件格式”,支持“hls”、"mp4"、"aac"三种格式,默认值为"mp4"。其中"mp4"和"aac"格式,不能同时指定。
|
|
1150
|
-
只录制 mp4格式,示例值:["mp4"]。同时录制mp4 和 HLS 格式,示例值:["mp4","hls"]。
|
|
1151
|
-
*/
|
|
1152
|
-
RecordFormat?: Array<string>
|
|
1153
|
-
/**
|
|
1154
|
-
* 【仅当UniRecord=3时此参数有效】
|
|
1155
|
-
单个文件录制时长,对应录制模板“单个录制文件时长”,单位:分钟。该值需大于等于 1,且小于等于 1440(24小时),默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制,超过2G则强制拆分。
|
|
1156
|
-
*/
|
|
1157
|
-
MaxMediaFileDuration?: number
|
|
1158
|
-
/**
|
|
1159
|
-
* 【仅当UniRecord=3时此参数有效】
|
|
1160
|
-
录制的音视频类型,对应录制模板“录制格式”,0:音视频,1:纯音频,2:纯视频。最终录制文件内容是录制指定类型和转推内容的交集。
|
|
1161
|
-
*/
|
|
1162
|
-
StreamType?: number
|
|
1163
|
-
/**
|
|
1164
|
-
* 录制文件名前缀,不超过64字符。只有存储为vod时生效。
|
|
1165
|
-
【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线(_)和连词符(-)】
|
|
1166
|
-
*/
|
|
1167
|
-
UserDefineRecordPrefix?: string
|
|
1168
|
-
/**
|
|
1169
|
-
* 【仅当UniRecord=3时此参数有效】
|
|
1170
|
-
录制文件存储参数,对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式,只能填写一种。
|
|
1171
|
-
*/
|
|
1172
|
-
McuStorageParams?: McuStorageParams
|
|
1173
|
-
}
|
|
1174
|
-
|
|
1175
|
-
/**
|
|
1176
|
-
* DismissRoomByStrRoomId请求参数结构体
|
|
1177
|
-
*/
|
|
1178
|
-
export interface DismissRoomByStrRoomIdRequest {
|
|
1179
|
-
/**
|
|
1180
|
-
* TRTC的SDKAppId。
|
|
1181
|
-
*/
|
|
1182
|
-
SdkAppId: number
|
|
1183
|
-
/**
|
|
1184
|
-
* 字符串类型房间号。
|
|
1185
|
-
本接口仅支持解散字符串类型房间号,如需解散数字类型房间号,请使用:DismissRoom
|
|
1186
|
-
*/
|
|
1187
|
-
RoomId: string
|
|
1188
|
-
}
|
|
1189
|
-
|
|
1190
|
-
/**
|
|
1191
|
-
* DescribeTRTCMarketQualityMetricData请求参数结构体
|
|
1192
|
-
*/
|
|
1193
|
-
export interface DescribeTRTCMarketQualityMetricDataRequest {
|
|
1194
|
-
/**
|
|
1195
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
1196
|
-
*/
|
|
1197
|
-
SdkAppId: string
|
|
1198
|
-
/**
|
|
1199
|
-
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
1200
|
-
*/
|
|
1201
|
-
StartTime: string
|
|
1202
|
-
/**
|
|
1203
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1204
|
-
*/
|
|
1205
|
-
EndTime: string
|
|
1206
|
-
/**
|
|
1207
|
-
* 返回数据的粒度,支持设为以下值:
|
|
1208
|
-
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
1209
|
-
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
1210
|
-
*/
|
|
1211
|
-
Period: string
|
|
1212
|
-
}
|
|
1213
|
-
|
|
1214
|
-
/**
|
|
1215
|
-
* DescribeWebRecord请求参数结构体
|
|
1216
|
-
*/
|
|
1217
|
-
export interface DescribeWebRecordRequest {
|
|
1218
|
-
/**
|
|
1219
|
-
* 开始页面录制时返回的任务id
|
|
1220
|
-
*/
|
|
1221
|
-
TaskId?: string
|
|
1222
|
-
/**
|
|
1223
|
-
* 发起页面录制时传递的SdkAppId
|
|
1224
|
-
*/
|
|
1225
|
-
SdkAppId?: number
|
|
1226
|
-
/**
|
|
1227
|
-
* 发起录制时传递的RecordId, 传入此值时需要传递SdkAppId
|
|
1228
|
-
*/
|
|
1229
|
-
RecordId?: string
|
|
1230
|
-
}
|
|
1231
|
-
|
|
1232
|
-
/**
|
|
1233
|
-
* DescribeTRTCRealTimeScaleData返回参数结构体
|
|
1234
|
-
*/
|
|
1235
|
-
export interface DescribeTRTCRealTimeScaleDataResponse {
|
|
1236
|
-
/**
|
|
1237
|
-
* TRTC监控数据出参
|
|
1238
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1239
|
-
*/
|
|
1240
|
-
Data?: TRTCDataResult
|
|
1241
|
-
/**
|
|
1242
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1243
|
-
*/
|
|
1244
|
-
RequestId?: string
|
|
1245
|
-
}
|
|
1246
|
-
|
|
1247
|
-
/**
|
|
1248
|
-
* DescribeRecordStatistic请求参数结构体
|
|
1249
|
-
*/
|
|
1250
|
-
export interface DescribeRecordStatisticRequest {
|
|
1251
|
-
/**
|
|
1252
|
-
* 查询开始日期,格式为YYYY-MM-DD。
|
|
1253
|
-
*/
|
|
1254
|
-
StartTime: string
|
|
1255
|
-
/**
|
|
1256
|
-
* 查询结束日期,格式为YYYY-MM-DD。
|
|
1257
|
-
单次查询统计区间最多不能超过31天。
|
|
1258
|
-
*/
|
|
1259
|
-
EndTime: string
|
|
1260
|
-
/**
|
|
1261
|
-
* 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
|
|
1262
|
-
*/
|
|
1263
|
-
SdkAppId?: number
|
|
1264
|
-
}
|
|
1265
|
-
|
|
1266
|
-
/**
|
|
1267
|
-
* DescribeRoomInfo请求参数结构体
|
|
1268
|
-
*/
|
|
1269
|
-
export interface DescribeRoomInfoRequest {
|
|
1270
|
-
/**
|
|
1271
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
1272
|
-
*/
|
|
1273
|
-
SdkAppId: number
|
|
1274
|
-
/**
|
|
1275
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据
|
|
1276
|
-
*/
|
|
1277
|
-
StartTime: number
|
|
1278
|
-
/**
|
|
1279
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
|
|
1280
|
-
注意:与StartTime间隔时间不超过24小时。
|
|
1281
|
-
*/
|
|
1282
|
-
EndTime: number
|
|
1283
|
-
/**
|
|
1284
|
-
* 房间号(如:223)
|
|
1285
|
-
*/
|
|
1286
|
-
RoomId?: string
|
|
1287
|
-
/**
|
|
1288
|
-
* 当前页数,默认为0,
|
|
1289
|
-
注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
|
|
1290
|
-
*/
|
|
1291
|
-
PageNumber?: number
|
|
1292
|
-
/**
|
|
1293
|
-
* 每页个数,默认为10,
|
|
1294
|
-
范围:[1,100]
|
|
1295
|
-
*/
|
|
1296
|
-
PageSize?: number
|
|
1297
|
-
}
|
|
1298
|
-
|
|
1299
|
-
/**
|
|
1300
|
-
* 录制存储参数
|
|
1301
|
-
*/
|
|
1302
|
-
export interface StorageParams {
|
|
1303
|
-
/**
|
|
1304
|
-
* 腾讯云对象存储COS以及第三方云存储的账号信息
|
|
1305
|
-
*/
|
|
1306
|
-
CloudStorage?: CloudStorage
|
|
1307
|
-
/**
|
|
1308
|
-
* 腾讯云云点播Vod的存储信息
|
|
1309
|
-
*/
|
|
1310
|
-
CloudVod?: CloudVod
|
|
1311
|
-
}
|
|
1312
|
-
|
|
1313
|
-
/**
|
|
1314
|
-
* CreateBasicModeration请求参数结构体
|
|
1315
|
-
*/
|
|
1316
|
-
export interface CreateBasicModerationRequest {
|
|
1317
|
-
/**
|
|
1318
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。
|
|
1319
|
-
*/
|
|
1320
|
-
SdkAppId: number
|
|
1321
|
-
/**
|
|
1322
|
-
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),为TRTC房间所对应的RoomId。
|
|
1323
|
-
*/
|
|
1324
|
-
RoomId: string
|
|
1325
|
-
/**
|
|
1326
|
-
* 目标审核用户id
|
|
1327
|
-
*/
|
|
1328
|
-
UserId: string
|
|
1329
|
-
/**
|
|
1330
|
-
* TRTC房间号的类型。【*注意】必须和TRTC的房间所对应的RoomId类型相同:0: 字符串类型的RoomId1: 32位整型的RoomId(默认)
|
|
1331
|
-
*/
|
|
1332
|
-
RoomIdType?: number
|
|
1333
|
-
/**
|
|
1334
|
-
* 音频文件上传到云存储的参数
|
|
1335
|
-
*/
|
|
1336
|
-
AuditStorageParams?: AuditStorageParams
|
|
1337
|
-
}
|
|
1338
|
-
|
|
1339
|
-
/**
|
|
1340
|
-
* 点播相关参数。
|
|
1341
|
-
*/
|
|
1342
|
-
export interface CloudVod {
|
|
1343
|
-
/**
|
|
1344
|
-
* 腾讯云点播相关参数。
|
|
1345
|
-
*/
|
|
1346
|
-
TencentVod?: TencentVod
|
|
1347
|
-
}
|
|
1348
|
-
|
|
1349
|
-
/**
|
|
1350
|
-
* MCU混流输出流编码参数
|
|
1351
|
-
*/
|
|
1352
|
-
export interface EncodeParams {
|
|
1353
|
-
/**
|
|
1354
|
-
* 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。
|
|
1355
|
-
*/
|
|
1356
|
-
AudioSampleRate: number
|
|
1357
|
-
/**
|
|
1358
|
-
* 混流-输出流音频码率。取值范围[8,500],单位为kbps。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。
|
|
1359
|
-
*/
|
|
1360
|
-
AudioBitrate: number
|
|
1361
|
-
/**
|
|
1362
|
-
* 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。
|
|
1363
|
-
*/
|
|
1364
|
-
AudioChannels: number
|
|
1365
|
-
/**
|
|
1366
|
-
* 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
|
|
1367
|
-
*/
|
|
1368
|
-
VideoWidth?: number
|
|
1369
|
-
/**
|
|
1370
|
-
* 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
|
|
1371
|
-
*/
|
|
1372
|
-
VideoHeight?: number
|
|
1373
|
-
/**
|
|
1374
|
-
* 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。
|
|
1375
|
-
*/
|
|
1376
|
-
VideoBitrate?: number
|
|
1377
|
-
/**
|
|
1378
|
-
* 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。
|
|
1379
|
-
*/
|
|
1380
|
-
VideoFramerate?: number
|
|
1381
|
-
/**
|
|
1382
|
-
* 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
|
|
1383
|
-
*/
|
|
1384
|
-
VideoGop?: number
|
|
1385
|
-
/**
|
|
1386
|
-
* 混流-输出流背景色,取值是十进制整数。常用的颜色有:
|
|
1387
|
-
红色:0xff0000,对应的十进制整数是16724736。
|
|
1388
|
-
黄色:0xffff00。对应的十进制整数是16776960。
|
|
1389
|
-
绿色:0x33cc00。对应的十进制整数是3394560。
|
|
1390
|
-
蓝色:0x0066ff。对应的十进制整数是26367。
|
|
1391
|
-
黑色:0x000000。对应的十进制整数是0。
|
|
1392
|
-
白色:0xFFFFFF。对应的十进制整数是16777215。
|
|
1393
|
-
灰色:0x999999。对应的十进制整数是10066329。
|
|
1394
|
-
*/
|
|
1395
|
-
BackgroundColor?: number
|
|
1396
|
-
/**
|
|
1397
|
-
* 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。
|
|
1398
|
-
*/
|
|
1399
|
-
BackgroundImageId?: number
|
|
1400
|
-
/**
|
|
1401
|
-
* 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。
|
|
1402
|
-
*/
|
|
1403
|
-
AudioCodec?: number
|
|
1404
|
-
/**
|
|
1405
|
-
* 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。
|
|
1406
|
-
*/
|
|
1407
|
-
BackgroundImageUrl?: string
|
|
1408
|
-
}
|
|
1409
|
-
|
|
1410
|
-
/**
|
|
1411
|
-
* 渲染移动模式参数,不渲染移动模式时,请勿设置此参数。
|
|
1412
|
-
*/
|
|
1413
|
-
export interface EmulateMobileParams {
|
|
1414
|
-
/**
|
|
1415
|
-
* 移动设备类型,
|
|
1416
|
-
0: 手机
|
|
1417
|
-
1: 平板
|
|
1418
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1419
|
-
*/
|
|
1420
|
-
MobileDeviceType?: number
|
|
1421
|
-
/**
|
|
1422
|
-
* 屏幕方向,
|
|
1423
|
-
0: 竖屏,
|
|
1424
|
-
1: 横屏
|
|
1425
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1426
|
-
*/
|
|
1427
|
-
ScreenOrientation?: number
|
|
1428
|
-
}
|
|
1429
|
-
|
|
1430
|
-
/**
|
|
1431
|
-
* DescribeCallDetailInfo返回参数结构体
|
|
1432
|
-
*/
|
|
1433
|
-
export interface DescribeCallDetailInfoResponse {
|
|
1434
|
-
/**
|
|
1435
|
-
* 返回的用户总条数
|
|
1436
|
-
*/
|
|
1437
|
-
Total?: number
|
|
1438
|
-
/**
|
|
1439
|
-
* 用户信息列表
|
|
1440
|
-
*/
|
|
1441
|
-
UserList?: Array<UserInformation>
|
|
1442
|
-
/**
|
|
1443
|
-
* 质量数据
|
|
1444
|
-
*/
|
|
1445
|
-
Data?: Array<QualityData>
|
|
1446
|
-
/**
|
|
1447
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1448
|
-
*/
|
|
1449
|
-
RequestId?: string
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
|
-
/**
|
|
1453
|
-
* DescribeTRTCRealTimeQualityData返回参数结构体
|
|
1454
|
-
*/
|
|
1455
|
-
export interface DescribeTRTCRealTimeQualityDataResponse {
|
|
1456
|
-
/**
|
|
1457
|
-
* TRTC监控数据出参
|
|
1458
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1459
|
-
*/
|
|
1460
|
-
Data?: TRTCDataResult
|
|
1461
|
-
/**
|
|
1462
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1463
|
-
*/
|
|
1464
|
-
RequestId?: string
|
|
1465
|
-
}
|
|
1466
|
-
|
|
1467
|
-
/**
|
|
1468
|
-
* 混流自定义裁剪参数
|
|
1469
|
-
*/
|
|
1470
|
-
export interface McuCustomCrop {
|
|
1471
|
-
/**
|
|
1472
|
-
* 自定义裁剪起始位置的X偏移,单位为像素值,大于等于0。
|
|
1473
|
-
*/
|
|
1474
|
-
LocationX: number
|
|
1475
|
-
/**
|
|
1476
|
-
* 自定义裁剪起始位置的Y偏移,单位为像素值,大于等于0。
|
|
1477
|
-
*/
|
|
1478
|
-
LocationY: number
|
|
1479
|
-
/**
|
|
1480
|
-
* 自定义裁剪画面的宽度,单位为像素值,大于0,且LocationX+Width不超过10000
|
|
1481
|
-
*/
|
|
1482
|
-
Width: number
|
|
1483
|
-
/**
|
|
1484
|
-
* 自定义裁剪画面的高度,单位为像素值,大于0,且LocationY+Height不超过10000
|
|
1485
|
-
*/
|
|
1486
|
-
Height: number
|
|
1487
|
-
}
|
|
1488
|
-
|
|
1489
|
-
/**
|
|
1490
|
-
* DescribeMixTranscodingUsage请求参数结构体
|
|
1491
|
-
*/
|
|
1492
|
-
export interface DescribeMixTranscodingUsageRequest {
|
|
1493
|
-
/**
|
|
1494
|
-
* 查询开始时间,格式为YYYY-MM-DD。
|
|
1495
|
-
*/
|
|
1496
|
-
StartTime: string
|
|
1497
|
-
/**
|
|
1498
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1499
|
-
单次查询统计区间最多不能超过31天。
|
|
1500
|
-
*/
|
|
1501
|
-
EndTime: string
|
|
1502
|
-
/**
|
|
1503
|
-
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
1504
|
-
*/
|
|
1505
|
-
SdkAppId?: number
|
|
1506
|
-
}
|
|
1507
|
-
|
|
1508
|
-
/**
|
|
1509
|
-
* DescribeStreamIngest返回参数结构体
|
|
1510
|
-
*/
|
|
1511
|
-
export interface DescribeStreamIngestResponse {
|
|
1512
|
-
/**
|
|
1513
|
-
* 任务的状态信息。
|
|
1514
|
-
InProgress:表示当前任务正在进行中。
|
|
1515
|
-
NotExist:表示当前任务不存在。
|
|
1516
|
-
示例值:InProgress
|
|
1517
|
-
*/
|
|
1518
|
-
Status?: string
|
|
1519
|
-
/**
|
|
1520
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1521
|
-
*/
|
|
1522
|
-
RequestId?: string
|
|
1523
|
-
}
|
|
1524
|
-
|
|
1525
|
-
/**
|
|
1526
|
-
* 录制的音视频转码参数。
|
|
1527
|
-
*/
|
|
1528
|
-
export interface MixTranscodeParams {
|
|
1529
|
-
/**
|
|
1530
|
-
* 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
|
|
1531
|
-
*/
|
|
1532
|
-
VideoParams?: VideoParams
|
|
1533
|
-
/**
|
|
1534
|
-
* 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。
|
|
1535
|
-
*/
|
|
1536
|
-
AudioParams?: AudioParams
|
|
1537
|
-
}
|
|
1538
|
-
|
|
1539
|
-
/**
|
|
1540
|
-
* StopStreamIngest请求参数结构体
|
|
1541
|
-
*/
|
|
1542
|
-
export interface StopStreamIngestRequest {
|
|
1543
|
-
/**
|
|
1544
|
-
* TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同。
|
|
1545
|
-
*/
|
|
1546
|
-
SdkAppId: number
|
|
1547
|
-
/**
|
|
1548
|
-
* 任务的唯一Id,在启动任务成功后会返回。
|
|
1549
|
-
*/
|
|
1550
|
-
TaskId: string
|
|
1551
|
-
}
|
|
1552
|
-
|
|
1553
|
-
/**
|
|
1554
|
-
* DescribeTRTCMarketQualityData返回参数结构体
|
|
1555
|
-
*/
|
|
1556
|
-
export interface DescribeTRTCMarketQualityDataResponse {
|
|
1557
|
-
/**
|
|
1558
|
-
* TRTC监控数据出参
|
|
1559
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1560
|
-
*/
|
|
1561
|
-
Data?: TRTCDataResult
|
|
1562
|
-
/**
|
|
1563
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1564
|
-
*/
|
|
1565
|
-
RequestId?: string
|
|
1566
|
-
}
|
|
1567
|
-
|
|
1568
|
-
/**
|
|
1569
|
-
* 画中画模板中有效,代表小画面的布局参数
|
|
1570
|
-
*/
|
|
1571
|
-
export interface SmallVideoLayoutParams {
|
|
1572
|
-
/**
|
|
1573
|
-
* 代表小画面对应的用户ID。
|
|
1574
|
-
*/
|
|
1575
|
-
UserId: string
|
|
1576
|
-
/**
|
|
1577
|
-
* 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
|
|
1578
|
-
*/
|
|
1579
|
-
StreamType: number
|
|
1580
|
-
/**
|
|
1581
|
-
* 小画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1582
|
-
*/
|
|
1583
|
-
ImageWidth?: number
|
|
1584
|
-
/**
|
|
1585
|
-
* 小画面在输出时的高度,单位为像素值,不填默认为0。
|
|
1586
|
-
*/
|
|
1587
|
-
ImageHeight?: number
|
|
1588
|
-
/**
|
|
1589
|
-
* 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1590
|
-
*/
|
|
1591
|
-
LocationX?: number
|
|
1592
|
-
/**
|
|
1593
|
-
* 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1594
|
-
*/
|
|
1595
|
-
LocationY?: number
|
|
1596
|
-
}
|
|
1597
|
-
|
|
1598
|
-
/**
|
|
1599
|
-
* 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。支持通过设置".*$"通配符,来前缀匹配黑白名单的UserId,注意房间里不能有和通配符规则相同的用户,否则将视为订阅具体用户,前缀规则会失效。
|
|
1600
|
-
*/
|
|
1601
|
-
export interface SubscribeStreamUserIds {
|
|
1602
|
-
/**
|
|
1603
|
-
* 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流;["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。
|
|
1604
|
-
*/
|
|
1605
|
-
SubscribeAudioUserIds?: Array<string>
|
|
1606
|
-
/**
|
|
1607
|
-
* 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅列表用户数不超过32。
|
|
1608
|
-
*/
|
|
1609
|
-
UnSubscribeAudioUserIds?: Array<string>
|
|
1610
|
-
/**
|
|
1611
|
-
* 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
|
|
1612
|
-
*/
|
|
1613
|
-
SubscribeVideoUserIds?: Array<string>
|
|
1614
|
-
/**
|
|
1615
|
-
* 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。
|
|
1616
|
-
*/
|
|
1617
|
-
UnSubscribeVideoUserIds?: Array<string>
|
|
1618
|
-
}
|
|
1619
|
-
|
|
1620
|
-
/**
|
|
1621
|
-
* 水印类型为图片的参数列表
|
|
1622
|
-
*/
|
|
1623
|
-
export interface WaterMarkImage {
|
|
1624
|
-
/**
|
|
1625
|
-
* 下载的url地址, 只支持jpg, png, jpeg,大小限制不超过5M。注意,url必须携带格式后缀,url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='
|
|
1626
|
-
*/
|
|
1627
|
-
WaterMarkUrl: string
|
|
1628
|
-
/**
|
|
1629
|
-
* 画布上该画面左上角的 y 轴坐标,取值范围 [0, 2560],不能超过画布的高。
|
|
1630
|
-
*/
|
|
1631
|
-
Top: number
|
|
1632
|
-
/**
|
|
1633
|
-
* 画布上该画面左上角的 x 轴坐标,取值范围 [0, 2560],不能超过画布的宽。
|
|
1634
|
-
*/
|
|
1635
|
-
Left: number
|
|
1636
|
-
/**
|
|
1637
|
-
* 画布上该画面宽度的相对值,取值范围 [0, 2560],与Left相加不应超过画布的宽。
|
|
1638
|
-
*/
|
|
1639
|
-
Width: number
|
|
1640
|
-
/**
|
|
1641
|
-
* 画布上该画面高度的相对值,取值范围 [0, 2560],与Top相加不应超过画布的高。
|
|
1642
|
-
*/
|
|
1643
|
-
Height: number
|
|
1644
|
-
}
|
|
1645
|
-
|
|
1646
|
-
/**
|
|
1647
|
-
* 混流用户参数
|
|
1648
|
-
*/
|
|
1649
|
-
export interface McuUserInfoParams {
|
|
1650
|
-
/**
|
|
1651
|
-
* 用户参数。
|
|
1652
|
-
*/
|
|
1653
|
-
UserInfo: MixUserInfo
|
|
1654
|
-
/**
|
|
1655
|
-
* 混音的音量调整:取值范围是0到100,100为原始上行音量,不填默认为100,值越小则音量越低。
|
|
1656
|
-
注:该参数只在音量白名单下配置生效,其他场景配置无效。
|
|
1657
|
-
*/
|
|
1658
|
-
SoundLevel?: number
|
|
1659
|
-
}
|
|
1660
|
-
|
|
1661
|
-
/**
|
|
1662
|
-
* 用户媒体流参数。
|
|
1663
|
-
*/
|
|
1664
|
-
export interface UserMediaStream {
|
|
1665
|
-
/**
|
|
1666
|
-
* TRTC用户参数。
|
|
1667
|
-
*/
|
|
1668
|
-
UserInfo?: MixUserInfo
|
|
1669
|
-
/**
|
|
1670
|
-
* 主辅路流类型,0为摄像头,1为屏幕分享,不填默认为0。
|
|
1671
|
-
*/
|
|
1672
|
-
StreamType?: number
|
|
1673
|
-
}
|
|
1674
|
-
|
|
1675
|
-
/**
|
|
1676
|
-
* sdk或webrtc的事件列表。
|
|
1677
|
-
*/
|
|
1678
|
-
export interface EventList {
|
|
1679
|
-
/**
|
|
1680
|
-
* 数据内容
|
|
1681
|
-
*/
|
|
1682
|
-
Content?: Array<EventMessage>
|
|
1683
|
-
/**
|
|
1684
|
-
* 发送端的userId
|
|
1685
|
-
*/
|
|
1686
|
-
PeerId?: string
|
|
1687
|
-
}
|
|
1688
|
-
|
|
1689
|
-
/**
|
|
1690
|
-
* DescribeTrtcUsage请求参数结构体
|
|
1691
|
-
*/
|
|
1692
|
-
export interface DescribeTrtcUsageRequest {
|
|
1693
|
-
/**
|
|
1694
|
-
* 查询开始时间,格式为YYYY-MM-DD。
|
|
1695
|
-
*/
|
|
1696
|
-
StartTime: string
|
|
1697
|
-
/**
|
|
1698
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1699
|
-
单次查询统计区间最多不能超过31天。
|
|
1700
|
-
*/
|
|
1701
|
-
EndTime: string
|
|
1702
|
-
/**
|
|
1703
|
-
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
1704
|
-
*/
|
|
1705
|
-
SdkAppId?: number
|
|
1706
|
-
}
|
|
1707
|
-
|
|
1708
|
-
/**
|
|
1709
|
-
* DescribeRoomInfo返回参数结构体
|
|
1710
|
-
*/
|
|
1711
|
-
export interface DescribeRoomInfoResponse {
|
|
1712
|
-
/**
|
|
1713
|
-
* 返回当页数据总数
|
|
1714
|
-
*/
|
|
1715
|
-
Total?: number
|
|
1716
|
-
/**
|
|
1717
|
-
* 房间信息列表
|
|
1718
|
-
*/
|
|
1719
|
-
RoomList?: Array<RoomState>
|
|
1720
|
-
/**
|
|
1721
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1722
|
-
*/
|
|
1723
|
-
RequestId?: string
|
|
1724
|
-
}
|
|
1725
|
-
|
|
1726
|
-
/**
|
|
1727
|
-
* 混流布局参数。
|
|
1728
|
-
*/
|
|
1729
|
-
export interface McuLayoutParams {
|
|
1730
|
-
/**
|
|
1731
|
-
* 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。最多支持混入16路音视频流,如果用户只上行音频,也会被算作一路;自定义布局中,如果子画面只设置占位图,也被算作一路。
|
|
1732
|
-
*/
|
|
1733
|
-
MixLayoutMode?: number
|
|
1734
|
-
/**
|
|
1735
|
-
* 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
|
|
1736
|
-
*/
|
|
1737
|
-
PureAudioHoldPlaceMode?: number
|
|
1738
|
-
/**
|
|
1739
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置,最多支持设置16个输入流。
|
|
1740
|
-
*/
|
|
1741
|
-
MixLayoutList?: Array<McuLayout>
|
|
1742
|
-
/**
|
|
1743
|
-
* 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
|
|
1744
|
-
*/
|
|
1745
|
-
MaxVideoUser?: MaxVideoUser
|
|
1746
|
-
/**
|
|
1747
|
-
* 屏幕分享模板、悬浮模板、九宫格模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底
|
|
1748
|
-
*/
|
|
1749
|
-
RenderMode?: number
|
|
1750
|
-
}
|
|
1751
|
-
|
|
1752
|
-
/**
|
|
1753
|
-
* DescribeTRTCRealTimeQualityMetricData请求参数结构体
|
|
1754
|
-
*/
|
|
1755
|
-
export interface DescribeTRTCRealTimeQualityMetricDataRequest {
|
|
1756
|
-
/**
|
|
1757
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
1758
|
-
*/
|
|
1759
|
-
SdkAppId: string
|
|
1760
|
-
/**
|
|
1761
|
-
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
1762
|
-
*/
|
|
1763
|
-
StartTime: number
|
|
1764
|
-
/**
|
|
1765
|
-
* 结束时间,unix时间戳,单位:秒
|
|
1766
|
-
*/
|
|
1767
|
-
EndTime: number
|
|
1768
|
-
/**
|
|
1769
|
-
* 房间ID
|
|
1770
|
-
*/
|
|
1771
|
-
RoomId?: string
|
|
1772
|
-
}
|
|
1773
|
-
|
|
1774
|
-
/**
|
|
1775
|
-
* DescribeAITranscription请求参数结构体
|
|
1776
|
-
*/
|
|
1777
|
-
export interface DescribeAITranscriptionRequest {
|
|
1778
|
-
/**
|
|
1779
|
-
* 查询任务状态,不使用时传入空字符串。
|
|
1780
|
-
有两种查询方式:
|
|
1781
|
-
1、只填写TaskId,这种方式使用TaskId来查询任务
|
|
1782
|
-
2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务
|
|
1783
|
-
*/
|
|
1784
|
-
TaskId: string
|
|
1785
|
-
/**
|
|
1786
|
-
* TRTC的SdkAppId,和SessionId配合使用。
|
|
1787
|
-
*/
|
|
1788
|
-
SdkAppId?: number
|
|
1789
|
-
/**
|
|
1790
|
-
* 开启转录任务时传入的SessionId,和SdkAppId配合使用。
|
|
1791
|
-
*/
|
|
1792
|
-
SessionId?: string
|
|
1793
|
-
}
|
|
1794
|
-
|
|
1795
|
-
/**
|
|
1796
|
-
* CreateBasicModeration返回参数结构体
|
|
1797
|
-
*/
|
|
1798
|
-
export interface CreateBasicModerationResponse {
|
|
1799
|
-
/**
|
|
1800
|
-
* 审核服务分配的任务ID。任务ID是对一次审核任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数
|
|
1801
|
-
*/
|
|
1802
|
-
TaskId?: string
|
|
1803
|
-
/**
|
|
1804
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1805
|
-
*/
|
|
1806
|
-
RequestId?: string
|
|
1807
|
-
}
|
|
1808
|
-
|
|
1809
|
-
/**
|
|
1810
|
-
* 查询旁路转码计费时长。
|
|
1811
|
-
查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
1812
|
-
*/
|
|
1813
|
-
export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
|
|
1814
|
-
/**
|
|
1815
|
-
* 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
|
|
1816
|
-
*/
|
|
1817
|
-
TimeKey: string
|
|
1818
|
-
/**
|
|
1819
|
-
* 语音时长,单位:秒。
|
|
1820
|
-
*/
|
|
1821
|
-
AudioTime: number
|
|
1822
|
-
/**
|
|
1823
|
-
* 视频时长-标清SD,单位:秒。
|
|
1824
|
-
*/
|
|
1825
|
-
VideoTimeSd: number
|
|
1826
|
-
/**
|
|
1827
|
-
* 视频时长-高清HD,单位:秒。
|
|
1828
|
-
*/
|
|
1829
|
-
VideoTimeHd: number
|
|
1830
|
-
/**
|
|
1831
|
-
* 视频时长-全高清FHD,单位:秒。
|
|
1832
|
-
*/
|
|
1833
|
-
VideoTimeFhd: number
|
|
1834
|
-
/**
|
|
1835
|
-
* 带宽,单位:Mbps。
|
|
1836
|
-
*/
|
|
1837
|
-
Flux: number
|
|
1838
|
-
}
|
|
1839
|
-
|
|
1840
|
-
/**
|
|
1841
|
-
* DescribeAIConversation返回参数结构体
|
|
1842
|
-
*/
|
|
1843
|
-
export interface DescribeAIConversationResponse {
|
|
1844
|
-
/**
|
|
1845
|
-
* 任务开始时间。
|
|
1846
|
-
*/
|
|
1847
|
-
StartTime?: string
|
|
1848
|
-
/**
|
|
1849
|
-
* 任务状态。有4个值:1、Idle表示任务未开始2、Preparing表示任务准备中3、InProgress表示任务正在运行4、Stopped表示任务已停止,正在清理资源中
|
|
1850
|
-
*/
|
|
1851
|
-
Status?: string
|
|
1852
|
-
/**
|
|
1853
|
-
* 任务的唯一标识,在启动任务时生成
|
|
1854
|
-
*/
|
|
1855
|
-
TaskId?: string
|
|
1856
|
-
/**
|
|
1857
|
-
* 开启对话任务时填写的SessionId,如果没写则不返回。
|
|
1858
|
-
*/
|
|
1859
|
-
SessionId?: string
|
|
1860
|
-
/**
|
|
1861
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1862
|
-
*/
|
|
1863
|
-
RequestId?: string
|
|
1864
|
-
}
|
|
1865
|
-
|
|
1866
|
-
/**
|
|
1867
|
-
* 混流布局参数。
|
|
1868
|
-
*/
|
|
1869
|
-
export interface McuLayout {
|
|
1870
|
-
/**
|
|
1871
|
-
* 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
|
|
1872
|
-
*/
|
|
1873
|
-
UserMediaStream?: UserMediaStream
|
|
1874
|
-
/**
|
|
1875
|
-
* 子画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1876
|
-
*/
|
|
1877
|
-
ImageWidth?: number
|
|
1878
|
-
/**
|
|
1879
|
-
* 子画面在输出时的高度,单位为像素值,不填默认为0。
|
|
1880
|
-
*/
|
|
1881
|
-
ImageHeight?: number
|
|
1882
|
-
/**
|
|
1883
|
-
* 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1884
|
-
*/
|
|
1885
|
-
LocationX?: number
|
|
1886
|
-
/**
|
|
1887
|
-
* 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1888
|
-
*/
|
|
1889
|
-
LocationY?: number
|
|
1890
|
-
/**
|
|
1891
|
-
* 子画面在输出时的层级,不填默认为0。
|
|
1892
|
-
*/
|
|
1893
|
-
ZOrder?: number
|
|
1894
|
-
/**
|
|
1895
|
-
* 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
|
|
1896
|
-
*/
|
|
1897
|
-
RenderMode?: number
|
|
1898
|
-
/**
|
|
1899
|
-
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1900
|
-
红色:0xcc0033。
|
|
1901
|
-
黄色:0xcc9900。
|
|
1902
|
-
绿色:0xcccc33。
|
|
1903
|
-
蓝色:0x99CCFF。
|
|
1904
|
-
黑色:0x000000。
|
|
1905
|
-
白色:0xFFFFFF。
|
|
1906
|
-
灰色:0x999999。
|
|
1907
|
-
*/
|
|
1908
|
-
BackGroundColor?: string
|
|
1909
|
-
/**
|
|
1910
|
-
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
|
|
1911
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。
|
|
1912
|
-
*/
|
|
1913
|
-
BackgroundImageUrl?: string
|
|
1914
|
-
/**
|
|
1915
|
-
* 客户自定义裁剪,针对原始输入流裁剪
|
|
1916
|
-
*/
|
|
1917
|
-
CustomCrop?: McuCustomCrop
|
|
1918
|
-
/**
|
|
1919
|
-
* 子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。
|
|
1920
|
-
*/
|
|
1921
|
-
BackgroundRenderMode?: number
|
|
1922
|
-
/**
|
|
1923
|
-
* 子画面的透明模版url,指向一张包含透明通道的模板图片。填写该参数,后台混流时会提取该模板图片的透明通道,将其缩放作为目标画面的透明通道,再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪(如圆角、星形、心形等)。 支持png格式。图片大小限制不超过5MB。
|
|
1924
|
-
注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。
|
|
1925
|
-
*/
|
|
1926
|
-
TransparentUrl?: string
|
|
1927
|
-
/**
|
|
1928
|
-
* 子背景图的自定义渲染参数,当BackgroundRenderMode为4时必须配置。
|
|
1929
|
-
*/
|
|
1930
|
-
BackgroundCustomRender?: McuBackgroundCustomRender
|
|
1931
|
-
/**
|
|
1932
|
-
* 子背景色生效模式,默认值为0表示均不生效。
|
|
1933
|
-
bit0:占位图缩放是否生效。
|
|
1934
|
-
bit1:上行流缩放是否生效。
|
|
1935
|
-
您可以将相应bit位置1启动生效,例如:
|
|
1936
|
-
0(00)表示子背景色不生效。
|
|
1937
|
-
1(01)表示子背景色只在占位图缩放时生效。
|
|
1938
|
-
2(10)表示子背景色只在上行流缩放时生效。
|
|
1939
|
-
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
|
|
1940
|
-
|
|
1941
|
-
*/
|
|
1942
|
-
BackGroundColorMode?: number
|
|
1943
|
-
}
|
|
1944
|
-
|
|
1945
|
-
/**
|
|
1946
|
-
* DescribeUserInfo返回参数结构体
|
|
1947
|
-
*/
|
|
1948
|
-
export interface DescribeUserInfoResponse {
|
|
1949
|
-
/**
|
|
1950
|
-
* 返回的用户总条数
|
|
1951
|
-
*/
|
|
1952
|
-
Total?: number
|
|
1953
|
-
/**
|
|
1954
|
-
* 用户信息列表
|
|
1955
|
-
*/
|
|
1956
|
-
UserList?: Array<UserInformation>
|
|
1957
|
-
/**
|
|
1958
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1959
|
-
*/
|
|
1960
|
-
RequestId?: string
|
|
1961
|
-
}
|
|
1962
|
-
|
|
1963
|
-
/**
|
|
1964
|
-
* RemoveUserByStrRoomId返回参数结构体
|
|
1965
|
-
*/
|
|
1966
|
-
export interface RemoveUserByStrRoomIdResponse {
|
|
1967
|
-
/**
|
|
1968
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1969
|
-
*/
|
|
1970
|
-
RequestId?: string
|
|
1971
|
-
}
|
|
1972
|
-
|
|
1973
|
-
/**
|
|
1974
|
-
* DescribeTRTCRealTimeScaleMetricData返回参数结构体
|
|
1975
|
-
*/
|
|
1976
|
-
export interface DescribeTRTCRealTimeScaleMetricDataResponse {
|
|
1977
|
-
/**
|
|
1978
|
-
* TRTC监控数据出参
|
|
1979
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1980
|
-
*/
|
|
1981
|
-
Data?: TRTCDataResp
|
|
1982
|
-
/**
|
|
1983
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1984
|
-
*/
|
|
1985
|
-
RequestId?: string
|
|
1986
|
-
}
|
|
1987
|
-
|
|
1988
|
-
/**
|
|
1989
|
-
* UpdateStreamIngest返回参数结构体
|
|
1990
|
-
*/
|
|
1991
|
-
export interface UpdateStreamIngestResponse {
|
|
1992
|
-
/**
|
|
1993
|
-
* 任务的状态信息。InProgress:表示当前任务正在进行中。NotExist:表示当前任务不存在。示例值:InProgress
|
|
1994
|
-
*/
|
|
1995
|
-
Status?: string
|
|
1996
|
-
/**
|
|
1997
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1998
|
-
*/
|
|
1999
|
-
RequestId?: string
|
|
2000
|
-
}
|
|
2001
|
-
|
|
2002
|
-
/**
|
|
2003
|
-
* StartMCUMixTranscode请求参数结构体
|
|
2004
|
-
*/
|
|
2005
|
-
export interface StartMCUMixTranscodeRequest {
|
|
2006
|
-
/**
|
|
2007
|
-
* TRTC的SDKAppId。
|
|
2008
|
-
*/
|
|
2009
|
-
SdkAppId: number
|
|
2010
|
-
/**
|
|
2011
|
-
* 房间号。
|
|
2012
|
-
*/
|
|
2013
|
-
RoomId: number
|
|
2014
|
-
/**
|
|
2015
|
-
* 混流输出控制参数。
|
|
2016
|
-
*/
|
|
2017
|
-
OutputParams: OutputParams
|
|
2018
|
-
/**
|
|
2019
|
-
* 混流输出编码参数。
|
|
2020
|
-
*/
|
|
2021
|
-
EncodeParams: EncodeParams
|
|
2022
|
-
/**
|
|
2023
|
-
* 混流输出布局参数。
|
|
2024
|
-
*/
|
|
2025
|
-
LayoutParams: LayoutParams
|
|
2026
|
-
/**
|
|
2027
|
-
* 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推
|
|
2028
|
-
*/
|
|
2029
|
-
PublishCdnParams?: PublishCdnParams
|
|
2030
|
-
}
|
|
2031
|
-
|
|
2032
|
-
/**
|
|
2033
|
-
* 页面录制控制参数
|
|
2034
|
-
*/
|
|
2035
|
-
export interface WebRecordVideoParams {
|
|
2036
|
-
/**
|
|
2037
|
-
* 录制画面宽度,默认为1280,取值范围[0, 1920]
|
|
2038
|
-
*/
|
|
2039
|
-
Width?: number
|
|
2040
|
-
/**
|
|
2041
|
-
* 录制画面高度,默认为720,取值范围[0, 1080]
|
|
2042
|
-
*/
|
|
2043
|
-
Height?: number
|
|
2044
|
-
/**
|
|
2045
|
-
* 指定输出格式,可选hls,mp4。存储到云点播VOD时此参数无效,存储到VOD时请通过TencentVod(https://cloud.tencent.com/document/api/647/44055#TencentVod)内的MediaType设置。
|
|
2046
|
-
|
|
2047
|
-
*/
|
|
2048
|
-
Format?: string
|
|
2049
|
-
/**
|
|
2050
|
-
* 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】
|
|
2051
|
-
Hls 格式录制此参数不生效。
|
|
2052
|
-
示例值:1440
|
|
2053
|
-
*/
|
|
2054
|
-
MaxMediaFileDuration?: number
|
|
2055
|
-
}
|
|
2056
|
-
|
|
2057
|
-
/**
|
|
2058
|
-
* 图片水印参数。
|
|
2059
|
-
*/
|
|
2060
|
-
export interface McuWaterMarkImage {
|
|
2061
|
-
/**
|
|
2062
|
-
* 水印图片URL地址,支持png、jpg、jpeg格式。图片大小限制不超过5MB。
|
|
2063
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,水印图片将不会生效。
|
|
2064
|
-
*/
|
|
2065
|
-
WaterMarkUrl: string
|
|
2066
|
-
/**
|
|
2067
|
-
* 水印在输出时的宽。单位为像素值。
|
|
2068
|
-
*/
|
|
2069
|
-
WaterMarkWidth: number
|
|
2070
|
-
/**
|
|
2071
|
-
* 水印在输出时的高。单位为像素值。
|
|
2072
|
-
*/
|
|
2073
|
-
WaterMarkHeight: number
|
|
2074
|
-
/**
|
|
2075
|
-
* 水印在输出时的X偏移。单位为像素值。
|
|
2076
|
-
*/
|
|
2077
|
-
LocationX: number
|
|
2078
|
-
/**
|
|
2079
|
-
* 水印在输出时的Y偏移。单位为像素值。
|
|
2080
|
-
*/
|
|
2081
|
-
LocationY: number
|
|
2082
|
-
/**
|
|
2083
|
-
* 水印在输出时的层级,不填默认为0。
|
|
2084
|
-
*/
|
|
2085
|
-
ZOrder?: number
|
|
2086
|
-
/**
|
|
2087
|
-
* 动态水印类型,默认为0。0:关闭;1:随机位置,每秒变动一次;2:边界扫描反弹,每帧变动一次。
|
|
2088
|
-
*/
|
|
2089
|
-
DynamicPosType?: number
|
|
2090
|
-
}
|
|
2091
|
-
|
|
2092
|
-
/**
|
|
2093
|
-
* StartPublishCdnStream返回参数结构体
|
|
2094
|
-
*/
|
|
2095
|
-
export interface StartPublishCdnStreamResponse {
|
|
2096
|
-
/**
|
|
2097
|
-
* 用于唯一标识转推任务,由腾讯云服务端生成,后续更新和停止请求都需要携带TaskiD参数。
|
|
2098
|
-
*/
|
|
2099
|
-
TaskId?: string
|
|
2100
|
-
/**
|
|
2101
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2102
|
-
*/
|
|
2103
|
-
RequestId?: string
|
|
2104
|
-
}
|
|
2105
|
-
|
|
2106
|
-
/**
|
|
2107
|
-
* 实时音视频用量在某一时间段的统计信息。
|
|
2108
|
-
*/
|
|
2109
|
-
export interface TrtcUsage {
|
|
2110
|
-
/**
|
|
2111
|
-
* 时间点,格式为YYYY-MM-DD HH:mm:ss。多天查询时,HH:mm:ss为00:00:00。
|
|
2112
|
-
*/
|
|
2113
|
-
TimeKey?: string
|
|
2114
|
-
/**
|
|
2115
|
-
* 时间点时间戳
|
|
2116
|
-
*/
|
|
2117
|
-
TimeStampKey?: number
|
|
2118
|
-
/**
|
|
2119
|
-
* 用量数组。每个数值含义与UsageKey对应。单位:分钟。
|
|
2120
|
-
*/
|
|
2121
|
-
UsageValue?: Array<number>
|
|
2122
|
-
}
|
|
2123
|
-
|
|
2124
|
-
/**
|
|
2125
|
-
* DescribeTRTCMarketScaleMetricData请求参数结构体
|
|
2126
|
-
*/
|
|
2127
|
-
export interface DescribeTRTCMarketScaleMetricDataRequest {
|
|
2128
|
-
/**
|
|
2129
|
-
* 用户SdkAppId
|
|
2130
|
-
*/
|
|
2131
|
-
SdkAppId: string
|
|
2132
|
-
/**
|
|
2133
|
-
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
2134
|
-
*/
|
|
2135
|
-
StartTime: string
|
|
2136
|
-
/**
|
|
2137
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
2138
|
-
*/
|
|
2139
|
-
EndTime: string
|
|
2140
|
-
/**
|
|
2141
|
-
* 返回数据的粒度,支持设为以下值:
|
|
2142
|
-
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
2143
|
-
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
2144
|
-
*/
|
|
2145
|
-
Period: string
|
|
2146
|
-
}
|
|
2147
|
-
|
|
2148
|
-
/**
|
|
2149
|
-
* DescribeRelayUsage返回参数结构体
|
|
2150
|
-
*/
|
|
2151
|
-
export interface DescribeRelayUsageResponse {
|
|
2152
|
-
/**
|
|
2153
|
-
* 用量类型,与UsageValue中各个位置的值对应。
|
|
2154
|
-
*/
|
|
2155
|
-
UsageKey?: Array<string>
|
|
2156
|
-
/**
|
|
2157
|
-
* 各个时间点用量明细。
|
|
2158
|
-
*/
|
|
2159
|
-
UsageList?: Array<TrtcUsage>
|
|
2160
|
-
/**
|
|
2161
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2162
|
-
*/
|
|
2163
|
-
RequestId?: string
|
|
2164
|
-
}
|
|
2165
|
-
|
|
2166
|
-
/**
|
|
2167
|
-
* StartStreamIngest请求参数结构体
|
|
2168
|
-
*/
|
|
2169
|
-
export interface StartStreamIngestRequest {
|
|
2170
|
-
/**
|
|
2171
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。
|
|
2172
|
-
*/
|
|
2173
|
-
SdkAppId: number
|
|
2174
|
-
/**
|
|
2175
|
-
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
|
|
2176
|
-
*/
|
|
2177
|
-
RoomId: string
|
|
2178
|
-
/**
|
|
2179
|
-
* TRTC房间号的类型。
|
|
2180
|
-
【*注意】必须和录制的房间所对应的RoomId类型相同:
|
|
2181
|
-
0: 字符串类型的RoomId
|
|
2182
|
-
1: 32位整型的RoomId(默认)
|
|
2183
|
-
*/
|
|
2184
|
-
RoomIdType: number
|
|
2185
|
-
/**
|
|
2186
|
-
* 输入在线媒体流机器人的UserId,用于进房发起拉流转推任务。
|
|
2187
|
-
*/
|
|
2188
|
-
UserId: string
|
|
2189
|
-
/**
|
|
2190
|
-
* 输入在线媒体流机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
2191
|
-
*/
|
|
2192
|
-
UserSig: string
|
|
2193
|
-
/**
|
|
2194
|
-
* 源流URL【必填】。如果是视频流,分辨率请保持不变。
|
|
2195
|
-
*/
|
|
2196
|
-
StreamUrl?: string
|
|
2197
|
-
/**
|
|
2198
|
-
* TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
|
|
2199
|
-
*/
|
|
2200
|
-
PrivateMapKey?: string
|
|
2201
|
-
/**
|
|
2202
|
-
* 【本字段已废弃】视频编码参数。可选,如果不填,保持原始流的参数。
|
|
2203
|
-
* @deprecated
|
|
2204
|
-
*/
|
|
2205
|
-
VideoEncodeParams?: VideoEncodeParams
|
|
2206
|
-
/**
|
|
2207
|
-
* 【本字段已废弃】音频编码参数。可选,如果不填,保持原始流的参数。
|
|
2208
|
-
* @deprecated
|
|
2209
|
-
*/
|
|
2210
|
-
AudioEncodeParams?: AudioEncodeParams
|
|
2211
|
-
/**
|
|
2212
|
-
* 【本字段已废弃,请使用 StreamUrl 字段】源流URL,支持一个地址。
|
|
2213
|
-
* @deprecated
|
|
2214
|
-
*/
|
|
2215
|
-
SourceUrl?: Array<string>
|
|
2216
|
-
/**
|
|
2217
|
-
* 指定视频从某个秒时间戳播放
|
|
2218
|
-
*/
|
|
2219
|
-
SeekSecond?: number
|
|
2220
|
-
/**
|
|
2221
|
-
* 开启自动旁路推流,请确认控制台已经开启该功能。
|
|
2222
|
-
*/
|
|
2223
|
-
AutoPush?: boolean
|
|
2224
|
-
/**
|
|
2225
|
-
* 循环播放次数, 取值范围[-1, 1000], 默认1次。
|
|
2226
|
-
- 0 无效值
|
|
2227
|
-
- -1 循环播放, 需要主动调用停止接口或设置MaxDuration
|
|
2228
|
-
|
|
2229
|
-
*/
|
|
2230
|
-
RepeatNum?: number
|
|
2231
|
-
/**
|
|
2232
|
-
* 循环播放最大时长,仅支持RepeatNum设置-1时生效,取值范围[1, 10080],单位分钟。
|
|
2233
|
-
*/
|
|
2234
|
-
MaxDuration?: number
|
|
2235
|
-
/**
|
|
2236
|
-
* 音量,取值范围[0, 100],默认100,表示原音量。
|
|
2237
|
-
*/
|
|
2238
|
-
Volume?: number
|
|
2239
|
-
}
|
|
2240
|
-
|
|
2241
|
-
/**
|
|
2242
|
-
* DescribeRecordingUsage返回参数结构体
|
|
2243
|
-
*/
|
|
2244
|
-
export interface DescribeRecordingUsageResponse {
|
|
2245
|
-
/**
|
|
2246
|
-
* 用量类型,与UsageValue中各个位置的值对应。
|
|
2247
|
-
*/
|
|
2248
|
-
UsageKey?: Array<string>
|
|
2249
|
-
/**
|
|
2250
|
-
* 各个时间点用量明细。
|
|
2251
|
-
*/
|
|
2252
|
-
UsageList?: Array<TrtcUsage>
|
|
2253
|
-
/**
|
|
2254
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2255
|
-
*/
|
|
2256
|
-
RequestId?: string
|
|
2257
|
-
}
|
|
2258
|
-
|
|
2259
|
-
/**
|
|
2260
|
-
* StopMCUMixTranscode请求参数结构体
|
|
2261
|
-
*/
|
|
2262
|
-
export interface StopMCUMixTranscodeRequest {
|
|
2263
|
-
/**
|
|
2264
|
-
* TRTC的SDKAppId。
|
|
2265
|
-
*/
|
|
2266
|
-
SdkAppId: number
|
|
2267
|
-
/**
|
|
2268
|
-
* 房间号。
|
|
2269
|
-
*/
|
|
2270
|
-
RoomId: number
|
|
2271
|
-
}
|
|
2272
|
-
|
|
2273
|
-
/**
|
|
2274
|
-
* ModifyPicture返回参数结构体
|
|
2275
|
-
*/
|
|
2276
|
-
export interface ModifyPictureResponse {
|
|
2277
|
-
/**
|
|
2278
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2279
|
-
*/
|
|
2280
|
-
RequestId?: string
|
|
2281
|
-
}
|
|
2282
|
-
|
|
2283
|
-
/**
|
|
2284
|
-
* DescribeRecordingUsage请求参数结构体
|
|
2285
|
-
*/
|
|
2286
|
-
export interface DescribeRecordingUsageRequest {
|
|
2287
|
-
/**
|
|
2288
|
-
* 查询开始时间,格式为YYYY-MM-DD。
|
|
2289
|
-
*/
|
|
2290
|
-
StartTime: string
|
|
2291
|
-
/**
|
|
2292
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
2293
|
-
单次查询统计区间最多不能超过31天。
|
|
2294
|
-
*/
|
|
2295
|
-
EndTime: string
|
|
2296
|
-
/**
|
|
2297
|
-
* 查询单流录制或合流录制,值为"single"或"multi"。
|
|
2298
|
-
*/
|
|
2299
|
-
MixType: string
|
|
2300
|
-
/**
|
|
2301
|
-
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
2302
|
-
*/
|
|
2303
|
-
SdkAppId?: number
|
|
2304
|
-
}
|
|
2305
|
-
|
|
2306
|
-
/**
|
|
2307
|
-
* 云端录制查询接口,录制文件的信息
|
|
2308
|
-
*/
|
|
2309
|
-
export interface StorageFile {
|
|
2310
|
-
/**
|
|
2311
|
-
* 录制文件对应的UserId,如果是混流的话的这里返回的是空串。
|
|
2312
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2313
|
-
*/
|
|
2314
|
-
UserId?: string
|
|
2315
|
-
/**
|
|
2316
|
-
* 录制索引文件名。
|
|
2317
|
-
*/
|
|
2318
|
-
FileName?: string
|
|
2319
|
-
/**
|
|
2320
|
-
* 录制文件流信息。
|
|
2321
|
-
video:视频录制文件
|
|
2322
|
-
audio:音频录制文件
|
|
2323
|
-
audio_video:音视频录制文件
|
|
2324
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2325
|
-
*/
|
|
2326
|
-
TrackType?: string
|
|
2327
|
-
/**
|
|
2328
|
-
* 录制文件开始Unix时间戳。
|
|
2329
|
-
*/
|
|
2330
|
-
BeginTimeStamp?: number
|
|
2331
|
-
}
|
|
2332
|
-
|
|
2333
|
-
/**
|
|
2334
|
-
* 水印布局参数
|
|
2335
|
-
*/
|
|
2336
|
-
export interface WaterMark {
|
|
2337
|
-
/**
|
|
2338
|
-
* 水印类型,0为图片(默认),1为文字,2为时间戳。
|
|
2339
|
-
*/
|
|
2340
|
-
WaterMarkType?: number
|
|
2341
|
-
/**
|
|
2342
|
-
* 水印为图片时的参数列表,水印为图片时校验必填。
|
|
2343
|
-
*/
|
|
2344
|
-
WaterMarkImage?: WaterMarkImage
|
|
2345
|
-
/**
|
|
2346
|
-
* 水印为文字时的参数列表,水印为文字时校验必填。
|
|
2347
|
-
*/
|
|
2348
|
-
WaterMarkChar?: WaterMarkChar
|
|
2349
|
-
/**
|
|
2350
|
-
* 水印为时间戳时的参数列表,水印为时间戳时校验必填。
|
|
2351
|
-
*/
|
|
2352
|
-
WaterMarkTimestamp?: WaterMarkTimestamp
|
|
2353
|
-
}
|
|
2354
|
-
|
|
2355
|
-
/**
|
|
2356
|
-
* Mcu转推录制,第三方存储参数。
|
|
2357
|
-
*/
|
|
2358
|
-
export interface McuStorageParams {
|
|
2359
|
-
/**
|
|
2360
|
-
* 第三方云存储的账号信息(特别说明:若您选择存储至对象存储COS将会收取录制文件投递至COS的费用,详见云端录制收费说明,存储至VOD将不收取此项费用。)。
|
|
2361
|
-
*/
|
|
2362
|
-
CloudStorage?: CloudStorage
|
|
2363
|
-
/**
|
|
2364
|
-
* 腾讯云云点播的账号信息。
|
|
2365
|
-
*/
|
|
2366
|
-
McuCloudVod?: McuCloudVod
|
|
2367
|
-
}
|
|
2368
|
-
|
|
2369
|
-
/**
|
|
2370
|
-
* DescribeScaleInfo返回参数结构体
|
|
2371
|
-
*/
|
|
2372
|
-
export interface DescribeScaleInfoResponse {
|
|
2373
|
-
/**
|
|
2374
|
-
* 返回的数据条数
|
|
2375
|
-
*/
|
|
2376
|
-
Total?: number
|
|
2377
|
-
/**
|
|
2378
|
-
* 返回的数据
|
|
2379
|
-
*/
|
|
2380
|
-
ScaleList?: Array<ScaleInfomation>
|
|
2381
|
-
/**
|
|
2382
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2383
|
-
*/
|
|
2384
|
-
RequestId?: string
|
|
2385
|
-
}
|
|
2386
|
-
|
|
2387
|
-
/**
|
|
2388
|
-
* 录制的混流布局参数。
|
|
2389
|
-
*/
|
|
2390
|
-
export interface MixLayoutParams {
|
|
2391
|
-
/**
|
|
2392
|
-
* 布局模式:
|
|
2393
|
-
1:悬浮布局;
|
|
2394
|
-
2:屏幕分享布局;
|
|
2395
|
-
3:九宫格布局;
|
|
2396
|
-
4:自定义布局;
|
|
2397
|
-
|
|
2398
|
-
悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
2399
|
-
|
|
2400
|
-
屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。
|
|
2401
|
-
|
|
2402
|
-
九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。
|
|
2403
|
-
|
|
2404
|
-
自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。
|
|
2405
|
-
*/
|
|
2406
|
-
MixLayoutMode: number
|
|
2407
|
-
/**
|
|
2408
|
-
* 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。
|
|
2409
|
-
*/
|
|
2410
|
-
MixLayoutList?: Array<MixLayout>
|
|
2411
|
-
/**
|
|
2412
|
-
* 录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值
|
|
2413
|
-
*/
|
|
2414
|
-
BackGroundColor?: string
|
|
2415
|
-
/**
|
|
2416
|
-
* 在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色
|
|
2417
|
-
*/
|
|
2418
|
-
MaxResolutionUserId?: string
|
|
2419
|
-
/**
|
|
2420
|
-
* 主辅路标识,
|
|
2421
|
-
0:主流(默认);
|
|
2422
|
-
1:辅流(屏幕分享);
|
|
2423
|
-
这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。
|
|
2424
|
-
*/
|
|
2425
|
-
MediaId?: number
|
|
2426
|
-
/**
|
|
2427
|
-
* 图片的url地址,只支持jpg, png, jpeg,大小限制不超过5M。注意,url必须携带格式后缀,url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='
|
|
2428
|
-
*/
|
|
2429
|
-
BackgroundImageUrl?: string
|
|
2430
|
-
/**
|
|
2431
|
-
* 设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。
|
|
2432
|
-
*/
|
|
2433
|
-
PlaceHolderMode?: number
|
|
2434
|
-
/**
|
|
2435
|
-
* 背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。
|
|
2436
|
-
*/
|
|
2437
|
-
BackgroundImageRenderMode?: number
|
|
2438
|
-
/**
|
|
2439
|
-
* 子画面占位图url地址,只支持jpg, png, jpeg,大小限制不超过5M。注意,url必须携带格式后缀,url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='
|
|
2440
|
-
*/
|
|
2441
|
-
DefaultSubBackgroundImage?: string
|
|
2442
|
-
/**
|
|
2443
|
-
* 水印布局参数, 最多支持25个。
|
|
2444
|
-
*/
|
|
2445
|
-
WaterMarkList?: Array<WaterMark>
|
|
2446
|
-
/**
|
|
2447
|
-
* 模板布局下,背景画面宽高比不一致的时候处理方案。自定义布局不生效,与MixLayoufList定义的RenderMode一致。
|
|
2448
|
-
*/
|
|
2449
|
-
RenderMode?: number
|
|
2450
|
-
/**
|
|
2451
|
-
* 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。
|
|
2452
|
-
*/
|
|
2453
|
-
MaxResolutionUserAlign?: number
|
|
2454
|
-
}
|
|
2455
|
-
|
|
2456
|
-
/**
|
|
2457
|
-
* StopMCUMixTranscode返回参数结构体
|
|
2458
|
-
*/
|
|
2459
|
-
export interface StopMCUMixTranscodeResponse {
|
|
2460
|
-
/**
|
|
2461
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2462
|
-
*/
|
|
2463
|
-
RequestId?: string
|
|
2464
|
-
}
|
|
2465
|
-
|
|
2466
|
-
/**
|
|
2467
|
-
* DescribeMixTranscodingUsage返回参数结构体
|
|
2468
|
-
*/
|
|
2469
|
-
export interface DescribeMixTranscodingUsageResponse {
|
|
2470
|
-
/**
|
|
2471
|
-
* 用量类型,与UsageValue中各个位置的值对应。
|
|
2472
|
-
*/
|
|
2473
|
-
UsageKey?: Array<string>
|
|
2474
|
-
/**
|
|
2475
|
-
* 各个时间点用量明细。
|
|
2476
|
-
*/
|
|
2477
|
-
UsageList?: Array<TrtcUsage>
|
|
2478
|
-
/**
|
|
2479
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2480
|
-
*/
|
|
2481
|
-
RequestId?: string
|
|
2482
|
-
}
|
|
2483
|
-
|
|
2484
|
-
/**
|
|
2485
|
-
* 回推房间参数。
|
|
2486
|
-
*/
|
|
2487
|
-
export interface McuFeedBackRoomParams {
|
|
2488
|
-
/**
|
|
2489
|
-
* 回推房间的RoomId。
|
|
2490
|
-
*/
|
|
2491
|
-
RoomId: string
|
|
2492
|
-
/**
|
|
2493
|
-
* 房间类型,必须和回推房间所对应的RoomId类型相同,0为整形房间号,1为字符串房间号。
|
|
2494
|
-
*/
|
|
2495
|
-
RoomIdType: number
|
|
2496
|
-
/**
|
|
2497
|
-
* 回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
|
|
2498
|
-
*/
|
|
2499
|
-
UserId: string
|
|
2500
|
-
/**
|
|
2501
|
-
* 回推房间UserId对应的用户签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
2502
|
-
*/
|
|
2503
|
-
UserSig: string
|
|
2504
|
-
}
|
|
2505
|
-
|
|
2506
|
-
/**
|
|
2507
|
-
* SdkAppId级别录制时长数据。
|
|
2508
|
-
*/
|
|
2509
|
-
export interface SdkAppIdRecordUsage {
|
|
2510
|
-
/**
|
|
2511
|
-
* SdkAppId的值。
|
|
2512
|
-
*/
|
|
2513
|
-
SdkAppId?: string
|
|
2514
|
-
/**
|
|
2515
|
-
* 统计的时间点数据。
|
|
2516
|
-
*/
|
|
2517
|
-
Usages?: Array<RecordUsage>
|
|
2518
|
-
}
|
|
2519
|
-
|
|
2520
|
-
/**
|
|
2521
|
-
* 音频编码参数。
|
|
2522
|
-
*/
|
|
2523
|
-
export interface AudioEncode {
|
|
2524
|
-
/**
|
|
2525
|
-
* 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。
|
|
2526
|
-
*/
|
|
2527
|
-
SampleRate: number
|
|
2528
|
-
/**
|
|
2529
|
-
* 输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。
|
|
2530
|
-
*/
|
|
2531
|
-
Channel: number
|
|
2532
|
-
/**
|
|
2533
|
-
* 输出流音频码率。取值范围[8,500],单位为kbps。
|
|
2534
|
-
*/
|
|
2535
|
-
BitRate: number
|
|
2536
|
-
/**
|
|
2537
|
-
* 输出流音频编码类型,取值范围[0, 1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。
|
|
2538
|
-
*/
|
|
2539
|
-
Codec?: number
|
|
2540
|
-
}
|
|
2541
|
-
|
|
2542
|
-
/**
|
|
2543
|
-
* RemoveUser请求参数结构体
|
|
2544
|
-
*/
|
|
2545
|
-
export interface RemoveUserRequest {
|
|
2546
|
-
/**
|
|
2547
|
-
* TRTC的SDKAppId。
|
|
2548
|
-
*/
|
|
2549
|
-
SdkAppId: number
|
|
2550
|
-
/**
|
|
2551
|
-
* 房间号。
|
|
2552
|
-
*/
|
|
2553
|
-
RoomId: number
|
|
2554
|
-
/**
|
|
2555
|
-
* 要移出的用户列表,最多10个。
|
|
2556
|
-
*/
|
|
2557
|
-
UserIds: Array<string>
|
|
2558
|
-
}
|
|
2559
|
-
|
|
2560
|
-
/**
|
|
2561
|
-
* TRTC数据大盘/实时监控 API接口数据出参
|
|
2562
|
-
*/
|
|
2563
|
-
export interface TRTCDataResult {
|
|
2564
|
-
/**
|
|
2565
|
-
* StatementID值,监控仪表盘下固定为0。
|
|
2566
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2567
|
-
*/
|
|
2568
|
-
StatementID?: number
|
|
2569
|
-
/**
|
|
2570
|
-
* 查询结果数据,以Columns-Values形式返回。
|
|
2571
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2572
|
-
*/
|
|
2573
|
-
Series?: Array<SeriesInfos>
|
|
2574
|
-
/**
|
|
2575
|
-
* Total值,监控仪表盘功能下固定为1。
|
|
2576
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2577
|
-
*/
|
|
2578
|
-
Total?: number
|
|
2579
|
-
}
|
|
2580
|
-
|
|
2581
|
-
/**
|
|
2582
|
-
* DismissRoom请求参数结构体
|
|
2583
|
-
*/
|
|
2584
|
-
export interface DismissRoomRequest {
|
|
2585
|
-
/**
|
|
2586
|
-
* TRTC的SDKAppId。
|
|
2587
|
-
*/
|
|
2588
|
-
SdkAppId: number
|
|
2589
|
-
/**
|
|
2590
|
-
* 数字房间号。本接口仅支持解散数字类型房间号,如需解散字符串类型房间号,请使用DismissRoomByStrRoomId。
|
|
2591
|
-
*/
|
|
2592
|
-
RoomId: number
|
|
2593
|
-
}
|
|
2594
|
-
|
|
2595
|
-
/**
|
|
2596
|
-
* DescribeUnusualEvent请求参数结构体
|
|
2597
|
-
*/
|
|
2598
|
-
export interface DescribeUnusualEventRequest {
|
|
2599
|
-
/**
|
|
2600
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
2601
|
-
*/
|
|
2602
|
-
SdkAppId: number
|
|
2603
|
-
/**
|
|
2604
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
2605
|
-
注意:支持查询14天内的数据
|
|
2606
|
-
*/
|
|
2607
|
-
StartTime: number
|
|
2608
|
-
/**
|
|
2609
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
|
|
2610
|
-
*/
|
|
2611
|
-
EndTime: number
|
|
2612
|
-
/**
|
|
2613
|
-
* 房间号,查询房间内任意20条以内异常体验事件
|
|
2614
|
-
*/
|
|
2615
|
-
RoomId?: string
|
|
2616
|
-
}
|
|
2617
|
-
|
|
2618
|
-
/**
|
|
2619
|
-
* DescribeCloudRecording请求参数结构体
|
|
2620
|
-
*/
|
|
2621
|
-
export interface DescribeCloudRecordingRequest {
|
|
2622
|
-
/**
|
|
2623
|
-
* TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
|
|
2624
|
-
*/
|
|
2625
|
-
SdkAppId: number
|
|
2626
|
-
/**
|
|
2627
|
-
* 录制任务的唯一Id,在启动录制成功后会返回。
|
|
2628
|
-
*/
|
|
2629
|
-
TaskId: string
|
|
2630
|
-
}
|
|
2631
|
-
|
|
2632
|
-
/**
|
|
2633
|
-
* 腾讯云点播相关参数。
|
|
2634
|
-
*/
|
|
2635
|
-
export interface TencentVod {
|
|
2636
|
-
/**
|
|
2637
|
-
* 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
|
|
2638
|
-
*/
|
|
2639
|
-
Procedure?: string
|
|
2640
|
-
/**
|
|
2641
|
-
* 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。
|
|
2642
|
-
*/
|
|
2643
|
-
ExpireTime?: number
|
|
2644
|
-
/**
|
|
2645
|
-
* 指定上传园区,仅适用于对上传地域有特殊需求的用户。
|
|
2646
|
-
*/
|
|
2647
|
-
StorageRegion?: string
|
|
2648
|
-
/**
|
|
2649
|
-
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
|
|
2650
|
-
默认值:0,表示其他分类。
|
|
2651
|
-
*/
|
|
2652
|
-
ClassId?: number
|
|
2653
|
-
/**
|
|
2654
|
-
* 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
|
|
2655
|
-
*/
|
|
2656
|
-
SubAppId?: number
|
|
2657
|
-
/**
|
|
2658
|
-
* 任务流上下文,任务完成回调时透传。
|
|
2659
|
-
*/
|
|
2660
|
-
SessionContext?: string
|
|
2661
|
-
/**
|
|
2662
|
-
* 上传上下文,上传完成回调时透传。
|
|
2663
|
-
*/
|
|
2664
|
-
SourceContext?: string
|
|
2665
|
-
/**
|
|
2666
|
-
* 上传到vod平台的录制文件格式类型,0:mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效),
|
|
2667
|
-
3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。
|
|
2668
|
-
*/
|
|
2669
|
-
MediaType?: number
|
|
2670
|
-
/**
|
|
2671
|
-
* 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。
|
|
2672
|
-
*/
|
|
2673
|
-
UserDefineRecordId?: string
|
|
2674
|
-
}
|
|
2675
|
-
|
|
2676
|
-
/**
|
|
2677
|
-
* 云端录制控制参数。
|
|
2678
|
-
*/
|
|
2679
|
-
export interface RecordParams {
|
|
2680
|
-
/**
|
|
2681
|
-
* 录制模式:
|
|
2682
|
-
1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件上传至云存储;
|
|
2683
|
-
2:合流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储;
|
|
2684
|
-
*/
|
|
2685
|
-
RecordMode: number
|
|
2686
|
-
/**
|
|
2687
|
-
* 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
|
|
2688
|
-
*/
|
|
2689
|
-
MaxIdleTime?: number
|
|
2690
|
-
/**
|
|
2691
|
-
* 录制的媒体流类型:
|
|
2692
|
-
0:录制音频+视频流(默认);
|
|
2693
|
-
1:仅录制音频流;
|
|
2694
|
-
2:仅录制视频流,
|
|
2695
|
-
*/
|
|
2696
|
-
StreamType?: number
|
|
2697
|
-
/**
|
|
2698
|
-
* 指定订阅流白名单或者黑名单。
|
|
2699
|
-
*/
|
|
2700
|
-
SubscribeStreamUserIds?: SubscribeStreamUserIds
|
|
2701
|
-
/**
|
|
2702
|
-
* 输出文件的格式(存储至COS等第三方存储时有效)。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4。2:输出文件格式为hls+aac 。3:输出文件格式为mp4。4:输出文件格式为aac。
|
|
2703
|
-
|
|
2704
|
-
存储到云点播VOD时此参数无效,存储到VOD时请通过TencentVod(https://cloud.tencent.com/document/api/647/44055#TencentVod)内的MediaType设置。
|
|
2705
|
-
*/
|
|
2706
|
-
OutputFormat?: number
|
|
2707
|
-
/**
|
|
2708
|
-
* 单流录制模式下,用户的音视频是否合并,0:单流音视频不合并(默认)。1:单流音视频合并成一个ts。合流录制此参数无需设置,默认音视频合并。
|
|
2709
|
-
*/
|
|
2710
|
-
AvMerge?: number
|
|
2711
|
-
/**
|
|
2712
|
-
* 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】
|
|
2713
|
-
Hls 格式录制此参数不生效。
|
|
2714
|
-
*/
|
|
2715
|
-
MaxMediaFileDuration?: number
|
|
2716
|
-
/**
|
|
2717
|
-
* 指定录制主辅流,0:主流+辅流(默认);1:主流;2:辅流。
|
|
2718
|
-
*/
|
|
2719
|
-
MediaId?: number
|
|
2720
|
-
/**
|
|
2721
|
-
* 上行视频停止时,录制的补帧类型,0:补最后一帧 1:补黑帧
|
|
2722
|
-
*/
|
|
2723
|
-
FillType?: number
|
|
2724
|
-
}
|
|
2725
|
-
|
|
2726
|
-
/**
|
|
2727
|
-
* 自定义透传SEI
|
|
2728
|
-
*/
|
|
2729
|
-
export interface McuPassThrough {
|
|
2730
|
-
/**
|
|
2731
|
-
* 透传SEI的payload内容。
|
|
2732
|
-
*/
|
|
2733
|
-
PayloadContent: string
|
|
2734
|
-
/**
|
|
2735
|
-
* SEI消息的PayloadType,取值范围5、100-254(244除外,244为我们内部自定义的时间戳SEI)。
|
|
2736
|
-
注:部分播放器可能不支持PayloadType为5带PayloadUuid的标准类型,建议优先使用其他PayloadType。
|
|
2737
|
-
*/
|
|
2738
|
-
PayloadType: number
|
|
2739
|
-
/**
|
|
2740
|
-
* PayloadType为5,PayloadUuid必须填写。PayloadType不是5时,不需要填写,填写会被后台忽略。该值必须是32长度的十六进制。
|
|
2741
|
-
*/
|
|
2742
|
-
PayloadUuid?: string
|
|
2743
|
-
/**
|
|
2744
|
-
* SEI发送间隔,单位毫秒,默认值为1000。
|
|
2745
|
-
*/
|
|
2746
|
-
Interval?: number
|
|
2747
|
-
/**
|
|
2748
|
-
* 取值范围[0,1],填1:发送关键帧时会确保带SEI;填0:发送关键帧时不确保带SEI。默认值为0。
|
|
2749
|
-
*/
|
|
2750
|
-
FollowIdr?: number
|
|
2751
|
-
}
|
|
2752
|
-
|
|
2753
|
-
/**
|
|
2754
|
-
* DescribeTRTCRealTimeQualityMetricData返回参数结构体
|
|
2755
|
-
*/
|
|
2756
|
-
export interface DescribeTRTCRealTimeQualityMetricDataResponse {
|
|
2757
|
-
/**
|
|
2758
|
-
* TRTC监控数据出参
|
|
2759
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2760
|
-
*/
|
|
2761
|
-
Data: TRTCDataResp
|
|
2762
|
-
/**
|
|
2763
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2764
|
-
*/
|
|
2765
|
-
RequestId?: string
|
|
2766
|
-
}
|
|
2767
|
-
|
|
2768
|
-
/**
|
|
2769
|
-
* DescribeTRTCRealTimeQualityData请求参数结构体
|
|
2770
|
-
*/
|
|
2771
|
-
export interface DescribeTRTCRealTimeQualityDataRequest {
|
|
2772
|
-
/**
|
|
2773
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
2774
|
-
*/
|
|
2775
|
-
SdkAppId: string
|
|
2776
|
-
/**
|
|
2777
|
-
* 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
|
|
2778
|
-
*/
|
|
2779
|
-
StartTime: number
|
|
2780
|
-
/**
|
|
2781
|
-
* 结束时间,unix时间戳,单位:秒
|
|
2782
|
-
*/
|
|
2783
|
-
EndTime: number
|
|
2784
|
-
/**
|
|
2785
|
-
* 房间ID
|
|
2786
|
-
*/
|
|
2787
|
-
RoomId?: string
|
|
2788
|
-
}
|
|
2789
|
-
|
|
2790
|
-
/**
|
|
2791
|
-
* StartWebRecord返回参数结构体
|
|
2792
|
-
*/
|
|
2793
|
-
export interface StartWebRecordResponse {
|
|
2794
|
-
/**
|
|
2795
|
-
* 录制任务的唯一Id
|
|
2796
|
-
*/
|
|
2797
|
-
TaskId?: string
|
|
2798
|
-
/**
|
|
2799
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2800
|
-
*/
|
|
2801
|
-
RequestId?: string
|
|
2802
|
-
}
|
|
2803
|
-
|
|
2804
|
-
/**
|
|
2805
|
-
* 录制的使用信息。
|
|
2806
|
-
*/
|
|
2807
|
-
export interface RecordUsage {
|
|
2808
|
-
/**
|
|
2809
|
-
* 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
|
|
2810
|
-
*/
|
|
2811
|
-
TimeKey?: string
|
|
2812
|
-
/**
|
|
2813
|
-
* 视频时长-标清SD,单位:秒。
|
|
2814
|
-
*/
|
|
2815
|
-
Class1VideoTime?: number
|
|
2816
|
-
/**
|
|
2817
|
-
* 视频时长-高清HD,单位:秒。
|
|
2818
|
-
*/
|
|
2819
|
-
Class2VideoTime?: number
|
|
2820
|
-
/**
|
|
2821
|
-
* 视频时长-超清HD,单位:秒。
|
|
2822
|
-
*/
|
|
2823
|
-
Class3VideoTime?: number
|
|
2824
|
-
/**
|
|
2825
|
-
* 语音时长,单位:秒。
|
|
2826
|
-
*/
|
|
2827
|
-
AudioTime?: number
|
|
2828
|
-
}
|
|
2829
|
-
|
|
2830
|
-
/**
|
|
2831
|
-
* CreateCloudRecording请求参数结构体
|
|
2832
|
-
*/
|
|
2833
|
-
export interface CreateCloudRecordingRequest {
|
|
2834
|
-
/**
|
|
2835
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
|
|
2836
|
-
*/
|
|
2837
|
-
SdkAppId: number
|
|
2838
|
-
/**
|
|
2839
|
-
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
|
|
2840
|
-
注:房间号类型默认为整型,若房间号类型为字符串,请通过RoomIdType指定。
|
|
2841
|
-
|
|
2842
|
-
*/
|
|
2843
|
-
RoomId: string
|
|
2844
|
-
/**
|
|
2845
|
-
* 录制机器人的UserId,用于进房发起录制任务。
|
|
2846
|
-
【*注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个录制任务时,机器人的userid也不能相互重复,否则会中断前一个录制任务。建议可以把房间ID作为UserId的标识的一部分,即录制机器人UserId在房间内唯一。
|
|
2847
|
-
*/
|
|
2848
|
-
UserId: string
|
|
2849
|
-
/**
|
|
2850
|
-
* 录制机器人UserId对应的校验签名,即UserId和UserSig相当于录制机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
2851
|
-
*/
|
|
2852
|
-
UserSig: string
|
|
2853
|
-
/**
|
|
2854
|
-
* 云端录制控制参数。
|
|
2855
|
-
*/
|
|
2856
|
-
RecordParams: RecordParams
|
|
2857
|
-
/**
|
|
2858
|
-
* 云端录制文件上传到云存储的参数(不支持同时设置云点播VOD和对象存储COS)
|
|
2859
|
-
*/
|
|
2860
|
-
StorageParams: StorageParams
|
|
2861
|
-
/**
|
|
2862
|
-
* TRTC房间号的类型。
|
|
2863
|
-
【*注意】必须和录制的房间所对应的RoomId类型相同:
|
|
2864
|
-
0: 字符串类型的RoomId
|
|
2865
|
-
1: 32位整型的RoomId(默认)
|
|
2866
|
-
*/
|
|
2867
|
-
RoomIdType?: number
|
|
2868
|
-
/**
|
|
2869
|
-
* 合流的转码参数,录制模式为合流的时候可以设置。
|
|
2870
|
-
*/
|
|
2871
|
-
MixTranscodeParams?: MixTranscodeParams
|
|
2872
|
-
/**
|
|
2873
|
-
* 合流的布局参数,录制模式为合流的时候可以设置。
|
|
2874
|
-
*/
|
|
2875
|
-
MixLayoutParams?: MixLayoutParams
|
|
2876
|
-
/**
|
|
2877
|
-
* 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
|
|
2878
|
-
*/
|
|
2879
|
-
ResourceExpiredHour?: number
|
|
2880
|
-
/**
|
|
2881
|
-
* TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
|
|
2882
|
-
*/
|
|
2883
|
-
PrivateMapKey?: string
|
|
2884
|
-
}
|
|
2885
|
-
|
|
2886
|
-
/**
|
|
2887
|
-
* MCU混流的输出参数
|
|
2888
|
-
*/
|
|
2889
|
-
export interface OutputParams {
|
|
2890
|
-
/**
|
|
2891
|
-
* 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同,限制64字节。
|
|
2892
|
-
*/
|
|
2893
|
-
StreamId: string
|
|
2894
|
-
/**
|
|
2895
|
-
* 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频
|
|
2896
|
-
*/
|
|
2897
|
-
PureAudioStream?: number
|
|
2898
|
-
/**
|
|
2899
|
-
* 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768。
|
|
2900
|
-
【注意】该方式仅对旧版云端录制功能的应用生效,新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见:https://cloud.tencent.com/document/product/647/50768#record
|
|
2901
|
-
*/
|
|
2902
|
-
RecordId?: string
|
|
2903
|
-
/**
|
|
2904
|
-
* 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。
|
|
2905
|
-
*/
|
|
2906
|
-
RecordAudioOnly?: number
|
|
2907
|
-
}
|
|
2908
|
-
|
|
2909
|
-
/**
|
|
2910
|
-
* DeleteBasicModeration请求参数结构体
|
|
2911
|
-
*/
|
|
2912
|
-
export interface DeleteBasicModerationRequest {
|
|
2913
|
-
/**
|
|
2914
|
-
* TRTC的SDKAppId,和TRTC的房间所使用的SDKAppId相同。
|
|
2915
|
-
*/
|
|
2916
|
-
SdkAppId: number
|
|
2917
|
-
/**
|
|
2918
|
-
* 审核任务的唯一Id,在启动审核任务成功后会返回。
|
|
2919
|
-
*/
|
|
2920
|
-
TaskId: string
|
|
2921
|
-
}
|
|
2922
|
-
|
|
2923
|
-
/**
|
|
2924
|
-
* DeleteCloudRecording返回参数结构体
|
|
2925
|
-
*/
|
|
2926
|
-
export interface DeleteCloudRecordingResponse {
|
|
2927
|
-
/**
|
|
2928
|
-
* 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
|
|
2929
|
-
*/
|
|
2930
|
-
TaskId?: string
|
|
2931
|
-
/**
|
|
2932
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2933
|
-
*/
|
|
2934
|
-
RequestId?: string
|
|
2935
|
-
}
|
|
2936
|
-
|
|
2937
|
-
/**
|
|
2938
|
-
* StopMCUMixTranscodeByStrRoomId请求参数结构体
|
|
2939
|
-
*/
|
|
2940
|
-
export interface StopMCUMixTranscodeByStrRoomIdRequest {
|
|
2941
|
-
/**
|
|
2942
|
-
* TRTC的SDKAppId。
|
|
2943
|
-
*/
|
|
2944
|
-
SdkAppId: number
|
|
2945
|
-
/**
|
|
2946
|
-
* 字符串房间号。
|
|
2947
|
-
*/
|
|
2948
|
-
StrRoomId: string
|
|
2949
|
-
}
|
|
2950
|
-
|
|
2951
|
-
/**
|
|
2952
|
-
* 语音识别使用的配置
|
|
2953
|
-
*/
|
|
2954
|
-
export interface RecognizeConfig {
|
|
2955
|
-
/**
|
|
2956
|
-
*
|
|
2957
|
-
语音转文字支持识别的语言,默认是"zh" 中文
|
|
2958
|
-
|
|
2959
|
-
可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考:[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976)
|
|
2960
|
-
|
|
2961
|
-
语音转文本不同套餐版本支持的语言如下:
|
|
2962
|
-
|
|
2963
|
-
**基础版**:
|
|
2964
|
-
|
|
2965
|
-
- "zh": 中文
|
|
2966
|
-
|
|
2967
|
-
- "zh-TW": 中国台湾
|
|
2968
|
-
|
|
2969
|
-
- "en": 英语
|
|
2970
|
-
|
|
2971
|
-
**标准版:**
|
|
2972
|
-
|
|
2973
|
-
- "8k_zh_large": 普方大模型引擎. 当前模型同时支持中文等语言的识别,模型参数量极大,语言模型性能增强,针对电话音频中各类场景、各类中文方言的识别准确率极大提升.
|
|
2974
|
-
|
|
2975
|
-
- "16k_zh_large": 普方英大模型引擎. 当前模型同时支持中文、英文、多种中文方言等语言的识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升.
|
|
2976
|
-
|
|
2977
|
-
- "16k_multi_lang": 多语种大模型引擎. 当前模型同时支持英语、日语、韩语、阿拉伯语、菲律宾语、法语、印地语、印尼语、马来语、葡萄牙语、西班牙语、泰语、土耳其语、越南语、德语的识别,可实现15个语种的自动识别(句子/段落级别).
|
|
2978
|
-
|
|
2979
|
-
- "16k_zh_en": 中英大模型引擎. 当前模型同时支持中文、英语识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升.
|
|
2980
|
-
|
|
2981
|
-
**高级版:**
|
|
2982
|
-
|
|
2983
|
-
- "zh-dialect": 中国方言
|
|
2984
|
-
|
|
2985
|
-
- "zh-yue": 中国粤语
|
|
2986
|
-
|
|
2987
|
-
- "vi": 越南语
|
|
2988
|
-
|
|
2989
|
-
- "ja": 日语
|
|
2990
|
-
|
|
2991
|
-
- "ko": 韩语
|
|
2992
|
-
|
|
2993
|
-
- "id": 印度尼西亚语
|
|
2994
|
-
|
|
2995
|
-
- "th": 泰语
|
|
2996
|
-
|
|
2997
|
-
- "pt": 葡萄牙语
|
|
2998
|
-
|
|
2999
|
-
- "tr": 土耳其语
|
|
3000
|
-
|
|
3001
|
-
- "ar": 阿拉伯语
|
|
3002
|
-
|
|
3003
|
-
- "es": 西班牙语
|
|
3004
|
-
|
|
3005
|
-
- "hi": 印地语
|
|
3006
|
-
|
|
3007
|
-
- "fr": 法语
|
|
3008
|
-
|
|
3009
|
-
- "ms": 马来语
|
|
3010
|
-
|
|
3011
|
-
- "fil": 菲律宾语
|
|
3012
|
-
|
|
3013
|
-
- "de": 德语
|
|
3014
|
-
|
|
3015
|
-
- "it": 意大利语
|
|
3016
|
-
|
|
3017
|
-
- "ru": 俄语
|
|
3018
|
-
|
|
3019
|
-
- "sv": 瑞典语
|
|
3020
|
-
|
|
3021
|
-
- "da": 丹麦语
|
|
3022
|
-
|
|
3023
|
-
- "no": 挪威语
|
|
3024
|
-
|
|
3025
|
-
**注意:**
|
|
3026
|
-
|
|
3027
|
-
如果缺少满足您需求的语言,请联系我们技术人员。
|
|
3028
|
-
|
|
3029
|
-
示例值:zh
|
|
3030
|
-
*/
|
|
3031
|
-
Language?: string
|
|
3032
|
-
/**
|
|
3033
|
-
* **发起模糊识别为高级版能力,默认按照高级版收费,仅支持填写基础版和高级版语言.**
|
|
3034
|
-
注意:不支持填写"zh-dialect"
|
|
3035
|
-
*/
|
|
3036
|
-
AlternativeLanguage?: Array<string>
|
|
3037
|
-
/**
|
|
3038
|
-
* 目前已不支持
|
|
3039
|
-
* @deprecated
|
|
3040
|
-
*/
|
|
3041
|
-
Model?: string
|
|
3042
|
-
/**
|
|
3043
|
-
* 填写则翻译,目前支持的语言:
|
|
3044
|
-
中文: zh
|
|
3045
|
-
英语: en
|
|
3046
|
-
越南语: vi
|
|
3047
|
-
日语: ja
|
|
3048
|
-
韩语: ko
|
|
3049
|
-
印度尼西亚语: id
|
|
3050
|
-
泰语: th
|
|
3051
|
-
葡萄牙语: pt
|
|
3052
|
-
土耳其语: tr
|
|
3053
|
-
阿拉伯语: ar
|
|
3054
|
-
西班牙语: es
|
|
3055
|
-
印地语: hi
|
|
3056
|
-
法语: fr
|
|
3057
|
-
马来语: ms
|
|
3058
|
-
菲律宾语: fil
|
|
3059
|
-
德语: de
|
|
3060
|
-
意大利语: it
|
|
3061
|
-
俄语: ru
|
|
3062
|
-
瑞典语: sv
|
|
3063
|
-
挪威语: no
|
|
3064
|
-
丹麦语: da
|
|
3065
|
-
* @deprecated
|
|
3066
|
-
*/
|
|
3067
|
-
TranslationLanguage?: string
|
|
3068
|
-
}
|
|
3069
|
-
|
|
3070
|
-
/**
|
|
3071
|
-
* Es返回的质量数据
|
|
3072
|
-
*/
|
|
3073
|
-
export interface QualityData {
|
|
3074
|
-
/**
|
|
3075
|
-
* 数据内容
|
|
3076
|
-
*/
|
|
3077
|
-
Content?: Array<TimeValue>
|
|
3078
|
-
/**
|
|
3079
|
-
* 用户ID
|
|
3080
|
-
*/
|
|
3081
|
-
UserId?: string
|
|
3082
|
-
/**
|
|
3083
|
-
* 对端Id,为空时表示上行数据
|
|
3084
|
-
*/
|
|
3085
|
-
PeerId?: string
|
|
3086
|
-
/**
|
|
3087
|
-
* 数据类型
|
|
3088
|
-
*/
|
|
3089
|
-
DataType?: string
|
|
3090
|
-
}
|
|
3091
|
-
|
|
3092
|
-
/**
|
|
3093
|
-
* StopPublishCdnStream请求参数结构体
|
|
3094
|
-
*/
|
|
3095
|
-
export interface StopPublishCdnStreamRequest {
|
|
3096
|
-
/**
|
|
3097
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
|
|
3098
|
-
*/
|
|
3099
|
-
SdkAppId: number
|
|
3100
|
-
/**
|
|
3101
|
-
* 唯一标识转推任务。
|
|
3102
|
-
*/
|
|
3103
|
-
TaskId: string
|
|
3104
|
-
/**
|
|
3105
|
-
* 录制任务 key,标识一个录制任务,对应转推任务发起时指定 RecordKey;
|
|
3106
|
-
如果填写该参数,表示调用者希望立即结束该录制任务。当RecordKey 指定的录制任务正在录制当前转推任务时,录制任务立即结束,否则录制任务不受影响。
|
|
3107
|
-
如果没有填写该参数,但是转推任务发起时填写了 RecordKey,则表示在续录等待时间结束后才结束录制任务,续录等待期间可以使用相同的 RecordKey 发起新的转推任务,和当前转推任务录制到同一文件。
|
|
3108
|
-
*/
|
|
3109
|
-
RecordKey?: string
|
|
3110
|
-
}
|
|
3111
|
-
|
|
3112
|
-
/**
|
|
3113
|
-
* StartAIConversation请求参数结构体
|
|
3114
|
-
*/
|
|
3115
|
-
export interface StartAIConversationRequest {
|
|
3116
|
-
/**
|
|
3117
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
|
|
3118
|
-
*/
|
|
3119
|
-
SdkAppId: number
|
|
3120
|
-
/**
|
|
3121
|
-
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启对话任务的房间号。
|
|
3122
|
-
*/
|
|
3123
|
-
RoomId: string
|
|
3124
|
-
/**
|
|
3125
|
-
* 机器人参数
|
|
3126
|
-
*/
|
|
3127
|
-
AgentConfig: AgentConfig
|
|
3128
|
-
/**
|
|
3129
|
-
* 调用方传入的唯一Id,可用于客户侧防止重复发起任务以及可以通过该字段查询任务状态。
|
|
3130
|
-
*/
|
|
3131
|
-
SessionId?: string
|
|
3132
|
-
/**
|
|
3133
|
-
* TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。
|
|
3134
|
-
*/
|
|
3135
|
-
RoomIdType?: number
|
|
3136
|
-
/**
|
|
3137
|
-
* 语音识别配置。
|
|
3138
|
-
*/
|
|
3139
|
-
STTConfig?: STTConfig
|
|
3140
|
-
/**
|
|
3141
|
-
* LLM配置。需符合openai规范,为JSON字符串,示例如下:
|
|
3142
|
-
<pre> { <br>   "LLMType": “大模型类型", // String 必填,如:"openai" <br>   "Model": "您的模型名称", // String 必填,指定使用的模型<br> "APIKey": "您的LLM API密钥", // String 必填 <br>   "APIUrl": "https://api.xxx.com/chat/completions", // String 必填,LLM API访问的URL<br>   "Streaming": true // Boolean 非必填,指定是否使用流式传输<br>  } </pre>
|
|
3143
|
-
|
|
3144
|
-
*/
|
|
3145
|
-
LLMConfig?: string
|
|
3146
|
-
/**
|
|
3147
|
-
* TTS配置,为JSON字符串,腾讯云TTS示例如下:
|
|
3148
|
-
<pre>{ <br>   "AppId": 您的应用ID, // Integer 必填<br>   "TTSType": "TTS类型", // String TTS类型, 固定为"tencent"<br>   "SecretId": "您的密钥ID", // String 必填<br>   "SecretKey": "您的密钥Key", // String 必填<br>   "VoiceType": 101001, // Integer 必填,音色 ID,包括标准音色与精品音色,精品音色拟真度更高,价格不同于标准音色,请参见<a href="https://cloud.tencent.com/document/product/1073/34112">语音合成计费概述</a>。完整的音色 ID 列表请参见<a href="https://cloud.tencent.com/document/product/1073/92668#55924b56-1a73-4663-a7a1-a8dd82d6e823">语音合成音色列表</a>。<br>   "Speed": 1.25, // Integer 非必填,语速,范围:[-2,6],分别对应不同语速: -2: 代表0.6倍 -1: 代表0.8倍 0: 代表1.0倍(默认) 1: 代表1.2倍 2: 代表1.5倍 6: 代表2.5倍 如果需要更细化的语速,可以保留小数点后 2 位,例如0.5/1.25/2.81等。 参数值与实际语速转换,可参考 <a href="https://sdk-1300466766.cos.ap-shanghai.myqcloud.com/sample/speed_sample.tar.gz">语速转换</a><br>   "Volume": 5, // Integer 非必填,音量大小,范围:[0,10],分别对应11个等级的音量,默认值为0,代表正常音量。<br>  }</pre>
|
|
3149
|
-
*/
|
|
3150
|
-
TTSConfig?: string
|
|
3151
|
-
/**
|
|
3152
|
-
* 数字人配置,为JSON字符串。**数字人配置需要提工单加白后才能使用**
|
|
3153
|
-
*/
|
|
3154
|
-
AvatarConfig?: string
|
|
3155
|
-
}
|
|
3156
|
-
|
|
3157
|
-
/**
|
|
3158
|
-
* DeletePicture返回参数结构体
|
|
3159
|
-
*/
|
|
3160
|
-
export interface DeletePictureResponse {
|
|
3161
|
-
/**
|
|
3162
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3163
|
-
*/
|
|
3164
|
-
RequestId?: string
|
|
3165
|
-
}
|
|
3166
|
-
|
|
3167
|
-
/**
|
|
3168
|
-
* ModifyCloudRecording请求参数结构体
|
|
3169
|
-
*/
|
|
3170
|
-
export interface ModifyCloudRecordingRequest {
|
|
3171
|
-
/**
|
|
3172
|
-
* TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
|
|
3173
|
-
*/
|
|
3174
|
-
SdkAppId: number
|
|
3175
|
-
/**
|
|
3176
|
-
* 录制任务的唯一Id,在启动录制成功后会返回。
|
|
3177
|
-
*/
|
|
3178
|
-
TaskId: string
|
|
3179
|
-
/**
|
|
3180
|
-
* 需要更新的混流的布局参数。
|
|
3181
|
-
*/
|
|
3182
|
-
MixLayoutParams?: MixLayoutParams
|
|
3183
|
-
/**
|
|
3184
|
-
* 指定订阅流白名单或者黑名单。
|
|
3185
|
-
*/
|
|
3186
|
-
SubscribeStreamUserIds?: SubscribeStreamUserIds
|
|
3187
|
-
}
|
|
3188
|
-
|
|
3189
|
-
/**
|
|
3190
|
-
* StopAIConversation返回参数结构体
|
|
3191
|
-
*/
|
|
3192
|
-
export interface StopAIConversationResponse {
|
|
3193
|
-
/**
|
|
3194
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3195
|
-
*/
|
|
3196
|
-
RequestId?: string
|
|
3197
|
-
}
|
|
3198
|
-
|
|
3199
|
-
/**
|
|
3200
|
-
* StartPublishCdnStream请求参数结构体
|
|
3201
|
-
*/
|
|
3202
|
-
export interface StartPublishCdnStreamRequest {
|
|
3203
|
-
/**
|
|
3204
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
|
|
3205
|
-
*/
|
|
3206
|
-
SdkAppId: number
|
|
3207
|
-
/**
|
|
3208
|
-
* 主房间信息RoomId,转推的TRTC房间所对应的RoomId。
|
|
3209
|
-
*/
|
|
3210
|
-
RoomId: string
|
|
3211
|
-
/**
|
|
3212
|
-
* 主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整型房间号,1为字符串房间号。
|
|
3213
|
-
*/
|
|
3214
|
-
RoomIdType: number
|
|
3215
|
-
/**
|
|
3216
|
-
* 转推服务加入TRTC房间的机器人参数。
|
|
3217
|
-
*/
|
|
3218
|
-
AgentParams: AgentParams
|
|
3219
|
-
/**
|
|
3220
|
-
* 是否转码,0表示无需转码,1表示需要转码。是否收取转码费是由WithTranscoding参数决定的,WithTranscoding为0,表示旁路转推,不会收取转码费用,WithTranscoding为1,表示混流转推,会收取转码费用。
|
|
3221
|
-
注:混流是必须转码,这个参数需设置为1。
|
|
3222
|
-
*/
|
|
3223
|
-
WithTranscoding: number
|
|
3224
|
-
/**
|
|
3225
|
-
* 转推流的音频编码参数。由于音频是必转码的(不会收取转码费用),所以启动任务的时候,必须填写。
|
|
3226
|
-
*/
|
|
3227
|
-
AudioParams?: McuAudioParams
|
|
3228
|
-
/**
|
|
3229
|
-
* 转推流的视频编码参数,不填表示纯音频转推。
|
|
3230
|
-
*/
|
|
3231
|
-
VideoParams?: McuVideoParams
|
|
3232
|
-
/**
|
|
3233
|
-
* 需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。
|
|
3234
|
-
*/
|
|
3235
|
-
SingleSubscribeParams?: SingleSubscribeParams
|
|
3236
|
-
/**
|
|
3237
|
-
* 转推的CDN参数,一个任务最多支持10个推流URL。和回推房间参数必须要有一个。
|
|
3238
|
-
*/
|
|
3239
|
-
PublishCdnParams?: Array<McuPublishCdnParam>
|
|
3240
|
-
/**
|
|
3241
|
-
* 混流SEI参数
|
|
3242
|
-
*/
|
|
3243
|
-
SeiParams?: McuSeiParams
|
|
3244
|
-
/**
|
|
3245
|
-
* 回推房间信息,一个任务最多支持回推10个房间,和转推CDN参数必须要有一个。注:回推房间需使用10.4及以上SDK版本,如您有需求,请联系腾讯云技术支持。
|
|
3246
|
-
*/
|
|
3247
|
-
FeedBackRoomParams?: Array<McuFeedBackRoomParams>
|
|
3248
|
-
/**
|
|
3249
|
-
* 转推录制参数,[参考文档](https://cloud.tencent.com/document/product/647/111748)。
|
|
3250
|
-
*/
|
|
3251
|
-
RecordParams?: McuRecordParams
|
|
3252
|
-
}
|
|
3253
|
-
|
|
3254
|
-
/**
|
|
3255
|
-
* DescribeAIConversation请求参数结构体
|
|
3256
|
-
*/
|
|
3257
|
-
export interface DescribeAIConversationRequest {
|
|
3258
|
-
/**
|
|
3259
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
|
|
3260
|
-
*/
|
|
3261
|
-
SdkAppId?: number
|
|
3262
|
-
/**
|
|
3263
|
-
* 唯一标识一次任务。
|
|
3264
|
-
*/
|
|
3265
|
-
TaskId?: string
|
|
3266
|
-
/**
|
|
3267
|
-
* 开启任务时填写的SessionId,如果没写则不返回。
|
|
3268
|
-
*/
|
|
3269
|
-
SessionId?: string
|
|
3270
|
-
}
|
|
3271
|
-
|
|
3272
|
-
/**
|
|
3273
|
-
* SeriesInfo类型的二维数组
|
|
3274
|
-
*/
|
|
3275
|
-
export interface RowValues {
|
|
3276
|
-
/**
|
|
3277
|
-
* 数据值
|
|
3278
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3279
|
-
*/
|
|
3280
|
-
RowValue?: Array<number | bigint>
|
|
3281
|
-
}
|
|
3282
|
-
|
|
3283
|
-
/**
|
|
3284
|
-
* 腾讯云对象存储COS以及第三方云存储的账号信息
|
|
3285
|
-
*/
|
|
3286
|
-
export interface CloudAuditStorage {
|
|
3287
|
-
/**
|
|
3288
|
-
* 腾讯云对象存储COS以及第三方云存储账号信息
|
|
3289
|
-
0:腾讯云对象存储 COS
|
|
3290
|
-
1:AWS
|
|
3291
|
-
【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中
|
|
3292
|
-
示例值:0
|
|
3293
|
-
*/
|
|
3294
|
-
Vendor: number
|
|
3295
|
-
/**
|
|
3296
|
-
* 腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。
|
|
3297
|
-
示例值:cn-shanghai-1
|
|
3298
|
-
|
|
3299
|
-
AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions)
|
|
3300
|
-
示例值:ap-southeast-3
|
|
3301
|
-
*/
|
|
3302
|
-
Region: string
|
|
3303
|
-
/**
|
|
3304
|
-
* 云存储桶名称。
|
|
3305
|
-
*/
|
|
3306
|
-
Bucket: string
|
|
3307
|
-
/**
|
|
3308
|
-
* 云存储的access_key账号信息。
|
|
3309
|
-
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。
|
|
3310
|
-
示例值:test-accesskey
|
|
3311
|
-
*/
|
|
3312
|
-
AccessKey: string
|
|
3313
|
-
/**
|
|
3314
|
-
* 云存储的secret_key账号信息。
|
|
3315
|
-
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。
|
|
3316
|
-
示例值:test-secretkey
|
|
3317
|
-
*/
|
|
3318
|
-
SecretKey: string
|
|
3319
|
-
/**
|
|
3320
|
-
* 云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
|
|
3321
|
-
示例值:["prefix1", "prefix2"]
|
|
3322
|
-
*/
|
|
3323
|
-
FileNamePrefix?: Array<string>
|
|
3324
|
-
}
|
|
3325
|
-
|
|
3326
|
-
/**
|
|
3327
|
-
* CreateCloudRecording返回参数结构体
|
|
3328
|
-
*/
|
|
3329
|
-
export interface CreateCloudRecordingResponse {
|
|
3330
|
-
/**
|
|
3331
|
-
* 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。
|
|
3332
|
-
*/
|
|
3333
|
-
TaskId?: string
|
|
3334
|
-
/**
|
|
3335
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3336
|
-
*/
|
|
3337
|
-
RequestId?: string
|
|
3338
|
-
}
|
|
3339
|
-
|
|
3340
|
-
/**
|
|
3341
|
-
* StartStreamIngest返回参数结构体
|
|
3342
|
-
*/
|
|
3343
|
-
export interface StartStreamIngestResponse {
|
|
3344
|
-
/**
|
|
3345
|
-
* 输入在线媒体流的任务 ID。任务 ID 是对一次输入在线媒体流生命周期过程的唯一标识,结束任务时会失去意义。任务 ID 需要业务保存下来,作为下次针对这个任务操作的参数。
|
|
3346
|
-
*/
|
|
3347
|
-
TaskId?: string
|
|
3348
|
-
/**
|
|
3349
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3350
|
-
*/
|
|
3351
|
-
RequestId?: string
|
|
3352
|
-
}
|
|
3353
|
-
|
|
3354
|
-
/**
|
|
3355
|
-
* StartMCUMixTranscode返回参数结构体
|
|
3356
|
-
*/
|
|
3357
|
-
export interface StartMCUMixTranscodeResponse {
|
|
3358
|
-
/**
|
|
3359
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3360
|
-
*/
|
|
3361
|
-
RequestId?: string
|
|
3362
|
-
}
|
|
3363
|
-
|
|
3364
|
-
/**
|
|
3365
|
-
* DescribeTrtcMcuTranscodeTime返回参数结构体
|
|
3366
|
-
*/
|
|
3367
|
-
export interface DescribeTrtcMcuTranscodeTimeResponse {
|
|
3368
|
-
/**
|
|
3369
|
-
* 应用的用量信息数组。
|
|
3370
|
-
*/
|
|
3371
|
-
Usages?: Array<OneSdkAppIdTranscodeTimeUsagesInfo>
|
|
3372
|
-
/**
|
|
3373
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3374
|
-
*/
|
|
3375
|
-
RequestId?: string
|
|
3376
|
-
}
|
|
3377
|
-
|
|
3378
|
-
/**
|
|
3379
|
-
* DeleteCloudRecording请求参数结构体
|
|
3380
|
-
*/
|
|
3381
|
-
export interface DeleteCloudRecordingRequest {
|
|
3382
|
-
/**
|
|
3383
|
-
* TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
|
|
3384
|
-
*/
|
|
3385
|
-
SdkAppId: number
|
|
3386
|
-
/**
|
|
3387
|
-
* 录制任务的唯一Id,在启动录制成功后会返回。
|
|
3388
|
-
*/
|
|
3389
|
-
TaskId: string
|
|
3390
|
-
}
|
|
3391
|
-
|
|
3392
|
-
/**
|
|
3393
|
-
* DescribePicture请求参数结构体
|
|
3394
|
-
*/
|
|
3395
|
-
export interface DescribePictureRequest {
|
|
3396
|
-
/**
|
|
3397
|
-
* 应用ID
|
|
3398
|
-
*/
|
|
3399
|
-
SdkAppId: number
|
|
3400
|
-
/**
|
|
3401
|
-
* 图片ID,不填时返回该应用下所有图片
|
|
3402
|
-
*/
|
|
3403
|
-
PictureId?: number
|
|
3404
|
-
/**
|
|
3405
|
-
* 每页数量,不填时默认为10
|
|
3406
|
-
*/
|
|
3407
|
-
PageSize?: number
|
|
3408
|
-
/**
|
|
3409
|
-
* 页码,不填时默认为1
|
|
3410
|
-
*/
|
|
3411
|
-
PageNo?: number
|
|
3412
|
-
}
|
|
3413
|
-
|
|
3414
|
-
/**
|
|
3415
|
-
* TRTC数据大盘/实时监控 API接口数据出参
|
|
3416
|
-
*/
|
|
3417
|
-
export interface TRTCDataResp {
|
|
3418
|
-
/**
|
|
3419
|
-
* StatementID值,监控仪表盘下固定为0。
|
|
3420
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3421
|
-
*/
|
|
3422
|
-
StatementID: number
|
|
3423
|
-
/**
|
|
3424
|
-
* 查询结果数据,以Columns-Values形式返回。
|
|
3425
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3426
|
-
*/
|
|
3427
|
-
Series: Array<SeriesInfo>
|
|
3428
|
-
/**
|
|
3429
|
-
* Total值,监控仪表盘功能下固定为1。
|
|
3430
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3431
|
-
*/
|
|
3432
|
-
Total: number
|
|
3433
|
-
}
|
|
3434
|
-
|
|
3435
|
-
/**
|
|
3436
|
-
* 录制视频转码参数。
|
|
3437
|
-
*/
|
|
3438
|
-
export interface VideoParams {
|
|
3439
|
-
/**
|
|
3440
|
-
* 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
|
|
3441
|
-
*/
|
|
3442
|
-
Width: number
|
|
3443
|
-
/**
|
|
3444
|
-
* 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
|
|
3445
|
-
*/
|
|
3446
|
-
Height: number
|
|
3447
|
-
/**
|
|
3448
|
-
* 视频的帧率,范围[1, 60],默认15。
|
|
3449
|
-
*/
|
|
3450
|
-
Fps: number
|
|
3451
|
-
/**
|
|
3452
|
-
* 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
|
|
3453
|
-
*/
|
|
3454
|
-
BitRate: number
|
|
3455
|
-
/**
|
|
3456
|
-
* 视频关键帧时间间隔,单位秒,默认值10秒。
|
|
3457
|
-
*/
|
|
3458
|
-
Gop: number
|
|
3459
|
-
}
|
|
3460
|
-
|
|
3461
|
-
/**
|
|
3462
|
-
* DescribePicture返回参数结构体
|
|
3463
|
-
*/
|
|
3464
|
-
export interface DescribePictureResponse {
|
|
3465
|
-
/**
|
|
3466
|
-
* 返回的图片记录数
|
|
3467
|
-
*/
|
|
3468
|
-
Total?: number
|
|
3469
|
-
/**
|
|
3470
|
-
* 图片信息列表
|
|
3471
|
-
*/
|
|
3472
|
-
PictureInfo?: Array<PictureInfo>
|
|
3473
|
-
/**
|
|
3474
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3475
|
-
*/
|
|
3476
|
-
RequestId?: string
|
|
3477
|
-
}
|
|
3478
|
-
|
|
3479
|
-
/**
|
|
3480
|
-
* DescribeTrtcRoomUsage请求参数结构体
|
|
3481
|
-
*/
|
|
3482
|
-
export interface DescribeTrtcRoomUsageRequest {
|
|
3483
|
-
/**
|
|
3484
|
-
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。
|
|
3485
|
-
*/
|
|
3486
|
-
SdkAppid: number
|
|
3487
|
-
/**
|
|
3488
|
-
* 查询开始时间,格式为YYYY-MM-DD HH:MM,精确到分钟级。
|
|
3489
|
-
*/
|
|
3490
|
-
StartTime: string
|
|
3491
|
-
/**
|
|
3492
|
-
* 查询结束时间,格式为YYYY-MM-DD HH:MM,单次查询不超过24h。
|
|
3493
|
-
*/
|
|
3494
|
-
EndTime: string
|
|
3495
|
-
}
|
|
3496
|
-
|
|
3497
|
-
/**
|
|
3498
|
-
* DescribeTrtcMcuTranscodeTime请求参数结构体
|
|
3499
|
-
*/
|
|
3500
|
-
export interface DescribeTrtcMcuTranscodeTimeRequest {
|
|
3501
|
-
/**
|
|
3502
|
-
* 查询开始时间,格式为YYYY-MM-DD。
|
|
3503
|
-
*/
|
|
3504
|
-
StartTime: string
|
|
3505
|
-
/**
|
|
3506
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
3507
|
-
单次查询统计区间最多不能超过31天。
|
|
3508
|
-
*/
|
|
3509
|
-
EndTime: string
|
|
3510
|
-
/**
|
|
3511
|
-
* 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。
|
|
3512
|
-
*/
|
|
3513
|
-
SdkAppId?: number
|
|
3514
|
-
}
|
|
3515
|
-
|
|
3516
|
-
/**
|
|
3517
|
-
* 用户信息,包括用户进房时间,退房时间等
|
|
3518
|
-
*/
|
|
3519
|
-
export interface UserInformation {
|
|
3520
|
-
/**
|
|
3521
|
-
* 房间号
|
|
3522
|
-
*/
|
|
3523
|
-
RoomStr?: string
|
|
3524
|
-
/**
|
|
3525
|
-
* 用户Id
|
|
3526
|
-
*/
|
|
3527
|
-
UserId?: string
|
|
3528
|
-
/**
|
|
3529
|
-
* 用户进房时间
|
|
3530
|
-
*/
|
|
3531
|
-
JoinTs?: number
|
|
3532
|
-
/**
|
|
3533
|
-
* 用户退房时间,用户没有退房则返回当前时间
|
|
3534
|
-
*/
|
|
3535
|
-
LeaveTs?: number
|
|
3536
|
-
/**
|
|
3537
|
-
* 终端类型
|
|
3538
|
-
*/
|
|
3539
|
-
DeviceType?: string
|
|
3540
|
-
/**
|
|
3541
|
-
* Sdk版本号
|
|
3542
|
-
*/
|
|
3543
|
-
SdkVersion?: string
|
|
3544
|
-
/**
|
|
3545
|
-
* 客户端IP地址
|
|
3546
|
-
*/
|
|
3547
|
-
ClientIp?: string
|
|
3548
|
-
/**
|
|
3549
|
-
* 判断用户是否已经离开房间
|
|
3550
|
-
*/
|
|
3551
|
-
Finished?: boolean
|
|
3552
|
-
}
|
|
3553
|
-
|
|
3554
|
-
/**
|
|
3555
|
-
* DescribeScaleInfo请求参数结构体
|
|
3556
|
-
*/
|
|
3557
|
-
export interface DescribeScaleInfoRequest {
|
|
3558
|
-
/**
|
|
3559
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
3560
|
-
*/
|
|
3561
|
-
SdkAppId: number
|
|
3562
|
-
/**
|
|
3563
|
-
* 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
|
|
3564
|
-
注意:支持查询14天内的数据。
|
|
3565
|
-
*/
|
|
3566
|
-
StartTime: number
|
|
3567
|
-
/**
|
|
3568
|
-
* 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
|
|
3569
|
-
注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。
|
|
3570
|
-
*/
|
|
3571
|
-
EndTime: number
|
|
3572
|
-
}
|
|
3573
|
-
|
|
3574
|
-
/**
|
|
3575
|
-
* ControlAIConversation请求参数结构体
|
|
3576
|
-
*/
|
|
3577
|
-
export interface ControlAIConversationRequest {
|
|
3578
|
-
/**
|
|
3579
|
-
* 任务唯一标识
|
|
3580
|
-
*/
|
|
3581
|
-
TaskId: string
|
|
3582
|
-
/**
|
|
3583
|
-
* 控制命令,目前支持命令如下:
|
|
3584
|
-
|
|
3585
|
-
- ServerPushText,服务端发送文本给AI机器人,AI机器人会播报该文本
|
|
3586
|
-
*/
|
|
3587
|
-
Command: string
|
|
3588
|
-
/**
|
|
3589
|
-
* 服务端发送播报文本命令,当Command为ServerPushText时必填
|
|
3590
|
-
*/
|
|
3591
|
-
ServerPushText?: ServerPushText
|
|
3592
|
-
}
|
|
3593
|
-
|
|
3594
|
-
/**
|
|
3595
|
-
* DismissRoomByStrRoomId返回参数结构体
|
|
3596
|
-
*/
|
|
3597
|
-
export interface DismissRoomByStrRoomIdResponse {
|
|
3598
|
-
/**
|
|
3599
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3600
|
-
*/
|
|
3601
|
-
RequestId?: string
|
|
3602
|
-
}
|
|
3603
|
-
|
|
3604
|
-
/**
|
|
3605
|
-
* DescribeUnusualEvent返回参数结构体
|
|
3606
|
-
*/
|
|
3607
|
-
export interface DescribeUnusualEventResponse {
|
|
3608
|
-
/**
|
|
3609
|
-
* 返回的数据总条数
|
|
3610
|
-
范围:[0,20]
|
|
3611
|
-
*/
|
|
3612
|
-
Total: number
|
|
3613
|
-
/**
|
|
3614
|
-
* 异常体验列表
|
|
3615
|
-
*/
|
|
3616
|
-
AbnormalExperienceList: Array<AbnormalExperience>
|
|
3617
|
-
/**
|
|
3618
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3619
|
-
*/
|
|
3620
|
-
RequestId?: string
|
|
3621
|
-
}
|
|
3622
|
-
|
|
3623
|
-
/**
|
|
3624
|
-
* ModifyCloudRecording返回参数结构体
|
|
3625
|
-
*/
|
|
3626
|
-
export interface ModifyCloudRecordingResponse {
|
|
3627
|
-
/**
|
|
3628
|
-
* 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
|
|
3629
|
-
*/
|
|
3630
|
-
TaskId?: string
|
|
3631
|
-
/**
|
|
3632
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3633
|
-
*/
|
|
3634
|
-
RequestId?: string
|
|
3635
|
-
}
|
|
3636
|
-
|
|
3637
|
-
/**
|
|
3638
|
-
* StartMCUMixTranscodeByStrRoomId请求参数结构体
|
|
3639
|
-
*/
|
|
3640
|
-
export interface StartMCUMixTranscodeByStrRoomIdRequest {
|
|
3641
|
-
/**
|
|
3642
|
-
* TRTC的SDKAppId。
|
|
3643
|
-
*/
|
|
3644
|
-
SdkAppId: number
|
|
3645
|
-
/**
|
|
3646
|
-
* 字符串房间号。
|
|
3647
|
-
*/
|
|
3648
|
-
StrRoomId: string
|
|
3649
|
-
/**
|
|
3650
|
-
* 混流输出控制参数。
|
|
3651
|
-
*/
|
|
3652
|
-
OutputParams: OutputParams
|
|
3653
|
-
/**
|
|
3654
|
-
* 混流输出编码参数。
|
|
3655
|
-
*/
|
|
3656
|
-
EncodeParams: EncodeParams
|
|
3657
|
-
/**
|
|
3658
|
-
* 混流输出布局参数。
|
|
3659
|
-
*/
|
|
3660
|
-
LayoutParams: LayoutParams
|
|
3661
|
-
/**
|
|
3662
|
-
* 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推
|
|
3663
|
-
*/
|
|
3664
|
-
PublishCdnParams?: PublishCdnParams
|
|
3665
|
-
}
|
|
3666
|
-
|
|
3667
|
-
/**
|
|
3668
|
-
* DescribeCloudRecording返回参数结构体
|
|
3669
|
-
*/
|
|
3670
|
-
export interface DescribeCloudRecordingResponse {
|
|
3671
|
-
/**
|
|
3672
|
-
* 录制任务的唯一Id。
|
|
3673
|
-
*/
|
|
3674
|
-
TaskId?: string
|
|
3675
|
-
/**
|
|
3676
|
-
* 云端录制任务的状态信息。
|
|
3677
|
-
Idle:表示当前录制任务空闲中
|
|
3678
|
-
InProgress:表示当前录制任务正在进行中。
|
|
3679
|
-
Exited:表示当前录制任务正在退出的过程中。
|
|
3680
|
-
*/
|
|
3681
|
-
Status?: string
|
|
3682
|
-
/**
|
|
3683
|
-
* 录制文件信息。
|
|
3684
|
-
*/
|
|
3685
|
-
StorageFileList?: Array<StorageFile>
|
|
3686
|
-
/**
|
|
3687
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3688
|
-
*/
|
|
3689
|
-
RequestId?: string
|
|
3690
|
-
}
|
|
3691
|
-
|
|
3692
|
-
/**
|
|
3693
|
-
* StartAITranscription请求参数结构体
|
|
3694
|
-
*/
|
|
3695
|
-
export interface StartAITranscriptionRequest {
|
|
3696
|
-
/**
|
|
3697
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
|
|
3698
|
-
*/
|
|
3699
|
-
SdkAppId: number
|
|
3700
|
-
/**
|
|
3701
|
-
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。
|
|
3702
|
-
*/
|
|
3703
|
-
RoomId: string
|
|
3704
|
-
/**
|
|
3705
|
-
* 转录机器人的参数。
|
|
3706
|
-
*/
|
|
3707
|
-
TranscriptionParams: TranscriptionParams
|
|
3708
|
-
/**
|
|
3709
|
-
* 调用方传入的唯一Id,服务端用来去重。
|
|
3710
|
-
注意:
|
|
3711
|
-
如果传入该参数,服务端优先使用该参数来去重。
|
|
3712
|
-
如果不传该参数,服务端的去重策略如下:
|
|
3713
|
-
- 如果TranscriptionMode字段是0,则一个房间只能开启一个任务
|
|
3714
|
-
- 如果TranscriptionMode字段是1,则一个TargetUserId只能开启一个任务
|
|
3715
|
-
*/
|
|
3716
|
-
SessionId?: string
|
|
3717
|
-
/**
|
|
3718
|
-
* TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。
|
|
3719
|
-
*/
|
|
3720
|
-
RoomIdType?: number
|
|
3721
|
-
/**
|
|
3722
|
-
* 语音识别配置。
|
|
3723
|
-
*/
|
|
3724
|
-
RecognizeConfig?: RecognizeConfig
|
|
3725
|
-
}
|
|
3726
|
-
|
|
3727
|
-
/**
|
|
3728
|
-
* StopStreamIngest返回参数结构体
|
|
3729
|
-
*/
|
|
3730
|
-
export interface StopStreamIngestResponse {
|
|
3731
|
-
/**
|
|
3732
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3733
|
-
*/
|
|
3734
|
-
RequestId?: string
|
|
3735
|
-
}
|
|
3736
|
-
|
|
3737
|
-
/**
|
|
3738
|
-
* TRTC用户参数。
|
|
3739
|
-
*/
|
|
3740
|
-
export interface MixUserInfo {
|
|
3741
|
-
/**
|
|
3742
|
-
* 用户ID。
|
|
3743
|
-
*/
|
|
3744
|
-
UserId: string
|
|
3745
|
-
/**
|
|
3746
|
-
* 动态布局时房间信息必须和主房间信息保持一致,自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致,不填时默认与主房间信息一致。
|
|
3747
|
-
*/
|
|
3748
|
-
RoomId?: string
|
|
3749
|
-
/**
|
|
3750
|
-
* 房间号类型,0为整型房间号,1为字符串房间号。
|
|
3751
|
-
*/
|
|
3752
|
-
RoomIdType?: number
|
|
3753
|
-
}
|
|
3754
|
-
|
|
3755
|
-
/**
|
|
3756
|
-
* DismissRoom返回参数结构体
|
|
3757
|
-
*/
|
|
3758
|
-
export interface DismissRoomResponse {
|
|
3759
|
-
/**
|
|
3760
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3761
|
-
*/
|
|
3762
|
-
RequestId?: string
|
|
3763
|
-
}
|
|
3764
|
-
|
|
3765
|
-
/**
|
|
3766
|
-
* DescribeTRTCMarketQualityData请求参数结构体
|
|
3767
|
-
*/
|
|
3768
|
-
export interface DescribeTRTCMarketQualityDataRequest {
|
|
3769
|
-
/**
|
|
3770
|
-
* 用户SdkAppId(如:1400xxxxxx)
|
|
3771
|
-
*/
|
|
3772
|
-
SdkAppId: string
|
|
3773
|
-
/**
|
|
3774
|
-
* 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
|
|
3775
|
-
*/
|
|
3776
|
-
StartTime: string
|
|
3777
|
-
/**
|
|
3778
|
-
* 查询结束时间,格式为YYYY-MM-DD。
|
|
3779
|
-
*/
|
|
3780
|
-
EndTime: string
|
|
3781
|
-
/**
|
|
3782
|
-
* 返回数据的粒度,支持设为以下值:
|
|
3783
|
-
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
|
|
3784
|
-
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
|
|
3785
|
-
*/
|
|
3786
|
-
Period: string
|
|
3787
|
-
}
|
|
3788
|
-
|
|
3789
|
-
/**
|
|
3790
|
-
* UpdatePublishCdnStream请求参数结构体
|
|
3791
|
-
*/
|
|
3792
|
-
export interface UpdatePublishCdnStreamRequest {
|
|
3793
|
-
/**
|
|
3794
|
-
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。
|
|
3795
|
-
*/
|
|
3796
|
-
SdkAppId: number
|
|
3797
|
-
/**
|
|
3798
|
-
* 唯一标识转推任务。
|
|
3799
|
-
*/
|
|
3800
|
-
TaskId: string
|
|
3801
|
-
/**
|
|
3802
|
-
* 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。
|
|
3803
|
-
*/
|
|
3804
|
-
SequenceNumber: number
|
|
3805
|
-
/**
|
|
3806
|
-
* 是否转码,0表示无需转码,1表示需要转码。
|
|
3807
|
-
注:混流是必须转码,这个参数需设置为1。
|
|
3808
|
-
*/
|
|
3809
|
-
WithTranscoding: number
|
|
3810
|
-
/**
|
|
3811
|
-
* 更新相关参数,只支持更新参与混音的主播列表参数,不支持更新Codec、采样率、码率和声道数。不填表示不更新此参数。
|
|
3812
|
-
*/
|
|
3813
|
-
AudioParams?: McuAudioParams
|
|
3814
|
-
/**
|
|
3815
|
-
* 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。
|
|
3816
|
-
*/
|
|
3817
|
-
VideoParams?: McuVideoParams
|
|
3818
|
-
/**
|
|
3819
|
-
* 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。
|
|
3820
|
-
*/
|
|
3821
|
-
SingleSubscribeParams?: SingleSubscribeParams
|
|
3822
|
-
/**
|
|
3823
|
-
* 更新转推的CDN参数。不填表示不更新此参数。
|
|
3824
|
-
*/
|
|
3825
|
-
PublishCdnParams?: Array<McuPublishCdnParam>
|
|
3826
|
-
/**
|
|
3827
|
-
* 混流SEI参数
|
|
3828
|
-
*/
|
|
3829
|
-
SeiParams?: McuSeiParams
|
|
3830
|
-
/**
|
|
3831
|
-
* 回推房间信息
|
|
3832
|
-
*/
|
|
3833
|
-
FeedBackRoomParams?: Array<McuFeedBackRoomParams>
|
|
3834
|
-
}
|
|
3835
|
-
|
|
3836
|
-
/**
|
|
3837
|
-
* StartWebRecord请求参数结构体
|
|
3838
|
-
*/
|
|
3839
|
-
export interface StartWebRecordRequest {
|
|
3840
|
-
/**
|
|
3841
|
-
* 需要录制的网页URL
|
|
3842
|
-
|
|
3843
|
-
*/
|
|
3844
|
-
RecordUrl: string
|
|
3845
|
-
/**
|
|
3846
|
-
* 录制最大时长限制, 单位 s, 合法取值范围[1800, 36000], 默认 36000s(10 小时)
|
|
3847
|
-
|
|
3848
|
-
*/
|
|
3849
|
-
MaxDurationLimit?: number
|
|
3850
|
-
/**
|
|
3851
|
-
* 【必填】云存储相关的参数,目前支持腾讯云对象存储以及腾讯云云点播VOD,不支持第三方云存储;输出文件的存储格式仅支持hls或mp4
|
|
3852
|
-
*/
|
|
3853
|
-
StorageParams?: StorageParams
|
|
3854
|
-
/**
|
|
3855
|
-
* 页面录制视频参数
|
|
3856
|
-
*/
|
|
3857
|
-
WebRecordVideoParams?: WebRecordVideoParams
|
|
3858
|
-
/**
|
|
3859
|
-
* 【必填】TRTC的SdkAppId
|
|
3860
|
-
*/
|
|
3861
|
-
SdkAppId?: number
|
|
3862
|
-
/**
|
|
3863
|
-
* 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复
|
|
3864
|
-
传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。
|
|
3865
|
-
*/
|
|
3866
|
-
RecordId?: string
|
|
3867
|
-
/**
|
|
3868
|
-
* 若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1
|
|
3869
|
-
*/
|
|
3870
|
-
PublishCdnParams?: Array<McuPublishCdnParam>
|
|
3871
|
-
/**
|
|
3872
|
-
* 录制页面资源加载的超时时间,单位:秒。默认值为 0 秒,该值需大于等于 0秒,且小于等于 60秒。录制页面未启用页面加载超时检测时,请勿设置此参数。
|
|
3873
|
-
*/
|
|
3874
|
-
ReadyTimeout?: number
|
|
3875
|
-
/**
|
|
3876
|
-
* 渲染移动模式参数;不准备渲染移动模式页面时,请勿设置此参数。
|
|
3877
|
-
*/
|
|
3878
|
-
EmulateMobileParams?: EmulateMobileParams
|
|
3879
|
-
}
|
|
3880
|
-
|
|
3881
|
-
/**
|
|
3882
|
-
* 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
|
|
3883
|
-
*/
|
|
3884
|
-
export interface MaxVideoUser {
|
|
3885
|
-
/**
|
|
3886
|
-
* 用户媒体流参数。
|
|
3887
|
-
*/
|
|
3888
|
-
UserMediaStream: UserMediaStream
|
|
3889
|
-
}
|
|
3890
|
-
|
|
3891
|
-
/**
|
|
3892
|
-
* 审核存储参数
|
|
3893
|
-
*/
|
|
3894
|
-
export interface AuditStorageParams {
|
|
3895
|
-
/**
|
|
3896
|
-
* 腾讯云对象存储COS以及第三方云存储的账号信息
|
|
3897
|
-
*/
|
|
3898
|
-
CloudAuditStorage?: CloudAuditStorage
|
|
3899
|
-
}
|
|
3900
|
-
|
|
3901
|
-
/**
|
|
3902
|
-
* 转推服务加入TRTC房间的机器人参数。
|
|
3903
|
-
*/
|
|
3904
|
-
export interface AgentParams {
|
|
3905
|
-
/**
|
|
3906
|
-
* 转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
|
|
3907
|
-
*/
|
|
3908
|
-
UserId: string
|
|
3909
|
-
/**
|
|
3910
|
-
* 转推服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
3911
|
-
*/
|
|
3912
|
-
UserSig?: string
|
|
3913
|
-
/**
|
|
3914
|
-
* 所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
|
|
3915
|
-
*/
|
|
3916
|
-
MaxIdleTime?: number
|
|
3917
|
-
}
|
|
3918
|
-
|
|
3919
|
-
/**
|
|
3920
|
-
* UpdateStreamIngest请求参数结构体
|
|
3921
|
-
*/
|
|
3922
|
-
export interface UpdateStreamIngestRequest {
|
|
3923
|
-
/**
|
|
3924
|
-
* TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同
|
|
3925
|
-
*/
|
|
3926
|
-
SdkAppId: number
|
|
3927
|
-
/**
|
|
3928
|
-
* 任务的唯一Id,在启动任务成功后会返回。
|
|
3929
|
-
*/
|
|
3930
|
-
TaskId: string
|
|
3931
|
-
/**
|
|
3932
|
-
* 源流URL。
|
|
3933
|
-
*/
|
|
3934
|
-
StreamUrl?: string
|
|
3935
|
-
/**
|
|
3936
|
-
* 音量,取值范围[0, 100],默认100,表示原音量。
|
|
3937
|
-
*/
|
|
3938
|
-
Volume?: number
|
|
3939
|
-
/**
|
|
3940
|
-
* 是否暂停,默认false表示不暂停。暂停期间任务仍在进行中仍会计费,如果要销毁任务请调用停止接口。
|
|
3941
|
-
*/
|
|
3942
|
-
IsPause?: boolean
|
|
3943
|
-
}
|
|
3944
|
-
|
|
3945
|
-
/**
|
|
3946
|
-
* StopWebRecord返回参数结构体
|
|
3947
|
-
*/
|
|
3948
|
-
export interface StopWebRecordResponse {
|
|
3949
|
-
/**
|
|
3950
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3951
|
-
*/
|
|
3952
|
-
RequestId?: string
|
|
3953
|
-
}
|
|
3954
|
-
|
|
3955
|
-
/**
|
|
3956
|
-
* DeletePicture请求参数结构体
|
|
3957
|
-
*/
|
|
3958
|
-
export interface DeletePictureRequest {
|
|
3959
|
-
/**
|
|
3960
|
-
* 图片id
|
|
3961
|
-
*/
|
|
3962
|
-
PictureId: number
|
|
3963
|
-
/**
|
|
3964
|
-
* 应用id
|
|
3965
|
-
*/
|
|
3966
|
-
SdkAppId: number
|
|
3967
|
-
}
|
|
3968
|
-
|
|
3969
|
-
/**
|
|
3970
|
-
* StopWebRecord请求参数结构体
|
|
3971
|
-
*/
|
|
3972
|
-
export interface StopWebRecordRequest {
|
|
3973
|
-
/**
|
|
3974
|
-
* 需要停止的任务Id
|
|
3975
|
-
*/
|
|
3976
|
-
TaskId: string
|
|
3977
|
-
}
|
|
3978
|
-
|
|
3979
|
-
/**
|
|
3980
|
-
* 混流SEI参数
|
|
3981
|
-
*/
|
|
3982
|
-
export interface McuSeiParams {
|
|
3983
|
-
/**
|
|
3984
|
-
* 音量布局SEI
|
|
3985
|
-
*/
|
|
3986
|
-
LayoutVolume?: McuLayoutVolume
|
|
3987
|
-
/**
|
|
3988
|
-
* 透传SEI
|
|
3989
|
-
*/
|
|
3990
|
-
PassThrough?: McuPassThrough
|
|
3991
|
-
}
|
|
3992
|
-
|
|
3993
|
-
/**
|
|
3994
|
-
* StopAIConversation请求参数结构体
|
|
3995
|
-
*/
|
|
3996
|
-
export interface StopAIConversationRequest {
|
|
3997
|
-
/**
|
|
3998
|
-
* 唯一标识任务。
|
|
3999
|
-
*/
|
|
4000
|
-
TaskId: string
|
|
4001
|
-
}
|
|
4002
|
-
|
|
4003
|
-
/**
|
|
4004
|
-
* 事件信息,包括,事件时间戳,事件ID,
|
|
4005
|
-
*/
|
|
4006
|
-
export interface EventMessage {
|
|
4007
|
-
/**
|
|
4008
|
-
* 视频流类型:
|
|
4009
|
-
0:与视频无关的事件;
|
|
4010
|
-
2:视频为大画面;
|
|
4011
|
-
3:视频为小画面;
|
|
4012
|
-
7:视频为旁路画面;
|
|
4013
|
-
*/
|
|
4014
|
-
Type?: number
|
|
4015
|
-
/**
|
|
4016
|
-
* 事件上报的时间戳,unix时间(1589891188801ms)
|
|
4017
|
-
*/
|
|
4018
|
-
Time?: number
|
|
4019
|
-
/**
|
|
4020
|
-
* 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
|
|
4021
|
-
*/
|
|
4022
|
-
EventId?: number
|
|
4023
|
-
/**
|
|
4024
|
-
* 事件的第一个参数,如视频分辨率宽
|
|
4025
|
-
*/
|
|
4026
|
-
ParamOne?: number
|
|
4027
|
-
/**
|
|
4028
|
-
* 事件的第二个参数,如视频分辨率高
|
|
4029
|
-
*/
|
|
4030
|
-
ParamTwo?: number
|
|
4031
|
-
}
|
|
4032
|
-
|
|
4033
|
-
/**
|
|
4034
|
-
* UpdatePublishCdnStream返回参数结构体
|
|
4035
|
-
*/
|
|
4036
|
-
export interface UpdatePublishCdnStreamResponse {
|
|
4037
|
-
/**
|
|
4038
|
-
* 转推任务唯一的String Id
|
|
4039
|
-
*/
|
|
4040
|
-
TaskId?: string
|
|
4041
|
-
/**
|
|
4042
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4043
|
-
*/
|
|
4044
|
-
RequestId?: string
|
|
4045
|
-
}
|
|
4046
|
-
|
|
4047
|
-
/**
|
|
4048
|
-
* 文字水印参数。
|
|
4049
|
-
*/
|
|
4050
|
-
export interface McuWaterMarkText {
|
|
4051
|
-
/**
|
|
4052
|
-
* 文字水印内容。
|
|
4053
|
-
*/
|
|
4054
|
-
Text: string
|
|
4055
|
-
/**
|
|
4056
|
-
* 水印在输出时的宽。单位为像素值。
|
|
4057
|
-
*/
|
|
4058
|
-
WaterMarkWidth: number
|
|
4059
|
-
/**
|
|
4060
|
-
* 水印在输出时的高。单位为像素值。
|
|
4061
|
-
*/
|
|
4062
|
-
WaterMarkHeight: number
|
|
4063
|
-
/**
|
|
4064
|
-
* 水印在输出时的X偏移。单位为像素值。
|
|
4065
|
-
*/
|
|
4066
|
-
LocationX: number
|
|
4067
|
-
/**
|
|
4068
|
-
* 水印在输出时的Y偏移。单位为像素值。
|
|
4069
|
-
*/
|
|
4070
|
-
LocationY: number
|
|
4071
|
-
/**
|
|
4072
|
-
* 字体大小
|
|
4073
|
-
*/
|
|
4074
|
-
FontSize: number
|
|
4075
|
-
/**
|
|
4076
|
-
* 字体颜色,默认为白色。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。
|
|
4077
|
-
*/
|
|
4078
|
-
FontColor?: string
|
|
4079
|
-
/**
|
|
4080
|
-
* 字体背景色,不配置默认为透明。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。
|
|
4081
|
-
*/
|
|
4082
|
-
BackGroundColor?: string
|
|
4083
|
-
/**
|
|
4084
|
-
* 动态水印类型,默认为0。0:关闭;1:随机位置,每秒变动一次;2:边界扫描反弹,每帧变动一次。
|
|
4085
|
-
*/
|
|
4086
|
-
DynamicPosType?: number
|
|
4087
|
-
/**
|
|
4088
|
-
* 水印在输出时的层级,不填默认为0。
|
|
4089
|
-
*/
|
|
4090
|
-
ZOrder?: number
|
|
4091
|
-
/**
|
|
4092
|
-
* 水印字体,不填默认为Tencent。支持设置以下值: Tencent (默认) SourceHanSans
|
|
4093
|
-
*/
|
|
4094
|
-
Font?: string
|
|
4095
|
-
}
|
|
4096
|
-
|
|
4097
|
-
/**
|
|
4098
|
-
* AI转录参数
|
|
4099
|
-
*/
|
|
4100
|
-
export interface TranscriptionParams {
|
|
4101
|
-
/**
|
|
4102
|
-
* 转录机器人的UserId,用于进房发起转录任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个转录任务时,机器人的userid也不能相互重复,否则会中断前一个任务。需要保证转录机器人UserId在房间内唯一。
|
|
4103
|
-
*/
|
|
4104
|
-
UserId: string
|
|
4105
|
-
/**
|
|
4106
|
-
* 转录机器人UserId对应的校验签名,即UserId和UserSig相当于转录机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
4107
|
-
*/
|
|
4108
|
-
UserSig: string
|
|
4109
|
-
/**
|
|
4110
|
-
* IM[管理员账户](
|
|
4111
|
-
https://cloud.tencent.com/document/product/269/31999#app-.E7.AE.A1.E7.90.86.E5.91.98),如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。
|
|
4112
|
-
* @deprecated
|
|
4113
|
-
*/
|
|
4114
|
-
IMAdminUserId?: string
|
|
4115
|
-
/**
|
|
4116
|
-
* IM管理员账户生成的签名,用于向特定群组发送消息。如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。必须和IM管理员的UserId一起填写。
|
|
4117
|
-
* @deprecated
|
|
4118
|
-
*/
|
|
4119
|
-
IMAdminUserSig?: string
|
|
4120
|
-
/**
|
|
4121
|
-
* 房间内推流用户全部退出后超过MaxIdleTime秒,后台自动关闭转录任务,默认值是60s。
|
|
4122
|
-
*/
|
|
4123
|
-
MaxIdleTime?: number
|
|
4124
|
-
/**
|
|
4125
|
-
* 1表示机器人只订阅单个人的流,0表示机器人订阅整个房间的流,如果不填默认订阅整个房间的流。
|
|
4126
|
-
*/
|
|
4127
|
-
TranscriptionMode?: number
|
|
4128
|
-
/**
|
|
4129
|
-
* TranscriptionMode为1时必填,机器人只会拉该userid的流,忽略房间里其他用户。
|
|
4130
|
-
*/
|
|
4131
|
-
TargetUserId?: string
|
|
4132
|
-
/**
|
|
4133
|
-
* 机器人订阅的用户列表
|
|
4134
|
-
仅 TranscriptionMode 为 1或者 TranscriptionMode 为无限上麦模式支持传入多个用户列表
|
|
4135
|
-
*/
|
|
4136
|
-
TargetUserIdList?: Array<string>
|
|
4137
|
-
}
|
|
4138
|
-
|
|
4139
|
-
/**
|
|
4140
|
-
* SeriesInfos类型
|
|
4141
|
-
*/
|
|
4142
|
-
export interface SeriesInfos {
|
|
4143
|
-
/**
|
|
4144
|
-
* 数据列
|
|
4145
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4146
|
-
*/
|
|
4147
|
-
Columns?: Array<string>
|
|
4148
|
-
/**
|
|
4149
|
-
* 数据值
|
|
4150
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4151
|
-
*/
|
|
4152
|
-
Values?: Array<RowValues>
|
|
4153
|
-
}
|
|
4154
|
-
|
|
4155
|
-
/**
|
|
4156
|
-
* RemoveUserByStrRoomId请求参数结构体
|
|
4157
|
-
*/
|
|
4158
|
-
export interface RemoveUserByStrRoomIdRequest {
|
|
4159
|
-
/**
|
|
4160
|
-
* TRTC的SDKAppId。
|
|
4161
|
-
*/
|
|
4162
|
-
SdkAppId: number
|
|
4163
|
-
/**
|
|
4164
|
-
* 房间号。
|
|
4165
|
-
*/
|
|
4166
|
-
RoomId: string
|
|
4167
|
-
/**
|
|
4168
|
-
* 要移出的用户列表,最多10个。
|
|
4169
|
-
*/
|
|
4170
|
-
UserIds: Array<string>
|
|
4171
|
-
}
|
|
4172
|
-
|
|
4173
|
-
/**
|
|
4174
|
-
* DeleteBasicModeration返回参数结构体
|
|
4175
|
-
*/
|
|
4176
|
-
export interface DeleteBasicModerationResponse {
|
|
4177
|
-
/**
|
|
4178
|
-
* 审核任务的唯一Id。
|
|
4179
|
-
*/
|
|
4180
|
-
TaskId?: string
|
|
4181
|
-
/**
|
|
4182
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4183
|
-
*/
|
|
4184
|
-
RequestId?: string
|
|
4185
|
-
}
|
|
4186
|
-
|
|
4187
|
-
/**
|
|
4188
|
-
* DescribeStreamIngest请求参数结构体
|
|
4189
|
-
*/
|
|
4190
|
-
export interface DescribeStreamIngestRequest {
|
|
4191
|
-
/**
|
|
4192
|
-
* TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同
|
|
4193
|
-
*/
|
|
4194
|
-
SdkAppId: number
|
|
4195
|
-
/**
|
|
4196
|
-
* 任务的唯一Id,在启动任务成功后会返回。
|
|
4197
|
-
*/
|
|
4198
|
-
TaskId: string
|
|
4199
|
-
}
|
|
4200
|
-
|
|
4201
|
-
/**
|
|
4202
|
-
* 旁路转码时长的查询结果
|
|
4203
|
-
*/
|
|
4204
|
-
export interface OneSdkAppIdTranscodeTimeUsagesInfo {
|
|
4205
|
-
/**
|
|
4206
|
-
* 旁路转码时长查询结果数组
|
|
4207
|
-
*/
|
|
4208
|
-
SdkAppIdTranscodeTimeUsages?: Array<SdkAppIdTrtcMcuTranscodeTimeUsage>
|
|
4209
|
-
/**
|
|
4210
|
-
* 查询记录数量
|
|
4211
|
-
*/
|
|
4212
|
-
TotalNum?: number
|
|
4213
|
-
/**
|
|
4214
|
-
* 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
|
|
4215
|
-
*/
|
|
4216
|
-
SdkAppId?: string
|
|
4217
|
-
}
|
|
4218
|
-
|
|
4219
|
-
/**
|
|
4220
|
-
* DescribeTRTCMarketScaleMetricData返回参数结构体
|
|
4221
|
-
*/
|
|
4222
|
-
export interface DescribeTRTCMarketScaleMetricDataResponse {
|
|
4223
|
-
/**
|
|
4224
|
-
* TRTC监控数据出参
|
|
4225
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4226
|
-
*/
|
|
4227
|
-
Data: TRTCDataResp
|
|
4228
|
-
/**
|
|
4229
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4230
|
-
*/
|
|
4231
|
-
RequestId?: string
|
|
4232
|
-
}
|
|
4233
|
-
|
|
4234
|
-
/**
|
|
4235
|
-
* 混流转推的音频相关参数。
|
|
4236
|
-
*/
|
|
4237
|
-
export interface McuAudioParams {
|
|
4238
|
-
/**
|
|
4239
|
-
* 音频编码参数。
|
|
4240
|
-
*/
|
|
4241
|
-
AudioEncode?: AudioEncode
|
|
4242
|
-
/**
|
|
4243
|
-
* 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。
|
|
4244
|
-
使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。
|
|
4245
|
-
*/
|
|
4246
|
-
SubscribeAudioList?: Array<McuUserInfoParams>
|
|
4247
|
-
/**
|
|
4248
|
-
* 音频用户黑名单,为空或不填表示无黑名单,填具体值表示不混指定主播音频。update时,不填表示不更新,为空表示更新为清空黑名单,填具体值表示更新为不混指定主播音频。
|
|
4249
|
-
使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。
|
|
4250
|
-
*/
|
|
4251
|
-
UnSubscribeAudioList?: Array<McuUserInfoParams>
|
|
4252
|
-
}
|
|
4253
|
-
|
|
4254
|
-
/**
|
|
4255
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
4256
|
-
*/
|
|
4257
|
-
export interface PresetLayoutConfig {
|
|
4258
|
-
/**
|
|
4259
|
-
* 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
|
|
4260
|
-
*/
|
|
4261
|
-
UserId?: string
|
|
4262
|
-
/**
|
|
4263
|
-
* 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。
|
|
4264
|
-
*/
|
|
4265
|
-
StreamType?: number
|
|
4266
|
-
/**
|
|
4267
|
-
* 该画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
4268
|
-
*/
|
|
4269
|
-
ImageWidth?: number
|
|
4270
|
-
/**
|
|
4271
|
-
* 该画面在输出时的高度,单位为像素值,不填默认为0。
|
|
4272
|
-
*/
|
|
4273
|
-
ImageHeight?: number
|
|
4274
|
-
/**
|
|
4275
|
-
* 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
4276
|
-
*/
|
|
4277
|
-
LocationX?: number
|
|
4278
|
-
/**
|
|
4279
|
-
* 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
4280
|
-
*/
|
|
4281
|
-
LocationY?: number
|
|
4282
|
-
/**
|
|
4283
|
-
* 该画面在输出时的层级,不填默认为0。
|
|
4284
|
-
*/
|
|
4285
|
-
ZOrder?: number
|
|
4286
|
-
/**
|
|
4287
|
-
* 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。
|
|
4288
|
-
*/
|
|
4289
|
-
RenderMode?: number
|
|
4290
|
-
/**
|
|
4291
|
-
* 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。
|
|
4292
|
-
*/
|
|
4293
|
-
MixInputType?: number
|
|
4294
|
-
/**
|
|
4295
|
-
* 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769
|
|
4296
|
-
*/
|
|
4297
|
-
PlaceImageId?: number
|
|
4298
|
-
}
|
|
4299
|
-
|
|
4300
|
-
/**
|
|
4301
|
-
* 转推参数。
|
|
4302
|
-
*/
|
|
4303
|
-
export interface McuPublishCdnParam {
|
|
4304
|
-
/**
|
|
4305
|
-
* CDN转推URL,只支持rtmp链接。
|
|
4306
|
-
注:若更新转推时,URL有任何变化,都会断流重推。
|
|
4307
|
-
*/
|
|
4308
|
-
PublishCdnUrl: string
|
|
4309
|
-
/**
|
|
4310
|
-
* 是否是腾讯云CDN,0为转推非腾讯云CDN,1为转推腾讯CDN,不携带该参数默认为1。注意:1,为避免误产生转推费用,该参数建议明确填写,转推非腾讯云CDN时会产生转推费用,详情参见接口文档说明;2,国内站默认只支持转推腾讯云CDN,如您有转推第三方CDN需求,请联系腾讯云技术支持。
|
|
4311
|
-
*/
|
|
4312
|
-
IsTencentCdn?: number
|
|
4313
|
-
}
|
|
4314
|
-
|
|
4315
|
-
/**
|
|
4316
|
-
* 录制音频转码参数。
|
|
4317
|
-
*/
|
|
4318
|
-
export interface AudioParams {
|
|
4319
|
-
/**
|
|
4320
|
-
* 音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ)
|
|
4321
|
-
1:48000Hz(默认);
|
|
4322
|
-
2:44100Hz
|
|
4323
|
-
3:16000Hz。
|
|
4324
|
-
*/
|
|
4325
|
-
SampleRate: number
|
|
4326
|
-
/**
|
|
4327
|
-
* 声道数枚举值:
|
|
4328
|
-
1:单声道;
|
|
4329
|
-
2:双声道(默认)。
|
|
4330
|
-
*/
|
|
4331
|
-
Channel: number
|
|
4332
|
-
/**
|
|
4333
|
-
* 音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。
|
|
4334
|
-
*/
|
|
4335
|
-
BitRate: number
|
|
4336
|
-
}
|
|
4337
|
-
|
|
4338
|
-
/**
|
|
4339
|
-
* StopAITranscription返回参数结构体
|
|
4340
|
-
*/
|
|
4341
|
-
export interface StopAITranscriptionResponse {
|
|
4342
|
-
/**
|
|
4343
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4344
|
-
*/
|
|
4345
|
-
RequestId?: string
|
|
4346
|
-
}
|
|
4347
|
-
|
|
4348
|
-
/**
|
|
4349
|
-
* SeriesInfo类型
|
|
4350
|
-
*/
|
|
4351
|
-
export interface SeriesInfo {
|
|
4352
|
-
/**
|
|
4353
|
-
* 数据列
|
|
4354
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4355
|
-
*/
|
|
4356
|
-
Columns: Array<string>
|
|
4357
|
-
/**
|
|
4358
|
-
* 数据值
|
|
4359
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4360
|
-
*/
|
|
4361
|
-
Values: Array<number | bigint>
|
|
4362
|
-
}
|
|
4363
|
-
|
|
4364
|
-
/**
|
|
4365
|
-
* 时间戳水印数据结构
|
|
4366
|
-
*/
|
|
4367
|
-
export interface WaterMarkTimestamp {
|
|
4368
|
-
/**
|
|
4369
|
-
* 时间戳的位置,取值范围0-6,分别代表上左,上右,下左,下右,上居中,下居中,居中
|
|
4370
|
-
*/
|
|
4371
|
-
Pos: number
|
|
4372
|
-
/**
|
|
4373
|
-
* 显示时间戳的时区,默认东八区
|
|
4374
|
-
*/
|
|
4375
|
-
TimeZone?: number
|
|
4376
|
-
/**
|
|
4377
|
-
* 文字水印的字体,支持设置以下值:
|
|
4378
|
-
1. Tencent (默认)
|
|
4379
|
-
2. SourceHanSans
|
|
4380
|
-
*/
|
|
4381
|
-
Font?: string
|
|
4382
|
-
}
|
|
4383
|
-
|
|
4384
|
-
/**
|
|
4385
|
-
* Mcu转推录制,点播相关参数。
|
|
4386
|
-
*/
|
|
4387
|
-
export interface McuCloudVod {
|
|
4388
|
-
/**
|
|
4389
|
-
* 腾讯云点播相关参数。
|
|
4390
|
-
*/
|
|
4391
|
-
McuTencentVod?: McuTencentVod
|
|
4392
|
-
}
|
|
4393
|
-
|
|
4394
|
-
/**
|
|
4395
|
-
* 单流旁路转推的用户上行信息。
|
|
4396
|
-
*/
|
|
4397
|
-
export interface SingleSubscribeParams {
|
|
4398
|
-
/**
|
|
4399
|
-
* 用户媒体流参数。
|
|
4400
|
-
*/
|
|
4401
|
-
UserMediaStream: UserMediaStream
|
|
4402
|
-
}
|
|
4403
|
-
|
|
4404
|
-
/**
|
|
4405
|
-
* 第三方CDN转推参数
|
|
4406
|
-
*/
|
|
4407
|
-
export interface PublishCdnParams {
|
|
4408
|
-
/**
|
|
4409
|
-
* 腾讯云直播BizId。
|
|
4410
|
-
*/
|
|
4411
|
-
BizId: number
|
|
4412
|
-
/**
|
|
4413
|
-
* 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。
|
|
4414
|
-
*/
|
|
4415
|
-
PublishCdnUrls: Array<string>
|
|
4416
|
-
}
|
|
4417
|
-
|
|
4418
|
-
/**
|
|
4419
|
-
* DescribeAITranscription返回参数结构体
|
|
4420
|
-
*/
|
|
4421
|
-
export interface DescribeAITranscriptionResponse {
|
|
4422
|
-
/**
|
|
4423
|
-
* 任务开始时间。
|
|
4424
|
-
*/
|
|
4425
|
-
StartTime?: string
|
|
4426
|
-
/**
|
|
4427
|
-
* 转录任务状态。
|
|
4428
|
-
有4个值:
|
|
4429
|
-
1、Idle表示任务未开始
|
|
4430
|
-
2、Preparing表示任务准备中
|
|
4431
|
-
3、InProgress表示任务正在运行
|
|
4432
|
-
4、Stopped表示任务已停止,正在清理资源中
|
|
4433
|
-
*/
|
|
4434
|
-
Status?: string
|
|
4435
|
-
/**
|
|
4436
|
-
* 唯一标识一次任务。
|
|
4437
|
-
*/
|
|
4438
|
-
TaskId?: string
|
|
4439
|
-
/**
|
|
4440
|
-
* 开启转录任务时填写的SessionId,如果没写则不返回。
|
|
4441
|
-
*/
|
|
4442
|
-
SessionId?: string
|
|
4443
|
-
/**
|
|
4444
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4445
|
-
*/
|
|
4446
|
-
RequestId?: string
|
|
4447
|
-
}
|
|
4448
|
-
|
|
4449
|
-
/**
|
|
4450
|
-
* 水印参数。
|
|
4451
|
-
*/
|
|
4452
|
-
export interface McuWaterMarkParams {
|
|
4453
|
-
/**
|
|
4454
|
-
* 水印类型,0为图片(默认),1为文字。
|
|
4455
|
-
*/
|
|
4456
|
-
WaterMarkType?: number
|
|
4457
|
-
/**
|
|
4458
|
-
* 图片水印参数。WaterMarkType为0指定。
|
|
4459
|
-
*/
|
|
4460
|
-
WaterMarkImage?: McuWaterMarkImage
|
|
4461
|
-
/**
|
|
4462
|
-
* 文字水印参数。WaterMarkType为1指定。
|
|
4463
|
-
*/
|
|
4464
|
-
WaterMarkText?: McuWaterMarkText
|
|
4465
|
-
}
|
|
4466
|
-
|
|
4467
|
-
/**
|
|
4468
|
-
* 用户的异常体验及可能的原因
|
|
4469
|
-
*/
|
|
4470
|
-
export interface AbnormalExperience {
|
|
4471
|
-
/**
|
|
4472
|
-
* 用户ID
|
|
4473
|
-
*/
|
|
4474
|
-
UserId?: string
|
|
4475
|
-
/**
|
|
4476
|
-
* 异常体验ID
|
|
4477
|
-
*/
|
|
4478
|
-
ExperienceId?: number
|
|
4479
|
-
/**
|
|
4480
|
-
* 字符串房间号
|
|
4481
|
-
*/
|
|
4482
|
-
RoomId?: string
|
|
4483
|
-
/**
|
|
4484
|
-
* 异常事件数组
|
|
4485
|
-
*/
|
|
4486
|
-
AbnormalEventList?: Array<AbnormalEvent>
|
|
4487
|
-
/**
|
|
4488
|
-
* 异常事件的上报时间
|
|
4489
|
-
*/
|
|
4490
|
-
EventTime?: number
|
|
4491
|
-
}
|
|
4492
|
-
|
|
4493
|
-
/**
|
|
4494
|
-
* UpdateAIConversation请求参数结构体
|
|
4495
|
-
*/
|
|
4496
|
-
export interface UpdateAIConversationRequest {
|
|
4497
|
-
/**
|
|
4498
|
-
* 唯一标识一个任务
|
|
4499
|
-
*/
|
|
4500
|
-
TaskId: string
|
|
4501
|
-
/**
|
|
4502
|
-
* 不填写则不进行更新,机器人的欢迎语
|
|
4503
|
-
*/
|
|
4504
|
-
WelcomeMessage?: string
|
|
4505
|
-
/**
|
|
4506
|
-
* 不填写则不进行更新。智能打断模式,0表示服务端自动打断,1表示服务端不打断,由端上发送打断信令进行打断
|
|
4507
|
-
*/
|
|
4508
|
-
InterruptMode?: number
|
|
4509
|
-
/**
|
|
4510
|
-
* 不填写则不进行更新。InterruptMode为0时使用,单位为毫秒,默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断
|
|
4511
|
-
*/
|
|
4512
|
-
InterruptSpeechDuration?: number
|
|
4513
|
-
/**
|
|
4514
|
-
* 不填写则不进行更新,LLM配置,详情见StartAIConversation接口
|
|
4515
|
-
*/
|
|
4516
|
-
LLMConfig?: string
|
|
4517
|
-
/**
|
|
4518
|
-
* 不填写则不进行更新,TTS配置,详情见StartAIConversation接口
|
|
4519
|
-
*/
|
|
4520
|
-
TTSConfig?: string
|
|
4521
|
-
}
|
|
4522
|
-
|
|
4523
|
-
/**
|
|
4524
|
-
* 房间信息列表
|
|
4525
|
-
*/
|
|
4526
|
-
export interface RoomState {
|
|
4527
|
-
/**
|
|
4528
|
-
* 通话ID(唯一标识一次通话)
|
|
4529
|
-
*/
|
|
4530
|
-
CommId?: string
|
|
4531
|
-
/**
|
|
4532
|
-
* 房间号
|
|
4533
|
-
*/
|
|
4534
|
-
RoomString?: string
|
|
4535
|
-
/**
|
|
4536
|
-
* 房间创建时间
|
|
4537
|
-
*/
|
|
4538
|
-
CreateTime?: number
|
|
4539
|
-
/**
|
|
4540
|
-
* 房间销毁时间
|
|
4541
|
-
*/
|
|
4542
|
-
DestroyTime?: number
|
|
4543
|
-
/**
|
|
4544
|
-
* 房间是否已经结束
|
|
4545
|
-
*/
|
|
4546
|
-
IsFinished?: boolean
|
|
4547
|
-
/**
|
|
4548
|
-
* 房间创建者Id
|
|
4549
|
-
*/
|
|
4550
|
-
UserId?: string
|
|
4551
|
-
}
|
|
4552
|
-
|
|
4553
|
-
/**
|
|
4554
|
-
* CreatePicture返回参数结构体
|
|
4555
|
-
*/
|
|
4556
|
-
export interface CreatePictureResponse {
|
|
4557
|
-
/**
|
|
4558
|
-
* 图片id
|
|
4559
|
-
*/
|
|
4560
|
-
PictureId?: number
|
|
4561
|
-
/**
|
|
4562
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4563
|
-
*/
|
|
4564
|
-
RequestId?: string
|
|
4565
|
-
}
|
|
4566
|
-
|
|
4567
|
-
/**
|
|
4568
|
-
* StartAITranscription返回参数结构体
|
|
4569
|
-
*/
|
|
4570
|
-
export interface StartAITranscriptionResponse {
|
|
4571
|
-
/**
|
|
4572
|
-
* 用于唯一标识转录任务。
|
|
4573
|
-
*/
|
|
4574
|
-
TaskId?: string
|
|
4575
|
-
/**
|
|
4576
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4577
|
-
*/
|
|
4578
|
-
RequestId?: string
|
|
4579
|
-
}
|
|
4580
|
-
|
|
4581
|
-
/**
|
|
4582
|
-
* RemoveUser返回参数结构体
|
|
4583
|
-
*/
|
|
4584
|
-
export interface RemoveUserResponse {
|
|
4585
|
-
/**
|
|
4586
|
-
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4587
|
-
*/
|
|
4588
|
-
RequestId?: string
|
|
4589
|
-
}
|