tencentcloud-sdk-nodejs-trtc 4.0.458 → 4.0.460
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 +325 -0
- package/SERVICE_CHANGELOG.md +383 -56
- package/package.json +1 -1
- package/products.md +19 -19
- package/src/services/trtc/v20190722/trtc_client.ts +128 -59
- package/src/services/trtc/v20190722/trtc_models.ts +189 -0
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +76 -40
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +90 -46
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +161 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreatePictureRequest, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, ModifyPictureRequest, DescribeRoomInfoResponse, DescribeUserInfoResponse, ModifyPictureResponse, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
|
|
2
|
+
import { CreatePictureRequest, DescribeRelayUsageRequest, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeMixTranscodingUsageRequest, ModifyPictureRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DescribeUserInfoResponse, DescribeRelayUsageResponse, DescribeRecordingUsageResponse, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
|
|
3
3
|
/**
|
|
4
4
|
* trtc client
|
|
5
5
|
* @class
|
|
@@ -13,10 +13,30 @@ 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
|
+
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
27
|
+
**注意**:
|
|
28
|
+
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
29
|
+
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
30
|
+
*/
|
|
31
|
+
DescribeCallDetailInfo(req: DescribeCallDetailInfoRequest, cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void): Promise<DescribeCallDetailInfoResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* 接口说明:结束云端混流
|
|
34
|
+
*/
|
|
35
|
+
StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
|
|
16
36
|
/**
|
|
17
37
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
18
38
|
|
|
19
|
-
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API
|
|
39
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
|
|
20
40
|
|
|
21
41
|
您可以通过此接口实现如下目标:
|
|
22
42
|
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
@@ -28,7 +48,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
28
48
|
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
29
49
|
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
30
50
|
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
31
|
-
-
|
|
51
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
32
52
|
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
33
53
|
|
|
34
54
|
注意:
|
|
@@ -36,18 +56,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
36
56
|
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
37
57
|
3、客户端混流和服务端混流不能混用。
|
|
38
58
|
*/
|
|
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>;
|
|
59
|
+
StartMCUMixTranscodeByStrRoomId(req: StartMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StartMCUMixTranscodeByStrRoomIdResponse>;
|
|
51
60
|
/**
|
|
52
61
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
53
62
|
*/
|
|
@@ -68,6 +77,30 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
68
77
|
* 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
|
|
69
78
|
*/
|
|
70
79
|
DescribeUserEvent(req: DescribeUserEventRequest, cb?: (error: string, rep: DescribeUserEventResponse) => void): Promise<DescribeUserEventResponse>;
|
|
80
|
+
/**
|
|
81
|
+
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
82
|
+
|
|
83
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
84
|
+
|
|
85
|
+
您可以通过此接口实现如下目标:
|
|
86
|
+
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
87
|
+
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
88
|
+
- 设置录制文件名,用于二次回放。
|
|
89
|
+
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
90
|
+
|
|
91
|
+
目前已经支持了如下几种布局模板:
|
|
92
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
93
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
94
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
95
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
|
|
96
|
+
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
97
|
+
|
|
98
|
+
注意:
|
|
99
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
100
|
+
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
101
|
+
3、客户端混流和服务端混流不能混用。
|
|
102
|
+
*/
|
|
103
|
+
StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
|
|
71
104
|
/**
|
|
72
105
|
* 接口说明:
|
|
73
106
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
|
|
@@ -92,9 +125,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
92
125
|
*/
|
|
93
126
|
DescribeScaleInfo(req: DescribeScaleInfoRequest, cb?: (error: string, rep: DescribeScaleInfoResponse) => void): Promise<DescribeScaleInfoResponse>;
|
|
94
127
|
/**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
128
|
+
* 获取TRTC旁路转推的用量明细。
|
|
129
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
130
|
+
- 单次查询统计区间最多不能超过31天。
|
|
131
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
132
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
133
|
+
- 默认接口请求频率限制:5次/秒。
|
|
134
|
+
*/
|
|
135
|
+
DescribeRelayUsage(req: DescribeRelayUsageRequest, cb?: (error: string, rep: DescribeRelayUsageResponse) => void): Promise<DescribeRelayUsageResponse>;
|
|
98
136
|
/**
|
|
99
137
|
* 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
100
138
|
**注意**:
|
|
@@ -111,33 +149,27 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
111
149
|
*/
|
|
112
150
|
StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
|
|
113
151
|
/**
|
|
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、客户端混流和服务端混流不能混用。
|
|
152
|
+
* 获取TRTC录制的用量明细。
|
|
153
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
154
|
+
- 单次查询统计区间最多不能超过31天。
|
|
155
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
156
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
157
|
+
- 默认接口请求频率限制:5次/秒。
|
|
135
158
|
*/
|
|
136
|
-
|
|
159
|
+
DescribeRecordingUsage(req: DescribeRecordingUsageRequest, cb?: (error: string, rep: DescribeRecordingUsageResponse) => void): Promise<DescribeRecordingUsageResponse>;
|
|
137
160
|
/**
|
|
138
161
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
139
162
|
*/
|
|
140
163
|
RemoveUserByStrRoomId(req: RemoveUserByStrRoomIdRequest, cb?: (error: string, rep: RemoveUserByStrRoomIdResponse) => void): Promise<RemoveUserByStrRoomIdResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* 获取TRTC混流转码的用量明细。
|
|
166
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
167
|
+
- 单次查询统计区间最多不能超过31天。
|
|
168
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
169
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
170
|
+
- 默认接口请求频率限制:5次/秒。
|
|
171
|
+
*/
|
|
172
|
+
DescribeMixTranscodingUsage(req: DescribeMixTranscodingUsageRequest, cb?: (error: string, rep: DescribeMixTranscodingUsageResponse) => void): Promise<DescribeMixTranscodingUsageResponse>;
|
|
141
173
|
/**
|
|
142
174
|
* 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
143
175
|
*/
|
|
@@ -164,6 +196,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
196
|
录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
|
|
165
197
|
*/
|
|
166
198
|
DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
201
|
+
*/
|
|
202
|
+
ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
|
|
167
203
|
/**
|
|
168
204
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
169
205
|
*/
|
|
@@ -36,10 +36,36 @@ 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
|
+
* 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
52
|
+
**注意**:
|
|
53
|
+
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
54
|
+
2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735
|
|
55
|
+
*/
|
|
56
|
+
async DescribeCallDetailInfo(req, cb) {
|
|
57
|
+
return this.request("DescribeCallDetailInfo", req, cb);
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* 接口说明:结束云端混流
|
|
61
|
+
*/
|
|
62
|
+
async StopMCUMixTranscode(req, cb) {
|
|
63
|
+
return this.request("StopMCUMixTranscode", req, cb);
|
|
64
|
+
}
|
|
39
65
|
/**
|
|
40
66
|
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
41
67
|
|
|
42
|
-
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API
|
|
68
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
|
|
43
69
|
|
|
44
70
|
您可以通过此接口实现如下目标:
|
|
45
71
|
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
@@ -51,7 +77,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
51
77
|
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
52
78
|
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
53
79
|
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
54
|
-
-
|
|
80
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
|
|
55
81
|
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
56
82
|
|
|
57
83
|
注意:
|
|
@@ -59,23 +85,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
59
85
|
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
60
86
|
3、客户端混流和服务端混流不能混用。
|
|
61
87
|
*/
|
|
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);
|
|
88
|
+
async StartMCUMixTranscodeByStrRoomId(req, cb) {
|
|
89
|
+
return this.request("StartMCUMixTranscodeByStrRoomId", req, cb);
|
|
79
90
|
}
|
|
80
91
|
/**
|
|
81
92
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
@@ -107,6 +118,32 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
107
118
|
async DescribeUserEvent(req, cb) {
|
|
108
119
|
return this.request("DescribeUserEvent", req, cb);
|
|
109
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
123
|
+
|
|
124
|
+
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
125
|
+
|
|
126
|
+
您可以通过此接口实现如下目标:
|
|
127
|
+
- 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
128
|
+
- 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
|
|
129
|
+
- 设置录制文件名,用于二次回放。
|
|
130
|
+
- 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
|
|
131
|
+
|
|
132
|
+
目前已经支持了如下几种布局模板:
|
|
133
|
+
- 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
|
|
134
|
+
- 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
|
|
135
|
+
- 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
|
|
136
|
+
- 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。
|
|
137
|
+
- 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
|
|
138
|
+
|
|
139
|
+
注意:
|
|
140
|
+
1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
141
|
+
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
142
|
+
3、客户端混流和服务端混流不能混用。
|
|
143
|
+
*/
|
|
144
|
+
async StartMCUMixTranscode(req, cb) {
|
|
145
|
+
return this.request("StartMCUMixTranscode", req, cb);
|
|
146
|
+
}
|
|
110
147
|
/**
|
|
111
148
|
* 接口说明:
|
|
112
149
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
|
|
@@ -137,10 +174,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
137
174
|
return this.request("DescribeScaleInfo", req, cb);
|
|
138
175
|
}
|
|
139
176
|
/**
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
177
|
+
* 获取TRTC旁路转推的用量明细。
|
|
178
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
179
|
+
- 单次查询统计区间最多不能超过31天。
|
|
180
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
181
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
182
|
+
- 默认接口请求频率限制:5次/秒。
|
|
183
|
+
*/
|
|
184
|
+
async DescribeRelayUsage(req, cb) {
|
|
185
|
+
return this.request("DescribeRelayUsage", req, cb);
|
|
144
186
|
}
|
|
145
187
|
/**
|
|
146
188
|
* 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
@@ -164,30 +206,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
164
206
|
return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
|
|
165
207
|
}
|
|
166
208
|
/**
|
|
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、客户端混流和服务端混流不能混用。
|
|
209
|
+
* 获取TRTC录制的用量明细。
|
|
210
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
211
|
+
- 单次查询统计区间最多不能超过31天。
|
|
212
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
213
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
214
|
+
- 默认接口请求频率限制:5次/秒。
|
|
188
215
|
*/
|
|
189
|
-
async
|
|
190
|
-
return this.request("
|
|
216
|
+
async DescribeRecordingUsage(req, cb) {
|
|
217
|
+
return this.request("DescribeRecordingUsage", req, cb);
|
|
191
218
|
}
|
|
192
219
|
/**
|
|
193
220
|
* 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
@@ -195,6 +222,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
195
222
|
async RemoveUserByStrRoomId(req, cb) {
|
|
196
223
|
return this.request("RemoveUserByStrRoomId", req, cb);
|
|
197
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
* 获取TRTC混流转码的用量明细。
|
|
227
|
+
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
228
|
+
- 单次查询统计区间最多不能超过31天。
|
|
229
|
+
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
230
|
+
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。
|
|
231
|
+
- 默认接口请求频率限制:5次/秒。
|
|
232
|
+
*/
|
|
233
|
+
async DescribeMixTranscodingUsage(req, cb) {
|
|
234
|
+
return this.request("DescribeMixTranscodingUsage", req, cb);
|
|
235
|
+
}
|
|
198
236
|
/**
|
|
199
237
|
* 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
200
238
|
*/
|
|
@@ -229,6 +267,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
229
267
|
async DescribeCloudRecording(req, cb) {
|
|
230
268
|
return this.request("DescribeCloudRecording", req, cb);
|
|
231
269
|
}
|
|
270
|
+
/**
|
|
271
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
272
|
+
*/
|
|
273
|
+
async ModifyPicture(req, cb) {
|
|
274
|
+
return this.request("ModifyPicture", req, cb);
|
|
275
|
+
}
|
|
232
276
|
/**
|
|
233
277
|
* 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
234
278
|
*/
|
|
@@ -31,6 +31,24 @@ export interface CreatePictureRequest {
|
|
|
31
31
|
*/
|
|
32
32
|
YPosition: number;
|
|
33
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* DescribeRelayUsage请求参数结构体
|
|
36
|
+
*/
|
|
37
|
+
export interface DescribeRelayUsageRequest {
|
|
38
|
+
/**
|
|
39
|
+
* 查询开始时间,格式为YYYY-MM-DD。
|
|
40
|
+
*/
|
|
41
|
+
StartTime: string;
|
|
42
|
+
/**
|
|
43
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
44
|
+
单次查询统计区间最多不能超过31天。
|
|
45
|
+
*/
|
|
46
|
+
EndTime: string;
|
|
47
|
+
/**
|
|
48
|
+
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
49
|
+
*/
|
|
50
|
+
SdkAppId?: number;
|
|
51
|
+
}
|
|
34
52
|
/**
|
|
35
53
|
* 用户自定义混流布局参数列表。
|
|
36
54
|
*/
|
|
@@ -445,6 +463,23 @@ export interface CloudStorage {
|
|
|
445
463
|
*/
|
|
446
464
|
FileNamePrefix?: Array<string>;
|
|
447
465
|
}
|
|
466
|
+
/**
|
|
467
|
+
* DescribeTrtcUsage返回参数结构体
|
|
468
|
+
*/
|
|
469
|
+
export interface DescribeTrtcUsageResponse {
|
|
470
|
+
/**
|
|
471
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
472
|
+
*/
|
|
473
|
+
UsageKey: Array<string>;
|
|
474
|
+
/**
|
|
475
|
+
* 各个时间点用量明细。
|
|
476
|
+
*/
|
|
477
|
+
UsageList: Array<TrtcUsage>;
|
|
478
|
+
/**
|
|
479
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
480
|
+
*/
|
|
481
|
+
RequestId?: string;
|
|
482
|
+
}
|
|
448
483
|
/**
|
|
449
484
|
* 返回的质量数据,时间:值
|
|
450
485
|
*/
|
|
@@ -701,6 +736,24 @@ export interface TrtcTimeNewUsage {
|
|
|
701
736
|
*/
|
|
702
737
|
Video4KTime: number;
|
|
703
738
|
}
|
|
739
|
+
/**
|
|
740
|
+
* DescribeMixTranscodingUsage请求参数结构体
|
|
741
|
+
*/
|
|
742
|
+
export interface DescribeMixTranscodingUsageRequest {
|
|
743
|
+
/**
|
|
744
|
+
* 查询开始时间,格式为YYYY-MM-DD。
|
|
745
|
+
*/
|
|
746
|
+
StartTime: string;
|
|
747
|
+
/**
|
|
748
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
749
|
+
单次查询统计区间最多不能超过31天。
|
|
750
|
+
*/
|
|
751
|
+
EndTime: string;
|
|
752
|
+
/**
|
|
753
|
+
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
754
|
+
*/
|
|
755
|
+
SdkAppId?: number;
|
|
756
|
+
}
|
|
704
757
|
/**
|
|
705
758
|
* ModifyPicture请求参数结构体
|
|
706
759
|
*/
|
|
@@ -818,6 +871,24 @@ export interface EventList {
|
|
|
818
871
|
*/
|
|
819
872
|
PeerId: string;
|
|
820
873
|
}
|
|
874
|
+
/**
|
|
875
|
+
* DescribeTrtcUsage请求参数结构体
|
|
876
|
+
*/
|
|
877
|
+
export interface DescribeTrtcUsageRequest {
|
|
878
|
+
/**
|
|
879
|
+
* 查询开始时间,格式为YYYY-MM-DD。
|
|
880
|
+
*/
|
|
881
|
+
StartTime: string;
|
|
882
|
+
/**
|
|
883
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
884
|
+
单次查询统计区间最多不能超过31天。
|
|
885
|
+
*/
|
|
886
|
+
EndTime: string;
|
|
887
|
+
/**
|
|
888
|
+
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
889
|
+
*/
|
|
890
|
+
SdkAppId?: number;
|
|
891
|
+
}
|
|
821
892
|
/**
|
|
822
893
|
* DescribeRoomInfo返回参数结构体
|
|
823
894
|
*/
|
|
@@ -860,6 +931,10 @@ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
|
|
|
860
931
|
* 视频时长-全高清FHD,单位:秒。
|
|
861
932
|
*/
|
|
862
933
|
VideoTimeFhd: number;
|
|
934
|
+
/**
|
|
935
|
+
* 带宽,单位:Mbps。
|
|
936
|
+
*/
|
|
937
|
+
Flux: number;
|
|
863
938
|
}
|
|
864
939
|
/**
|
|
865
940
|
* DescribeUserInfo返回参数结构体
|
|
@@ -879,6 +954,53 @@ export interface DescribeUserInfoResponse {
|
|
|
879
954
|
*/
|
|
880
955
|
RequestId?: string;
|
|
881
956
|
}
|
|
957
|
+
/**
|
|
958
|
+
* 实时音视频用量在某一时间段的统计信息。
|
|
959
|
+
*/
|
|
960
|
+
export interface TrtcUsage {
|
|
961
|
+
/**
|
|
962
|
+
* 时间点,格式为YYYY-MM-DD HH:mm:ss。多天查询时,HH:mm:ss为00:00:00。
|
|
963
|
+
*/
|
|
964
|
+
TimeKey: string;
|
|
965
|
+
/**
|
|
966
|
+
* 用量数组。每个数值含义与UsageKey对应。单位:分钟。
|
|
967
|
+
*/
|
|
968
|
+
UsageValue: Array<number>;
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* DescribeRelayUsage返回参数结构体
|
|
972
|
+
*/
|
|
973
|
+
export interface DescribeRelayUsageResponse {
|
|
974
|
+
/**
|
|
975
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
976
|
+
*/
|
|
977
|
+
UsageKey: Array<string>;
|
|
978
|
+
/**
|
|
979
|
+
* 各个时间点用量明细。
|
|
980
|
+
*/
|
|
981
|
+
UsageList: Array<TrtcUsage>;
|
|
982
|
+
/**
|
|
983
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
984
|
+
*/
|
|
985
|
+
RequestId?: string;
|
|
986
|
+
}
|
|
987
|
+
/**
|
|
988
|
+
* DescribeRecordingUsage返回参数结构体
|
|
989
|
+
*/
|
|
990
|
+
export interface DescribeRecordingUsageResponse {
|
|
991
|
+
/**
|
|
992
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
993
|
+
*/
|
|
994
|
+
UsageKey: Array<string>;
|
|
995
|
+
/**
|
|
996
|
+
* 各个时间点用量明细。
|
|
997
|
+
*/
|
|
998
|
+
UsageList: Array<TrtcUsage>;
|
|
999
|
+
/**
|
|
1000
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1001
|
+
*/
|
|
1002
|
+
RequestId?: string;
|
|
1003
|
+
}
|
|
882
1004
|
/**
|
|
883
1005
|
* ModifyPicture返回参数结构体
|
|
884
1006
|
*/
|
|
@@ -888,6 +1010,28 @@ export interface ModifyPictureResponse {
|
|
|
888
1010
|
*/
|
|
889
1011
|
RequestId?: string;
|
|
890
1012
|
}
|
|
1013
|
+
/**
|
|
1014
|
+
* DescribeRecordingUsage请求参数结构体
|
|
1015
|
+
*/
|
|
1016
|
+
export interface DescribeRecordingUsageRequest {
|
|
1017
|
+
/**
|
|
1018
|
+
* 查询开始时间,格式为YYYY-MM-DD。
|
|
1019
|
+
*/
|
|
1020
|
+
StartTime: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* 查询结束时间,格式为YYYY-MM-DD。
|
|
1023
|
+
单次查询统计区间最多不能超过31天。
|
|
1024
|
+
*/
|
|
1025
|
+
EndTime: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* 查询单流录制或合流录制,值为"single"或"multi"。
|
|
1028
|
+
*/
|
|
1029
|
+
MixType: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。
|
|
1032
|
+
*/
|
|
1033
|
+
SdkAppId?: number;
|
|
1034
|
+
}
|
|
891
1035
|
/**
|
|
892
1036
|
* 云端录制查询接口,录制文件的信息
|
|
893
1037
|
*/
|
|
@@ -1015,6 +1159,23 @@ export interface StopMCUMixTranscodeResponse {
|
|
|
1015
1159
|
*/
|
|
1016
1160
|
RequestId?: string;
|
|
1017
1161
|
}
|
|
1162
|
+
/**
|
|
1163
|
+
* DescribeMixTranscodingUsage返回参数结构体
|
|
1164
|
+
*/
|
|
1165
|
+
export interface DescribeMixTranscodingUsageResponse {
|
|
1166
|
+
/**
|
|
1167
|
+
* 用量类型,与UsageValue中各个位置的值对应。
|
|
1168
|
+
*/
|
|
1169
|
+
UsageKey: Array<string>;
|
|
1170
|
+
/**
|
|
1171
|
+
* 各个时间点用量明细。
|
|
1172
|
+
*/
|
|
1173
|
+
UsageList: Array<TrtcUsage>;
|
|
1174
|
+
/**
|
|
1175
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1176
|
+
*/
|
|
1177
|
+
RequestId?: string;
|
|
1178
|
+
}
|
|
1018
1179
|
/**
|
|
1019
1180
|
* SdkAppId级别实时音视频的用量数据
|
|
1020
1181
|
*/
|