tencentcloud-sdk-nodejs-trtc 4.0.905 → 4.0.908
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 +32 -32
- package/src/services/trtc/v20190722/trtc_client.ts +34 -107
- package/src/services/trtc/v20190722/trtc_models.ts +208 -164
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +18 -100
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +19 -99
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +204 -163
|
@@ -84,102 +84,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
84
84
|
return this.request("DescribeWebRecord", req, cb);
|
|
85
85
|
}
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
88
|
-
|
|
89
|
-
云api混流转推功能包含三个接口:
|
|
90
|
-
1、StartPublishCdnStream:启动一个混流转推任务,此接口会发起一个新的混流转推任务,启动成功后会返回一个sdkappid维度唯一的任务id(TaskId)。您需要保存该TaskId,后续需要依赖此TaskId更新任务和结束任务。
|
|
91
|
-
2、UpdatePublishCdnStream:更新指定的混流转推任务,包括:更新视频画面的布局、更新混音列表、更新转推cdn的地址列表以及更新回推房间列表。
|
|
92
|
-
3、StopPublishCdnStream:停止指定的混流转推任务。
|
|
93
|
-
|
|
94
|
-
您可以通过此套接口实现目标:
|
|
95
|
-
1、设置最终混流的画质和音质,包括视频分辨率、视频帧率、视频码率,和音频质量。
|
|
96
|
-
2、设置每一路画面的布局位置,您只需要设置一次,后续您指定的混流用户进房上行音视频时,排版引擎会自动将该用户的画面混合到您指定的布局位置。同时您可以使用更新接口调整画面的布局位置。
|
|
97
|
-
3、设置多个cdn转推的目的地址,一个转推任务最多可以同时设置10个cdn转推地址,如果您需要转推非腾讯云的cdn地址时,需要联系腾讯云开通能力。
|
|
98
|
-
4、设置多个回推房间列表,一个转推任务最多可以同时将混流回推到10个TRTC房间。
|
|
99
|
-
|
|
100
|
-
目前已经支持如下几种布局模版,其中动态布局模版(悬浮模板、九宫格模板、屏幕分享模板)只支持单个TRTC房间,自定义模版支持混合多个TRTC房间内的音视频流。具体说明如下:
|
|
101
|
-
1、悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
|
|
102
|
-
2、九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。
|
|
103
|
-
3、屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,需要您明确设置占据大画面的混流用户信息。其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理,也支持统一设置子画面的渲染方式。
|
|
104
|
-
4、自定义布局模版:支持您主动根据业务需要设置布局位置,每个预设的布局位置支持具名设置(具名设置需要明确指定房间号和用户名)和不具名设置。当一个子画面具名设置时,该位置就为该用户预留,用户进房且上行音视频数据时会自动占据该位置,其它用户不会占据该位置。当预设的布局位置未具名时,排版引擎会根据进房间顺序自动填充,预设位置填满时,不再混合其它用户的画面和声音。每个子画面位置支持设置占位图(BackgroundImageUrl),当用户未进房或者只上行音频数据时,该位置画面可显示对应的占位图画面。
|
|
105
|
-
|
|
106
|
-
您可以控制台开通旁路转推回调功能实现转推cdn状态的事件监控,具体说明请参考官网文档:[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552)
|
|
107
|
-
您使用转推api时根据使用特性可能会产生如下费用:
|
|
108
|
-
MCU混流转码费用请参考文档:[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
|
|
109
|
-
转推非腾讯云CDN费用请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
|
|
110
|
-
|
|
111
|
-
参数的使用说明:
|
|
112
|
-
1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC房间进行拉流,您需要通过AgentParams.UserId参数进行设置,这个机器人id不能和房间中的普通用户id冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。您可以通过设置AgentParams.MaxIdleTime控制转推任务的自动结束,当设置此参数时,所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推任务。注意:参与混流转推的主播仅是停止音视频上行,转推任务不会自动停止。
|
|
113
|
-
2、WithTranscoding:如果需要将多路音视频流混合到一路时,WithTranscoding必须设置为1。
|
|
114
|
-
3、AudioParams:转推任务音频参数和视频参数是分开设置的,若您想要将指定的用户音频进行混音时,需要明确设置AudioParams.SubscribeAudioList。若您不设置AudioParams.SubscribeAudioList,混音引擎会自动将TRTC房间中所有用户的音频混合。若您想要混合TRTC房间除指定用户之外的所有用户的声音,可以通过AudioParams.UnSubscribeAudioList设置音频黑名单列表。
|
|
115
|
-
4、VideoParams:若您想要将用户的视频混合,可以通过VideoParams设置,若只想要混纯音频,则不用设置VideoParams参数。您可以通过VideoParams.LayoutParams.MixLayoutMode设置画面的布局模式,包括:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局)和自定义布局。动态布局模式由排版引擎按照固定的布局自动混合,不需要设置VideoParams.LayoutParams.MixLayoutList。当使用悬浮布局和屏幕分享布局时,您可以通过设置VideoParams.LayoutParams.MaxVideoUser参数指定大画面用户。自定义布局模式提供给您自主布局画面的能力,可以通过VideoParams.LayoutParams.MixLayoutList参数指定每个用户所在的布局位置。在每个布局参数中,您可以通过用户媒体流参数(UserMediaStream)指定这个布局位置为指定的用户预留,也可以不设置UserMediaStream,由排版引擎按照用户进入TRTC房间的顺序自动填充,另外您也可以设置每个布局位置的渲染方式(RenderMode)和裁剪方式(CustomCrop)。
|
|
116
|
-
5、VideoParams.WaterMarkList:若您想要混流画面中叠加水印,可以通过VideoParams.WaterMarkList参数设置,支持图片水印和文字水印,支持透明通道。
|
|
117
|
-
6、SingleSubscribeParams:若您想要将TRTC房间中的一路单流推到CDN,可以使用SingleSubscribeParams参数设置,此时需要将WithTranscoding参数设置为0。
|
|
118
|
-
7、PublishCdnParams.N:若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1;若您有转推非腾讯云CDN的需求时,请联系腾讯云技术支持开通,转推非腾讯云会产生转推费用,费用说明请参考官网文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)。
|
|
119
|
-
8、FeedBackRoomParams.N:若您想要将混合的音视频流回推到TRTC房间,可以使用FeedBackRoomParams.N参数设置,支持最多同时推10路流回TRTC房间。您需要指定回推的TRTC房间号和机器人ID(UserId),机器人ID不能与普通用户ID冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。
|
|
120
|
-
9、SeiParams:若您想要混合的音视频流中增加SEI信息时,可以使用SeiParams参数设置,支持音量布局SEI和叠加转推请求中的SEI,其中音量布局SEI的内容是固定的json结构,具体请看本章节后续的SEI说明。您可以通过FollowIdr参数设置SEI跟随关键帧一起发送。音量布局sei的说明如下:
|
|
121
|
-
如果您的CDN观众端需要识别到参与混流的主播位置,以及需要识别到参与混流的主播的音量信息,可以通过音量布局sei实现。音量布局sei的payload内容及参数说明如下:
|
|
122
|
-
|
|
123
|
-
```
|
|
124
|
-
{
|
|
125
|
-
"app_data":"",
|
|
126
|
-
"canvas":{
|
|
127
|
-
"w":1080,
|
|
128
|
-
"h":960
|
|
129
|
-
},
|
|
130
|
-
"regions":[
|
|
131
|
-
{
|
|
132
|
-
"uid":"65949987242835883c",
|
|
133
|
-
"zorder":2,
|
|
134
|
-
"volume":45,
|
|
135
|
-
"x":270,
|
|
136
|
-
"y":480,
|
|
137
|
-
"w":540,
|
|
138
|
-
"h":480
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"uid":"659c9d8d242b328d31",
|
|
142
|
-
"zorder":2,
|
|
143
|
-
"volume":0,
|
|
144
|
-
"x":0,
|
|
145
|
-
"y":0,
|
|
146
|
-
"w":540,
|
|
147
|
-
"h":480
|
|
148
|
-
},
|
|
149
|
-
{
|
|
150
|
-
"uid":"64989a82272b308c",
|
|
151
|
-
"zorder":2,
|
|
152
|
-
"volume":91,
|
|
153
|
-
"x":540,
|
|
154
|
-
"y":0,
|
|
155
|
-
"w":540,
|
|
156
|
-
"h":480
|
|
157
|
-
}
|
|
158
|
-
],
|
|
159
|
-
"ver":"1.0",
|
|
160
|
-
"ts":1648544726
|
|
161
|
-
}
|
|
162
|
-
```
|
|
163
|
-
canvas:这个是混流信令中VideoEncode设置的宽高,即:混流输出的整个画布宽高。
|
|
164
|
-
regions:里面是真实混入的用户id和对应的子画面位置,若参与混流的用户未进入TRTC房间或者未开启视频上行,regions中不会包含该用户。
|
|
165
|
-
uid:代表参与混流的用户ID。
|
|
166
|
-
zorder:参与混流userid在混流输出的层级。
|
|
167
|
-
x/y:参与混流userid的子画面在画布的坐标。
|
|
168
|
-
w/h:参与混流userid的子画面的大小。
|
|
169
|
-
volume:代表混流用户的音量,取值范围为0-100,值越大,代表该用户参与混流时的音量越大。
|
|
170
|
-
ts:是输出sei的服务器本地秒级时戳。
|
|
171
|
-
ver:可以忽略。
|
|
87
|
+
* 接口说明:
|
|
88
|
+
启动一个混流转推任务,将 TRTC 房间的多路音视频流混成一路音视频流,编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后,会返回一个 SdkAppid 维度唯一的任务 Id(TaskId)。您需要保存该 TaskId,后续需要依赖此 TaskId 更新和结束任务。可以参考文档: [功能说明](https://cloud.tencent.com/document/product/647/84721#b9a855f4-e38c-4616-9b07-fc44e0e8282a) 和 [常见问题](https://cloud.tencent.com/document/product/647/62620)
|
|
172
89
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
5、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。
|
|
179
|
-
6、更新请求中必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增,否则会导致混流任务更新失败。
|
|
180
|
-
7、调用api时region选择说明:如果应用id是1400xxx时,region可填北京、上海、广州、香港,如果您的cdn观众主要在海外,请选择香港;如果应用id是200xxx或400xxx时,region请选择新加坡。
|
|
181
|
-
8、回推到TRTC房间的流不会参与其他回推房间任务的混流,满足下面条件之一时,可以参与其他转推cdn任务的混流: (1) 转推cdn任务在视频参数中通过具名方式指定推流机器人参与混流;(2) 转推cdn任务在音频参数中通过白名单方式指定推流机器人参与混流;(3) 转推cdn任务参与混流用户的房间号与回推机器人对应混流用户的房间号完全不同。
|
|
182
|
-
9、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。
|
|
90
|
+
注意:
|
|
91
|
+
您可以在控制台开通旁路转推回调功能,对转推 CDN 状态的事件进行监控,回调请参考文档:[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552)
|
|
92
|
+
您发起混流转推任务时,可能会产生如下费用:
|
|
93
|
+
MCU 混流转码费用,请参考文档:[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
|
|
94
|
+
转推非腾讯云 CDN 费用,请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
|
|
183
95
|
*/
|
|
184
96
|
async StartPublishCdnStream(req, cb) {
|
|
185
97
|
return this.request("StartPublishCdnStream", req, cb);
|
|
@@ -418,8 +330,9 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
418
330
|
return this.request("StopWebRecord", req, cb);
|
|
419
331
|
}
|
|
420
332
|
/**
|
|
421
|
-
|
|
422
|
-
|
|
333
|
+
* 接口说明:
|
|
334
|
+
停止指定的混流转推任务。如果没有调用 Stop 接口停止任务,所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后,任务也会自动停止。
|
|
335
|
+
*/
|
|
423
336
|
async StopPublishCdnStream(req, cb) {
|
|
424
337
|
return this.request("StopPublishCdnStream", req, cb);
|
|
425
338
|
}
|
|
@@ -571,8 +484,9 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
571
484
|
return this.request("DescribeAITranscription", req, cb);
|
|
572
485
|
}
|
|
573
486
|
/**
|
|
574
|
-
*
|
|
575
|
-
|
|
487
|
+
* 接口说明:
|
|
488
|
+
成功发起混流转推后,可以使用此接口来更新任务。仅在任务进行时有效,任务退出后更新将会返回错误。更新操作为增量更新模式。
|
|
489
|
+
注意:为了保障推流的稳定性,更新不支持任务在纯音频、音视频、纯视频之间进行切换。
|
|
576
490
|
*/
|
|
577
491
|
async UpdatePublishCdnStream(req, cb) {
|
|
578
492
|
return this.request("UpdatePublishCdnStream", req, cb);
|
|
@@ -614,6 +528,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
614
528
|
async DescribeTRTCMarketQualityData(req, cb) {
|
|
615
529
|
return this.request("DescribeTRTCMarketQualityData", req, cb);
|
|
616
530
|
}
|
|
531
|
+
/**
|
|
532
|
+
* 提供服务端控制机器人的功能
|
|
533
|
+
*/
|
|
534
|
+
async ControlAIConversation(req, cb) {
|
|
535
|
+
return this.request("ControlAIConversation", req, cb);
|
|
536
|
+
}
|
|
617
537
|
/**
|
|
618
538
|
* 停止AI转录任务。
|
|
619
539
|
*/
|
|
@@ -77,6 +77,19 @@ export interface AudioEncodeParams {
|
|
|
77
77
|
*/
|
|
78
78
|
Volume?: number;
|
|
79
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* 服务端控制AI对话机器人播报指定文本
|
|
82
|
+
*/
|
|
83
|
+
export interface ServerPushText {
|
|
84
|
+
/**
|
|
85
|
+
* 服务端推送播报文本
|
|
86
|
+
*/
|
|
87
|
+
Text?: string;
|
|
88
|
+
/**
|
|
89
|
+
* 是否允许该文本打断机器人说话
|
|
90
|
+
*/
|
|
91
|
+
Interrupt?: boolean;
|
|
92
|
+
}
|
|
80
93
|
/**
|
|
81
94
|
* DescribeTRTCMarketQualityMetricData返回参数结构体
|
|
82
95
|
*/
|
|
@@ -145,21 +158,41 @@ export interface MixLayout {
|
|
|
145
158
|
SubBackgroundImage?: string;
|
|
146
159
|
}
|
|
147
160
|
/**
|
|
148
|
-
*
|
|
161
|
+
* 混流转推的视频相关参数。
|
|
149
162
|
*/
|
|
150
|
-
export interface
|
|
163
|
+
export interface McuVideoParams {
|
|
151
164
|
/**
|
|
152
|
-
*
|
|
165
|
+
* 输出流视频编码参数。
|
|
153
166
|
*/
|
|
154
|
-
|
|
167
|
+
VideoEncode?: VideoEncode;
|
|
155
168
|
/**
|
|
156
|
-
*
|
|
169
|
+
* 混流布局参数。
|
|
157
170
|
*/
|
|
158
|
-
|
|
171
|
+
LayoutParams?: McuLayoutParams;
|
|
159
172
|
/**
|
|
160
|
-
*
|
|
173
|
+
* 整个画布背景颜色,常用的颜色有:
|
|
174
|
+
红色:0xcc0033。
|
|
175
|
+
黄色:0xcc9900。
|
|
176
|
+
绿色:0xcccc33。
|
|
177
|
+
蓝色:0x99CCFF。
|
|
178
|
+
黑色:0x000000。
|
|
179
|
+
白色:0xFFFFFF。
|
|
180
|
+
灰色:0x999999。
|
|
161
181
|
*/
|
|
162
|
-
|
|
182
|
+
BackGroundColor?: string;
|
|
183
|
+
/**
|
|
184
|
+
* 整个画布的背景图url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。
|
|
185
|
+
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。
|
|
186
|
+
*/
|
|
187
|
+
BackgroundImageUrl?: string;
|
|
188
|
+
/**
|
|
189
|
+
* 混流布局的水印参数。
|
|
190
|
+
*/
|
|
191
|
+
WaterMarkList?: Array<McuWaterMarkParams>;
|
|
192
|
+
/**
|
|
193
|
+
* 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。
|
|
194
|
+
*/
|
|
195
|
+
BackgroundRenderMode?: number;
|
|
163
196
|
}
|
|
164
197
|
/**
|
|
165
198
|
* DescribeTRTCRealTimeScaleData请求参数结构体
|
|
@@ -457,13 +490,13 @@ export interface DescribeTRTCRealTimeScaleMetricDataRequest {
|
|
|
457
490
|
RoomId?: string;
|
|
458
491
|
}
|
|
459
492
|
/**
|
|
460
|
-
*
|
|
493
|
+
* ControlAIConversation返回参数结构体
|
|
461
494
|
*/
|
|
462
|
-
export interface
|
|
495
|
+
export interface ControlAIConversationResponse {
|
|
463
496
|
/**
|
|
464
|
-
*
|
|
497
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
465
498
|
*/
|
|
466
|
-
|
|
499
|
+
RequestId?: string;
|
|
467
500
|
}
|
|
468
501
|
/**
|
|
469
502
|
* StopAITranscription请求参数结构体
|
|
@@ -978,43 +1011,6 @@ export interface DescribeRecordStatisticRequest {
|
|
|
978
1011
|
*/
|
|
979
1012
|
SdkAppId?: number;
|
|
980
1013
|
}
|
|
981
|
-
/**
|
|
982
|
-
* 混流转推的视频相关参数。
|
|
983
|
-
*/
|
|
984
|
-
export interface McuVideoParams {
|
|
985
|
-
/**
|
|
986
|
-
* 输出流视频编码参数。
|
|
987
|
-
*/
|
|
988
|
-
VideoEncode?: VideoEncode;
|
|
989
|
-
/**
|
|
990
|
-
* 混流布局参数。
|
|
991
|
-
*/
|
|
992
|
-
LayoutParams?: McuLayoutParams;
|
|
993
|
-
/**
|
|
994
|
-
* 整个画布背景颜色,常用的颜色有:
|
|
995
|
-
红色:0xcc0033。
|
|
996
|
-
黄色:0xcc9900。
|
|
997
|
-
绿色:0xcccc33。
|
|
998
|
-
蓝色:0x99CCFF。
|
|
999
|
-
黑色:0x000000。
|
|
1000
|
-
白色:0xFFFFFF。
|
|
1001
|
-
灰色:0x999999。
|
|
1002
|
-
*/
|
|
1003
|
-
BackGroundColor?: string;
|
|
1004
|
-
/**
|
|
1005
|
-
* 整个画布的背景图url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。
|
|
1006
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图将不会生效。
|
|
1007
|
-
*/
|
|
1008
|
-
BackgroundImageUrl?: string;
|
|
1009
|
-
/**
|
|
1010
|
-
* 混流布局的水印参数。
|
|
1011
|
-
*/
|
|
1012
|
-
WaterMarkList?: Array<McuWaterMarkParams>;
|
|
1013
|
-
/**
|
|
1014
|
-
* 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。
|
|
1015
|
-
*/
|
|
1016
|
-
BackgroundRenderMode?: number;
|
|
1017
|
-
}
|
|
1018
1014
|
/**
|
|
1019
1015
|
* DescribeRoomInfo请求参数结构体
|
|
1020
1016
|
*/
|
|
@@ -1414,17 +1410,29 @@ export interface DescribeRoomInfoResponse {
|
|
|
1414
1410
|
RequestId?: string;
|
|
1415
1411
|
}
|
|
1416
1412
|
/**
|
|
1417
|
-
*
|
|
1413
|
+
* 混流布局参数。
|
|
1418
1414
|
*/
|
|
1419
|
-
export interface
|
|
1415
|
+
export interface McuLayoutParams {
|
|
1420
1416
|
/**
|
|
1421
|
-
*
|
|
1417
|
+
* 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
|
|
1422
1418
|
*/
|
|
1423
|
-
|
|
1419
|
+
MixLayoutMode?: number;
|
|
1424
1420
|
/**
|
|
1425
|
-
*
|
|
1421
|
+
* 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
|
|
1426
1422
|
*/
|
|
1427
|
-
|
|
1423
|
+
PureAudioHoldPlaceMode?: number;
|
|
1424
|
+
/**
|
|
1425
|
+
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
1426
|
+
*/
|
|
1427
|
+
MixLayoutList?: Array<McuLayout>;
|
|
1428
|
+
/**
|
|
1429
|
+
* 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
|
|
1430
|
+
*/
|
|
1431
|
+
MaxVideoUser?: MaxVideoUser;
|
|
1432
|
+
/**
|
|
1433
|
+
* 屏幕分享模板、悬浮模板、九宫格模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底
|
|
1434
|
+
*/
|
|
1435
|
+
RenderMode?: number;
|
|
1428
1436
|
}
|
|
1429
1437
|
/**
|
|
1430
1438
|
* DescribeTRTCRealTimeQualityMetricData请求参数结构体
|
|
@@ -1522,6 +1530,84 @@ export interface DescribeAIConversationResponse {
|
|
|
1522
1530
|
*/
|
|
1523
1531
|
RequestId?: string;
|
|
1524
1532
|
}
|
|
1533
|
+
/**
|
|
1534
|
+
* 混流布局参数。
|
|
1535
|
+
*/
|
|
1536
|
+
export interface McuLayout {
|
|
1537
|
+
/**
|
|
1538
|
+
* 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
|
|
1539
|
+
*/
|
|
1540
|
+
UserMediaStream?: UserMediaStream;
|
|
1541
|
+
/**
|
|
1542
|
+
* 子画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1543
|
+
*/
|
|
1544
|
+
ImageWidth?: number;
|
|
1545
|
+
/**
|
|
1546
|
+
* 子画面在输出时的高度,单位为像素值,不填默认为0。
|
|
1547
|
+
*/
|
|
1548
|
+
ImageHeight?: number;
|
|
1549
|
+
/**
|
|
1550
|
+
* 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1551
|
+
*/
|
|
1552
|
+
LocationX?: number;
|
|
1553
|
+
/**
|
|
1554
|
+
* 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1555
|
+
*/
|
|
1556
|
+
LocationY?: number;
|
|
1557
|
+
/**
|
|
1558
|
+
* 子画面在输出时的层级,不填默认为0。
|
|
1559
|
+
*/
|
|
1560
|
+
ZOrder?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
|
|
1563
|
+
*/
|
|
1564
|
+
RenderMode?: number;
|
|
1565
|
+
/**
|
|
1566
|
+
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1567
|
+
红色:0xcc0033。
|
|
1568
|
+
黄色:0xcc9900。
|
|
1569
|
+
绿色:0xcccc33。
|
|
1570
|
+
蓝色:0x99CCFF。
|
|
1571
|
+
黑色:0x000000。
|
|
1572
|
+
白色:0xFFFFFF。
|
|
1573
|
+
灰色:0x999999。
|
|
1574
|
+
*/
|
|
1575
|
+
BackGroundColor?: string;
|
|
1576
|
+
/**
|
|
1577
|
+
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
|
|
1578
|
+
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。
|
|
1579
|
+
*/
|
|
1580
|
+
BackgroundImageUrl?: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* 客户自定义裁剪,针对原始输入流裁剪
|
|
1583
|
+
*/
|
|
1584
|
+
CustomCrop?: McuCustomCrop;
|
|
1585
|
+
/**
|
|
1586
|
+
* 子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。
|
|
1587
|
+
*/
|
|
1588
|
+
BackgroundRenderMode?: number;
|
|
1589
|
+
/**
|
|
1590
|
+
* 子画面的透明模版url,指向一张包含透明通道的模板图片。填写该参数,后台混流时会提取该模板图片的透明通道,将其缩放作为目标画面的透明通道,再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪(如圆角、星形、心形等)。 支持png格式。图片大小限制不超过5MB。
|
|
1591
|
+
注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。
|
|
1592
|
+
*/
|
|
1593
|
+
TransparentUrl?: string;
|
|
1594
|
+
/**
|
|
1595
|
+
* 子背景图的自定义渲染参数,当BackgroundRenderMode为4时必须配置。
|
|
1596
|
+
*/
|
|
1597
|
+
BackgroundCustomRender?: McuBackgroundCustomRender;
|
|
1598
|
+
/**
|
|
1599
|
+
* 子背景色生效模式,默认值为0表示均不生效。
|
|
1600
|
+
bit0:占位图缩放是否生效。
|
|
1601
|
+
bit1:上行流缩放是否生效。
|
|
1602
|
+
您可以将相应bit位置1启动生效,例如:
|
|
1603
|
+
0(00)表示子背景色不生效。
|
|
1604
|
+
1(01)表示子背景色只在占位图缩放时生效。
|
|
1605
|
+
2(10)表示子背景色只在上行流缩放时生效。
|
|
1606
|
+
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
|
|
1607
|
+
|
|
1608
|
+
*/
|
|
1609
|
+
BackGroundColorMode?: number;
|
|
1610
|
+
}
|
|
1525
1611
|
/**
|
|
1526
1612
|
* DescribeUserInfo返回参数结构体
|
|
1527
1613
|
*/
|
|
@@ -1776,82 +1862,21 @@ export interface StartStreamIngestRequest {
|
|
|
1776
1862
|
SeekSecond?: number;
|
|
1777
1863
|
}
|
|
1778
1864
|
/**
|
|
1779
|
-
*
|
|
1865
|
+
* DescribeRecordingUsage返回参数结构体
|
|
1780
1866
|
*/
|
|
1781
|
-
export interface
|
|
1782
|
-
/**
|
|
1783
|
-
* 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
|
|
1784
|
-
*/
|
|
1785
|
-
UserMediaStream?: UserMediaStream;
|
|
1786
|
-
/**
|
|
1787
|
-
* 子画面在输出时的宽度,单位为像素值,不填默认为0。
|
|
1788
|
-
*/
|
|
1789
|
-
ImageWidth?: number;
|
|
1790
|
-
/**
|
|
1791
|
-
* 子画面在输出时的高度,单位为像素值,不填默认为0。
|
|
1792
|
-
*/
|
|
1793
|
-
ImageHeight?: number;
|
|
1794
|
-
/**
|
|
1795
|
-
* 子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
|
|
1796
|
-
*/
|
|
1797
|
-
LocationX?: number;
|
|
1798
|
-
/**
|
|
1799
|
-
* 子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
|
|
1800
|
-
*/
|
|
1801
|
-
LocationY?: number;
|
|
1802
|
-
/**
|
|
1803
|
-
* 子画面在输出时的层级,不填默认为0。
|
|
1804
|
-
*/
|
|
1805
|
-
ZOrder?: number;
|
|
1806
|
-
/**
|
|
1807
|
-
* 子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
|
|
1808
|
-
*/
|
|
1809
|
-
RenderMode?: number;
|
|
1810
|
-
/**
|
|
1811
|
-
* 【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
|
|
1812
|
-
红色:0xcc0033。
|
|
1813
|
-
黄色:0xcc9900。
|
|
1814
|
-
绿色:0xcccc33。
|
|
1815
|
-
蓝色:0x99CCFF。
|
|
1816
|
-
黑色:0x000000。
|
|
1817
|
-
白色:0xFFFFFF。
|
|
1818
|
-
灰色:0x999999。
|
|
1819
|
-
*/
|
|
1820
|
-
BackGroundColor?: string;
|
|
1821
|
-
/**
|
|
1822
|
-
* 子画面的背景图url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
|
|
1823
|
-
注:您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,子画面的背景图将不会生效。
|
|
1824
|
-
*/
|
|
1825
|
-
BackgroundImageUrl?: string;
|
|
1826
|
-
/**
|
|
1827
|
-
* 客户自定义裁剪,针对原始输入流裁剪
|
|
1828
|
-
*/
|
|
1829
|
-
CustomCrop?: McuCustomCrop;
|
|
1830
|
-
/**
|
|
1831
|
-
* 子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。
|
|
1832
|
-
*/
|
|
1833
|
-
BackgroundRenderMode?: number;
|
|
1867
|
+
export interface DescribeRecordingUsageResponse {
|
|
1834
1868
|
/**
|
|
1835
|
-
*
|
|
1836
|
-
注:1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模版将不会生效。
|
|
1869
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
1837
1870
|
*/
|
|
1838
|
-
|
|
1871
|
+
UsageKey?: Array<string>;
|
|
1839
1872
|
/**
|
|
1840
|
-
*
|
|
1873
|
+
* 各个时间点用量明细。
|
|
1841
1874
|
*/
|
|
1842
|
-
|
|
1875
|
+
UsageList?: Array<TrtcUsage>;
|
|
1843
1876
|
/**
|
|
1844
|
-
*
|
|
1845
|
-
bit0:占位图缩放是否生效。
|
|
1846
|
-
bit1:上行流缩放是否生效。
|
|
1847
|
-
您可以将相应bit位置1启动生效,例如:
|
|
1848
|
-
0(00)表示子背景色不生效。
|
|
1849
|
-
1(01)表示子背景色只在占位图缩放时生效。
|
|
1850
|
-
2(10)表示子背景色只在上行流缩放时生效。
|
|
1851
|
-
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
|
|
1852
|
-
|
|
1877
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1853
1878
|
*/
|
|
1854
|
-
|
|
1879
|
+
RequestId?: string;
|
|
1855
1880
|
}
|
|
1856
1881
|
/**
|
|
1857
1882
|
* StopMCUMixTranscode请求参数结构体
|
|
@@ -2149,29 +2174,17 @@ export interface TRTCDataResult {
|
|
|
2149
2174
|
Total?: number;
|
|
2150
2175
|
}
|
|
2151
2176
|
/**
|
|
2152
|
-
*
|
|
2177
|
+
* DismissRoom请求参数结构体
|
|
2153
2178
|
*/
|
|
2154
|
-
export interface
|
|
2155
|
-
/**
|
|
2156
|
-
* 布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。
|
|
2157
|
-
*/
|
|
2158
|
-
MixLayoutMode?: number;
|
|
2159
|
-
/**
|
|
2160
|
-
* 纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
|
|
2161
|
-
*/
|
|
2162
|
-
PureAudioHoldPlaceMode?: number;
|
|
2163
|
-
/**
|
|
2164
|
-
* 自定义模板中有效,指定用户视频在混合画面中的位置。
|
|
2165
|
-
*/
|
|
2166
|
-
MixLayoutList?: Array<McuLayout>;
|
|
2179
|
+
export interface DismissRoomRequest {
|
|
2167
2180
|
/**
|
|
2168
|
-
*
|
|
2181
|
+
* TRTC的SDKAppId。
|
|
2169
2182
|
*/
|
|
2170
|
-
|
|
2183
|
+
SdkAppId: number;
|
|
2171
2184
|
/**
|
|
2172
|
-
*
|
|
2185
|
+
* 数字房间号。本接口仅支持解散数字类型房间号,如需解散字符串类型房间号,请使用DismissRoomByStrRoomId。
|
|
2173
2186
|
*/
|
|
2174
|
-
|
|
2187
|
+
RoomId: number;
|
|
2175
2188
|
}
|
|
2176
2189
|
/**
|
|
2177
2190
|
* DescribeUnusualEvent请求参数结构体
|
|
@@ -2855,6 +2868,31 @@ export interface TRTCDataResp {
|
|
|
2855
2868
|
*/
|
|
2856
2869
|
Total: number;
|
|
2857
2870
|
}
|
|
2871
|
+
/**
|
|
2872
|
+
* 录制视频转码参数。
|
|
2873
|
+
*/
|
|
2874
|
+
export interface VideoParams {
|
|
2875
|
+
/**
|
|
2876
|
+
* 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
|
|
2877
|
+
*/
|
|
2878
|
+
Width: number;
|
|
2879
|
+
/**
|
|
2880
|
+
* 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
|
|
2881
|
+
*/
|
|
2882
|
+
Height: number;
|
|
2883
|
+
/**
|
|
2884
|
+
* 视频的帧率,范围[1, 60],默认15。
|
|
2885
|
+
*/
|
|
2886
|
+
Fps: number;
|
|
2887
|
+
/**
|
|
2888
|
+
* 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
|
|
2889
|
+
*/
|
|
2890
|
+
BitRate: number;
|
|
2891
|
+
/**
|
|
2892
|
+
* 视频关键帧时间间隔,单位秒,默认值10秒。
|
|
2893
|
+
*/
|
|
2894
|
+
Gop: number;
|
|
2895
|
+
}
|
|
2858
2896
|
/**
|
|
2859
2897
|
* DescribePicture返回参数结构体
|
|
2860
2898
|
*/
|
|
@@ -2963,6 +3001,25 @@ export interface DescribeScaleInfoRequest {
|
|
|
2963
3001
|
*/
|
|
2964
3002
|
EndTime: number;
|
|
2965
3003
|
}
|
|
3004
|
+
/**
|
|
3005
|
+
* ControlAIConversation请求参数结构体
|
|
3006
|
+
*/
|
|
3007
|
+
export interface ControlAIConversationRequest {
|
|
3008
|
+
/**
|
|
3009
|
+
* 任务唯一标识
|
|
3010
|
+
*/
|
|
3011
|
+
TaskId: string;
|
|
3012
|
+
/**
|
|
3013
|
+
* 控制命令,目前支持命令如下:
|
|
3014
|
+
|
|
3015
|
+
- ServerPushText,服务端发送文本给AI机器人,AI机器人会播报该文本
|
|
3016
|
+
*/
|
|
3017
|
+
Command: string;
|
|
3018
|
+
/**
|
|
3019
|
+
* 服务端发送播报文本命令,当Command为ServerPushText时必填
|
|
3020
|
+
*/
|
|
3021
|
+
ServerPushText?: ServerPushText;
|
|
3022
|
+
}
|
|
2966
3023
|
/**
|
|
2967
3024
|
* DismissRoomByStrRoomId返回参数结构体
|
|
2968
3025
|
*/
|
|
@@ -3203,7 +3260,7 @@ export interface UpdatePublishCdnStreamRequest {
|
|
|
3203
3260
|
*/
|
|
3204
3261
|
WithTranscoding: number;
|
|
3205
3262
|
/**
|
|
3206
|
-
*
|
|
3263
|
+
* 更新相关参数,只支持更新参与混音的主播列表参数,不支持更新Codec、采样率、码率和声道数。不填表示不更新此参数。
|
|
3207
3264
|
*/
|
|
3208
3265
|
AudioParams?: McuAudioParams;
|
|
3209
3266
|
/**
|
|
@@ -3321,29 +3378,13 @@ export interface DeletePictureRequest {
|
|
|
3321
3378
|
SdkAppId: number;
|
|
3322
3379
|
}
|
|
3323
3380
|
/**
|
|
3324
|
-
*
|
|
3381
|
+
* StopWebRecord请求参数结构体
|
|
3325
3382
|
*/
|
|
3326
|
-
export interface
|
|
3327
|
-
/**
|
|
3328
|
-
* 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。
|
|
3329
|
-
*/
|
|
3330
|
-
Width: number;
|
|
3331
|
-
/**
|
|
3332
|
-
* 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。
|
|
3333
|
-
*/
|
|
3334
|
-
Height: number;
|
|
3335
|
-
/**
|
|
3336
|
-
* 视频的帧率,范围[1, 60],默认15。
|
|
3337
|
-
*/
|
|
3338
|
-
Fps: number;
|
|
3339
|
-
/**
|
|
3340
|
-
* 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。
|
|
3341
|
-
*/
|
|
3342
|
-
BitRate: number;
|
|
3383
|
+
export interface StopWebRecordRequest {
|
|
3343
3384
|
/**
|
|
3344
|
-
*
|
|
3385
|
+
* 需要停止的任务Id
|
|
3345
3386
|
*/
|
|
3346
|
-
|
|
3387
|
+
TaskId: string;
|
|
3347
3388
|
}
|
|
3348
3389
|
/**
|
|
3349
3390
|
* 混流SEI参数
|