tencentcloud-sdk-nodejs-trtc 4.0.891 → 4.0.893
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/package.json +1 -1
- package/products.md +23 -23
- package/src/services/trtc/v20190722/trtc_client.ts +58 -20
- package/src/services/trtc/v20190722/trtc_models.ts +310 -124
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +20 -8
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +27 -9
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +302 -124
|
@@ -15,6 +15,32 @@
|
|
|
15
15
|
* under the License.
|
|
16
16
|
*/
|
|
17
17
|
|
|
18
|
+
/**
|
|
19
|
+
* 机器人参数
|
|
20
|
+
*/
|
|
21
|
+
export interface AgentConfig {
|
|
22
|
+
/**
|
|
23
|
+
* 机器人的UserId,用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个任务时,机器人的UserId也不能相互重复,否则会中断前一个任务。需要保证机器人UserId在房间内唯一。
|
|
24
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
25
|
+
*/
|
|
26
|
+
UserId: string
|
|
27
|
+
/**
|
|
28
|
+
* 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
|
|
29
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
30
|
+
*/
|
|
31
|
+
UserSig: string
|
|
32
|
+
/**
|
|
33
|
+
* 机器人拉流的UserId, 填写后,机器人会拉取该UserId的流进行实时处理
|
|
34
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
35
|
+
*/
|
|
36
|
+
TargetUserId: string
|
|
37
|
+
/**
|
|
38
|
+
* 房间内推流用户全部退出后超过MaxIdleTime秒,后台自动关闭任务,默认值是60s。
|
|
39
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
40
|
+
*/
|
|
41
|
+
MaxIdleTime?: number
|
|
42
|
+
}
|
|
43
|
+
|
|
18
44
|
/**
|
|
19
45
|
* CreatePicture请求参数结构体
|
|
20
46
|
*/
|
|
@@ -141,41 +167,21 @@ export interface MixLayout {
|
|
|
141
167
|
}
|
|
142
168
|
|
|
143
169
|
/**
|
|
144
|
-
*
|
|
170
|
+
* DescribeRecordingUsage返回参数结构体
|
|
145
171
|
*/
|
|
146
|
-
export interface
|
|
147
|
-
/**
|
|
148
|
-
* 输出流视频编码参数。
|
|
149
|
-
*/
|
|
150
|
-
VideoEncode?: VideoEncode
|
|
151
|
-
/**
|
|
152
|
-
* 混流布局参数。
|
|
153
|
-
*/
|
|
154
|
-
LayoutParams?: McuLayoutParams
|
|
155
|
-
/**
|
|
156
|
-
* 整个画布背景颜色,常用的颜色有:
|
|
157
|
-
红色:0xcc0033。
|
|
158
|
-
黄色:0xcc9900。
|
|
159
|
-
绿色:0xcccc33。
|
|
160
|
-
蓝色:0x99CCFF。
|
|
161
|
-
黑色:0x000000。
|
|
162
|
-
白色:0xFFFFFF。
|
|
163
|
-
灰色:0x999999。
|
|
164
|
-
*/
|
|
165
|
-
BackGroundColor?: string
|
|
172
|
+
export interface DescribeRecordingUsageResponse {
|
|
166
173
|
/**
|
|
167
|
-
*
|
|
168
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。
|
|
174
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
169
175
|
*/
|
|
170
|
-
|
|
176
|
+
UsageKey?: Array<string>
|
|
171
177
|
/**
|
|
172
|
-
*
|
|
178
|
+
* 各个时间点用量明细。
|
|
173
179
|
*/
|
|
174
|
-
|
|
180
|
+
UsageList?: Array<TrtcUsage>
|
|
175
181
|
/**
|
|
176
|
-
*
|
|
182
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
177
183
|
*/
|
|
178
|
-
|
|
184
|
+
RequestId?: string
|
|
179
185
|
}
|
|
180
186
|
|
|
181
187
|
/**
|
|
@@ -200,6 +206,61 @@ export interface DescribeTRTCRealTimeScaleDataRequest {
|
|
|
200
206
|
RoomId?: string
|
|
201
207
|
}
|
|
202
208
|
|
|
209
|
+
/**
|
|
210
|
+
* StartAIConversation返回参数结构体
|
|
211
|
+
*/
|
|
212
|
+
export interface StartAIConversationResponse {
|
|
213
|
+
/**
|
|
214
|
+
* 用于唯一标识对话任务。
|
|
215
|
+
*/
|
|
216
|
+
TaskId?: string
|
|
217
|
+
/**
|
|
218
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
219
|
+
*/
|
|
220
|
+
RequestId?: string
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* 语音转文字参数
|
|
225
|
+
*/
|
|
226
|
+
export interface STTConfig {
|
|
227
|
+
/**
|
|
228
|
+
* 语音识别支持的语言,默认是"zh" 中文
|
|
229
|
+
目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes):
|
|
230
|
+
1. Chinese = "zh" # 中文
|
|
231
|
+
2. Chinese_TW = "zh-TW" # 中国台湾
|
|
232
|
+
3. Chinese_DIALECT = "zh-dialect" # 中国方言
|
|
233
|
+
4. English = "en" # 英语
|
|
234
|
+
5. Vietnamese = "vi" # 越南语
|
|
235
|
+
6. Japanese = "ja" # 日语
|
|
236
|
+
7. Korean = "ko" # 汉语
|
|
237
|
+
8. Indonesia = "id" # 印度尼西亚语
|
|
238
|
+
9. Thai = "th" # 泰语
|
|
239
|
+
10. Portuguese = "pt" # 葡萄牙语
|
|
240
|
+
11. Turkish = "tr" # 土耳其语
|
|
241
|
+
12. Arabic = "ar" # 阿拉伯语
|
|
242
|
+
13. Spanish = "es" # 西班牙语
|
|
243
|
+
14. Hindi = "hi" # 印地语
|
|
244
|
+
15. French = "fr" # 法语
|
|
245
|
+
16. Malay = "ms" # 马来语
|
|
246
|
+
17. Filipino = "fil" # 菲律宾语
|
|
247
|
+
18. German = "de" # 德语
|
|
248
|
+
19. Italian = "it" # 意大利语
|
|
249
|
+
20. Russian = "ru" # 俄语
|
|
250
|
+
|
|
251
|
+
注意:
|
|
252
|
+
如果缺少满足您需求的语言,请联系我们技术人员。
|
|
253
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
254
|
+
*/
|
|
255
|
+
Language?: string
|
|
256
|
+
/**
|
|
257
|
+
* 额外识别可能替代语言,最多3个, 需高级版支持,Language指定方言时,不允许设置该字段
|
|
258
|
+
|
|
259
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
260
|
+
*/
|
|
261
|
+
AlternativeLanguage?: Array<string>
|
|
262
|
+
}
|
|
263
|
+
|
|
203
264
|
/**
|
|
204
265
|
* DescribeTRTCMarketScaleData请求参数结构体
|
|
205
266
|
*/
|
|
@@ -441,6 +502,16 @@ export interface StopWebRecordRequest {
|
|
|
441
502
|
TaskId: string
|
|
442
503
|
}
|
|
443
504
|
|
|
505
|
+
/**
|
|
506
|
+
* StopAITranscription请求参数结构体
|
|
507
|
+
*/
|
|
508
|
+
export interface StopAITranscriptionRequest {
|
|
509
|
+
/**
|
|
510
|
+
* 唯一标识转录任务。
|
|
511
|
+
*/
|
|
512
|
+
TaskId: string
|
|
513
|
+
}
|
|
514
|
+
|
|
444
515
|
/**
|
|
445
516
|
* 视频转码参数
|
|
446
517
|
*/
|
|
@@ -968,6 +1039,44 @@ export interface DescribeRecordStatisticRequest {
|
|
|
968
1039
|
SdkAppId?: number
|
|
969
1040
|
}
|
|
970
1041
|
|
|
1042
|
+
/**
|
|
1043
|
+
* 混流转推的视频相关参数。
|
|
1044
|
+
*/
|
|
1045
|
+
export interface McuVideoParams {
|
|
1046
|
+
/**
|
|
1047
|
+
* 输出流视频编码参数。
|
|
1048
|
+
*/
|
|
1049
|
+
VideoEncode?: VideoEncode
|
|
1050
|
+
/**
|
|
1051
|
+
* 混流布局参数。
|
|
1052
|
+
*/
|
|
1053
|
+
LayoutParams?: McuLayoutParams
|
|
1054
|
+
/**
|
|
1055
|
+
* 整个画布背景颜色,常用的颜色有:
|
|
1056
|
+
红色:0xcc0033。
|
|
1057
|
+
黄色:0xcc9900。
|
|
1058
|
+
绿色:0xcccc33。
|
|
1059
|
+
蓝色:0x99CCFF。
|
|
1060
|
+
黑色:0x000000。
|
|
1061
|
+
白色:0xFFFFFF。
|
|
1062
|
+
灰色:0x999999。
|
|
1063
|
+
*/
|
|
1064
|
+
BackGroundColor?: string
|
|
1065
|
+
/**
|
|
1066
|
+
* 整个画布的背景图url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。
|
|
1067
|
+
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。
|
|
1068
|
+
*/
|
|
1069
|
+
BackgroundImageUrl?: string
|
|
1070
|
+
/**
|
|
1071
|
+
* 混流布局的水印参数。
|
|
1072
|
+
*/
|
|
1073
|
+
WaterMarkList?: Array<McuWaterMarkParams>
|
|
1074
|
+
/**
|
|
1075
|
+
* 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。
|
|
1076
|
+
*/
|
|
1077
|
+
BackgroundRenderMode?: number
|
|
1078
|
+
}
|
|
1079
|
+
|
|
971
1080
|
/**
|
|
972
1081
|
* DescribeRoomInfo请求参数结构体
|
|
973
1082
|
*/
|
|
@@ -1475,82 +1584,29 @@ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
|
|
|
1475
1584
|
}
|
|
1476
1585
|
|
|
1477
1586
|
/**
|
|
1478
|
-
*
|
|
1587
|
+
* DescribeAIConversation返回参数结构体
|
|
1479
1588
|
*/
|
|
1480
|
-
export interface
|
|
1481
|
-
/**
|
|
1482
|
-
* 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
|
|
1483
|
-
*/
|
|
1484
|
-
UserMediaStream?: UserMediaStream
|
|
1485
|
-
/**
|
|
1486
|
-
* 子画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1487
|
-
*/
|
|
1488
|
-
ImageWidth?: number
|
|
1589
|
+
export interface DescribeAIConversationResponse {
|
|
1489
1590
|
/**
|
|
1490
|
-
*
|
|
1491
|
-
*/
|
|
1492
|
-
ImageHeight?: number
|
|
1493
|
-
/**
|
|
1494
|
-
* 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1495
|
-
*/
|
|
1496
|
-
LocationX?: number
|
|
1497
|
-
/**
|
|
1498
|
-
* 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1499
|
-
*/
|
|
1500
|
-
LocationY?: number
|
|
1501
|
-
/**
|
|
1502
|
-
* 子画面在输出时的层级,不填默认为0。
|
|
1503
|
-
*/
|
|
1504
|
-
ZOrder?: number
|
|
1505
|
-
/**
|
|
1506
|
-
* 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
|
|
1507
|
-
*/
|
|
1508
|
-
RenderMode?: number
|
|
1509
|
-
/**
|
|
1510
|
-
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1511
|
-
红色:0xcc0033。
|
|
1512
|
-
黄色:0xcc9900。
|
|
1513
|
-
绿色:0xcccc33。
|
|
1514
|
-
蓝色:0x99CCFF。
|
|
1515
|
-
黑色:0x000000。
|
|
1516
|
-
白色:0xFFFFFF。
|
|
1517
|
-
灰色:0x999999。
|
|
1518
|
-
*/
|
|
1519
|
-
BackGroundColor?: string
|
|
1520
|
-
/**
|
|
1521
|
-
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
|
|
1522
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。
|
|
1523
|
-
*/
|
|
1524
|
-
BackgroundImageUrl?: string
|
|
1525
|
-
/**
|
|
1526
|
-
* 客户自定义裁剪,针对原始输入流裁剪
|
|
1591
|
+
* 任务开始时间。
|
|
1527
1592
|
*/
|
|
1528
|
-
|
|
1593
|
+
StartTime?: string
|
|
1529
1594
|
/**
|
|
1530
|
-
*
|
|
1595
|
+
* 任务状态。有4个值:1、Idle表示任务未开始2、Preparing表示任务准备中3、InProgress表示任务正在运行4、Stopped表示任务已停止,正在清理资源中
|
|
1531
1596
|
*/
|
|
1532
|
-
|
|
1597
|
+
Status?: string
|
|
1533
1598
|
/**
|
|
1534
|
-
*
|
|
1535
|
-
注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。
|
|
1599
|
+
* 唯一标识一次任务。
|
|
1536
1600
|
*/
|
|
1537
|
-
|
|
1601
|
+
TaskId?: string
|
|
1538
1602
|
/**
|
|
1539
|
-
*
|
|
1603
|
+
* 开启对话任务时填写的SessionId,如果没写则不返回。
|
|
1540
1604
|
*/
|
|
1541
|
-
|
|
1605
|
+
SessionId?: string
|
|
1542
1606
|
/**
|
|
1543
|
-
*
|
|
1544
|
-
bit0:占位图缩放是否生效。
|
|
1545
|
-
bit1:上行流缩放是否生效。
|
|
1546
|
-
您可以将相应bit位置1启动生效,例如:
|
|
1547
|
-
0(00)表示子背景色不生效。
|
|
1548
|
-
1(01)表示子背景色只在占位图缩放时生效。
|
|
1549
|
-
2(10)表示子背景色只在上行流缩放时生效。
|
|
1550
|
-
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
|
|
1551
|
-
|
|
1607
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1552
1608
|
*/
|
|
1553
|
-
|
|
1609
|
+
RequestId?: string
|
|
1554
1610
|
}
|
|
1555
1611
|
|
|
1556
1612
|
/**
|
|
@@ -1814,21 +1870,82 @@ export interface StartStreamIngestRequest {
|
|
|
1814
1870
|
}
|
|
1815
1871
|
|
|
1816
1872
|
/**
|
|
1817
|
-
*
|
|
1873
|
+
* 混流布局参数。
|
|
1818
1874
|
*/
|
|
1819
|
-
export interface
|
|
1875
|
+
export interface McuLayout {
|
|
1820
1876
|
/**
|
|
1821
|
-
*
|
|
1877
|
+
* 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
|
|
1822
1878
|
*/
|
|
1823
|
-
|
|
1879
|
+
UserMediaStream?: UserMediaStream
|
|
1824
1880
|
/**
|
|
1825
|
-
*
|
|
1881
|
+
* 子画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1826
1882
|
*/
|
|
1827
|
-
|
|
1883
|
+
ImageWidth?: number
|
|
1828
1884
|
/**
|
|
1829
|
-
*
|
|
1885
|
+
* 子画面在输出时的高度,单位为像素值,不填默认为0。
|
|
1830
1886
|
*/
|
|
1831
|
-
|
|
1887
|
+
ImageHeight?: number
|
|
1888
|
+
/**
|
|
1889
|
+
* 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1890
|
+
*/
|
|
1891
|
+
LocationX?: number
|
|
1892
|
+
/**
|
|
1893
|
+
* 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1894
|
+
*/
|
|
1895
|
+
LocationY?: number
|
|
1896
|
+
/**
|
|
1897
|
+
* 子画面在输出时的层级,不填默认为0。
|
|
1898
|
+
*/
|
|
1899
|
+
ZOrder?: number
|
|
1900
|
+
/**
|
|
1901
|
+
* 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
|
|
1902
|
+
*/
|
|
1903
|
+
RenderMode?: number
|
|
1904
|
+
/**
|
|
1905
|
+
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1906
|
+
红色:0xcc0033。
|
|
1907
|
+
黄色:0xcc9900。
|
|
1908
|
+
绿色:0xcccc33。
|
|
1909
|
+
蓝色:0x99CCFF。
|
|
1910
|
+
黑色:0x000000。
|
|
1911
|
+
白色:0xFFFFFF。
|
|
1912
|
+
灰色:0x999999。
|
|
1913
|
+
*/
|
|
1914
|
+
BackGroundColor?: string
|
|
1915
|
+
/**
|
|
1916
|
+
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
|
|
1917
|
+
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。
|
|
1918
|
+
*/
|
|
1919
|
+
BackgroundImageUrl?: string
|
|
1920
|
+
/**
|
|
1921
|
+
* 客户自定义裁剪,针对原始输入流裁剪
|
|
1922
|
+
*/
|
|
1923
|
+
CustomCrop?: McuCustomCrop
|
|
1924
|
+
/**
|
|
1925
|
+
* 子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。
|
|
1926
|
+
*/
|
|
1927
|
+
BackgroundRenderMode?: number
|
|
1928
|
+
/**
|
|
1929
|
+
* 子画面的透明模版url,指向一张包含透明通道的模板图片。填写该参数,后台混流时会提取该模板图片的透明通道,将其缩放作为目标画面的透明通道,再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪(如圆角、星形、心形等)。 支持png格式。图片大小限制不超过5MB。
|
|
1930
|
+
注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。
|
|
1931
|
+
*/
|
|
1932
|
+
TransparentUrl?: string
|
|
1933
|
+
/**
|
|
1934
|
+
* 子背景图的自定义渲染参数,当BackgroundRenderMode为4时必须配置。
|
|
1935
|
+
*/
|
|
1936
|
+
BackgroundCustomRender?: McuBackgroundCustomRender
|
|
1937
|
+
/**
|
|
1938
|
+
* 子背景色生效模式,默认值为0表示均不生效。
|
|
1939
|
+
bit0:占位图缩放是否生效。
|
|
1940
|
+
bit1:上行流缩放是否生效。
|
|
1941
|
+
您可以将相应bit位置1启动生效,例如:
|
|
1942
|
+
0(00)表示子背景色不生效。
|
|
1943
|
+
1(01)表示子背景色只在占位图缩放时生效。
|
|
1944
|
+
2(10)表示子背景色只在上行流缩放时生效。
|
|
1945
|
+
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
|
|
1946
|
+
|
|
1947
|
+
*/
|
|
1948
|
+
BackGroundColorMode?: number
|
|
1832
1949
|
}
|
|
1833
1950
|
|
|
1834
1951
|
/**
|
|
@@ -2589,6 +2706,47 @@ export interface StopPublishCdnStreamRequest {
|
|
|
2589
2706
|
TaskId: string
|
|
2590
2707
|
}
|
|
2591
2708
|
|
|
2709
|
+
/**
|
|
2710
|
+
* StartAIConversation请求参数结构体
|
|
2711
|
+
*/
|
|
2712
|
+
export interface StartAIConversationRequest {
|
|
2713
|
+
/**
|
|
2714
|
+
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
|
|
2715
|
+
*/
|
|
2716
|
+
SdkAppId: number
|
|
2717
|
+
/**
|
|
2718
|
+
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启对话任务的房间号。
|
|
2719
|
+
*/
|
|
2720
|
+
RoomId: string
|
|
2721
|
+
/**
|
|
2722
|
+
* 机器人参数
|
|
2723
|
+
*/
|
|
2724
|
+
AgentConfig: AgentConfig
|
|
2725
|
+
/**
|
|
2726
|
+
* 调用方传入的唯一Id,服务端用来去重。
|
|
2727
|
+
*/
|
|
2728
|
+
SessionId?: string
|
|
2729
|
+
/**
|
|
2730
|
+
* TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。
|
|
2731
|
+
*/
|
|
2732
|
+
RoomIdType?: number
|
|
2733
|
+
/**
|
|
2734
|
+
* 语音识别配置。
|
|
2735
|
+
*/
|
|
2736
|
+
STTConfig?: STTConfig
|
|
2737
|
+
/**
|
|
2738
|
+
* LLM配置。需符合openai规范,为JSON字符串,示例如下:
|
|
2739
|
+
<pre> { <br>   "LLMType": “大模型类型", // String 必填,目前固定为"openai" <br>   "Model": "您的模型名称", // String 必填,指定使用的模型<br> "APIKey": "您的OpenAI API密钥", // String 必填,相当于环境变量中的OPENAI_API_KEY<br>   "APIBaseUrl": "https://api.openai.com", // String 必填,OpenAI API的基础URL<br>   "Streaming": true // Boolean 非必填,指定是否使用流式传输<br>  } </pre>
|
|
2740
|
+
|
|
2741
|
+
*/
|
|
2742
|
+
LLMConfig?: string
|
|
2743
|
+
/**
|
|
2744
|
+
* TTS配置。目前支持腾讯云TTS, 为JSON字符串,示例如下:
|
|
2745
|
+
<pre>{ <br>   "AppId": "您的应用ID", // String 必填<br>   "TTSType": "TTS类型", // String TTS类型, 固定为"tencent"<br>   "SercetId": "您的密钥ID", // String 必填<br>   "SercetKey": "您的密钥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>   "PrimaryLanguage": "zh-CN" // String 非必填,主要语言<br>  }</pre>
|
|
2746
|
+
*/
|
|
2747
|
+
TTSConfig?: string
|
|
2748
|
+
}
|
|
2749
|
+
|
|
2592
2750
|
/**
|
|
2593
2751
|
* DeletePicture返回参数结构体
|
|
2594
2752
|
*/
|
|
@@ -2622,29 +2780,13 @@ export interface ModifyCloudRecordingRequest {
|
|
|
2622
2780
|
}
|
|
2623
2781
|
|
|
2624
2782
|
/**
|
|
2625
|
-
*
|
|
2783
|
+
* StopAIConversation返回参数结构体
|
|
2626
2784
|
*/
|
|
2627
|
-
export interface
|
|
2785
|
+
export interface StopAIConversationResponse {
|
|
2628
2786
|
/**
|
|
2629
|
-
*
|
|
2630
|
-
*/
|
|
2631
|
-
Width: number
|
|
2632
|
-
/**
|
|
2633
|
-
* 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
|
|
2634
|
-
*/
|
|
2635
|
-
Height: number
|
|
2636
|
-
/**
|
|
2637
|
-
* 视频的帧率,范围[1, 60],默认15。
|
|
2638
|
-
*/
|
|
2639
|
-
Fps: number
|
|
2640
|
-
/**
|
|
2641
|
-
* 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
|
|
2642
|
-
*/
|
|
2643
|
-
BitRate: number
|
|
2644
|
-
/**
|
|
2645
|
-
* 视频关键帧时间间隔,单位秒,默认值10秒。
|
|
2787
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2646
2788
|
*/
|
|
2647
|
-
|
|
2789
|
+
RequestId?: string
|
|
2648
2790
|
}
|
|
2649
2791
|
|
|
2650
2792
|
/**
|
|
@@ -2697,6 +2839,24 @@ export interface StartPublishCdnStreamRequest {
|
|
|
2697
2839
|
FeedBackRoomParams?: Array<McuFeedBackRoomParams>
|
|
2698
2840
|
}
|
|
2699
2841
|
|
|
2842
|
+
/**
|
|
2843
|
+
* DescribeAIConversation请求参数结构体
|
|
2844
|
+
*/
|
|
2845
|
+
export interface DescribeAIConversationRequest {
|
|
2846
|
+
/**
|
|
2847
|
+
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。
|
|
2848
|
+
*/
|
|
2849
|
+
SdkAppId?: number
|
|
2850
|
+
/**
|
|
2851
|
+
* 唯一标识一次任务。
|
|
2852
|
+
*/
|
|
2853
|
+
TaskId?: string
|
|
2854
|
+
/**
|
|
2855
|
+
* 开启任务时填写的SessionId,如果没写则不返回。
|
|
2856
|
+
*/
|
|
2857
|
+
SessionId?: string
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2700
2860
|
/**
|
|
2701
2861
|
* SeriesInfo类型的二维数组
|
|
2702
2862
|
*/
|
|
@@ -3324,6 +3484,32 @@ export interface DeletePictureRequest {
|
|
|
3324
3484
|
SdkAppId: number
|
|
3325
3485
|
}
|
|
3326
3486
|
|
|
3487
|
+
/**
|
|
3488
|
+
* 录制视频转码参数。
|
|
3489
|
+
*/
|
|
3490
|
+
export interface VideoParams {
|
|
3491
|
+
/**
|
|
3492
|
+
* 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
|
|
3493
|
+
*/
|
|
3494
|
+
Width: number
|
|
3495
|
+
/**
|
|
3496
|
+
* 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
|
|
3497
|
+
*/
|
|
3498
|
+
Height: number
|
|
3499
|
+
/**
|
|
3500
|
+
* 视频的帧率,范围[1, 60],默认15。
|
|
3501
|
+
*/
|
|
3502
|
+
Fps: number
|
|
3503
|
+
/**
|
|
3504
|
+
* 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
|
|
3505
|
+
*/
|
|
3506
|
+
BitRate: number
|
|
3507
|
+
/**
|
|
3508
|
+
* 视频关键帧时间间隔,单位秒,默认值10秒。
|
|
3509
|
+
*/
|
|
3510
|
+
Gop: number
|
|
3511
|
+
}
|
|
3512
|
+
|
|
3327
3513
|
/**
|
|
3328
3514
|
* 混流SEI参数
|
|
3329
3515
|
*/
|
|
@@ -3339,11 +3525,11 @@ export interface McuSeiParams {
|
|
|
3339
3525
|
}
|
|
3340
3526
|
|
|
3341
3527
|
/**
|
|
3342
|
-
*
|
|
3528
|
+
* StopAIConversation请求参数结构体
|
|
3343
3529
|
*/
|
|
3344
|
-
export interface
|
|
3530
|
+
export interface StopAIConversationRequest {
|
|
3345
3531
|
/**
|
|
3346
|
-
*
|
|
3532
|
+
* 唯一标识任务。
|
|
3347
3533
|
*/
|
|
3348
3534
|
TaskId: string
|
|
3349
3535
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreatePictureRequest, DescribeTRTCMarketQualityMetricDataResponse, DescribeTRTCRealTimeScaleDataRequest, DescribeTRTCMarketScaleDataRequest, DescribeUserEventRequest, DescribeTrtcRoomUsageResponse, StopPublishCdnStreamResponse, DescribeTRTCRealTimeScaleMetricDataRequest, StopWebRecordRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeTRTCMarketScaleDataResponse, ModifyPictureRequest, DescribeWebRecordResponse, DescribeUserInfoRequest, DescribeTRTCMarketQualityDataResponse, DescribeRelayUsageRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeWebRecordRequest, DescribeTRTCRealTimeScaleDataResponse, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeMixTranscodingUsageRequest, DescribeStreamIngestResponse, StopStreamIngestRequest, DescribeTRTCRealTimeQualityDataRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DismissRoomRequest, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeAITranscriptionRequest, DescribeUserInfoResponse, RemoveUserByStrRoomIdResponse, DescribeTRTCRealTimeScaleMetricDataResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest,
|
|
2
|
+
import { CreatePictureRequest, DescribeTRTCMarketQualityMetricDataResponse, DescribeRecordingUsageResponse, DescribeTRTCRealTimeScaleDataRequest, StartAIConversationResponse, DescribeTRTCMarketScaleDataRequest, DescribeUserEventRequest, DescribeTrtcRoomUsageResponse, StopPublishCdnStreamResponse, DescribeTRTCRealTimeScaleMetricDataRequest, StopWebRecordRequest, StopAITranscriptionRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeTRTCMarketScaleDataResponse, ModifyPictureRequest, DescribeWebRecordResponse, DescribeUserInfoRequest, DescribeTRTCMarketQualityDataResponse, DescribeRelayUsageRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeWebRecordRequest, DescribeTRTCRealTimeScaleDataResponse, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeMixTranscodingUsageRequest, DescribeStreamIngestResponse, StopStreamIngestRequest, DescribeTRTCRealTimeQualityDataRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DismissRoomRequest, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeAITranscriptionRequest, DescribeAIConversationResponse, DescribeUserInfoResponse, RemoveUserByStrRoomIdResponse, DescribeTRTCRealTimeScaleMetricDataResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest, StopMCUMixTranscodeRequest, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, DescribeTRTCRealTimeQualityMetricDataResponse, StartWebRecordResponse, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopPublishCdnStreamRequest, StartAIConversationRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StopAIConversationResponse, StartPublishCdnStreamRequest, DescribeAIConversationRequest, CreateCloudRecordingResponse, StartStreamIngestResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribePictureResponse, DescribeTrtcRoomUsageRequest, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, DescribeCloudRecordingResponse, StartAITranscriptionRequest, DismissRoomResponse, StopStreamIngestResponse, DescribeTRTCMarketQualityDataRequest, SummarizeTranscriptionRequest, UpdatePublishCdnStreamRequest, StartWebRecordRequest, StopWebRecordResponse, SummarizeTranscriptionResponse, DeletePictureRequest, StopAIConversationRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, DescribeStreamIngestRequest, DescribeTRTCMarketScaleMetricDataResponse, StopAITranscriptionResponse, DescribeAITranscriptionResponse, CreatePictureResponse, StartAITranscriptionResponse, RemoveUserResponse } from "./trtc_models";
|
|
3
3
|
/**
|
|
4
4
|
* trtc client
|
|
5
5
|
* @class
|
|
@@ -24,6 +24,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
24
24
|
- 默认接口请求频率限制:5次/秒。
|
|
25
25
|
*/
|
|
26
26
|
DescribeTrtcUsage(req: DescribeTrtcUsageRequest, cb?: (error: string, rep: DescribeTrtcUsageResponse) => void): Promise<DescribeTrtcUsageResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* 接口不再支持
|
|
29
|
+
|
|
30
|
+
对转录的文本进行总结。
|
|
31
|
+
*/
|
|
32
|
+
SummarizeTranscription(req?: SummarizeTranscriptionRequest, cb?: (error: string, rep: SummarizeTranscriptionResponse) => void): Promise<SummarizeTranscriptionResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* 停止AI对话任务
|
|
35
|
+
*/
|
|
36
|
+
StopAIConversation(req: StopAIConversationRequest, cb?: (error: string, rep: StopAIConversationResponse) => void): Promise<StopAIConversationResponse>;
|
|
27
37
|
/**
|
|
28
38
|
* 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
29
39
|
joinSuccessRate:加入频道成功率。
|
|
@@ -164,9 +174,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
174
|
*/
|
|
165
175
|
DescribeTRTCMarketScaleMetricData(req: DescribeTRTCMarketScaleMetricDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleMetricDataResponse) => void): Promise<DescribeTRTCMarketScaleMetricDataResponse>;
|
|
166
176
|
/**
|
|
167
|
-
*
|
|
177
|
+
* 启动一个任务,机器人将进入TRTC房间,与指定成员进行AI对话
|
|
168
178
|
*/
|
|
169
|
-
|
|
179
|
+
StartAIConversation(req: StartAIConversationRequest, cb?: (error: string, rep: StartAIConversationResponse) => void): Promise<StartAIConversationResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* 查询AI对话任务状态。
|
|
182
|
+
*/
|
|
183
|
+
DescribeAIConversation(req: DescribeAIConversationRequest, cb?: (error: string, rep: DescribeAIConversationResponse) => void): Promise<DescribeAIConversationResponse>;
|
|
170
184
|
/**
|
|
171
185
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
172
186
|
|
|
@@ -379,11 +393,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
379
393
|
*/
|
|
380
394
|
StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
|
|
381
395
|
/**
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
*/
|
|
386
|
-
SummarizeTranscription(req?: SummarizeTranscriptionRequest, cb?: (error: string, rep: SummarizeTranscriptionResponse) => void): Promise<SummarizeTranscriptionResponse>;
|
|
396
|
+
* 停止一个输入在线媒体流任务。
|
|
397
|
+
*/
|
|
398
|
+
StopStreamIngest(req: StopStreamIngestRequest, cb?: (error: string, rep: StopStreamIngestResponse) => void): Promise<StopStreamIngestResponse>;
|
|
387
399
|
/**
|
|
388
400
|
* 获取TRTC录制的用量明细。
|
|
389
401
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
@@ -49,6 +49,20 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
49
49
|
async DescribeTrtcUsage(req, cb) {
|
|
50
50
|
return this.request("DescribeTrtcUsage", req, cb);
|
|
51
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* 接口不再支持
|
|
54
|
+
|
|
55
|
+
对转录的文本进行总结。
|
|
56
|
+
*/
|
|
57
|
+
async SummarizeTranscription(req, cb) {
|
|
58
|
+
return this.request("SummarizeTranscription", req, cb);
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* 停止AI对话任务
|
|
62
|
+
*/
|
|
63
|
+
async StopAIConversation(req, cb) {
|
|
64
|
+
return this.request("StopAIConversation", req, cb);
|
|
65
|
+
}
|
|
52
66
|
/**
|
|
53
67
|
* 查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
54
68
|
joinSuccessRate:加入频道成功率。
|
|
@@ -201,10 +215,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
201
215
|
return this.request("DescribeTRTCMarketScaleMetricData", req, cb);
|
|
202
216
|
}
|
|
203
217
|
/**
|
|
204
|
-
*
|
|
218
|
+
* 启动一个任务,机器人将进入TRTC房间,与指定成员进行AI对话
|
|
205
219
|
*/
|
|
206
|
-
async
|
|
207
|
-
return this.request("
|
|
220
|
+
async StartAIConversation(req, cb) {
|
|
221
|
+
return this.request("StartAIConversation", req, cb);
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* 查询AI对话任务状态。
|
|
225
|
+
*/
|
|
226
|
+
async DescribeAIConversation(req, cb) {
|
|
227
|
+
return this.request("DescribeAIConversation", req, cb);
|
|
208
228
|
}
|
|
209
229
|
/**
|
|
210
230
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
@@ -462,12 +482,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
462
482
|
return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
|
|
463
483
|
}
|
|
464
484
|
/**
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
async SummarizeTranscription(req, cb) {
|
|
470
|
-
return this.request("SummarizeTranscription", req, cb);
|
|
485
|
+
* 停止一个输入在线媒体流任务。
|
|
486
|
+
*/
|
|
487
|
+
async StopStreamIngest(req, cb) {
|
|
488
|
+
return this.request("StopStreamIngest", req, cb);
|
|
471
489
|
}
|
|
472
490
|
/**
|
|
473
491
|
* 获取TRTC录制的用量明细。
|