tencentcloud-sdk-nodejs-trtc 4.0.340 → 4.0.343

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.
@@ -1,60 +1,11 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { DescribeAbnormalEventResponse, DescribeAbnormalEventRequest, ModifyPictureResponse, StartMCUMixTranscodeByStrRoomIdRequest, CreatePictureRequest, DescribeTrtcMcuTranscodeTimeRequest, StopMCUMixTranscodeResponse, RemoveUserByStrRoomIdRequest, DismissRoomResponse, DescribeRecordStatisticRequest, DescribeUserInformationRequest, DescribeCallDetailRequest, DescribeUserInformationResponse, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, StopMCUMixTranscodeRequest, DescribeHistoryScaleRequest, DeletePictureRequest, DescribeRoomInformationResponse, RemoveUserRequest, ModifyPictureRequest, CreateTroubleInfoResponse, StopMCUMixTranscodeByStrRoomIdRequest, StopMCUMixTranscodeByStrRoomIdResponse, DeletePictureResponse, CreateTroubleInfoRequest, DismissRoomRequest, DescribeDetailEventResponse, DismissRoomByStrRoomIdRequest, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DescribePictureRequest, RemoveUserResponse, DescribeCallDetailResponse, DescribePictureResponse, DescribeRoomInformationRequest, DescribeDetailEventRequest, CreatePictureResponse, DescribeRecordStatisticResponse, DismissRoomByStrRoomIdResponse, DescribeHistoryScaleResponse, StartMCUMixTranscodeByStrRoomIdResponse } from "./trtc_models";
2
+ import { DismissRoomByStrRoomIdRequest, DescribeAbnormalEventResponse, DescribeAbnormalEventRequest, ModifyPictureResponse, RemoveUserRequest, DescribeCloudRecordingResponse, StartMCUMixTranscodeByStrRoomIdRequest, CreatePictureRequest, DescribeTrtcMcuTranscodeTimeRequest, StopMCUMixTranscodeResponse, RemoveUserByStrRoomIdRequest, DismissRoomResponse, DescribeRecordStatisticRequest, DescribeUserInformationRequest, DescribeCallDetailRequest, ModifyPictureRequest, StartMCUMixTranscodeRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, DescribeHistoryScaleRequest, DeletePictureRequest, DescribeRoomInformationResponse, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, CreateTroubleInfoResponse, StopMCUMixTranscodeByStrRoomIdRequest, RemoveUserByStrRoomIdResponse, StopMCUMixTranscodeByStrRoomIdResponse, DeletePictureResponse, ModifyCloudRecordingRequest, CreateTroubleInfoRequest, DescribeUserInformationResponse, DescribeDetailEventResponse, CreateCloudRecordingResponse, DescribeCallDetailResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, RemoveUserResponse, DescribePictureResponse, DismissRoomRequest, DescribeRoomInformationRequest, DescribeDetailEventRequest, StartMCUMixTranscodeResponse, CreatePictureResponse, DescribeRecordStatisticResponse, DismissRoomByStrRoomIdResponse, DescribeHistoryScaleResponse, StartMCUMixTranscodeByStrRoomIdResponse, ModifyCloudRecordingResponse } from "./trtc_models";
3
3
  /**
4
4
  * trtc client
5
5
  * @class
6
6
  */
7
7
  export declare class Client extends TencentCloudCommon.AbstractClient {
8
8
  constructor(clientConfig: TencentCloudCommon.ClientConfig);
9
- /**
10
- * 查询云端录制计费时长。
11
-
12
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
13
- - 单次查询统计区间最多不能超过31天。
14
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
15
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
16
- */
17
- DescribeRecordStatistic(req: DescribeRecordStatisticRequest, cb?: (error: string, rep: DescribeRecordStatisticResponse) => void): Promise<DescribeRecordStatisticResponse>;
18
- /**
19
- * 查询旁路转码计费时长。
20
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
21
- - 单次查询统计区间最多不能超过31天。
22
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
23
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
24
- */
25
- DescribeTrtcMcuTranscodeTime(req: DescribeTrtcMcuTranscodeTimeRequest, cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void): Promise<DescribeTrtcMcuTranscodeTimeResponse>;
26
- /**
27
- * 创建异常信息
28
- */
29
- CreateTroubleInfo(req: CreateTroubleInfoRequest, cb?: (error: string, rep: CreateTroubleInfoResponse) => void): Promise<CreateTroubleInfoResponse>;
30
- /**
31
- * 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。
32
- */
33
- DescribeHistoryScale(req: DescribeHistoryScaleRequest, cb?: (error: string, rep: DescribeHistoryScaleResponse) => void): Promise<DescribeHistoryScaleResponse>;
34
- /**
35
- * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
36
-
37
- TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
38
-
39
- 您可以通过此接口实现如下目标:
40
- - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
41
- - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
42
- - 设置录制文件名,用于二次回放。
43
- - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
44
-
45
- 目前已经支持了如下几种布局模板:
46
- - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
47
- - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
48
- - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
49
- - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
50
- - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
51
-
52
- 注意:
53
- 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
54
- 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
55
- 3、客户端混流和服务端混流不能混用。
56
- */
57
- StartMCUMixTranscodeByStrRoomId(req: StartMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StartMCUMixTranscodeByStrRoomIdResponse>;
58
9
  /**
59
10
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
60
11
 
@@ -80,38 +31,66 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
80
31
  */
81
32
  StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
82
33
  /**
83
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
34
+ * 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
35
+ **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
84
36
  */
85
- DeletePicture(req: DeletePictureRequest, cb?: (error: string, rep: DeletePictureResponse) => void): Promise<DeletePictureResponse>;
37
+ DescribeRoomInformation(req: DescribeRoomInformationRequest, cb?: (error: string, rep: DescribeRoomInformationResponse) => void): Promise<DescribeRoomInformationResponse>;
86
38
  /**
87
39
  * 接口说明:结束云端混流
88
40
  */
89
- StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
41
+ StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
90
42
  /**
91
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
43
+ * 创建异常信息
92
44
  */
93
- CreatePicture(req: CreatePictureRequest, cb?: (error: string, rep: CreatePictureResponse) => void): Promise<CreatePictureResponse>;
45
+ CreateTroubleInfo(req: CreateTroubleInfoRequest, cb?: (error: string, rep: CreateTroubleInfoResponse) => void): Promise<CreateTroubleInfoResponse>;
94
46
  /**
95
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
47
+ * 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。
96
48
  */
97
- DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
49
+ DescribeHistoryScale(req: DescribeHistoryScaleRequest, cb?: (error: string, rep: DescribeHistoryScaleResponse) => void): Promise<DescribeHistoryScaleResponse>;
98
50
  /**
99
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
51
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
100
52
  */
101
- ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
53
+ DeletePicture(req: DeletePictureRequest, cb?: (error: string, rep: DeletePictureResponse) => void): Promise<DeletePictureResponse>;
54
+ /**
55
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
56
+ */
57
+ CreatePicture(req: CreatePictureRequest, cb?: (error: string, rep: CreatePictureResponse) => void): Promise<CreatePictureResponse>;
102
58
  /**
103
59
  * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
104
60
  */
105
61
  RemoveUser(req: RemoveUserRequest, cb?: (error: string, rep: RemoveUserResponse) => void): Promise<RemoveUserResponse>;
106
62
  /**
107
- * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
63
+ * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
108
64
  */
109
- DescribeDetailEvent(req: DescribeDetailEventRequest, cb?: (error: string, rep: DescribeDetailEventResponse) => void): Promise<DescribeDetailEventResponse>;
65
+ ModifyCloudRecording(req: ModifyCloudRecordingRequest, cb?: (error: string, rep: ModifyCloudRecordingResponse) => void): Promise<ModifyCloudRecordingResponse>;
110
66
  /**
111
67
  * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
112
68
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
113
69
  */
114
70
  DescribeCallDetail(req: DescribeCallDetailRequest, cb?: (error: string, rep: DescribeCallDetailResponse) => void): Promise<DescribeCallDetailResponse>;
71
+ /**
72
+ * ###接口说明:
73
+ 启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
74
+
75
+ ###您可以通过此接口实现如下目标:
76
+ * 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
77
+ * 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储
78
+ * 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
79
+ * 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
80
+
81
+ ###关键名词:
82
+ * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。
83
+ * 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。
84
+ */
85
+ CreateCloudRecording(req: CreateCloudRecordingRequest, cb?: (error: string, rep: CreateCloudRecordingResponse) => void): Promise<CreateCloudRecordingResponse>;
86
+ /**
87
+ * 接口说明:结束云端混流
88
+ */
89
+ StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
90
+ /**
91
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
92
+ */
93
+ ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
115
94
  /**
116
95
  * 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
117
96
  */
@@ -121,14 +100,29 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
121
100
  */
122
101
  DescribeAbnormalEvent(req: DescribeAbnormalEventRequest, cb?: (error: string, rep: DescribeAbnormalEventResponse) => void): Promise<DescribeAbnormalEventResponse>;
123
102
  /**
124
- * 接口说明:结束云端混流
125
- */
126
- StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
127
- /**
128
- * 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
129
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
130
- */
131
- DescribeRoomInformation(req: DescribeRoomInformationRequest, cb?: (error: string, rep: DescribeRoomInformationResponse) => void): Promise<DescribeRoomInformationResponse>;
103
+ * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
104
+
105
+ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
106
+
107
+ 您可以通过此接口实现如下目标:
108
+ - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
109
+ - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
110
+ - 设置录制文件名,用于二次回放。
111
+ - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
112
+
113
+ 目前已经支持了如下几种布局模板:
114
+ - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
115
+ - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
116
+ - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
117
+ - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
118
+ - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
119
+
120
+ 注意:
121
+ 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
122
+ 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
123
+ 3、客户端混流和服务端混流不能混用。
124
+ */
125
+ StartMCUMixTranscodeByStrRoomId(req: StartMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StartMCUMixTranscodeByStrRoomIdResponse>;
132
126
  /**
133
127
  * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
134
128
  */
@@ -137,6 +131,39 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
137
131
  * 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
138
132
  */
139
133
  DismissRoom(req: DismissRoomRequest, cb?: (error: string, rep: DismissRoomResponse) => void): Promise<DismissRoomResponse>;
134
+ /**
135
+ * 查询云端录制计费时长。
136
+
137
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
138
+ - 单次查询统计区间最多不能超过31天。
139
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
140
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
141
+ */
142
+ DescribeRecordStatistic(req: DescribeRecordStatisticRequest, cb?: (error: string, rep: DescribeRecordStatisticResponse) => void): Promise<DescribeRecordStatisticResponse>;
143
+ /**
144
+ * 查询旁路转码计费时长。
145
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
146
+ - 单次查询统计区间最多不能超过31天。
147
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
148
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
149
+ */
150
+ DescribeTrtcMcuTranscodeTime(req: DescribeTrtcMcuTranscodeTimeRequest, cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void): Promise<DescribeTrtcMcuTranscodeTimeResponse>;
151
+ /**
152
+ * 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
153
+ */
154
+ DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
155
+ /**
156
+ * 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
157
+ */
158
+ DeleteCloudRecording(req: DeleteCloudRecordingRequest, cb?: (error: string, rep: DeleteCloudRecordingResponse) => void): Promise<DeleteCloudRecordingResponse>;
159
+ /**
160
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
161
+ */
162
+ DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
163
+ /**
164
+ * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
165
+ */
166
+ DescribeDetailEvent(req: DescribeDetailEventRequest, cb?: (error: string, rep: DescribeDetailEventResponse) => void): Promise<DescribeDetailEventResponse>;
140
167
  /**
141
168
  * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
142
169
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
@@ -27,65 +27,6 @@ class Client extends TencentCloudCommon.AbstractClient {
27
27
  constructor(clientConfig) {
28
28
  super("trtc.tencentcloudapi.com", "2019-07-22", clientConfig);
29
29
  }
30
- /**
31
- * 查询云端录制计费时长。
32
-
33
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
34
- - 单次查询统计区间最多不能超过31天。
35
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
36
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
37
- */
38
- async DescribeRecordStatistic(req, cb) {
39
- return this.request("DescribeRecordStatistic", req, cb);
40
- }
41
- /**
42
- * 查询旁路转码计费时长。
43
- - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
44
- - 单次查询统计区间最多不能超过31天。
45
- - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
46
- - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
47
- */
48
- async DescribeTrtcMcuTranscodeTime(req, cb) {
49
- return this.request("DescribeTrtcMcuTranscodeTime", req, cb);
50
- }
51
- /**
52
- * 创建异常信息
53
- */
54
- async CreateTroubleInfo(req, cb) {
55
- return this.request("CreateTroubleInfo", req, cb);
56
- }
57
- /**
58
- * 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。
59
- */
60
- async DescribeHistoryScale(req, cb) {
61
- return this.request("DescribeHistoryScale", req, cb);
62
- }
63
- /**
64
- * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
65
-
66
- TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
67
-
68
- 您可以通过此接口实现如下目标:
69
- - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
70
- - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
71
- - 设置录制文件名,用于二次回放。
72
- - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
73
-
74
- 目前已经支持了如下几种布局模板:
75
- - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
76
- - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
77
- - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
78
- - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
79
- - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
80
-
81
- 注意:
82
- 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
83
- 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
84
- 3、客户端混流和服务端混流不能混用。
85
- */
86
- async StartMCUMixTranscodeByStrRoomId(req, cb) {
87
- return this.request("StartMCUMixTranscodeByStrRoomId", req, cb);
88
- }
89
30
  /**
90
31
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
91
32
 
@@ -113,34 +54,41 @@ class Client extends TencentCloudCommon.AbstractClient {
113
54
  return this.request("StartMCUMixTranscode", req, cb);
114
55
  }
115
56
  /**
116
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
57
+ * 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
58
+ **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
117
59
  */
118
- async DeletePicture(req, cb) {
119
- return this.request("DeletePicture", req, cb);
60
+ async DescribeRoomInformation(req, cb) {
61
+ return this.request("DescribeRoomInformation", req, cb);
120
62
  }
121
63
  /**
122
64
  * 接口说明:结束云端混流
123
65
  */
124
- async StopMCUMixTranscodeByStrRoomId(req, cb) {
125
- return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
66
+ async StopMCUMixTranscode(req, cb) {
67
+ return this.request("StopMCUMixTranscode", req, cb);
126
68
  }
127
69
  /**
128
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
70
+ * 创建异常信息
129
71
  */
130
- async CreatePicture(req, cb) {
131
- return this.request("CreatePicture", req, cb);
72
+ async CreateTroubleInfo(req, cb) {
73
+ return this.request("CreateTroubleInfo", req, cb);
132
74
  }
133
75
  /**
134
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
76
+ * 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。
135
77
  */
136
- async DescribePicture(req, cb) {
137
- return this.request("DescribePicture", req, cb);
78
+ async DescribeHistoryScale(req, cb) {
79
+ return this.request("DescribeHistoryScale", req, cb);
138
80
  }
139
81
  /**
140
- * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
82
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
141
83
  */
142
- async ModifyPicture(req, cb) {
143
- return this.request("ModifyPicture", req, cb);
84
+ async DeletePicture(req, cb) {
85
+ return this.request("DeletePicture", req, cb);
86
+ }
87
+ /**
88
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
89
+ */
90
+ async CreatePicture(req, cb) {
91
+ return this.request("CreatePicture", req, cb);
144
92
  }
145
93
  /**
146
94
  * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
@@ -149,10 +97,10 @@ class Client extends TencentCloudCommon.AbstractClient {
149
97
  return this.request("RemoveUser", req, cb);
150
98
  }
151
99
  /**
152
- * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
100
+ * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
153
101
  */
154
- async DescribeDetailEvent(req, cb) {
155
- return this.request("DescribeDetailEvent", req, cb);
102
+ async ModifyCloudRecording(req, cb) {
103
+ return this.request("ModifyCloudRecording", req, cb);
156
104
  }
157
105
  /**
158
106
  * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
@@ -161,6 +109,35 @@ class Client extends TencentCloudCommon.AbstractClient {
161
109
  async DescribeCallDetail(req, cb) {
162
110
  return this.request("DescribeCallDetail", req, cb);
163
111
  }
112
+ /**
113
+ * ###接口说明:
114
+ 启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
115
+
116
+ ###您可以通过此接口实现如下目标:
117
+ * 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
118
+ * 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储
119
+ * 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
120
+ * 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
121
+
122
+ ###关键名词:
123
+ * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。
124
+ * 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。
125
+ */
126
+ async CreateCloudRecording(req, cb) {
127
+ return this.request("CreateCloudRecording", req, cb);
128
+ }
129
+ /**
130
+ * 接口说明:结束云端混流
131
+ */
132
+ async StopMCUMixTranscodeByStrRoomId(req, cb) {
133
+ return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
134
+ }
135
+ /**
136
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
137
+ */
138
+ async ModifyPicture(req, cb) {
139
+ return this.request("ModifyPicture", req, cb);
140
+ }
164
141
  /**
165
142
  * 接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
166
143
  */
@@ -174,17 +151,30 @@ class Client extends TencentCloudCommon.AbstractClient {
174
151
  return this.request("DescribeAbnormalEvent", req, cb);
175
152
  }
176
153
  /**
177
- * 接口说明:结束云端混流
178
- */
179
- async StopMCUMixTranscode(req, cb) {
180
- return this.request("StopMCUMixTranscode", req, cb);
181
- }
182
- /**
183
- * 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
184
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
185
- */
186
- async DescribeRoomInformation(req, cb) {
187
- return this.request("DescribeRoomInformation", req, cb);
154
+ * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
155
+
156
+ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
157
+
158
+ 您可以通过此接口实现如下目标:
159
+ - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。
160
+ - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。
161
+ - 设置录制文件名,用于二次回放。
162
+ - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。
163
+
164
+ 目前已经支持了如下几种布局模板:
165
+ - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。
166
+ - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。
167
+ - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。
168
+ - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。
169
+ - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。
170
+
171
+ 注意:
172
+ 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
173
+ 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
174
+ 3、客户端混流和服务端混流不能混用。
175
+ */
176
+ async StartMCUMixTranscodeByStrRoomId(req, cb) {
177
+ return this.request("StartMCUMixTranscodeByStrRoomId", req, cb);
188
178
  }
189
179
  /**
190
180
  * 接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
@@ -198,6 +188,51 @@ class Client extends TencentCloudCommon.AbstractClient {
198
188
  async DismissRoom(req, cb) {
199
189
  return this.request("DismissRoom", req, cb);
200
190
  }
191
+ /**
192
+ * 查询云端录制计费时长。
193
+
194
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
195
+ - 单次查询统计区间最多不能超过31天。
196
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
197
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
198
+ */
199
+ async DescribeRecordStatistic(req, cb) {
200
+ return this.request("DescribeRecordStatistic", req, cb);
201
+ }
202
+ /**
203
+ * 查询旁路转码计费时长。
204
+ - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
205
+ - 单次查询统计区间最多不能超过31天。
206
+ - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
207
+ - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。
208
+ */
209
+ async DescribeTrtcMcuTranscodeTime(req, cb) {
210
+ return this.request("DescribeTrtcMcuTranscodeTime", req, cb);
211
+ }
212
+ /**
213
+ * 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
214
+ */
215
+ async DescribeCloudRecording(req, cb) {
216
+ return this.request("DescribeCloudRecording", req, cb);
217
+ }
218
+ /**
219
+ * 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
220
+ */
221
+ async DeleteCloudRecording(req, cb) {
222
+ return this.request("DeleteCloudRecording", req, cb);
223
+ }
224
+ /**
225
+ * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
226
+ */
227
+ async DescribePicture(req, cb) {
228
+ return this.request("DescribePicture", req, cb);
229
+ }
230
+ /**
231
+ * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
232
+ */
233
+ async DescribeDetailEvent(req, cb) {
234
+ return this.request("DescribeDetailEvent", req, cb);
235
+ }
201
236
  /**
202
237
  * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
203
238
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。