tencentcloud-sdk-nodejs-trtc 4.1.310 → 4.1.312
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,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { DescribeAsyncTextToSpeechRequest, ModifyCloudSliceTaskResponse, DescribeCloudModerationResponse, StartStreamIngestResponse, CreatePictureRequest, DeleteRecognizeVocabV3Request, GetRecognizeVocabListV3Response, DescribeTRTCRealTimeScaleDataRequest, StartAIConversationResponse, DescribeTRTCMarketScaleDataRequest, VoiceCloneRequest, DescribeUserEventRequest, DeleteCloudModerationRequest, CreateLiveStreamModerationRequest, CreateCloudSliceTaskRequest, AsyncTextToSpeechRequest, DescribeTrtcRoomUsageResponse, RegisterVoicePrintRequest, DeleteCloudSliceTaskRequest, ControlAIConversationResponse, StopAIConversationRequest, UpdateAIConversationResponse, DescribeUserEventResponse, DeleteRecognizeVocabV3Response, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, CreateCloudModerationResponse, DescribeTRTCSegmentModerationUsageRequest, DescribeTRTCMarketScaleDataResponse, RegisterVoicePrintResponse, ModifyPictureRequest, DescribeWebRecordResponse, DescribeCloudTranscriptionResponse, DescribeUserInfoRequest, DeleteCloudModerationResponse, DescribeRelayUsageRequest, DismissRoomResponse, DescribeRecordStatisticResponse, DescribeLiveStreamModerationResponse, DeleteVoicePrintRequest, DescribeAsyncTextToSpeechResponse, DescribeTrtcUsageResponse, StopAITranscriptionRequest, SetVocabStateV3Response, CreateCloudRecordingResponse, RemoveUserRequest, DescribeWebRecordRequest, CreateRecognizeVocabV3Request, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeTRTCMarketScaleMetricDataResponse, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeTRTCAIRecognitionUsageResponse, DescribeMixTranscodingUsageRequest, DescribeTRTCRealTimeQualityDataRequest, DescribeStreamIngestResponse, CreateCloudTranscriptionResponse, DescribeTRTCMarketQualityDataResponse, DescribeVoicePrintResponse, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, StartWebRecordRequest, DescribeAITranscriptionRequest, DescribeAIConversationResponse, DeleteCloudTranscriptionResponse, DescribeUserInfoResponse, GetRecognizeVocabV3Response, RemoveUserByStrRoomIdResponse, DescribeVoicePrintRequest, UpdateStreamIngestResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DeleteLiveStreamModerationResponse, StartMCUMixTranscodeByStrRoomIdResponse, DeleteCloudSliceTaskResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest, TextToSpeechSSEResponse, DescribeRecordingUsageResponse, DescribeRecordingUsageRequest, ModifyPictureResponse, DescribeScaleInfoResponse, ModifyCloudSliceTaskRequest, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, DismissRoomRequest, DeleteLiveStreamModerationRequest, DescribeUnusualEventRequest, GetRecognizeVocabV3Request, DescribeCloudRecordingRequest, DeleteVoicePrintResponse, StartWebRecordResponse, DescribeCloudRecordingResponse, ModifyCloudModerationRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StartAITranscriptionRequest, StopMCUMixTranscodeByStrRoomIdRequest, StartAIConversationRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StopAIConversationResponse, CreateLiveStreamModerationResponse, DescribeAIConversationRequest, DismissRoomByStrRoomIdRequest,
|
|
2
|
+
import { DescribeAsyncTextToSpeechRequest, ModifyCloudSliceTaskResponse, DescribeCloudModerationResponse, StartStreamIngestResponse, CreatePictureRequest, DeleteRecognizeVocabV3Request, GetRecognizeVocabListV3Response, DescribeTRTCRealTimeScaleDataRequest, StartAIConversationResponse, DescribeTRTCMarketScaleDataRequest, VoiceCloneRequest, DescribeUserEventRequest, DeleteCloudModerationRequest, CreateLiveStreamModerationRequest, CreateCloudSliceTaskRequest, AsyncTextToSpeechRequest, DescribeTrtcRoomUsageResponse, RegisterVoicePrintRequest, DeleteCloudSliceTaskRequest, ControlAIConversationResponse, StopAIConversationRequest, UpdateAIConversationResponse, DescribeUserEventResponse, DeleteRecognizeVocabV3Response, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, CreateCloudModerationResponse, DescribeTRTCSegmentModerationUsageRequest, DescribeTRTCMarketScaleDataResponse, RegisterVoicePrintResponse, ModifyPictureRequest, DescribeWebRecordResponse, DescribeCloudTranscriptionResponse, DescribeUserInfoRequest, DeleteCloudModerationResponse, DescribeRelayUsageRequest, DismissRoomResponse, DescribeRecordStatisticResponse, DescribeLiveStreamModerationResponse, DeleteVoicePrintRequest, DescribeAsyncTextToSpeechResponse, DescribeTrtcUsageResponse, StopAITranscriptionRequest, SetVocabStateV3Response, CreateCloudRecordingResponse, RemoveUserRequest, DescribeWebRecordRequest, CreateRecognizeVocabV3Request, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeTRTCMarketScaleMetricDataResponse, DescribeCallDetailInfoResponse, DescribeTRTCRealTimeQualityDataResponse, DescribeTRTCAIRecognitionUsageResponse, DescribeMixTranscodingUsageRequest, DescribeTRTCRealTimeQualityDataRequest, DescribeStreamIngestResponse, CreateCloudTranscriptionResponse, DescribeTRTCMarketQualityDataResponse, DescribeVoicePrintResponse, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, StartWebRecordRequest, DescribeAITranscriptionRequest, DescribeAIConversationResponse, DeleteCloudTranscriptionResponse, DescribeUserInfoResponse, GetRecognizeVocabV3Response, RemoveUserByStrRoomIdResponse, DescribeVoicePrintRequest, UpdateStreamIngestResponse, StartMCUMixTranscodeRequest, StartPublishCdnStreamResponse, DeleteLiveStreamModerationResponse, StartMCUMixTranscodeByStrRoomIdResponse, DeleteCloudSliceTaskResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, StartStreamIngestRequest, TextToSpeechSSEResponse, DescribeRecordingUsageResponse, DescribeRecordingUsageRequest, ModifyPictureResponse, DescribeScaleInfoResponse, ModifyCloudSliceTaskRequest, StopMCUMixTranscodeResponse, CreateAudioModerationSyncResponse, DescribeMixTranscodingUsageResponse, DismissRoomRequest, DeleteLiveStreamModerationRequest, DescribeUnusualEventRequest, GetRecognizeVocabV3Request, DescribeCloudRecordingRequest, DeleteVoicePrintResponse, StartWebRecordResponse, CreateAudioModerationSyncRequest, DescribeCloudRecordingResponse, ModifyCloudModerationRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StartAITranscriptionRequest, StopMCUMixTranscodeByStrRoomIdRequest, StartAIConversationRequest, DeletePictureResponse, ModifyCloudRecordingRequest, StopAIConversationResponse, CreateLiveStreamModerationResponse, DescribeAIConversationRequest, DismissRoomByStrRoomIdRequest, DescribeCloudTranscriptionRequest, CreateCloudSliceTaskResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DownloadRecognizeVocabV3Request, ModifyCloudModerationResponse, DescribeLiveStreamModerationRequest, DescribeTRTCSegmentModerationUsageResponse, DescribePictureResponse, DescribeTrtcRoomUsageRequest, TextToSpeechResponse, CreateCloudModerationRequest, StopStreamIngestRequest, DescribeTrtcMcuTranscodeTimeRequest, StopStreamIngestResponse, DescribeScaleInfoRequest, ControlAIConversationRequest, DismissRoomByStrRoomIdResponse, StopPublishCdnStreamResponse, StopPublishCdnStreamRequest, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, CreateCloudTranscriptionRequest, AsyncTextToSpeechResponse, GetRecognizeVocabListV3Request, DescribeCloudSliceTaskRequest, StartMCUMixTranscodeByStrRoomIdRequest, SetVocabStateV3Request, DescribeTRTCMarketQualityDataRequest, DescribeTRTCRealTimeScaleDataResponse, DeleteCloudTranscriptionRequest, UpdatePublishCdnStreamRequest, DescribeTRTCDedicatedCloudAccUsageRequest, VoiceCloneResponse, UpdateStreamIngestRequest, TextToSpeechSSERequest, StopWebRecordResponse, DeletePictureRequest, StopWebRecordRequest, UpdateVoicePrintRequest, StartPublishCdnStreamRequest, UpdateAIConversationRequest, UpdatePublishCdnStreamResponse, RemoveUserByStrRoomIdRequest, UpdateRecognizeVocabV3Response, UpdateRecognizeVocabV3Request, TextToSpeechRequest, DescribeStreamIngestRequest, UpdateVoicePrintResponse, DownloadRecognizeVocabV3Response, DescribeTRTCDedicatedCloudAccUsageResponse, DescribeTRTCAIRecognitionUsageRequest, StopAITranscriptionResponse, CreateRecognizeVocabV3Response, StopMCUMixTranscodeRequest, DescribeCloudModerationRequest, DescribeAITranscriptionResponse, DescribeCloudSliceTaskResponse, CreatePictureResponse, StartAITranscriptionResponse, RemoveUserResponse } from "./trtc_models";
|
|
3
3
|
/**
|
|
4
4
|
* trtc client
|
|
5
5
|
* @class
|
|
@@ -7,28 +7,126 @@ import { DescribeAsyncTextToSpeechRequest, ModifyCloudSliceTaskResponse, Describ
|
|
|
7
7
|
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
8
|
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
* 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
|
|
11
|
+
|
|
12
|
+
TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
13
|
+
|
|
14
|
+
您可以通过此接口实现如下目标：
|
|
15
|
+
- 设置最终直播流的画质和音质，包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
16
|
+
- 设置各路画面的位置和布局，您只需要在启动时设置一次，排版引擎会自动完成后续的画面排布。
|
|
17
|
+
- 设置录制文件名，用于二次回放。
|
|
18
|
+
- 设置 CDN 直播流 ID，用于在 CDN 进行直播观看。
|
|
19
|
+
|
|
20
|
+
目前已经支持了如下几种布局模板：
|
|
21
|
+
- 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。
|
|
22
|
+
- 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小。最多支持16个画面，如果用户只发送音频，仍然会占用画面位置。
|
|
23
|
+
- 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时，左侧大画面为了保持内容的完整性采用缩放方式处理，右侧小画面采用裁剪方式处理。
|
|
24
|
+
- 画中画模板：适用于混合大小两路视频画面和其他用户混音，或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上，可以指定大小画面的用户以及小画面的显示位置，最多支持2个画面。
|
|
25
|
+
- 自定义模板：适用于在混流中指定用户的画面位置，或者预设视频画面位置的场景。当预设位置指定用户时，排版引擎会为该用户预留位置；当预设位置未指定用户时，排版引擎会根据进房间顺序自动填充。预设位置填满时，不再混合其他用户的画面和声音。自定义模板启用占位图功能时（LayoutParams中的PlaceHolderMode设置成1），在预设位置的用户没有上行视频时可显示对应的占位图（PlaceImageId）。
|
|
26
|
+
|
|
27
|
+
注意：
|
|
28
|
+
1、**混流转码为收费功能，调用接口将产生云端混流转码费用，详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
29
|
+
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流，如需切换至MCU混流，请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
30
|
+
3、客户端混流和服务端混流不能混用。
|
|
13
31
|
*/
|
|
14
|
-
|
|
32
|
+
StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
|
|
15
33
|
/**
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
34
|
+
* 停止AI对话任务
|
|
35
|
+
*/
|
|
36
|
+
StopAIConversation(req: StopAIConversationRequest, cb?: (error: string, rep: StopAIConversationResponse) => void): Promise<StopAIConversationResponse>;
|
|
37
|
+
/**
|
|
38
|
+
* 接口说明：结束云端混流
|
|
39
|
+
*/
|
|
40
|
+
StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* 查询AI对话任务状态。
|
|
43
|
+
*/
|
|
44
|
+
DescribeAIConversation(req: DescribeAIConversationRequest, cb?: (error: string, rep: DescribeAIConversationResponse) => void): Promise<DescribeAIConversationResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* 查询TRTC监控仪表盘-实时监控规模指标（会返回下列指标）
|
|
47
|
+
-userCount（在线用户数）
|
|
48
|
+
-roomCount（在线房间数）
|
|
19
49
|
注意：
|
|
20
50
|
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。
|
|
21
51
|
2.查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
|
|
22
52
|
*/
|
|
23
|
-
|
|
53
|
+
DescribeTRTCRealTimeScaleData(req: DescribeTRTCRealTimeScaleDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeScaleDataResponse) => void): Promise<DescribeTRTCRealTimeScaleDataResponse>;
|
|
24
54
|
/**
|
|
25
|
-
*
|
|
55
|
+
* 接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
26
56
|
*/
|
|
27
|
-
|
|
57
|
+
RemoveUser(req: RemoveUserRequest, cb?: (error: string, rep: RemoveUserResponse) => void): Promise<RemoveUserResponse>;
|
|
28
58
|
/**
|
|
29
|
-
*
|
|
59
|
+
* 成功开启直播流AI 内容理解任务后，可以使用此接口来查询AI 内容理解任务状态，仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
30
60
|
*/
|
|
31
|
-
|
|
61
|
+
DescribeLiveStreamModeration(req: DescribeLiveStreamModerationRequest, cb?: (error: string, rep: DescribeLiveStreamModerationResponse) => void): Promise<DescribeLiveStreamModerationResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* 传入音频base64串，注册声纹信息，返回声纹ID
|
|
64
|
+
*/
|
|
65
|
+
RegisterVoicePrint(req: RegisterVoicePrintRequest, cb?: (error: string, rep: RegisterVoicePrintResponse) => void): Promise<RegisterVoicePrintResponse>;
|
|
66
|
+
/**
|
|
67
|
+
* 接口说明：结束云端混流
|
|
68
|
+
*/
|
|
69
|
+
StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* 声音克隆
|
|
72
|
+
*/
|
|
73
|
+
VoiceClone(req: VoiceCloneRequest, cb?: (error: string, rep: VoiceCloneResponse) => void): Promise<VoiceCloneResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* 成功开启转录后，可以使用此接口来查询录制状态。仅在转录任务进行时有效，转录退出后查询将会返回错误。
|
|
76
|
+
*/
|
|
77
|
+
DescribeCloudTranscription(req: DescribeCloudTranscriptionRequest, cb?: (error: string, rep: DescribeCloudTranscriptionResponse) => void): Promise<DescribeCloudTranscriptionResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* 成功开启直播流AI 内容理解任务后，可以使用此接口来停止进行内容识别。
|
|
80
|
+
*/
|
|
81
|
+
DeleteLiveStreamModeration(req: DeleteLiveStreamModerationRequest, cb?: (error: string, rep: DeleteLiveStreamModerationResponse) => void): Promise<DeleteLiveStreamModerationResponse>;
|
|
82
|
+
/**
|
|
83
|
+
* 成功开启切片任务后，可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。
|
|
84
|
+
*/
|
|
85
|
+
ModifyCloudSliceTask(req: ModifyCloudSliceTaskRequest, cb?: (error: string, rep: ModifyCloudSliceTaskResponse) => void): Promise<ModifyCloudSliceTaskResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* 获取TRTC录制的用量明细。
|
|
88
|
+
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
89
|
+
- 单次查询统计区间最多不能超过31天。
|
|
90
|
+
- 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
91
|
+
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。
|
|
92
|
+
- 默认接口请求频率限制：5次/秒。
|
|
93
|
+
*/
|
|
94
|
+
DescribeRecordingUsage(req: DescribeRecordingUsageRequest, cb?: (error: string, rep: DescribeRecordingUsageResponse) => void): Promise<DescribeRecordingUsageResponse>;
|
|
95
|
+
/**
|
|
96
|
+
* 成功开启切片任务后，可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
|
|
97
|
+
*/
|
|
98
|
+
DeleteCloudSliceTask(req: DeleteCloudSliceTaskRequest, cb?: (error: string, rep: DeleteCloudSliceTaskResponse) => void): Promise<DeleteCloudSliceTaskResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* 接口说明：
|
|
101
|
+
用户通过本接口分页列举所有的热词表。
|
|
102
|
+
*/
|
|
103
|
+
GetRecognizeVocabListV3(req: GetRecognizeVocabListV3Request, cb?: (error: string, rep: GetRecognizeVocabListV3Response) => void): Promise<GetRecognizeVocabListV3Response>;
|
|
104
|
+
/**
|
|
105
|
+
* 查询TRTC音视频房间维度用量。
|
|
106
|
+
- 单次只能查询一天数据，返回查询时间段内的汇总数据；通过多次查询可以查不同天数据。若查询跨天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
107
|
+
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用，不可用于账单核对，如需对账请使用账号/应用维度用量API：DescribeTrtcUsage。
|
|
108
|
+
- 默认接口请求频率限制：1次/15秒。
|
|
109
|
+
- 数据最早可查日期为2023年4月1日0点，最大可查范围近3个月。
|
|
110
|
+
*/
|
|
111
|
+
DescribeTrtcRoomUsage(req: DescribeTrtcRoomUsageRequest, cb?: (error: string, rep: DescribeTrtcRoomUsageResponse) => void): Promise<DescribeTrtcRoomUsageResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* 查询AI转录任务状态。
|
|
114
|
+
*/
|
|
115
|
+
DescribeAITranscription(req: DescribeAITranscriptionRequest, cb?: (error: string, rep: DescribeAITranscriptionResponse) => void): Promise<DescribeAITranscriptionResponse>;
|
|
116
|
+
/**
|
|
117
|
+
* 成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
|
|
118
|
+
*/
|
|
119
|
+
DeleteCloudRecording(req: DeleteCloudRecordingRequest, cb?: (error: string, rep: DeleteCloudRecordingResponse) => void): Promise<DeleteCloudRecordingResponse>;
|
|
120
|
+
/**
|
|
121
|
+
* 查询SdkAppId下任意20条异常体验事件，返回异常体验ID与可能产生异常体验的原因。可查询14天内数据，查询起止时间不超过1个小时。支持跨天查询。（同老接口DescribeAbnormalEvent）
|
|
122
|
+
异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916
|
|
123
|
+
*/
|
|
124
|
+
DescribeUnusualEvent(req: DescribeUnusualEventRequest, cb?: (error: string, rep: DescribeUnusualEventResponse) => void): Promise<DescribeUnusualEventResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* 接口说明：
|
|
127
|
+
用户根据词表的ID可以获取对应的热词表信息
|
|
128
|
+
*/
|
|
129
|
+
GetRecognizeVocabV3(req: GetRecognizeVocabV3Request, cb?: (error: string, rep: GetRecognizeVocabV3Response) => void): Promise<GetRecognizeVocabV3Response>;
|
|
32
130
|
/**
|
|
33
131
|
* 更新AIConversation参数
|
|
34
132
|
*/
|
|
@@ -43,53 +141,101 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
43
141
|
*/
|
|
44
142
|
DescribeTrtcUsage(req: DescribeTrtcUsageRequest, cb?: (error: string, rep: DescribeTrtcUsageResponse) => void): Promise<DescribeTrtcUsageResponse>;
|
|
45
143
|
/**
|
|
46
|
-
*
|
|
144
|
+
* 接口说明：
|
|
145
|
+
启动一个混流转推任务，将 TRTC 房间的多路音视频流混成一路音视频流，编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后，会返回一个 SdkAppid 维度唯一的任务 Id（TaskId）。您需要保存该 TaskId，后续需要依赖此 TaskId 更新和结束任务。可以参考文档： [功能说明](https://cloud.tencent.com/document/product/647/84721#b9a855f4-e38c-4616-9b07-fc44e0e8282a) 和 [常见问题](https://cloud.tencent.com/document/product/647/62620)
|
|
146
|
+
需要注意的是，TaskId调用时效性是30天，从成功启动转推并获得任务ID后开始计算，超时后无法调用更新和停止等接口，但是转推任务不会停止。最终任务会等所有参与混流转推的主播离开TRTC房间或切换成观众，并且超过MaxIdleTime时长后，自动停止。
|
|
147
|
+
|
|
148
|
+
注意：
|
|
149
|
+
您可以在控制台开通旁路转推回调功能，对转推 CDN 状态的事件进行监控，回调请参考文档：[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552)
|
|
150
|
+
您发起混流转推任务时，可能会产生如下费用：
|
|
151
|
+
MCU 混流转码费用，请参考文档：[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
|
|
152
|
+
转推非腾讯云 CDN 费用，请参考文档：[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
|
|
153
|
+
*/
|
|
154
|
+
StartPublishCdnStream(req: StartPublishCdnStreamRequest, cb?: (error: string, rep: StartPublishCdnStreamResponse) => void): Promise<StartPublishCdnStreamResponse>;
|
|
155
|
+
/**
|
|
156
|
+
* 查询指定时间内的用户列表及用户通话质量数据，最大可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail）
|
|
47
157
|
**注意**：
|
|
48
158
|
1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
|
|
49
|
-
2.该接口自2024年4月1
|
|
159
|
+
2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任选其一解锁：
|
|
50
160
|
方式一：通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」（可查近7天）和「旗舰版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
|
|
51
161
|
方式二：通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」（可查近7天）和「进阶版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
|
|
52
162
|
*/
|
|
53
|
-
|
|
163
|
+
DescribeCallDetailInfo(req: DescribeCallDetailInfoRequest, cb?: (error: string, rep: DescribeCallDetailInfoResponse) => void): Promise<DescribeCallDetailInfoResponse>;
|
|
54
164
|
/**
|
|
55
|
-
|
|
165
|
+
* 将一个在线媒体流推到TRTC房间，更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
|
|
166
|
+
使用输入在线媒体流功能需先订阅 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386) 解锁能力位。
|
|
167
|
+
*/
|
|
168
|
+
StartStreamIngest(req: StartStreamIngestRequest, cb?: (error: string, rep: StartStreamIngestResponse) => void): Promise<StartStreamIngestResponse>;
|
|
169
|
+
/**
|
|
170
|
+
* 短音频同步内容理解接口
|
|
56
171
|
*/
|
|
57
|
-
|
|
172
|
+
CreateAudioModerationSync(req: CreateAudioModerationSyncRequest, cb?: (error: string, rep: CreateAudioModerationSyncResponse) => void): Promise<CreateAudioModerationSyncResponse>;
|
|
58
173
|
/**
|
|
59
|
-
*
|
|
174
|
+
* 更新输入在线媒体流任务的StreamUrl
|
|
60
175
|
*/
|
|
61
|
-
|
|
176
|
+
UpdateStreamIngest(req: UpdateStreamIngestRequest, cb?: (error: string, rep: UpdateStreamIngestResponse) => void): Promise<UpdateStreamIngestResponse>;
|
|
177
|
+
/**
|
|
178
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印，可通过此接口删除已上传的图片。无需频繁删除图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
179
|
+
*/
|
|
180
|
+
DeletePicture(req: DeletePictureRequest, cb?: (error: string, rep: DeletePictureResponse) => void): Promise<DeletePictureResponse>;
|
|
62
181
|
/**
|
|
63
182
|
* 接口说明：
|
|
64
|
-
|
|
183
|
+
用户通过本接口进行热词表的创建。
|
|
184
|
+
|
|
185
|
+
• 默认最多可创建30个热词表。
|
|
186
|
+
• 每个热词表最多可添加1000个词，每个词最长10个汉字或30个英文字符，不能超出限制。
|
|
187
|
+
• 热词表可以通过数组或者本地文件形式上传。
|
|
188
|
+
• 本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。
|
|
189
|
+
• 热词权重取值范围为[1,11]之间的整数或者100，权重越大代表该词被识别出来的概率越大。
|
|
190
|
+
• 注意: 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多权重为11的热词将影响整体字准率。
|
|
65
191
|
*/
|
|
66
|
-
|
|
192
|
+
CreateRecognizeVocabV3(req: CreateRecognizeVocabV3Request, cb?: (error: string, rep: CreateRecognizeVocabV3Response) => void): Promise<CreateRecognizeVocabV3Response>;
|
|
67
193
|
/**
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
194
|
+
* 成功开启录制后，可以使用此接口来更新录制任务。仅在录制任务进行时有效，录制退出后更新将会返回错误。更新操作是全量覆盖，并不是增量更新的模式，也就是说每次更新都需要携带全量的信息。
|
|
195
|
+
*/
|
|
196
|
+
ModifyCloudRecording(req: ModifyCloudRecordingRequest, cb?: (error: string, rep: ModifyCloudRecordingResponse) => void): Promise<ModifyCloudRecordingResponse>;
|
|
197
|
+
/**
|
|
198
|
+
* 通过此接口可以发起 WEB 页面录制任务，在接口参数中指定录制 URL，录制分辨率，录制结果存储等参数。
|
|
199
|
+
因为参数或API逻辑问题会立即返回结果。而因为页面问题，如页面无法访问，会在回调中返回结果，请关注。
|
|
74
200
|
*/
|
|
75
|
-
|
|
201
|
+
StartWebRecord(req: StartWebRecordRequest, cb?: (error: string, rep: StartWebRecordResponse) => void): Promise<StartWebRecordResponse>;
|
|
76
202
|
/**
|
|
77
|
-
*
|
|
203
|
+
* 停止页面录制任务
|
|
78
204
|
*/
|
|
79
|
-
|
|
205
|
+
StopWebRecord(req: StopWebRecordRequest, cb?: (error: string, rep: StopWebRecordResponse) => void): Promise<StopWebRecordResponse>;
|
|
80
206
|
/**
|
|
81
|
-
*
|
|
207
|
+
* 接口说明：
|
|
208
|
+
启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
|
|
209
|
+
在线上正式运营之前，请关注录制的最佳实践 [录制最佳实践](https://cloud.tencent.com/document/product/647/76497#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c)，配合最佳实践，可大大提高接口录制的可用性。
|
|
82
210
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
211
|
+
您可以通过此接口实现如下目标：
|
|
212
|
+
* 指定订阅流参数（RecordParams）来指定需要录制的主播的黑名单或者白名单。
|
|
213
|
+
* 指定录制存储参数（StorageParams）来指定上传到您希望的云存储，目前支持腾讯云（云点播VOD、对象存储COS）和第三方AWS
|
|
214
|
+
* 指定合流模式下的音视频转码详细参数（MixTranscodeParams），包括视频分辨率、视频码率、视频帧率、以及声音质量等
|
|
215
|
+
* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
|
|
216
|
+
|
|
217
|
+
关键名词：
|
|
218
|
+
* 单流录制：分别录制房间的订阅UserId的音频和视频，录制服务会实时将录制文件上传至您指定的云存储。
|
|
219
|
+
* 合流录制：将房间内订阅UserId的音视频混录成一个视频文件，并将录制文件上传至您指定的云存储。（录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件）。
|
|
91
220
|
*/
|
|
92
|
-
|
|
221
|
+
CreateCloudRecording(req: CreateCloudRecordingRequest, cb?: (error: string, rep: CreateCloudRecordingResponse) => void): Promise<CreateCloudRecordingResponse>;
|
|
222
|
+
/**
|
|
223
|
+
* 成功开启AI 内容理解任务后，可以使用此接口来停止进行内容识别。
|
|
224
|
+
*/
|
|
225
|
+
DeleteCloudModeration(req: DeleteCloudModerationRequest, cb?: (error: string, rep: DeleteCloudModerationResponse) => void): Promise<DeleteCloudModerationResponse>;
|
|
226
|
+
/**
|
|
227
|
+
* 可查询SdkAppId每天的房间数和用户数，按天统计，可查询最近14天的数据。当天未结束，数据未统计完成，无法查到当天的房间数与用户数。（同老接口DescribeHistoryScale）
|
|
228
|
+
*/
|
|
229
|
+
DescribeScaleInfo(req: DescribeScaleInfoRequest, cb?: (error: string, rep: DescribeScaleInfoResponse) => void): Promise<DescribeScaleInfoResponse>;
|
|
230
|
+
/**
|
|
231
|
+
* 获取TRTC混流转码的用量明细。
|
|
232
|
+
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
233
|
+
- 单次查询统计区间最多不能超过31天。
|
|
234
|
+
- 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
235
|
+
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。
|
|
236
|
+
- 默认接口请求频率限制：5次/秒。
|
|
237
|
+
*/
|
|
238
|
+
DescribeMixTranscodingUsage(req: DescribeMixTranscodingUsageRequest, cb?: (error: string, rep: DescribeMixTranscodingUsageResponse) => void): Promise<DescribeMixTranscodingUsageResponse>;
|
|
93
239
|
/**
|
|
94
240
|
* 查询云端录制计费时长。
|
|
95
241
|
|
|
@@ -100,32 +246,120 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
100
246
|
*/
|
|
101
247
|
DescribeRecordStatistic(req: DescribeRecordStatisticRequest, cb?: (error: string, rep: DescribeRecordStatisticResponse) => void): Promise<DescribeRecordStatisticResponse>;
|
|
102
248
|
/**
|
|
103
|
-
*
|
|
249
|
+
* 查询先前注册的声纹信息
|
|
104
250
|
*/
|
|
105
|
-
|
|
251
|
+
DescribeVoicePrint(req: DescribeVoicePrintRequest, cb?: (error: string, rep: DescribeVoicePrintResponse) => void): Promise<DescribeVoicePrintResponse>;
|
|
252
|
+
/**
|
|
253
|
+
* 接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
254
|
+
*/
|
|
255
|
+
DismissRoomByStrRoomId(req: DismissRoomByStrRoomIdRequest, cb?: (error: string, rep: DismissRoomByStrRoomIdResponse) => void): Promise<DismissRoomByStrRoomIdResponse>;
|
|
256
|
+
/**
|
|
257
|
+
* 查询TRTC监控仪表盘-实时监控质量指标（会返回下列指标）
|
|
258
|
+
-视频卡顿率
|
|
259
|
+
-音频卡顿率
|
|
260
|
+
注意：
|
|
261
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。
|
|
262
|
+
2.查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
|
|
263
|
+
*/
|
|
264
|
+
DescribeTRTCRealTimeQualityData(req: DescribeTRTCRealTimeQualityDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeQualityDataResponse) => void): Promise<DescribeTRTCRealTimeQualityDataResponse>;
|
|
265
|
+
/**
|
|
266
|
+
* 提供服务端控制机器人的功能
|
|
267
|
+
*/
|
|
268
|
+
ControlAIConversation(req: ControlAIConversationRequest, cb?: (error: string, rep: ControlAIConversationResponse) => void): Promise<ControlAIConversationResponse>;
|
|
269
|
+
/**
|
|
270
|
+
* SSE流式文本转语音
|
|
271
|
+
*/
|
|
272
|
+
TextToSpeechSSE(req: TextToSpeechSSERequest, cb?: (error: string, rep: TextToSpeechSSEResponse) => void): Promise<TextToSpeechSSEResponse>;
|
|
273
|
+
/**
|
|
274
|
+
* 查询SdkAppId下的房间列表。默认返回10条通话，一次最多返回100条通话。最大可查询14天内的数据。（同老接口DescribeRoomInformation）
|
|
275
|
+
**注意**：
|
|
276
|
+
1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
|
|
277
|
+
2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任意其一解锁：
|
|
278
|
+
方式一：通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」（可查近7天）和「旗舰版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
|
|
279
|
+
方式二：通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」（可查近7天）和「进阶版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
|
|
280
|
+
*/
|
|
281
|
+
DescribeRoomInfo(req: DescribeRoomInfoRequest, cb?: (error: string, rep: DescribeRoomInfoResponse) => void): Promise<DescribeRoomInfoResponse>;
|
|
282
|
+
/**
|
|
283
|
+
* 您可以查询输入在线媒体流任务的状态。
|
|
284
|
+
*/
|
|
285
|
+
DescribeStreamIngest(req: DescribeStreamIngestRequest, cb?: (error: string, rep: DescribeStreamIngestResponse) => void): Promise<DescribeStreamIngestResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* 接口说明：
|
|
288
|
+
用户通过该接口可以设置热词表的默认状态。初始状态为0，用户可设置状态为1，即为默认状态。默认状态表示用户在请求识别时，如不设置热词表ID，则默认使用状态为1的热词表。
|
|
289
|
+
*/
|
|
290
|
+
SetVocabStateV3(req: SetVocabStateV3Request, cb?: (error: string, rep: SetVocabStateV3Response) => void): Promise<SetVocabStateV3Response>;
|
|
106
291
|
/**
|
|
107
292
|
* 接口说明：
|
|
108
293
|
用户通过本接口进行热词表的更新。
|
|
109
294
|
*/
|
|
110
295
|
UpdateRecognizeVocabV3(req: UpdateRecognizeVocabV3Request, cb?: (error: string, rep: UpdateRecognizeVocabV3Response) => void): Promise<UpdateRecognizeVocabV3Response>;
|
|
296
|
+
/**
|
|
297
|
+
* 传入声纹ID，删除之前注册的声纹信息
|
|
298
|
+
*/
|
|
299
|
+
DeleteVoicePrint(req: DeleteVoicePrintRequest, cb?: (error: string, rep: DeleteVoicePrintResponse) => void): Promise<DeleteVoicePrintResponse>;
|
|
111
300
|
/**
|
|
112
301
|
* 接口说明：
|
|
113
|
-
|
|
302
|
+
成功发起混流转推后，可以使用此接口来更新任务。仅在任务进行时有效，任务退出后更新将会返回错误。更新操作为增量更新模式。
|
|
303
|
+
注意：为了保障推流的稳定性，更新不支持任务在纯音频、音视频、纯视频之间进行切换。
|
|
114
304
|
*/
|
|
115
|
-
|
|
305
|
+
UpdatePublishCdnStream(req: UpdatePublishCdnStreamRequest, cb?: (error: string, rep: UpdatePublishCdnStreamResponse) => void): Promise<UpdatePublishCdnStreamResponse>;
|
|
116
306
|
/**
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
307
|
+
* 语音合成接口
|
|
308
|
+
*/
|
|
309
|
+
TextToSpeech(req: TextToSpeechRequest, cb?: (error: string, rep: TextToSpeechResponse) => void): Promise<TextToSpeechResponse>;
|
|
310
|
+
/**
|
|
311
|
+
* 启动AI对话任务，AI通道机器人进入TRTC房间，与房间内指定的成员进行AI对话，适用于智能客服，AI口语教师等场景
|
|
312
|
+
|
|
313
|
+
TRTC AI对话功能内置语音转文本能力，同时提供通道服务，即客户可灵活指定第三方AI模型（LLM）服务和文本转音频（TTS)服务，更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。
|
|
314
|
+
*/
|
|
315
|
+
StartAIConversation(req: StartAIConversationRequest, cb?: (error: string, rep: StartAIConversationResponse) => void): Promise<StartAIConversationResponse>;
|
|
316
|
+
/**
|
|
317
|
+
* 接口说明：
|
|
318
|
+
用户通过本接口进行热词表的删除。
|
|
319
|
+
*/
|
|
320
|
+
DeleteRecognizeVocabV3(req: DeleteRecognizeVocabV3Request, cb?: (error: string, rep: DeleteRecognizeVocabV3Response) => void): Promise<DeleteRecognizeVocabV3Response>;
|
|
321
|
+
/**
|
|
322
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印，可通过此接口上传新的图片素材。无需频繁新增图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
323
|
+
*/
|
|
324
|
+
CreatePicture(req: CreatePictureRequest, cb?: (error: string, rep: CreatePictureResponse) => void): Promise<CreatePictureResponse>;
|
|
325
|
+
/**
|
|
326
|
+
* 启动一路直播流审核。服务端异步拉流、定频截帧、音频切片、送审，通过回调返回结果。一次一个任务（一路流）。您可以通过此接口实现如下目标：
|
|
327
|
+
●指定内容参数（LiveModerationParams）来指定内容理解需要的详细参数。
|
|
328
|
+
●指定存储参数（LiveModerationStorageParams）将命中的切片文件指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）以及第三方AWS（S3）和阿里云（OSS）
|
|
329
|
+
*/
|
|
330
|
+
CreateLiveStreamModeration(req: CreateLiveStreamModerationRequest, cb?: (error: string, rep: CreateLiveStreamModerationResponse) => void): Promise<CreateLiveStreamModerationResponse>;
|
|
331
|
+
/**
|
|
332
|
+
* 查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
|
|
333
|
+
userCount：通话人数，
|
|
334
|
+
roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
335
|
+
peakCurrentChannels：峰值同时在线频道数。
|
|
336
|
+
peakCurrentUsers：峰值同时在线人数。
|
|
120
337
|
注意：
|
|
121
|
-
1
|
|
122
|
-
2
|
|
338
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
|
|
339
|
+
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
|
|
123
340
|
*/
|
|
124
|
-
|
|
341
|
+
DescribeTRTCMarketScaleData(req: DescribeTRTCMarketScaleDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleDataResponse) => void): Promise<DescribeTRTCMarketScaleDataResponse>;
|
|
125
342
|
/**
|
|
126
|
-
*
|
|
343
|
+
* 成功开启AI 内容理解任务后，可以使用此接口来更新订阅黑白名单。
|
|
127
344
|
*/
|
|
128
|
-
|
|
345
|
+
ModifyCloudModeration(req: ModifyCloudModerationRequest, cb?: (error: string, rep: ModifyCloudModerationResponse) => void): Promise<ModifyCloudModerationResponse>;
|
|
346
|
+
/**
|
|
347
|
+
* 成功开启切片后，可以使用此接口来查询切片任务状态。仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
348
|
+
*/
|
|
349
|
+
DescribeCloudSliceTask(req: DescribeCloudSliceTaskRequest, cb?: (error: string, rep: DescribeCloudSliceTaskResponse) => void): Promise<DescribeCloudSliceTaskResponse>;
|
|
350
|
+
/**
|
|
351
|
+
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材，可通过此接口修改已上传的图片。无需频繁修改图片素材的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
352
|
+
*/
|
|
353
|
+
ModifyPicture(req: ModifyPictureRequest, cb?: (error: string, rep: ModifyPictureResponse) => void): Promise<ModifyPictureResponse>;
|
|
354
|
+
/**
|
|
355
|
+
* 查询指定时间内的用户列表，最大可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。（同老接口DescribeUserInformation）
|
|
356
|
+
**注意**：
|
|
357
|
+
1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
|
|
358
|
+
2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任选其一解锁：
|
|
359
|
+
方式一：通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」（可查近7天）和「旗舰版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
|
|
360
|
+
方式二：通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」（可查近7天）和「进阶版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
|
|
361
|
+
*/
|
|
362
|
+
DescribeUserInfo(req: DescribeUserInfoRequest, cb?: (error: string, rep: DescribeUserInfoResponse) => void): Promise<DescribeUserInfoResponse>;
|
|
129
363
|
/**
|
|
130
364
|
* 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
|
|
131
365
|
|
|
@@ -150,44 +384,19 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
150
384
|
3、客户端混流和服务端混流不能混用。
|
|
151
385
|
*/
|
|
152
386
|
StartMCUMixTranscodeByStrRoomId(req: StartMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StartMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StartMCUMixTranscodeByStrRoomIdResponse>;
|
|
153
|
-
/**
|
|
154
|
-
* 语音合成接口
|
|
155
|
-
*/
|
|
156
|
-
TextToSpeech(req: TextToSpeechRequest, cb?: (error: string, rep: TextToSpeechResponse) => void): Promise<TextToSpeechResponse>;
|
|
157
|
-
/**
|
|
158
|
-
* 将一个在线媒体流推到TRTC房间，更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
|
|
159
|
-
使用输入在线媒体流功能需先订阅 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386) 解锁能力位。
|
|
160
|
-
*/
|
|
161
|
-
StartStreamIngest(req: StartStreamIngestRequest, cb?: (error: string, rep: StartStreamIngestResponse) => void): Promise<StartStreamIngestResponse>;
|
|
162
|
-
/**
|
|
163
|
-
* 启动AI对话任务，AI通道机器人进入TRTC房间，与房间内指定的成员进行AI对话，适用于智能客服，AI口语教师等场景
|
|
164
|
-
|
|
165
|
-
TRTC AI对话功能内置语音转文本能力，同时提供通道服务，即客户可灵活指定第三方AI模型（LLM）服务和文本转音频（TTS)服务，更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。
|
|
166
|
-
*/
|
|
167
|
-
StartAIConversation(req: StartAIConversationRequest, cb?: (error: string, rep: StartAIConversationResponse) => void): Promise<StartAIConversationResponse>;
|
|
168
387
|
/**
|
|
169
388
|
* 接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
170
389
|
*/
|
|
171
390
|
RemoveUserByStrRoomId(req: RemoveUserByStrRoomIdRequest, cb?: (error: string, rep: RemoveUserByStrRoomIdResponse) => void): Promise<RemoveUserByStrRoomIdResponse>;
|
|
172
391
|
/**
|
|
173
|
-
|
|
174
|
-
用户通过本接口进行热词表的删除。
|
|
175
|
-
*/
|
|
176
|
-
DeleteRecognizeVocabV3(req: DeleteRecognizeVocabV3Request, cb?: (error: string, rep: DeleteRecognizeVocabV3Response) => void): Promise<DeleteRecognizeVocabV3Response>;
|
|
177
|
-
/**
|
|
178
|
-
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印，可通过此接口删除已上传的图片。无需频繁删除图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
179
|
-
*/
|
|
180
|
-
DeletePicture(req: DeletePictureRequest, cb?: (error: string, rep: DeletePictureResponse) => void): Promise<DeletePictureResponse>;
|
|
181
|
-
/**
|
|
182
|
-
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印，可通过此接口上传新的图片素材。无需频繁新增图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
392
|
+
* 停止AI转录任务。
|
|
183
393
|
*/
|
|
184
|
-
|
|
394
|
+
StopAITranscription(req: StopAITranscriptionRequest, cb?: (error: string, rep: StopAITranscriptionResponse) => void): Promise<StopAITranscriptionResponse>;
|
|
185
395
|
/**
|
|
186
|
-
*
|
|
187
|
-
|
|
188
|
-
●指定存储参数（LiveModerationStorageParams）将命中的切片文件指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）以及第三方AWS（S3）和阿里云（OSS）
|
|
396
|
+
* 成功开启录制后，可以使用此接口来查询录制状态。仅在录制任务进行时有效，录制退出后查询将会返回错误。
|
|
397
|
+
录制文件上传到云点播VOD时，StorageFileList中不会返回录制文件信息，请订阅相关录制文件回调事件，获取录制文件信息。
|
|
189
398
|
*/
|
|
190
|
-
|
|
399
|
+
DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
|
|
191
400
|
/**
|
|
192
401
|
* 切片截图与内容理解用量查询，支持查询音视频切片（云端切片场景）和 AI 内容理解（审核场景）两种业务类型
|
|
193
402
|
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
@@ -197,77 +406,70 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
197
406
|
DescribeTRTCSegmentModerationUsage(req: DescribeTRTCSegmentModerationUsageRequest, cb?: (error: string, rep: DescribeTRTCSegmentModerationUsageResponse) => void): Promise<DescribeTRTCSegmentModerationUsageResponse>;
|
|
198
407
|
/**
|
|
199
408
|
* 接口说明：
|
|
200
|
-
|
|
409
|
+
启动云端切片功能，完成房间内的音视频切片，并上传到指定的云存储。
|
|
201
410
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
• 本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。
|
|
206
|
-
• 热词权重取值范围为[1,11]之间的整数或者100，权重越大代表该词被识别出来的概率越大。
|
|
207
|
-
• 注意: 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多权重为11的热词将影响整体字准率。
|
|
411
|
+
您可以通过此接口实现如下目标：
|
|
412
|
+
* 指定切片参数（SliceParams）来指定需要切片的主播的黑名单或者白名单。
|
|
413
|
+
* 指定存储参数（SliceStorageParams）来指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）和第三方AWS
|
|
208
414
|
*/
|
|
209
|
-
|
|
415
|
+
CreateCloudSliceTask(req: CreateCloudSliceTaskRequest, cb?: (error: string, rep: CreateCloudSliceTaskResponse) => void): Promise<CreateCloudSliceTaskResponse>;
|
|
210
416
|
/**
|
|
211
|
-
*
|
|
417
|
+
* 查询页面录制任务
|
|
212
418
|
*/
|
|
213
|
-
|
|
419
|
+
DescribeWebRecord(req: DescribeWebRecordRequest, cb?: (error: string, rep: DescribeWebRecordResponse) => void): Promise<DescribeWebRecordResponse>;
|
|
420
|
+
/**
|
|
421
|
+
* 成功开启AI 内容理解任务后，可以使用此接口来查询AI 内容理解任务状态和订阅的黑白名单信息。仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
422
|
+
*/
|
|
423
|
+
DescribeCloudModeration(req: DescribeCloudModerationRequest, cb?: (error: string, rep: DescribeCloudModerationResponse) => void): Promise<DescribeCloudModerationResponse>;
|
|
424
|
+
/**
|
|
425
|
+
* 查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标）
|
|
426
|
+
joinSuccessRate：加入频道成功率。
|
|
427
|
+
joinSuccessIn5sRate：5s内加入频道成功率。
|
|
428
|
+
audioFreezeRate：音频卡顿率。
|
|
429
|
+
videoFreezeRate：视频卡顿率。
|
|
430
|
+
networkDelay ：网络延迟率。
|
|
431
|
+
注意：
|
|
432
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
|
|
433
|
+
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
|
|
434
|
+
*/
|
|
435
|
+
DescribeTRTCMarketQualityData(req: DescribeTRTCMarketQualityDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityDataResponse) => void): Promise<DescribeTRTCMarketQualityDataResponse>;
|
|
214
436
|
/**
|
|
215
437
|
* 接口说明：
|
|
216
|
-
|
|
217
|
-
|
|
438
|
+
停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后，任务也会自动停止。
|
|
439
|
+
*/
|
|
440
|
+
StopPublishCdnStream(req: StopPublishCdnStreamRequest, cb?: (error: string, rep: StopPublishCdnStreamResponse) => void): Promise<StopPublishCdnStreamResponse>;
|
|
441
|
+
/**
|
|
442
|
+
* 启动AI 内容理解功能，完成房间内的音视频切片，视频截帧，或者录制音频流，投递到AI内容理解，完成内容识别。您可以通过此接口实现如下目标：
|
|
443
|
+
●指定内容参数（ModerationParams）来指定内容理解需要的详细参数。
|
|
444
|
+
●指定存储参数（ModerationStorageParams）将命中的切片文件指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）以及第三方AWS（S3）和阿里云（OSS）
|
|
445
|
+
*/
|
|
446
|
+
CreateCloudModeration(req: CreateCloudModerationRequest, cb?: (error: string, rep: CreateCloudModerationResponse) => void): Promise<CreateCloudModerationResponse>;
|
|
447
|
+
/**
|
|
448
|
+
* 云监控monitor接口已下线，trtc同步下线接口
|
|
218
449
|
|
|
450
|
+
查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
|
|
451
|
+
userCount：通话人数，
|
|
452
|
+
roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
453
|
+
peakCurrentChannels：峰值同时在线频道数。
|
|
454
|
+
peakCurrentUsers：峰值同时在线人数。
|
|
219
455
|
注意：
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
MCU 混流转码费用，请参考文档：[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)
|
|
223
|
-
转推非腾讯云 CDN 费用，请参考文档：[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
|
|
456
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
|
|
457
|
+
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
|
|
224
458
|
*/
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* 成功开启直播流AI 内容理解任务后，可以使用此接口来查询AI 内容理解任务状态，仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
228
|
-
*/
|
|
229
|
-
DescribeLiveStreamModeration(req: DescribeLiveStreamModerationRequest, cb?: (error: string, rep: DescribeLiveStreamModerationResponse) => void): Promise<DescribeLiveStreamModerationResponse>;
|
|
459
|
+
DescribeTRTCMarketScaleMetricData(req: DescribeTRTCMarketScaleMetricDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleMetricDataResponse) => void): Promise<DescribeTRTCMarketScaleMetricDataResponse>;
|
|
230
460
|
/**
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
461
|
+
* 接口说明：
|
|
462
|
+
用户通过本接口进行热词表的下载，获得词表权重文件形式的 base64 值，文件形式为通过 “|” 分割的词和权重，即 word|weight 的形式。
|
|
463
|
+
*/
|
|
464
|
+
DownloadRecognizeVocabV3(req: DownloadRecognizeVocabV3Request, cb?: (error: string, rep: DownloadRecognizeVocabV3Response) => void): Promise<DownloadRecognizeVocabV3Response>;
|
|
234
465
|
/**
|
|
235
466
|
* 查询用户某次通话内的进退房，视频开关等详细事件。可查询14天内数据。（同接口DescribeDetailEvent）
|
|
236
467
|
*/
|
|
237
468
|
DescribeUserEvent(req: DescribeUserEventRequest, cb?: (error: string, rep: DescribeUserEventResponse) => void): Promise<DescribeUserEventResponse>;
|
|
238
|
-
/**
|
|
239
|
-
* 通过此接口可以发起 WEB 页面录制任务，在接口参数中指定录制 URL，录制分辨率，录制结果存储等参数。
|
|
240
|
-
因为参数或API逻辑问题会立即返回结果。而因为页面问题，如页面无法访问，会在回调中返回结果，请关注。
|
|
241
|
-
*/
|
|
242
|
-
StartWebRecord(req: StartWebRecordRequest, cb?: (error: string, rep: StartWebRecordResponse) => void): Promise<StartWebRecordResponse>;
|
|
243
469
|
/**
|
|
244
470
|
* 成功开启转录后，可以使用此接口来停止转录任务。
|
|
245
471
|
*/
|
|
246
472
|
DeleteCloudTranscription(req: DeleteCloudTranscriptionRequest, cb?: (error: string, rep: DeleteCloudTranscriptionResponse) => void): Promise<DeleteCloudTranscriptionResponse>;
|
|
247
|
-
/**
|
|
248
|
-
* 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
|
|
249
|
-
|
|
250
|
-
TRTC 的一个房间中可能会同时存在多路音视频流，您可以通过此 API 接口，通知腾讯云服务端将多路视频画面合成一路，并指定每一路画面的位置，同时将多路声音进行混音，最终形成一路音视频流，以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
251
|
-
|
|
252
|
-
您可以通过此接口实现如下目标：
|
|
253
|
-
- 设置最终直播流的画质和音质，包括视频分辨率、视频码率、视频帧率、以及声音质量等。
|
|
254
|
-
- 设置各路画面的位置和布局，您只需要在启动时设置一次，排版引擎会自动完成后续的画面排布。
|
|
255
|
-
- 设置录制文件名，用于二次回放。
|
|
256
|
-
- 设置 CDN 直播流 ID，用于在 CDN 进行直播观看。
|
|
257
|
-
|
|
258
|
-
目前已经支持了如下几种布局模板：
|
|
259
|
-
- 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面，如果用户只发送音频，仍然会占用画面位置。
|
|
260
|
-
- 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小。最多支持16个画面，如果用户只发送音频，仍然会占用画面位置。
|
|
261
|
-
- 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时，左侧大画面为了保持内容的完整性采用缩放方式处理，右侧小画面采用裁剪方式处理。
|
|
262
|
-
- 画中画模板：适用于混合大小两路视频画面和其他用户混音，或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上，可以指定大小画面的用户以及小画面的显示位置，最多支持2个画面。
|
|
263
|
-
- 自定义模板：适用于在混流中指定用户的画面位置，或者预设视频画面位置的场景。当预设位置指定用户时，排版引擎会为该用户预留位置；当预设位置未指定用户时，排版引擎会根据进房间顺序自动填充。预设位置填满时，不再混合其他用户的画面和声音。自定义模板启用占位图功能时（LayoutParams中的PlaceHolderMode设置成1），在预设位置的用户没有上行视频时可显示对应的占位图（PlaceImageId）。
|
|
264
|
-
|
|
265
|
-
注意：
|
|
266
|
-
1、**混流转码为收费功能，调用接口将产生云端混流转码费用，详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。**
|
|
267
|
-
2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流，如需切换至MCU混流，请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。
|
|
268
|
-
3、客户端混流和服务端混流不能混用。
|
|
269
|
-
*/
|
|
270
|
-
StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
|
|
271
473
|
/**
|
|
272
474
|
* 启动转录机器人，后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。
|
|
273
475
|
转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：
|
|
@@ -281,87 +483,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
281
483
|
TranscriptionMode为0时，需要保证一个房间内只发起一个任务，如果发起多个任务，则机器人之间会相互订阅，除非主动停止任务，否则只有10小时后任务才会超时退出，这种情况下建议填写SessionId，保证后续重复发起的任务失败。
|
|
282
484
|
*/
|
|
283
485
|
StartAITranscription(req: StartAITranscriptionRequest, cb?: (error: string, rep: StartAITranscriptionResponse) => void): Promise<StartAITranscriptionResponse>;
|
|
284
|
-
/**
|
|
285
|
-
* 查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
|
|
286
|
-
userCount：通话人数，
|
|
287
|
-
roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
288
|
-
peakCurrentChannels：峰值同时在线频道数。
|
|
289
|
-
peakCurrentUsers：峰值同时在线人数。
|
|
290
|
-
注意：
|
|
291
|
-
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
|
|
292
|
-
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
|
|
293
|
-
*/
|
|
294
|
-
DescribeTRTCMarketScaleData(req: DescribeTRTCMarketScaleDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleDataResponse) => void): Promise<DescribeTRTCMarketScaleDataResponse>;
|
|
295
|
-
/**
|
|
296
|
-
* 传入音频base64串，注册声纹信息，返回声纹ID
|
|
297
|
-
*/
|
|
298
|
-
RegisterVoicePrint(req: RegisterVoicePrintRequest, cb?: (error: string, rep: RegisterVoicePrintResponse) => void): Promise<RegisterVoicePrintResponse>;
|
|
299
|
-
/**
|
|
300
|
-
* 成功开启AI 内容理解任务后，可以使用此接口来更新订阅黑白名单。
|
|
301
|
-
*/
|
|
302
|
-
ModifyCloudModeration(req: ModifyCloudModerationRequest, cb?: (error: string, rep: ModifyCloudModerationResponse) => void): Promise<ModifyCloudModerationResponse>;
|
|
303
|
-
/**
|
|
304
|
-
* 接口说明：
|
|
305
|
-
停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后，任务也会自动停止。
|
|
306
|
-
*/
|
|
307
|
-
StopPublishCdnStream(req: StopPublishCdnStreamRequest, cb?: (error: string, rep: StopPublishCdnStreamResponse) => void): Promise<StopPublishCdnStreamResponse>;
|
|
308
|
-
/**
|
|
309
|
-
* 成功开启切片后，可以使用此接口来查询切片任务状态。仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
310
|
-
*/
|
|
311
|
-
DescribeCloudSliceTask(req: DescribeCloudSliceTaskRequest, cb?: (error: string, rep: DescribeCloudSliceTaskResponse) => void): Promise<DescribeCloudSliceTaskResponse>;
|
|
312
|
-
/**
|
|
313
|
-
* 接口说明：
|
|
314
|
-
启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
|
|
315
|
-
在线上正式运营之前，请关注录制的最佳实践 [录制最佳实践](https://cloud.tencent.com/document/product/647/76497#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c)，配合最佳实践，可大大提高接口录制的可用性。
|
|
316
|
-
|
|
317
|
-
您可以通过此接口实现如下目标：
|
|
318
|
-
* 指定订阅流参数（RecordParams）来指定需要录制的主播的黑名单或者白名单。
|
|
319
|
-
* 指定录制存储参数（StorageParams）来指定上传到您希望的云存储，目前支持腾讯云（云点播VOD、对象存储COS）和第三方AWS
|
|
320
|
-
* 指定合流模式下的音视频转码详细参数（MixTranscodeParams），包括视频分辨率、视频码率、视频帧率、以及声音质量等
|
|
321
|
-
* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
|
|
322
|
-
|
|
323
|
-
关键名词：
|
|
324
|
-
* 单流录制：分别录制房间的订阅UserId的音频和视频，录制服务会实时将录制文件上传至您指定的云存储。
|
|
325
|
-
* 合流录制：将房间内订阅UserId的音视频混录成一个视频文件，并将录制文件上传至您指定的云存储。（录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件）。
|
|
326
|
-
*/
|
|
327
|
-
CreateCloudRecording(req: CreateCloudRecordingRequest, cb?: (error: string, rep: CreateCloudRecordingResponse) => void): Promise<CreateCloudRecordingResponse>;
|
|
328
|
-
/**
|
|
329
|
-
* 成功开启AI 内容理解任务后，可以使用此接口来停止进行内容识别。
|
|
330
|
-
*/
|
|
331
|
-
DeleteCloudModeration(req: DeleteCloudModerationRequest, cb?: (error: string, rep: DeleteCloudModerationResponse) => void): Promise<DeleteCloudModerationResponse>;
|
|
332
|
-
/**
|
|
333
|
-
* 可查询SdkAppId每天的房间数和用户数，按天统计，可查询最近14天的数据。当天未结束，数据未统计完成，无法查到当天的房间数与用户数。（同老接口DescribeHistoryScale）
|
|
334
|
-
*/
|
|
335
|
-
DescribeScaleInfo(req: DescribeScaleInfoRequest, cb?: (error: string, rep: DescribeScaleInfoResponse) => void): Promise<DescribeScaleInfoResponse>;
|
|
336
486
|
/**
|
|
337
487
|
* 异步语音合成
|
|
338
488
|
*/
|
|
339
489
|
AsyncTextToSpeech(req: AsyncTextToSpeechRequest, cb?: (error: string, rep: AsyncTextToSpeechResponse) => void): Promise<AsyncTextToSpeechResponse>;
|
|
340
|
-
/**
|
|
341
|
-
* 成功开启转录后，可以使用此接口来查询录制状态。仅在转录任务进行时有效，转录退出后查询将会返回错误。
|
|
342
|
-
*/
|
|
343
|
-
DescribeCloudTranscription(req: DescribeCloudTranscriptionRequest, cb?: (error: string, rep: DescribeCloudTranscriptionResponse) => void): Promise<DescribeCloudTranscriptionResponse>;
|
|
344
|
-
/**
|
|
345
|
-
* 成功开启直播流AI 内容理解任务后，可以使用此接口来停止进行内容识别。
|
|
346
|
-
*/
|
|
347
|
-
DeleteLiveStreamModeration(req: DeleteLiveStreamModerationRequest, cb?: (error: string, rep: DeleteLiveStreamModerationResponse) => void): Promise<DeleteLiveStreamModerationResponse>;
|
|
348
|
-
/**
|
|
349
|
-
* 查询指定时间内的用户列表，最大可查询14天内数据，查询起止时间不超过4小时。默认每页查询6个用户，支持每页最大查询100个用户PageSize不超过100）。（同老接口DescribeUserInformation）
|
|
350
|
-
**注意**：
|
|
351
|
-
1.该接口只用于历史数据统计或核对数据使用，实时类关键业务逻辑不能使用。
|
|
352
|
-
2.该接口自2024年4月1日起正式商业化，需订阅套餐解锁调用能力，提供以下两种解锁方式，可任选其一解锁：
|
|
353
|
-
方式一：通过订阅[包月套餐](https://cloud.tencent.com/document/product/647/85386)「尊享版」（可查近7天）和「旗舰版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc?trtcversion=top)。
|
|
354
|
-
方式二：通过订阅[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)商业套餐包「基础版」（可查近7天）和「进阶版」（可查近14天），[前往订阅](https://buy.cloud.tencent.com/trtc_monitor)。
|
|
355
|
-
*/
|
|
356
|
-
DescribeUserInfo(req: DescribeUserInfoRequest, cb?: (error: string, rep: DescribeUserInfoResponse) => void): Promise<DescribeUserInfoResponse>;
|
|
357
|
-
/**
|
|
358
|
-
* 接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
359
|
-
*/
|
|
360
|
-
DismissRoomByStrRoomId(req: DismissRoomByStrRoomIdRequest, cb?: (error: string, rep: DismissRoomByStrRoomIdResponse) => void): Promise<DismissRoomByStrRoomIdResponse>;
|
|
361
|
-
/**
|
|
362
|
-
* 成功开启切片任务后，可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。
|
|
363
|
-
*/
|
|
364
|
-
ModifyCloudSliceTask(req: ModifyCloudSliceTaskRequest, cb?: (error: string, rep: ModifyCloudSliceTaskResponse) => void): Promise<ModifyCloudSliceTaskResponse>;
|
|
365
490
|
/**
|
|
366
491
|
* 接口说明：
|
|
367
492
|
启动云端转录功能。
|
|
@@ -371,53 +496,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
371
496
|
* 停止一个输入在线媒体流任务。
|
|
372
497
|
*/
|
|
373
498
|
StopStreamIngest(req: StopStreamIngestRequest, cb?: (error: string, rep: StopStreamIngestResponse) => void): Promise<StopStreamIngestResponse>;
|
|
374
|
-
/**
|
|
375
|
-
* 查询SdkAppId下任意20条异常体验事件，返回异常体验ID与可能产生异常体验的原因。可查询14天内数据，查询起止时间不超过1个小时。支持跨天查询。（同老接口DescribeAbnormalEvent）
|
|
376
|
-
异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916
|
|
377
|
-
*/
|
|
378
|
-
DescribeUnusualEvent(req: DescribeUnusualEventRequest, cb?: (error: string, rep: DescribeUnusualEventResponse) => void): Promise<DescribeUnusualEventResponse>;
|
|
379
|
-
/**
|
|
380
|
-
* 声音克隆
|
|
381
|
-
*/
|
|
382
|
-
VoiceClone(req: VoiceCloneRequest, cb?: (error: string, rep: VoiceCloneResponse) => void): Promise<VoiceCloneResponse>;
|
|
383
|
-
/**
|
|
384
|
-
* 获取TRTC录制的用量明细。
|
|
385
|
-
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
386
|
-
- 单次查询统计区间最多不能超过31天。
|
|
387
|
-
- 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
388
|
-
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。
|
|
389
|
-
- 默认接口请求频率限制：5次/秒。
|
|
390
|
-
*/
|
|
391
|
-
DescribeRecordingUsage(req: DescribeRecordingUsageRequest, cb?: (error: string, rep: DescribeRecordingUsageResponse) => void): Promise<DescribeRecordingUsageResponse>;
|
|
392
499
|
/**
|
|
393
500
|
* 查询异步语音合成状态
|
|
394
501
|
*/
|
|
395
502
|
DescribeAsyncTextToSpeech(req: DescribeAsyncTextToSpeechRequest, cb?: (error: string, rep: DescribeAsyncTextToSpeechResponse) => void): Promise<DescribeAsyncTextToSpeechResponse>;
|
|
396
|
-
/**
|
|
397
|
-
* 获取TRTC混流转码的用量明细。
|
|
398
|
-
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
399
|
-
- 单次查询统计区间最多不能超过31天。
|
|
400
|
-
- 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
401
|
-
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用。
|
|
402
|
-
- 默认接口请求频率限制：5次/秒。
|
|
403
|
-
*/
|
|
404
|
-
DescribeMixTranscodingUsage(req: DescribeMixTranscodingUsageRequest, cb?: (error: string, rep: DescribeMixTranscodingUsageResponse) => void): Promise<DescribeMixTranscodingUsageResponse>;
|
|
405
503
|
/**
|
|
406
504
|
* 接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
407
505
|
*/
|
|
408
506
|
DismissRoom(req: DismissRoomRequest, cb?: (error: string, rep: DismissRoomResponse) => void): Promise<DismissRoomResponse>;
|
|
409
|
-
/**
|
|
410
|
-
* 查询TRTC音视频房间维度用量。
|
|
411
|
-
- 单次只能查询一天数据，返回查询时间段内的汇总数据；通过多次查询可以查不同天数据。若查询跨天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
412
|
-
- 该接口只用于历史用量数据统计或核对数据使用，关键业务逻辑不能使用，不可用于账单核对，如需对账请使用账号/应用维度用量API：DescribeTrtcUsage。
|
|
413
|
-
- 默认接口请求频率限制：1次/15秒。
|
|
414
|
-
- 数据最早可查日期为2023年4月1日0点，最大可查范围近3个月。
|
|
415
|
-
*/
|
|
416
|
-
DescribeTrtcRoomUsage(req: DescribeTrtcRoomUsageRequest, cb?: (error: string, rep: DescribeTrtcRoomUsageResponse) => void): Promise<DescribeTrtcRoomUsageResponse>;
|
|
417
|
-
/**
|
|
418
|
-
* 成功开启切片任务后，可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
|
|
419
|
-
*/
|
|
420
|
-
DeleteCloudSliceTask(req: DeleteCloudSliceTaskRequest, cb?: (error: string, rep: DeleteCloudSliceTaskResponse) => void): Promise<DeleteCloudSliceTaskResponse>;
|
|
421
507
|
/**
|
|
422
508
|
* TRTC专属云网络加速用量查询
|
|
423
509
|
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
@@ -433,11 +519,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
433
519
|
- 日结后付费将于次日上午推送账单，建议次日上午9点以后再来查询前一天的用量。
|
|
434
520
|
*/
|
|
435
521
|
DescribeTrtcMcuTranscodeTime(req: DescribeTrtcMcuTranscodeTimeRequest, cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void): Promise<DescribeTrtcMcuTranscodeTimeResponse>;
|
|
436
|
-
/**
|
|
437
|
-
* 成功开启录制后，可以使用此接口来查询录制状态。仅在录制任务进行时有效，录制退出后查询将会返回错误。
|
|
438
|
-
录制文件上传到云点播VOD时，StorageFileList中不会返回录制文件信息，请订阅相关录制文件回调事件，获取录制文件信息。
|
|
439
|
-
*/
|
|
440
|
-
DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
|
|
441
522
|
/**
|
|
442
523
|
* 获取TRTC旁路转推的用量明细。
|
|
443
524
|
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
@@ -448,73 +529,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
448
529
|
*/
|
|
449
530
|
DescribeRelayUsage(req: DescribeRelayUsageRequest, cb?: (error: string, rep: DescribeRelayUsageResponse) => void): Promise<DescribeRelayUsageResponse>;
|
|
450
531
|
/**
|
|
451
|
-
*
|
|
452
|
-
*/
|
|
453
|
-
DescribeAITranscription(req: DescribeAITranscriptionRequest, cb?: (error: string, rep: DescribeAITranscriptionResponse) => void): Promise<DescribeAITranscriptionResponse>;
|
|
454
|
-
/**
|
|
455
|
-
* 接口说明：
|
|
456
|
-
成功发起混流转推后，可以使用此接口来更新任务。仅在任务进行时有效，任务退出后更新将会返回错误。更新操作为增量更新模式。
|
|
457
|
-
注意：为了保障推流的稳定性，更新不支持任务在纯音频、音视频、纯视频之间进行切换。
|
|
458
|
-
*/
|
|
459
|
-
UpdatePublishCdnStream(req: UpdatePublishCdnStreamRequest, cb?: (error: string, rep: UpdatePublishCdnStreamResponse) => void): Promise<UpdatePublishCdnStreamResponse>;
|
|
460
|
-
/**
|
|
461
|
-
* 传入声纹ID，删除之前注册的声纹信息
|
|
462
|
-
*/
|
|
463
|
-
DeleteVoicePrint(req: DeleteVoicePrintRequest, cb?: (error: string, rep: DeleteVoicePrintResponse) => void): Promise<DeleteVoicePrintResponse>;
|
|
464
|
-
/**
|
|
465
|
-
* 接口说明：
|
|
466
|
-
启动云端切片功能，完成房间内的音视频切片，并上传到指定的云存储。
|
|
467
|
-
|
|
468
|
-
您可以通过此接口实现如下目标：
|
|
469
|
-
* 指定切片参数（SliceParams）来指定需要切片的主播的黑名单或者白名单。
|
|
470
|
-
* 指定存储参数（SliceStorageParams）来指定上传到您希望的云存储，目前支持腾讯云（对象存储COS）和第三方AWS
|
|
471
|
-
*/
|
|
472
|
-
CreateCloudSliceTask(req: CreateCloudSliceTaskRequest, cb?: (error: string, rep: CreateCloudSliceTaskResponse) => void): Promise<CreateCloudSliceTaskResponse>;
|
|
473
|
-
/**
|
|
474
|
-
* 成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。
|
|
475
|
-
*/
|
|
476
|
-
DeleteCloudRecording(req: DeleteCloudRecordingRequest, cb?: (error: string, rep: DeleteCloudRecordingResponse) => void): Promise<DeleteCloudRecordingResponse>;
|
|
477
|
-
/**
|
|
478
|
-
* 停止AI对话任务
|
|
532
|
+
* 传入声纹ID以及对应音频信息，更新对应声纹信息
|
|
479
533
|
*/
|
|
480
|
-
|
|
534
|
+
UpdateVoicePrint(req: UpdateVoicePrintRequest, cb?: (error: string, rep: UpdateVoicePrintResponse) => void): Promise<UpdateVoicePrintResponse>;
|
|
481
535
|
/**
|
|
482
536
|
* 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息，可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
|
|
483
537
|
*/
|
|
484
538
|
DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* 成功开启AI 内容理解任务后，可以使用此接口来查询AI 内容理解任务状态和订阅的黑白名单信息。仅在任务进行时有效，任务退出后查询将会返回错误。
|
|
487
|
-
*/
|
|
488
|
-
DescribeCloudModeration(req: DescribeCloudModerationRequest, cb?: (error: string, rep: DescribeCloudModerationResponse) => void): Promise<DescribeCloudModerationResponse>;
|
|
489
|
-
/**
|
|
490
|
-
* 接口说明：
|
|
491
|
-
用户通过本接口分页列举所有的热词表。
|
|
492
|
-
*/
|
|
493
|
-
GetRecognizeVocabListV3(req: GetRecognizeVocabListV3Request, cb?: (error: string, rep: GetRecognizeVocabListV3Response) => void): Promise<GetRecognizeVocabListV3Response>;
|
|
494
|
-
/**
|
|
495
|
-
* 查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标）
|
|
496
|
-
joinSuccessRate：加入频道成功率。
|
|
497
|
-
joinSuccessIn5sRate：5s内加入频道成功率。
|
|
498
|
-
audioFreezeRate：音频卡顿率。
|
|
499
|
-
videoFreezeRate：视频卡顿率。
|
|
500
|
-
networkDelay ：网络延迟率。
|
|
501
|
-
注意：
|
|
502
|
-
1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘[版本功能和计费说明](https://cloud.tencent.com/document/product/647/81331)。
|
|
503
|
-
2.查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
|
|
504
|
-
*/
|
|
505
|
-
DescribeTRTCMarketQualityData(req: DescribeTRTCMarketQualityDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityDataResponse) => void): Promise<DescribeTRTCMarketQualityDataResponse>;
|
|
506
|
-
/**
|
|
507
|
-
* 提供服务端控制机器人的功能
|
|
508
|
-
*/
|
|
509
|
-
ControlAIConversation(req: ControlAIConversationRequest, cb?: (error: string, rep: ControlAIConversationResponse) => void): Promise<ControlAIConversationResponse>;
|
|
510
|
-
/**
|
|
511
|
-
* 停止AI转录任务。
|
|
512
|
-
*/
|
|
513
|
-
StopAITranscription(req: StopAITranscriptionRequest, cb?: (error: string, rep: StopAITranscriptionResponse) => void): Promise<StopAITranscriptionResponse>;
|
|
514
|
-
/**
|
|
515
|
-
* 更新输入在线媒体流任务的StreamUrl
|
|
516
|
-
*/
|
|
517
|
-
UpdateStreamIngest(req: UpdateStreamIngestRequest, cb?: (error: string, rep: UpdateStreamIngestResponse) => void): Promise<UpdateStreamIngestResponse>;
|
|
518
539
|
/**
|
|
519
540
|
* AI 智能识别与对话用量查询（AI对话/语音转文本/实时翻译/实时语音合成）
|
|
520
541
|
- 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
|
|
@@ -522,21 +543,4 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
522
543
|
- 若查询当天用量，由于统计延迟等原因，返回数据可能不够准确。
|
|
523
544
|
*/
|
|
524
545
|
DescribeTRTCAIRecognitionUsage(req: DescribeTRTCAIRecognitionUsageRequest, cb?: (error: string, rep: DescribeTRTCAIRecognitionUsageResponse) => void): Promise<DescribeTRTCAIRecognitionUsageResponse>;
|
|
525
|
-
/**
|
|
526
|
-
* 查询先前注册的声纹信息
|
|
527
|
-
*/
|
|
528
|
-
DescribeVoicePrint(req: DescribeVoicePrintRequest, cb?: (error: string, rep: DescribeVoicePrintResponse) => void): Promise<DescribeVoicePrintResponse>;
|
|
529
|
-
/**
|
|
530
|
-
* SSE流式文本转语音
|
|
531
|
-
*/
|
|
532
|
-
TextToSpeechSSE(req: TextToSpeechSSERequest, cb?: (error: string, rep: TextToSpeechSSEResponse) => void): Promise<TextToSpeechSSEResponse>;
|
|
533
|
-
/**
|
|
534
|
-
* 接口说明：结束云端混流
|
|
535
|
-
*/
|
|
536
|
-
StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
|
|
537
|
-
/**
|
|
538
|
-
* 接口说明：
|
|
539
|
-
用户根据词表的ID可以获取对应的热词表信息
|
|
540
|
-
*/
|
|
541
|
-
GetRecognizeVocabV3(req: GetRecognizeVocabV3Request, cb?: (error: string, rep: GetRecognizeVocabV3Response) => void): Promise<GetRecognizeVocabV3Response>;
|
|
542
546
|
}
|