tencentcloud-sdk-nodejs-trtc 4.0.384 → 4.0.387

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.
@@ -18,15 +18,17 @@
18
18
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
19
19
  import {
20
20
  DescribeAbnormalEventResponse,
21
+ SdkAppIdRecordUsage,
22
+ EncodeParams,
21
23
  DescribeAbnormalEventRequest,
22
- SdkAppIdTrtcMcuTranscodeTimeUsage,
24
+ DescribeScaleInfoRequest,
23
25
  ModifyPictureResponse,
24
26
  StartMCUMixTranscodeByStrRoomIdRequest,
25
27
  LayoutParams,
26
- TimeValue,
28
+ DescribeScaleInfoResponse,
27
29
  CreatePictureRequest,
28
30
  DescribeTrtcMcuTranscodeTimeRequest,
29
- StopMCUMixTranscodeResponse,
31
+ SdkAppIdTrtcMcuTranscodeTimeUsage,
30
32
  RemoveUserByStrRoomIdRequest,
31
33
  DismissRoomResponse,
32
34
  EventMessage,
@@ -36,41 +38,50 @@ import {
36
38
  ScaleInfomation,
37
39
  DescribeUserInformationResponse,
38
40
  SdkAppIdNewTrtcTimeUsage,
39
- EncodeParams,
41
+ DescribeTrtcMcuTranscodeTimeResponse,
40
42
  RemoveUserByStrRoomIdResponse,
41
43
  StartMCUMixTranscodeRequest,
42
44
  StopMCUMixTranscodeRequest,
43
- UserInformation,
45
+ DescribeCallDetailInfoResponse,
46
+ DescribeUserEventRequest,
44
47
  DescribeHistoryScaleRequest,
45
48
  DeletePictureRequest,
46
49
  TrtcTimeNewUsage,
47
50
  DescribeRoomInformationResponse,
48
51
  RecordUsage,
49
52
  RemoveUserRequest,
50
- OutputParams,
53
+ DescribeRoomInfoRequest,
51
54
  DescribeExternalTrtcMeasureRequest,
52
55
  ModifyPictureRequest,
56
+ TimeValue,
53
57
  StopMCUMixTranscodeByStrRoomIdRequest,
58
+ OutputParams,
54
59
  QualityData,
55
60
  AbnormalEvent,
56
61
  StopMCUMixTranscodeByStrRoomIdResponse,
57
62
  DeletePictureResponse,
58
63
  EventList,
64
+ DescribeRoomInfoResponse,
59
65
  DismissRoomRequest,
60
66
  DescribeDetailEventResponse,
61
67
  DismissRoomByStrRoomIdRequest,
68
+ UserInformation,
62
69
  DescribeExternalTrtcMeasureResponse,
63
- OneSdkAppIdTranscodeTimeUsagesInfo,
64
- DescribeTrtcMcuTranscodeTimeResponse,
70
+ DescribeUserEventResponse,
71
+ DescribeCallDetailInfoRequest,
65
72
  DescribePictureRequest,
66
- SdkAppIdRecordUsage,
73
+ DescribeUnusualEventRequest,
74
+ DescribeUserInfoResponse,
67
75
  SmallVideoLayoutParams,
68
76
  RemoveUserResponse,
69
77
  PresetLayoutConfig,
78
+ StopMCUMixTranscodeResponse,
70
79
  DescribeCallDetailResponse,
80
+ OneSdkAppIdTranscodeTimeUsagesInfo,
71
81
  DescribePictureResponse,
72
82
  PublishCdnParams,
73
83
  DescribeRoomInformationRequest,
84
+ DescribeUserInfoRequest,
74
85
  DescribeDetailEventRequest,
75
86
  AbnormalExperience,
76
87
  StartMCUMixTranscodeResponse,
@@ -80,6 +91,7 @@ import {
80
91
  DescribeRecordStatisticResponse,
81
92
  DismissRoomByStrRoomIdResponse,
82
93
  DescribeHistoryScaleResponse,
94
+ DescribeUnusualEventResponse,
83
95
  StartMCUMixTranscodeByStrRoomIdResponse,
84
96
  PictureInfo,
85
97
  } from "./trtc_models"
@@ -94,48 +106,20 @@ export class Client extends TencentCloudCommon.AbstractClient {
94
106
  }
95
107
 
96
108
  /**
97
- * 查询云端录制计费时长。
98
-
99
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
100
- - 单次查询统计区间最多不能超过31天。
101
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
102
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
103
- */
104
- async DescribeRecordStatistic(
105
- req: DescribeRecordStatisticRequest,
106
- cb?: (error: string, rep: DescribeRecordStatisticResponse) => void
107
- ): Promise<DescribeRecordStatisticResponse> {
108
- return this.request("DescribeRecordStatistic", req, cb)
109
- }
110
-
111
- /**
112
- * 查询旁路转码计费时长。
113
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
114
- - 单次查询统计区间最多不能超过31天。
115
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
116
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
117
- */
118
- async DescribeTrtcMcuTranscodeTime(
119
- req: DescribeTrtcMcuTranscodeTimeRequest,
120
- cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void
121
- ): Promise<DescribeTrtcMcuTranscodeTimeResponse> {
122
- return this.request("DescribeTrtcMcuTranscodeTime", req, cb)
123
- }
124
-
125
- /**
126
- * 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。
109
+ * 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。(同老接口DescribeRoomInformation)
110
+ **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
127
111
  */
128
- async DescribeHistoryScale(
129
- req: DescribeHistoryScaleRequest,
130
- cb?: (error: string, rep: DescribeHistoryScaleResponse) => void
131
- ): Promise<DescribeHistoryScaleResponse> {
132
- return this.request("DescribeHistoryScale", req, cb)
112
+ async DescribeRoomInfo(
113
+ req: DescribeRoomInfoRequest,
114
+ cb?: (error: string, rep: DescribeRoomInfoResponse) => void
115
+ ): Promise<DescribeRoomInfoResponse> {
116
+ return this.request("DescribeRoomInfo", req, cb)
133
117
  }
134
118
 
135
119
  /**
136
120
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
137
121
 
138
- TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
122
+ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
139
123
 
140
124
  您可以通过此接口实现如下目标:
141
125
  - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
@@ -147,7 +131,7 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
147
131
  - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
148
132
  - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
149
133
  - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
150
- - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
134
+ - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
151
135
  - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
152
136
 
153
137
  注意:
@@ -155,71 +139,73 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
155
139
  2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
156
140
  3、客户端混流和服务端混流不能混用。
157
141
  */
158
- async StartMCUMixTranscodeByStrRoomId(
159
- req: StartMCUMixTranscodeByStrRoomIdRequest,
160
- cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void
161
- ): Promise<StartMCUMixTranscodeByStrRoomIdResponse> {
162
- return this.request("StartMCUMixTranscodeByStrRoomId", req, cb)
142
+ async StartMCUMixTranscode(
143
+ req: StartMCUMixTranscodeRequest,
144
+ cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void
145
+ ): Promise<StartMCUMixTranscodeResponse> {
146
+ return this.request("StartMCUMixTranscode", req, cb)
163
147
  }
164
148
 
165
149
  /**
166
- * 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据
150
+ * 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
151
+ **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
167
152
  */
168
- async DescribeExternalTrtcMeasure(
169
- req: DescribeExternalTrtcMeasureRequest,
170
- cb?: (error: string, rep: DescribeExternalTrtcMeasureResponse) => void
171
- ): Promise<DescribeExternalTrtcMeasureResponse> {
172
- return this.request("DescribeExternalTrtcMeasure", req, cb)
153
+ async DescribeRoomInformation(
154
+ req: DescribeRoomInformationRequest,
155
+ cb?: (error: string, rep: DescribeRoomInformationResponse) => void
156
+ ): Promise<DescribeRoomInformationResponse> {
157
+ return this.request("DescribeRoomInformation", req, cb)
173
158
  }
174
159
 
175
160
  /**
176
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
161
+ * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
162
+ **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
177
163
  */
178
- async DeletePicture(
179
- req: DeletePictureRequest,
180
- cb?: (error: string, rep: DeletePictureResponse) => void
181
- ): Promise<DeletePictureResponse> {
182
- return this.request("DeletePicture", req, cb)
164
+ async DescribeCallDetailInfo(
165
+ req: DescribeCallDetailInfoRequest,
166
+ cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void
167
+ ): Promise<DescribeCallDetailInfoResponse> {
168
+ return this.request("DescribeCallDetailInfo", req, cb)
183
169
  }
184
170
 
185
171
  /**
186
172
  * 接口说明:结束云端混流
187
173
  */
188
- async StopMCUMixTranscodeByStrRoomId(
189
- req: StopMCUMixTranscodeByStrRoomIdRequest,
190
- cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void
191
- ): Promise<StopMCUMixTranscodeByStrRoomIdResponse> {
192
- return this.request("StopMCUMixTranscodeByStrRoomId", req, cb)
174
+ async StopMCUMixTranscode(
175
+ req: StopMCUMixTranscodeRequest,
176
+ cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void
177
+ ): Promise<StopMCUMixTranscodeResponse> {
178
+ return this.request("StopMCUMixTranscode", req, cb)
193
179
  }
194
180
 
195
181
  /**
196
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
182
+ * 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数
197
183
  */
198
- async CreatePicture(
199
- req: CreatePictureRequest,
200
- cb?: (error: string, rep: CreatePictureResponse) => void
201
- ): Promise<CreatePictureResponse> {
202
- return this.request("CreatePicture", req, cb)
184
+ async DescribeHistoryScale(
185
+ req: DescribeHistoryScaleRequest,
186
+ cb?: (error: string, rep: DescribeHistoryScaleResponse) => void
187
+ ): Promise<DescribeHistoryScaleResponse> {
188
+ return this.request("DescribeHistoryScale", req, cb)
203
189
  }
204
190
 
205
191
  /**
206
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
192
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
207
193
  */
208
- async DescribePicture(
209
- req: DescribePictureRequest,
210
- cb?: (error: string, rep: DescribePictureResponse) => void
211
- ): Promise<DescribePictureResponse> {
212
- return this.request("DescribePicture", req, cb)
194
+ async DeletePicture(
195
+ req: DeletePictureRequest,
196
+ cb?: (error: string, rep: DeletePictureResponse) => void
197
+ ): Promise<DeletePictureResponse> {
198
+ return this.request("DeletePicture", req, cb)
213
199
  }
214
200
 
215
201
  /**
216
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
202
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
217
203
  */
218
- async ModifyPicture(
219
- req: ModifyPictureRequest,
220
- cb?: (error: string, rep: ModifyPictureResponse) => void
221
- ): Promise<ModifyPictureResponse> {
222
- return this.request("ModifyPicture", req, cb)
204
+ async CreatePicture(
205
+ req: CreatePictureRequest,
206
+ cb?: (error: string, rep: CreatePictureResponse) => void
207
+ ): Promise<CreatePictureResponse> {
208
+ return this.request("CreatePicture", req, cb)
223
209
  }
224
210
 
225
211
  /**
@@ -233,17 +219,7 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
233
219
  }
234
220
 
235
221
  /**
236
- * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
237
- */
238
- async DescribeDetailEvent(
239
- req: DescribeDetailEventRequest,
240
- cb?: (error: string, rep: DescribeDetailEventResponse) => void
241
- ): Promise<DescribeDetailEventResponse> {
242
- return this.request("DescribeDetailEvent", req, cb)
243
- }
244
-
245
- /**
246
- * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
222
+ * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
247
223
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
248
224
  */
249
225
  async DescribeCallDetail(
@@ -254,60 +230,91 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
254
230
  }
255
231
 
256
232
  /**
257
- * 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
233
+ * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
258
234
  */
259
- async DismissRoomByStrRoomId(
260
- req: DismissRoomByStrRoomIdRequest,
261
- cb?: (error: string, rep: DismissRoomByStrRoomIdResponse) => void
262
- ): Promise<DismissRoomByStrRoomIdResponse> {
263
- return this.request("DismissRoomByStrRoomId", req, cb)
235
+ async DescribeUserEvent(
236
+ req: DescribeUserEventRequest,
237
+ cb?: (error: string, rep: DescribeUserEventResponse) => void
238
+ ): Promise<DescribeUserEventResponse> {
239
+ return this.request("DescribeUserEvent", req, cb)
264
240
  }
265
241
 
266
242
  /**
267
- * 查询SDKAppID下用户的异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询15天内数据,查询起止时间不超过1个小时。支持跨天查询。异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
243
+ * 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据
268
244
  */
269
- async DescribeAbnormalEvent(
270
- req: DescribeAbnormalEventRequest,
271
- cb?: (error: string, rep: DescribeAbnormalEventResponse) => void
272
- ): Promise<DescribeAbnormalEventResponse> {
273
- return this.request("DescribeAbnormalEvent", req, cb)
245
+ async DescribeExternalTrtcMeasure(
246
+ req: DescribeExternalTrtcMeasureRequest,
247
+ cb?: (error: string, rep: DescribeExternalTrtcMeasureResponse) => void
248
+ ): Promise<DescribeExternalTrtcMeasureResponse> {
249
+ return this.request("DescribeExternalTrtcMeasure", req, cb)
274
250
  }
275
251
 
276
252
  /**
277
- * 接口说明:结束云端混流
253
+ * 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
278
254
  */
279
- async StopMCUMixTranscode(
280
- req: StopMCUMixTranscodeRequest,
281
- cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void
282
- ): Promise<StopMCUMixTranscodeResponse> {
283
- return this.request("StopMCUMixTranscode", req, cb)
255
+ async DescribeScaleInfo(
256
+ req: DescribeScaleInfoRequest,
257
+ cb?: (error: string, rep: DescribeScaleInfoResponse) => void
258
+ ): Promise<DescribeScaleInfoResponse> {
259
+ return this.request("DescribeScaleInfo", req, cb)
260
+ }
261
+
262
+ /**
263
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
264
+ */
265
+ async ModifyPicture(
266
+ req: ModifyPictureRequest,
267
+ cb?: (error: string, rep: ModifyPictureResponse) => void
268
+ ): Promise<ModifyPictureResponse> {
269
+ return this.request("ModifyPicture", req, cb)
284
270
  }
285
271
 
286
272
  /**
287
- * 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
273
+ * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
288
274
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
289
275
  */
290
- async DescribeRoomInformation(
291
- req: DescribeRoomInformationRequest,
292
- cb?: (error: string, rep: DescribeRoomInformationResponse) => void
293
- ): Promise<DescribeRoomInformationResponse> {
294
- return this.request("DescribeRoomInformation", req, cb)
276
+ async DescribeUserInfo(
277
+ req: DescribeUserInfoRequest,
278
+ cb?: (error: string, rep: DescribeUserInfoResponse) => void
279
+ ): Promise<DescribeUserInfoResponse> {
280
+ return this.request("DescribeUserInfo", req, cb)
295
281
  }
296
282
 
297
283
  /**
298
- * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
284
+ * 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
299
285
  */
300
- async RemoveUserByStrRoomId(
301
- req: RemoveUserByStrRoomIdRequest,
302
- cb?: (error: string, rep: RemoveUserByStrRoomIdResponse) => void
303
- ): Promise<RemoveUserByStrRoomIdResponse> {
304
- return this.request("RemoveUserByStrRoomId", req, cb)
286
+ async DismissRoomByStrRoomId(
287
+ req: DismissRoomByStrRoomIdRequest,
288
+ cb?: (error: string, rep: DismissRoomByStrRoomIdResponse) => void
289
+ ): Promise<DismissRoomByStrRoomIdResponse> {
290
+ return this.request("DismissRoomByStrRoomId", req, cb)
291
+ }
292
+
293
+ /**
294
+ * 接口说明:结束云端混流
295
+ */
296
+ async StopMCUMixTranscodeByStrRoomId(
297
+ req: StopMCUMixTranscodeByStrRoomIdRequest,
298
+ cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void
299
+ ): Promise<StopMCUMixTranscodeByStrRoomIdResponse> {
300
+ return this.request("StopMCUMixTranscodeByStrRoomId", req, cb)
301
+ }
302
+
303
+ /**
304
+ * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。
305
+ 异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
306
+ */
307
+ async DescribeAbnormalEvent(
308
+ req: DescribeAbnormalEventRequest,
309
+ cb?: (error: string, rep: DescribeAbnormalEventResponse) => void
310
+ ): Promise<DescribeAbnormalEventResponse> {
311
+ return this.request("DescribeAbnormalEvent", req, cb)
305
312
  }
306
313
 
307
314
  /**
308
315
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
309
316
 
310
- TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
317
+ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
311
318
 
312
319
  您可以通过此接口实现如下目标:
313
320
  - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
@@ -319,7 +326,7 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
319
326
  - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
320
327
  - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
321
328
  - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
322
- - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
329
+ - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
323
330
  - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
324
331
 
325
332
  注意:
@@ -327,11 +334,21 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
327
334
  2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
328
335
  3、客户端混流和服务端混流不能混用。
329
336
  */
330
- async StartMCUMixTranscode(
331
- req: StartMCUMixTranscodeRequest,
332
- cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void
333
- ): Promise<StartMCUMixTranscodeResponse> {
334
- return this.request("StartMCUMixTranscode", req, cb)
337
+ async StartMCUMixTranscodeByStrRoomId(
338
+ req: StartMCUMixTranscodeByStrRoomIdRequest,
339
+ cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void
340
+ ): Promise<StartMCUMixTranscodeByStrRoomIdResponse> {
341
+ return this.request("StartMCUMixTranscodeByStrRoomId", req, cb)
342
+ }
343
+
344
+ /**
345
+ * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
346
+ */
347
+ async RemoveUserByStrRoomId(
348
+ req: RemoveUserByStrRoomIdRequest,
349
+ cb?: (error: string, rep: RemoveUserByStrRoomIdResponse) => void
350
+ ): Promise<RemoveUserByStrRoomIdResponse> {
351
+ return this.request("RemoveUserByStrRoomId", req, cb)
335
352
  }
336
353
 
337
354
  /**
@@ -344,6 +361,66 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
344
361
  return this.request("DismissRoom", req, cb)
345
362
  }
346
363
 
364
+ /**
365
+ * 查询云端录制计费时长。
366
+
367
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
368
+ - 单次查询统计区间最多不能超过31天。
369
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
370
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
371
+ */
372
+ async DescribeRecordStatistic(
373
+ req: DescribeRecordStatisticRequest,
374
+ cb?: (error: string, rep: DescribeRecordStatisticResponse) => void
375
+ ): Promise<DescribeRecordStatisticResponse> {
376
+ return this.request("DescribeRecordStatistic", req, cb)
377
+ }
378
+
379
+ /**
380
+ * 查询旁路转码计费时长。
381
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
382
+ - 单次查询统计区间最多不能超过31天。
383
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
384
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
385
+ */
386
+ async DescribeTrtcMcuTranscodeTime(
387
+ req: DescribeTrtcMcuTranscodeTimeRequest,
388
+ cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void
389
+ ): Promise<DescribeTrtcMcuTranscodeTimeResponse> {
390
+ return this.request("DescribeTrtcMcuTranscodeTime", req, cb)
391
+ }
392
+
393
+ /**
394
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
395
+ */
396
+ async DescribePicture(
397
+ req: DescribePictureRequest,
398
+ cb?: (error: string, rep: DescribePictureResponse) => void
399
+ ): Promise<DescribePictureResponse> {
400
+ return this.request("DescribePicture", req, cb)
401
+ }
402
+
403
+ /**
404
+ * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
405
+ */
406
+ async DescribeDetailEvent(
407
+ req: DescribeDetailEventRequest,
408
+ cb?: (error: string, rep: DescribeDetailEventResponse) => void
409
+ ): Promise<DescribeDetailEventResponse> {
410
+ return this.request("DescribeDetailEvent", req, cb)
411
+ }
412
+
413
+ /**
414
+ * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
415
+ 异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
416
+ */
417
+ async DescribeUnusualEvent(
418
+ req: DescribeUnusualEventRequest,
419
+ cb?: (error: string, rep: DescribeUnusualEventResponse) => void
420
+ ): Promise<DescribeUnusualEventResponse> {
421
+ return this.request("DescribeUnusualEvent", req, cb)
422
+ }
423
+
347
424
  /**
348
425
  * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
349
426
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。