tencentcloud-sdk-nodejs-trtc 4.0.459 → 4.0.461
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +405 -0
- package/SERVICE_CHANGELOG.md +460 -47
- package/package.json +1 -1
- package/products.md +19 -19
- package/src/services/trtc/v20190722/trtc_client.ts +205 -62
- package/src/services/trtc/v20190722/trtc_models.ts +858 -84
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +107 -40
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +127 -46
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +772 -115
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreatePictureRequest,
|
|
2
|
+
import { CreatePictureRequest, DescribeRelayUsageRequest, RemoveUserByStrRoomIdResponse, DescribeUserEventRequest, StopPublishCdnStreamResponse, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeMixTranscodingUsageRequest, ModifyPictureRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, UpdatePublishCdnStreamRequest, DescribeUserInfoResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DescribeRelayUsageResponse, DescribeRecordingUsageResponse, StopMCUMixTranscodeRequest, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopPublishCdnStreamRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StartPublishCdnStreamRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
|
|
3
3
|
/**
|
|
4
4
|
* trtc client
|
|
5
5
|
* @class
|
|
@@ -13,10 +13,53 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
13
13
|
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
14
14
|
*/
|
|
15
15
|
DescribeRoomInfo(req: DescribeRoomInfoRequest, cb?: (error: string, rep: DescribeRoomInfoResponse) => void): Promise<DescribeRoomInfoResponse>;
|
|
16
|
+
/**
|
|
17
|
+
* 获取TRTC音视频互动的用量明细。
|
|
18
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
19
|
+
- 单次查询统计区间最多不能超过31天。
|
|
20
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
21
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
22
|
+
- 默认接口请求频率限制:5次/秒。
|
|
23
|
+
*/
|
|
24
|
+
DescribeTrtcUsage(req: DescribeTrtcUsageRequest, cb?: (error: string, rep: DescribeTrtcUsageResponse) => void): Promise<DescribeTrtcUsageResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* 接口说明:启动旁路以及混流转推任务。TRTC 的房间中可能会同时存在多路音视频流,您可以通过此API接口,实现以下几种效果:
|
|
27
|
+
1、支持将单个主播的音视频流发布(也称作“转推”)到直播CDN上,请参考示例2(发起单流音视频旁路转推)和示例3(发起单流纯音频旁路转推)。
|
|
28
|
+
2、支持将同个房间多个主播或者不同房间多个主播的音视频混合成1路后再发布到直播CDN上,您可以通过AudioParams.SubscribeAudioList和VideoParams.LayoutParams调整参与混音的用户列表以及指定各路混流画面的布局位置。请参考示例1(发起混流转推)。
|
|
29
|
+
3、支持预先设置一个房间的混流模板,将该房间中的多个音视频混合成1路发布到直播CDN,腾讯云后台实时监控TRTC房间中的主播变化,自动按照混流模板调整布局。目前已经支持了如下几种混流预设模板:
|
|
30
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面。
|
|
31
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小,最多支持16个画面。
|
|
32
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
33
|
+
4、支持同时将音视频流发布到最多10个直播CDN上。您可以通过PublishCdnParams.PublishCdnUrl指定转推CDN的url,如果您想转推到腾讯云CDN,PublishCdnParams.IsTencentCdn填为1。
|
|
34
|
+
5、支持通过配置服务端回调,实时将转推状态以HTTP/HTTPS POST 请求发送给您的服务器,如果您需要接入转推事件回调,请联系腾讯云技术支持。
|
|
35
|
+
注意:
|
|
36
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转推计费说明](https://intl.cloud.tencent.com/zh/document/product/647/47631)。**
|
|
37
|
+
2、**转推非腾讯云CDN将产生云端转推费用,详见[云端混流转推计费说明](https://intl.cloud.tencent.com/zh/document/product/647/47631)。**
|
|
38
|
+
|
|
39
|
+
其他使用说明如下:
|
|
40
|
+
1、使用混流转推接口时,您需要先调用启动转推任务接口(StartPublishCdnStream),获取启动转推任务响应中的任务ID标识(TaskId)。后续传入任务ID标识(TaskId)来更新转推任务(UpdatePublishCdnStream)和停止转推任务(StopPublishCdnStream)。
|
|
41
|
+
2、为了确保转推链接的稳定,同一个转推任务不支持纯音频、音视频、纯视频之间的切换。
|
|
42
|
+
3、为了确保转推链接的稳定,更新转推任务接口(UpdatePublishCdnStream)不支持时更改视频参数(codec)和音频参数(codec、采样率、码率、声道数)。
|
|
43
|
+
4、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。
|
|
44
|
+
5、更新转推任务(UpdatePublishCdnStream)必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增:腾讯云返回InternalError错误码时,需重试请求(不换SequenceNumber);腾讯云返回FailedOperation.OutdateRequest过期错误码时,无需处理即可。
|
|
45
|
+
6、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。
|
|
46
|
+
*/
|
|
47
|
+
StartPublishCdnStream(req: StartPublishCdnStreamRequest, cb?: (error: string, rep: StartPublishCdnStreamResponse) => void): Promise<StartPublishCdnStreamResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
50
|
+
**注意**:
|
|
51
|
+
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
52
|
+
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
53
|
+
*/
|
|
54
|
+
DescribeCallDetailInfo(req: DescribeCallDetailInfoRequest, cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void): Promise<DescribeCallDetailInfoResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* 接口说明:结束云端混流
|
|
57
|
+
*/
|
|
58
|
+
StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
|
|
16
59
|
/**
|
|
17
60
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
18
61
|
|
|
19
|
-
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API
|
|
62
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
|
|
20
63
|
|
|
21
64
|
您可以通过此接口实现如下目标:
|
|
22
65
|
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
@@ -28,7 +71,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
28
71
|
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
29
72
|
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
30
73
|
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
31
|
-
-
|
|
74
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
32
75
|
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
33
76
|
|
|
34
77
|
注意:
|
|
@@ -36,18 +79,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
36
79
|
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
37
80
|
3、客户端混流和服务端混流不能混用。
|
|
38
81
|
*/
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
42
|
-
**注意**:
|
|
43
|
-
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
44
|
-
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
45
|
-
*/
|
|
46
|
-
DescribeCallDetailInfo(req: DescribeCallDetailInfoRequest, cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void): Promise<DescribeCallDetailInfoResponse>;
|
|
47
|
-
/**
|
|
48
|
-
* 接口说明:结束云端混流
|
|
49
|
-
*/
|
|
50
|
-
StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
|
|
82
|
+
StartMCUMixTranscodeByStrRoomId(req: StartMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StartMCUMixTranscodeByStrRoomIdResponse>;
|
|
51
83
|
/**
|
|
52
84
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
53
85
|
*/
|
|
@@ -68,6 +100,30 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
68
100
|
* 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
|
|
69
101
|
*/
|
|
70
102
|
DescribeUserEvent(req: DescribeUserEventRequest, cb?: (error: string, rep: DescribeUserEventResponse) => void): Promise<DescribeUserEventResponse>;
|
|
103
|
+
/**
|
|
104
|
+
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
105
|
+
|
|
106
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
107
|
+
|
|
108
|
+
您可以通过此接口实现如下目标:
|
|
109
|
+
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
110
|
+
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
111
|
+
- 设置录制文件名,用于二次回放。
|
|
112
|
+
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
113
|
+
|
|
114
|
+
目前已经支持了如下几种布局模板:
|
|
115
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
116
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
117
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
118
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
|
|
119
|
+
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
120
|
+
|
|
121
|
+
注意:
|
|
122
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
123
|
+
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
124
|
+
3、客户端混流和服务端混流不能混用。
|
|
125
|
+
*/
|
|
126
|
+
StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
|
|
71
127
|
/**
|
|
72
128
|
* 接口说明:
|
|
73
129
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
|
|
@@ -92,9 +148,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
92
148
|
*/
|
|
93
149
|
DescribeScaleInfo(req: DescribeScaleInfoRequest, cb?: (error: string, rep: DescribeScaleInfoResponse) => void): Promise<DescribeScaleInfoResponse>;
|
|
94
150
|
/**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
151
|
+
* 获取TRTC旁路转推的用量明细。
|
|
152
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
153
|
+
- 单次查询统计区间最多不能超过31天。
|
|
154
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
155
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
156
|
+
- 默认接口请求频率限制:5次/秒。
|
|
157
|
+
*/
|
|
158
|
+
DescribeRelayUsage(req: DescribeRelayUsageRequest, cb?: (error: string, rep: DescribeRelayUsageResponse) => void): Promise<DescribeRelayUsageResponse>;
|
|
98
159
|
/**
|
|
99
160
|
* 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
100
161
|
**注意**:
|
|
@@ -111,33 +172,27 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
111
172
|
*/
|
|
112
173
|
StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
|
|
113
174
|
/**
|
|
114
|
-
*
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
-
|
|
120
|
-
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
121
|
-
- 设置录制文件名,用于二次回放。
|
|
122
|
-
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
123
|
-
|
|
124
|
-
目前已经支持了如下几种布局模板:
|
|
125
|
-
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
126
|
-
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
127
|
-
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
128
|
-
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
129
|
-
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
130
|
-
|
|
131
|
-
注意:
|
|
132
|
-
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
133
|
-
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
134
|
-
3、客户端混流和服务端混流不能混用。
|
|
175
|
+
* 获取TRTC录制的用量明细。
|
|
176
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
177
|
+
- 单次查询统计区间最多不能超过31天。
|
|
178
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
179
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
180
|
+
- 默认接口请求频率限制:5次/秒。
|
|
135
181
|
*/
|
|
136
|
-
|
|
182
|
+
DescribeRecordingUsage(req: DescribeRecordingUsageRequest, cb?: (error: string, rep: DescribeRecordingUsageResponse) => void): Promise<DescribeRecordingUsageResponse>;
|
|
137
183
|
/**
|
|
138
184
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
139
185
|
*/
|
|
140
186
|
RemoveUserByStrRoomId(req: RemoveUserByStrRoomIdRequest, cb?: (error: string, rep: RemoveUserByStrRoomIdResponse) => void): Promise<RemoveUserByStrRoomIdResponse>;
|
|
187
|
+
/**
|
|
188
|
+
* 获取TRTC混流转码的用量明细。
|
|
189
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
190
|
+
- 单次查询统计区间最多不能超过31天。
|
|
191
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
192
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
193
|
+
- 默认接口请求频率限制:5次/秒。
|
|
194
|
+
*/
|
|
195
|
+
DescribeMixTranscodingUsage(req: DescribeMixTranscodingUsageRequest, cb?: (error: string, rep: DescribeMixTranscodingUsageResponse) => void): Promise<DescribeMixTranscodingUsageResponse>;
|
|
141
196
|
/**
|
|
142
197
|
* 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
143
198
|
*/
|
|
@@ -164,6 +219,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
219
|
录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
|
|
165
220
|
*/
|
|
166
221
|
DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
|
|
222
|
+
/**
|
|
223
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
224
|
+
*/
|
|
225
|
+
ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
|
|
226
|
+
/**
|
|
227
|
+
* 更新转推任务。
|
|
228
|
+
*/
|
|
229
|
+
UpdatePublishCdnStream(req: UpdatePublishCdnStreamRequest, cb?: (error: string, rep: UpdatePublishCdnStreamResponse) => void): Promise<UpdatePublishCdnStreamResponse>;
|
|
167
230
|
/**
|
|
168
231
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
169
232
|
*/
|
|
@@ -172,6 +235,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
172
235
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
|
|
173
236
|
*/
|
|
174
237
|
DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
|
|
238
|
+
/**
|
|
239
|
+
* 停止转推任务。
|
|
240
|
+
*/
|
|
241
|
+
StopPublishCdnStream(req: StopPublishCdnStreamRequest, cb?: (error: string, rep: StopPublishCdnStreamResponse) => void): Promise<StopPublishCdnStreamResponse>;
|
|
175
242
|
/**
|
|
176
243
|
* 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
|
|
177
244
|
异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
|
|
@@ -36,10 +36,61 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
36
36
|
async DescribeRoomInfo(req, cb) {
|
|
37
37
|
return this.request("DescribeRoomInfo", req, cb);
|
|
38
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* 获取TRTC音视频互动的用量明细。
|
|
41
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
42
|
+
- 单次查询统计区间最多不能超过31天。
|
|
43
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
44
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
45
|
+
- 默认接口请求频率限制:5次/秒。
|
|
46
|
+
*/
|
|
47
|
+
async DescribeTrtcUsage(req, cb) {
|
|
48
|
+
return this.request("DescribeTrtcUsage", req, cb);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* 接口说明:启动旁路以及混流转推任务。TRTC 的房间中可能会同时存在多路音视频流,您可以通过此API接口,实现以下几种效果:
|
|
52
|
+
1、支持将单个主播的音视频流发布(也称作“转推”)到直播CDN上,请参考示例2(发起单流音视频旁路转推)和示例3(发起单流纯音频旁路转推)。
|
|
53
|
+
2、支持将同个房间多个主播或者不同房间多个主播的音视频混合成1路后再发布到直播CDN上,您可以通过AudioParams.SubscribeAudioList和VideoParams.LayoutParams调整参与混音的用户列表以及指定各路混流画面的布局位置。请参考示例1(发起混流转推)。
|
|
54
|
+
3、支持预先设置一个房间的混流模板,将该房间中的多个音视频混合成1路发布到直播CDN,腾讯云后台实时监控TRTC房间中的主播变化,自动按照混流模板调整布局。目前已经支持了如下几种混流预设模板:
|
|
55
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面。
|
|
56
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小,最多支持16个画面。
|
|
57
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
58
|
+
4、支持同时将音视频流发布到最多10个直播CDN上。您可以通过PublishCdnParams.PublishCdnUrl指定转推CDN的url,如果您想转推到腾讯云CDN,PublishCdnParams.IsTencentCdn填为1。
|
|
59
|
+
5、支持通过配置服务端回调,实时将转推状态以HTTP/HTTPS POST 请求发送给您的服务器,如果您需要接入转推事件回调,请联系腾讯云技术支持。
|
|
60
|
+
注意:
|
|
61
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转推计费说明](https://intl.cloud.tencent.com/zh/document/product/647/47631)。**
|
|
62
|
+
2、**转推非腾讯云CDN将产生云端转推费用,详见[云端混流转推计费说明](https://intl.cloud.tencent.com/zh/document/product/647/47631)。**
|
|
63
|
+
|
|
64
|
+
其他使用说明如下:
|
|
65
|
+
1、使用混流转推接口时,您需要先调用启动转推任务接口(StartPublishCdnStream),获取启动转推任务响应中的任务ID标识(TaskId)。后续传入任务ID标识(TaskId)来更新转推任务(UpdatePublishCdnStream)和停止转推任务(StopPublishCdnStream)。
|
|
66
|
+
2、为了确保转推链接的稳定,同一个转推任务不支持纯音频、音视频、纯视频之间的切换。
|
|
67
|
+
3、为了确保转推链接的稳定,更新转推任务接口(UpdatePublishCdnStream)不支持时更改视频参数(codec)和音频参数(codec、采样率、码率、声道数)。
|
|
68
|
+
4、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。
|
|
69
|
+
5、更新转推任务(UpdatePublishCdnStream)必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增:腾讯云返回InternalError错误码时,需重试请求(不换SequenceNumber);腾讯云返回FailedOperation.OutdateRequest过期错误码时,无需处理即可。
|
|
70
|
+
6、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。
|
|
71
|
+
*/
|
|
72
|
+
async StartPublishCdnStream(req, cb) {
|
|
73
|
+
return this.request("StartPublishCdnStream", req, cb);
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
77
|
+
**注意**:
|
|
78
|
+
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
79
|
+
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
80
|
+
*/
|
|
81
|
+
async DescribeCallDetailInfo(req, cb) {
|
|
82
|
+
return this.request("DescribeCallDetailInfo", req, cb);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* 接口说明:结束云端混流
|
|
86
|
+
*/
|
|
87
|
+
async StopMCUMixTranscode(req, cb) {
|
|
88
|
+
return this.request("StopMCUMixTranscode", req, cb);
|
|
89
|
+
}
|
|
39
90
|
/**
|
|
40
91
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
41
92
|
|
|
42
|
-
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API
|
|
93
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
|
|
43
94
|
|
|
44
95
|
您可以通过此接口实现如下目标:
|
|
45
96
|
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
@@ -51,7 +102,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
51
102
|
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
52
103
|
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
53
104
|
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
54
|
-
-
|
|
105
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
55
106
|
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
56
107
|
|
|
57
108
|
注意:
|
|
@@ -59,23 +110,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
59
110
|
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
60
111
|
3、客户端混流和服务端混流不能混用。
|
|
61
112
|
*/
|
|
62
|
-
async
|
|
63
|
-
return this.request("
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
67
|
-
**注意**:
|
|
68
|
-
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
69
|
-
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
70
|
-
*/
|
|
71
|
-
async DescribeCallDetailInfo(req, cb) {
|
|
72
|
-
return this.request("DescribeCallDetailInfo", req, cb);
|
|
73
|
-
}
|
|
74
|
-
/**
|
|
75
|
-
* 接口说明:结束云端混流
|
|
76
|
-
*/
|
|
77
|
-
async StopMCUMixTranscode(req, cb) {
|
|
78
|
-
return this.request("StopMCUMixTranscode", req, cb);
|
|
113
|
+
async StartMCUMixTranscodeByStrRoomId(req, cb) {
|
|
114
|
+
return this.request("StartMCUMixTranscodeByStrRoomId", req, cb);
|
|
79
115
|
}
|
|
80
116
|
/**
|
|
81
117
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
@@ -107,6 +143,32 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
107
143
|
async DescribeUserEvent(req, cb) {
|
|
108
144
|
return this.request("DescribeUserEvent", req, cb);
|
|
109
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
148
|
+
|
|
149
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
150
|
+
|
|
151
|
+
您可以通过此接口实现如下目标:
|
|
152
|
+
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
153
|
+
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
154
|
+
- 设置录制文件名,用于二次回放。
|
|
155
|
+
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
156
|
+
|
|
157
|
+
目前已经支持了如下几种布局模板:
|
|
158
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
159
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
160
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
161
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
|
|
162
|
+
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
163
|
+
|
|
164
|
+
注意:
|
|
165
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
166
|
+
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
167
|
+
3、客户端混流和服务端混流不能混用。
|
|
168
|
+
*/
|
|
169
|
+
async StartMCUMixTranscode(req, cb) {
|
|
170
|
+
return this.request("StartMCUMixTranscode", req, cb);
|
|
171
|
+
}
|
|
110
172
|
/**
|
|
111
173
|
* 接口说明:
|
|
112
174
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
|
|
@@ -137,10 +199,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
137
199
|
return this.request("DescribeScaleInfo", req, cb);
|
|
138
200
|
}
|
|
139
201
|
/**
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
202
|
+
* 获取TRTC旁路转推的用量明细。
|
|
203
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
204
|
+
- 单次查询统计区间最多不能超过31天。
|
|
205
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
206
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
207
|
+
- 默认接口请求频率限制:5次/秒。
|
|
208
|
+
*/
|
|
209
|
+
async DescribeRelayUsage(req, cb) {
|
|
210
|
+
return this.request("DescribeRelayUsage", req, cb);
|
|
144
211
|
}
|
|
145
212
|
/**
|
|
146
213
|
* 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
@@ -164,30 +231,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
231
|
return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
|
|
165
232
|
}
|
|
166
233
|
/**
|
|
167
|
-
*
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
-
|
|
173
|
-
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
174
|
-
- 设置录制文件名,用于二次回放。
|
|
175
|
-
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
176
|
-
|
|
177
|
-
目前已经支持了如下几种布局模板:
|
|
178
|
-
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
179
|
-
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
180
|
-
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
181
|
-
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
182
|
-
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
183
|
-
|
|
184
|
-
注意:
|
|
185
|
-
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
186
|
-
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
187
|
-
3、客户端混流和服务端混流不能混用。
|
|
234
|
+
* 获取TRTC录制的用量明细。
|
|
235
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
236
|
+
- 单次查询统计区间最多不能超过31天。
|
|
237
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
238
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
239
|
+
- 默认接口请求频率限制:5次/秒。
|
|
188
240
|
*/
|
|
189
|
-
async
|
|
190
|
-
return this.request("
|
|
241
|
+
async DescribeRecordingUsage(req, cb) {
|
|
242
|
+
return this.request("DescribeRecordingUsage", req, cb);
|
|
191
243
|
}
|
|
192
244
|
/**
|
|
193
245
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
@@ -195,6 +247,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
195
247
|
async RemoveUserByStrRoomId(req, cb) {
|
|
196
248
|
return this.request("RemoveUserByStrRoomId", req, cb);
|
|
197
249
|
}
|
|
250
|
+
/**
|
|
251
|
+
* 获取TRTC混流转码的用量明细。
|
|
252
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
253
|
+
- 单次查询统计区间最多不能超过31天。
|
|
254
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
255
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
256
|
+
- 默认接口请求频率限制:5次/秒。
|
|
257
|
+
*/
|
|
258
|
+
async DescribeMixTranscodingUsage(req, cb) {
|
|
259
|
+
return this.request("DescribeMixTranscodingUsage", req, cb);
|
|
260
|
+
}
|
|
198
261
|
/**
|
|
199
262
|
* 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
200
263
|
*/
|
|
@@ -229,6 +292,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
229
292
|
async DescribeCloudRecording(req, cb) {
|
|
230
293
|
return this.request("DescribeCloudRecording", req, cb);
|
|
231
294
|
}
|
|
295
|
+
/**
|
|
296
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
297
|
+
*/
|
|
298
|
+
async ModifyPicture(req, cb) {
|
|
299
|
+
return this.request("ModifyPicture", req, cb);
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* 更新转推任务。
|
|
303
|
+
*/
|
|
304
|
+
async UpdatePublishCdnStream(req, cb) {
|
|
305
|
+
return this.request("UpdatePublishCdnStream", req, cb);
|
|
306
|
+
}
|
|
232
307
|
/**
|
|
233
308
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
234
309
|
*/
|
|
@@ -241,6 +316,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
241
316
|
async DescribePicture(req, cb) {
|
|
242
317
|
return this.request("DescribePicture", req, cb);
|
|
243
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* 停止转推任务。
|
|
321
|
+
*/
|
|
322
|
+
async StopPublishCdnStream(req, cb) {
|
|
323
|
+
return this.request("StopPublishCdnStream", req, cb);
|
|
324
|
+
}
|
|
244
325
|
/**
|
|
245
326
|
* 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
|
|
246
327
|
异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
|