tencentcloud-sdk-nodejs-intl-en
Version:
940 lines (873 loc) • 51.3 kB
JavaScript
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const models = require("./models");
const AbstractClient = require('../../common/abstract_client')
const ModifyCloudSliceTaskResponse = models.ModifyCloudSliceTaskResponse;
const DescribeCloudModerationResponse = models.DescribeCloudModerationResponse;
const AgentConfig = models.AgentConfig;
const TerminologyItem = models.TerminologyItem;
const McuLayout = models.McuLayout;
const SubscribeModerationUserIds = models.SubscribeModerationUserIds;
const AudioEncodeParams = models.AudioEncodeParams;
const ServerPushText = models.ServerPushText;
const McuRecordParams = models.McuRecordParams;
const MixLayout = models.MixLayout;
const McuVideoParams = models.McuVideoParams;
const DescribeTRTCRealTimeScaleDataRequest = models.DescribeTRTCRealTimeScaleDataRequest;
const StartAIConversationResponse = models.StartAIConversationResponse;
const StartAIConversationRequest = models.StartAIConversationRequest;
const Voice = models.Voice;
const DescribeTRTCMarketScaleDataRequest = models.DescribeTRTCMarketScaleDataRequest;
const McuLayoutVolume = models.McuLayoutVolume;
const VoiceCloneRequest = models.VoiceCloneRequest;
const SetUserBlockedRequest = models.SetUserBlockedRequest;
const DescribeUserEventRequest = models.DescribeUserEventRequest;
const DeleteCloudModerationRequest = models.DeleteCloudModerationRequest;
const SetUserBlockedResponse = models.SetUserBlockedResponse;
const McuBackgroundCustomRender = models.McuBackgroundCustomRender;
const WaterMarkChar = models.WaterMarkChar;
const DescribeTrtcRoomUsageResponse = models.DescribeTrtcRoomUsageResponse;
const StopPublishCdnStreamResponse = models.StopPublishCdnStreamResponse;
const TranscriptionUserInfoParams = models.TranscriptionUserInfoParams;
const AbnormalEvent = models.AbnormalEvent;
const DeleteCloudSliceTaskRequest = models.DeleteCloudSliceTaskRequest;
const ScaleInfomation = models.ScaleInfomation;
const AgentParams = models.AgentParams;
const ControlAIConversationResponse = models.ControlAIConversationResponse;
const StopAITranscriptionRequest = models.StopAITranscriptionRequest;
const VideoEncodeParams = models.VideoEncodeParams;
const UpdateAIConversationResponse = models.UpdateAIConversationResponse;
const DescribeUserEventResponse = models.DescribeUserEventResponse;
const VideoEncode = models.VideoEncode;
const DescribeCallDetailInfoRequest = models.DescribeCallDetailInfoRequest;
const CreateCloudModerationResponse = models.CreateCloudModerationResponse;
const DescribeTRTCMarketScaleDataResponse = models.DescribeTRTCMarketScaleDataResponse;
const TranslationConfig = models.TranslationConfig;
const McuTencentVod = models.McuTencentVod;
const DescribeWebRecordResponse = models.DescribeWebRecordResponse;
const DescribeCloudTranscriptionResponse = models.DescribeCloudTranscriptionResponse;
const DescribeUserInfoRequest = models.DescribeUserInfoRequest;
const DeleteCloudModerationResponse = models.DeleteCloudModerationResponse;
const DescribeRelayUsageRequest = models.DescribeRelayUsageRequest;
const DismissRoomResponse = models.DismissRoomResponse;
const CloudStorage = models.CloudStorage;
const VoicePrint = models.VoicePrint;
const DescribeTrtcUsageResponse = models.DescribeTrtcUsageResponse;
const TimeValue = models.TimeValue;
const CreateCloudRecordingResponse = models.CreateCloudRecordingResponse;
const DescribeWebRecordRequest = models.DescribeWebRecordRequest;
const DescribeTRTCRealTimeScaleDataResponse = models.DescribeTRTCRealTimeScaleDataResponse;
const DescribeRoomInfoRequest = models.DescribeRoomInfoRequest;
const StorageParams = models.StorageParams;
const CloudVod = models.CloudVod;
const CloudSliceStorage = models.CloudSliceStorage;
const EmulateMobileParams = models.EmulateMobileParams;
const PronunciationDict = models.PronunciationDict;
const DescribeCallDetailInfoResponse = models.DescribeCallDetailInfoResponse;
const DescribeTRTCRealTimeQualityDataResponse = models.DescribeTRTCRealTimeQualityDataResponse;
const McuCustomCrop = models.McuCustomCrop;
const DescribeMixTranscodingUsageRequest = models.DescribeMixTranscodingUsageRequest;
const DescribeTRTCRealTimeQualityDataRequest = models.DescribeTRTCRealTimeQualityDataRequest;
const DescribeStreamIngestResponse = models.DescribeStreamIngestResponse;
const MixTranscodeParams = models.MixTranscodeParams;
const CreateCloudTranscriptionResponse = models.CreateCloudTranscriptionResponse;
const DescribeTRTCMarketQualityDataResponse = models.DescribeTRTCMarketQualityDataResponse;
const TranslationParam = models.TranslationParam;
const SubscribeStreamUserIds = models.SubscribeStreamUserIds;
const WaterMarkImage = models.WaterMarkImage;
const McuUserInfoParams = models.McuUserInfoParams;
const UserMediaStream = models.UserMediaStream;
const EventList = models.EventList;
const DescribeTrtcUsageRequest = models.DescribeTrtcUsageRequest;
const DescribeRoomInfoResponse = models.DescribeRoomInfoResponse;
const McuLayoutParams = models.McuLayoutParams;
const StartWebRecordRequest = models.StartWebRecordRequest;
const StartStreamIngestRequest = models.StartStreamIngestRequest;
const DescribeAITranscriptionRequest = models.DescribeAITranscriptionRequest;
const DescribeAIConversationResponse = models.DescribeAIConversationResponse;
const AudioFormat = models.AudioFormat;
const DeleteCloudTranscriptionResponse = models.DeleteCloudTranscriptionResponse;
const DescribeUserInfoResponse = models.DescribeUserInfoResponse;
const RemoveUserByStrRoomIdResponse = models.RemoveUserByStrRoomIdResponse;
const UpdateStreamIngestResponse = models.UpdateStreamIngestResponse;
const CloudModerationStorage = models.CloudModerationStorage;
const McuWaterMarkImage = models.McuWaterMarkImage;
const StartPublishCdnStreamResponse = models.StartPublishCdnStreamResponse;
const TrtcUsage = models.TrtcUsage;
const DeleteCloudSliceTaskResponse = models.DeleteCloudSliceTaskResponse;
const DescribeRelayUsageResponse = models.DescribeRelayUsageResponse;
const TextToSpeechSSEResponse = models.TextToSpeechSSEResponse;
const DescribeRecordingUsageResponse = models.DescribeRecordingUsageResponse;
const SliceParams = models.SliceParams;
const ModerationSupplierParam = models.ModerationSupplierParam;
const DescribeRecordingUsageRequest = models.DescribeRecordingUsageRequest;
const StorageFile = models.StorageFile;
const WaterMark = models.WaterMark;
const McuStorageParams = models.McuStorageParams;
const DescribeScaleInfoResponse = models.DescribeScaleInfoResponse;
const MixLayoutParams = models.MixLayoutParams;
const ModifyCloudSliceTaskRequest = models.ModifyCloudSliceTaskRequest;
const DescribeMixTranscodingUsageResponse = models.DescribeMixTranscodingUsageResponse;
const AsrParam = models.AsrParam;
const McuFeedBackRoomParams = models.McuFeedBackRoomParams;
const TurnDetection = models.TurnDetection;
const AudioEncode = models.AudioEncode;
const RemoveUserRequest = models.RemoveUserRequest;
const TTSVoice = models.TTSVoice;
const DismissRoomRequest = models.DismissRoomRequest;
const DescribeUnusualEventRequest = models.DescribeUnusualEventRequest;
const DescribeCloudRecordingRequest = models.DescribeCloudRecordingRequest;
const TencentVod = models.TencentVod;
const McuPassThrough = models.McuPassThrough;
const StartWebRecordResponse = models.StartWebRecordResponse;
const SetUserBlockedByStrRoomIdResponse = models.SetUserBlockedByStrRoomIdResponse;
const TRTCDataResult = models.TRTCDataResult;
const DescribeCloudRecordingResponse = models.DescribeCloudRecordingResponse;
const ModifyCloudModerationRequest = models.ModifyCloudModerationRequest;
const CreateCloudRecordingRequest = models.CreateCloudRecordingRequest;
const RecognizeConfig = models.RecognizeConfig;
const DeleteCloudRecordingResponse = models.DeleteCloudRecordingResponse;
const StartAITranscriptionRequest = models.StartAITranscriptionRequest;
const QualityData = models.QualityData;
const ModerationStorageParams = models.ModerationStorageParams;
const ModifyCloudRecordingRequest = models.ModifyCloudRecordingRequest;
const StopAIConversationResponse = models.StopAIConversationResponse;
const StartPublishCdnStreamRequest = models.StartPublishCdnStreamRequest;
const DescribeAIConversationRequest = models.DescribeAIConversationRequest;
const RowValues = models.RowValues;
const TranscriptionParam = models.TranscriptionParam;
const DismissRoomByStrRoomIdRequest = models.DismissRoomByStrRoomIdRequest;
const DescribeCloudTranscriptionRequest = models.DescribeCloudTranscriptionRequest;
const CreateCloudSliceTaskResponse = models.CreateCloudSliceTaskResponse;
const DeleteCloudRecordingRequest = models.DeleteCloudRecordingRequest;
const TTSParam = models.TTSParam;
const ModifyCloudModerationResponse = models.ModifyCloudModerationResponse;
const Terminology = models.Terminology;
const VideoParams = models.VideoParams;
const StopStreamIngestResponse = models.StopStreamIngestResponse;
const SetUserBlockedByStrRoomIdRequest = models.SetUserBlockedByStrRoomIdRequest;
const DescribeTrtcRoomUsageRequest = models.DescribeTrtcRoomUsageRequest;
const TextToSpeechResponse = models.TextToSpeechResponse;
const CreateCloudModerationRequest = models.CreateCloudModerationRequest;
const StopStreamIngestRequest = models.StopStreamIngestRequest;
const WebRecordVideoParams = models.WebRecordVideoParams;
const UserInformation = models.UserInformation;
const DescribeScaleInfoRequest = models.DescribeScaleInfoRequest;
const ControlAIConversationRequest = models.ControlAIConversationRequest;
const DismissRoomByStrRoomIdResponse = models.DismissRoomByStrRoomIdResponse;
const DescribeUnusualEventResponse = models.DescribeUnusualEventResponse;
const ModifyCloudRecordingResponse = models.ModifyCloudRecordingResponse;
const SingleSubscribeParams = models.SingleSubscribeParams;
const CreateCloudTranscriptionRequest = models.CreateCloudTranscriptionRequest;
const CreateCloudSliceTaskRequest = models.CreateCloudSliceTaskRequest;
const ModerationParams = models.ModerationParams;
const DescribeCloudSliceTaskRequest = models.DescribeCloudSliceTaskRequest;
const StopPublishCdnStreamRequest = models.StopPublishCdnStreamRequest;
const MixUserInfo = models.MixUserInfo;
const DeleteCloudTranscriptionRequest = models.DeleteCloudTranscriptionRequest;
const AmbientSound = models.AmbientSound;
const DescribeTRTCMarketQualityDataRequest = models.DescribeTRTCMarketQualityDataRequest;
const UpdatePublishCdnStreamRequest = models.UpdatePublishCdnStreamRequest;
const InvokeLLM = models.InvokeLLM;
const SliceStorageParams = models.SliceStorageParams;
const MaxVideoUser = models.MaxVideoUser;
const VoiceCloneResponse = models.VoiceCloneResponse;
const UpdateStreamIngestRequest = models.UpdateStreamIngestRequest;
const TextToSpeechSSERequest = models.TextToSpeechSSERequest;
const StopWebRecordResponse = models.StopWebRecordResponse;
const TermPair = models.TermPair;
const STTConfig = models.STTConfig;
const StopWebRecordRequest = models.StopWebRecordRequest;
const McuSeiParams = models.McuSeiParams;
const StopAIConversationRequest = models.StopAIConversationRequest;
const EventMessage = models.EventMessage;
const UpdateAIConversationRequest = models.UpdateAIConversationRequest;
const UpdatePublishCdnStreamResponse = models.UpdatePublishCdnStreamResponse;
const McuWaterMarkText = models.McuWaterMarkText;
const TranscriptionParams = models.TranscriptionParams;
const SeriesInfos = models.SeriesInfos;
const RemoveUserByStrRoomIdRequest = models.RemoveUserByStrRoomIdRequest;
const RecordParams = models.RecordParams;
const TextToSpeechRequest = models.TextToSpeechRequest;
const DescribeStreamIngestRequest = models.DescribeStreamIngestRequest;
const TTSConfig = models.TTSConfig;
const McuAudioParams = models.McuAudioParams;
const McuPublishCdnParam = models.McuPublishCdnParam;
const StartStreamIngestResponse = models.StartStreamIngestResponse;
const AudioParams = models.AudioParams;
const StopAITranscriptionResponse = models.StopAITranscriptionResponse;
const WaterMarkTimestamp = models.WaterMarkTimestamp;
const McuCloudVod = models.McuCloudVod;
const DescribeCloudModerationRequest = models.DescribeCloudModerationRequest;
const DescribeAITranscriptionResponse = models.DescribeAITranscriptionResponse;
const McuWaterMarkParams = models.McuWaterMarkParams;
const AbnormalExperience = models.AbnormalExperience;
const DescribeCloudSliceTaskResponse = models.DescribeCloudSliceTaskResponse;
const RoomState = models.RoomState;
const StartAITranscriptionResponse = models.StartAITranscriptionResponse;
const RemoveUserResponse = models.RemoveUserResponse;
const AlignmentItem = models.AlignmentItem;
/**
* trtc client
* @class
*/
class TrtcClient extends AbstractClient {
constructor(credential, region, profile) {
super("trtc.intl.tencentcloudapi.com", "2019-07-22", credential, region, profile);
}
/**
* API description:
This API is used to enable the cloud moderation feature to complete audio and video slicing, video frame extraction, and audio stream recording in the room, and submit them to the specified moderation supplier for completing the moderation.
This API is used to achieve the following goals:
* This API is used to specify the moderation parameters (ModerationParams) to specify the detailed parameters required for moderation.
* This API is used to specify the storage parameter (SliceStorageParams) to specify the cloud storage you want to upload the file complying with the moderation policy to. Currently, Tencent Cloud Object Storage (COS) and third-party AWS are supported.
* @param {CreateCloudModerationRequest} req
* @param {function(string, CreateCloudModerationResponse):void} cb
* @public
*/
CreateCloudModeration(req, cb) {
let resp = new CreateCloudModerationResponse();
this.request("CreateCloudModeration", req, resp, cb);
}
/**
* Update AI conversation task parameters
* @param {UpdateAIConversationRequest} req
* @param {function(string, UpdateAIConversationResponse):void} cb
* @public
*/
UpdateAIConversation(req, cb) {
let resp = new UpdateAIConversationResponse();
this.request("UpdateAIConversation", req, resp, cb);
}
/**
* This API is used to query your TRTC audio/video duration.
- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.
- The period queried per request cannot be longer than 31 days.
- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is five calls per second.
* @param {DescribeTrtcUsageRequest} req
* @param {function(string, DescribeTrtcUsageResponse):void} cb
* @public
*/
DescribeTrtcUsage(req, cb) {
let resp = new DescribeTrtcUsageResponse();
this.request("DescribeTrtcUsage", req, resp, cb);
}
/**
* This API (the old `DescribeRoomInformation`) is used to query the rooms of an application (`SDKAppID`) in the last 14 days. Up to 100 records can be returned per call (10 are returned by default).
**Note**:
1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481
* @param {DescribeRoomInfoRequest} req
* @param {function(string, DescribeRoomInfoResponse):void} cb
* @public
*/
DescribeRoomInfo(req, cb) {
let resp = new DescribeRoomInfoResponse();
this.request("DescribeRoomInfo", req, resp, cb);
}
/**
* Queries the status of a web-page recording task
* @param {DescribeWebRecordRequest} req
* @param {function(string, DescribeWebRecordResponse):void} cb
* @public
*/
DescribeWebRecord(req, cb) {
let resp = new DescribeWebRecordResponse();
this.request("DescribeWebRecord", req, resp, cb);
}
/**
* This API allows an anchor, room owner, admin to mute/unmute a user. It can be used on platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API when the room ID is a string.
* @param {SetUserBlockedByStrRoomIdRequest} req
* @param {function(string, SetUserBlockedByStrRoomIdResponse):void} cb
* @public
*/
SetUserBlockedByStrRoomId(req, cb) {
let resp = new SetUserBlockedByStrRoomIdResponse();
this.request("SetUserBlockedByStrRoomId", req, resp, cb);
}
/**
* API description:.
Start a mixed stream forwarding task to mix multiple audio and video streams in a TRTC room into one media stream, transcode it, and push it to live stream CDN or back to the TRTC room. It also supports directly forwarding a single stream from the TRTC room without transcoding. After startup successful, it will return a task ID (TaskId) unique to the SdkAppid dimension. You need to save this TaskId, as it will be relied on to update and end the task subsequently.
Note:.
You can enable bypass relay callback through console activation for monitoring events of CDN state.
Initiating a mixed stream push task may incur the following fees:.
MCU mix transcoding fees.
Forwarding expenses of non-Tencent Cloud CDN.
* @param {StartPublishCdnStreamRequest} req
* @param {function(string, StartPublishCdnStreamResponse):void} cb
* @public
*/
StartPublishCdnStream(req, cb) {
let resp = new StartPublishCdnStreamResponse();
this.request("StartPublishCdnStream", req, resp, cb);
}
/**
* This API (the old `DescribeCallDetail`) is used to query the user list and call quality data of a specified time range in the last 14 days. If `DataType` is not null, the data of up to six users during a period of up to one hour can be queried (the period can start and end on different days). If `DataType` is null, the data of up to 100 users can be returned per page (the value of `PageSize` cannot exceed 100). Six users are queried by default. The period queried cannot exceed four hours. This API is used to query call quality and is not recommended for billing purposes.
**Note**:
1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481?product=pricing.
* @param {DescribeCallDetailInfoRequest} req
* @param {function(string, DescribeCallDetailInfoResponse):void} cb
* @public
*/
DescribeCallDetailInfo(req, cb) {
let resp = new DescribeCallDetailInfoResponse();
this.request("DescribeCallDetailInfo", req, resp, cb);
}
/**
* You can query the status of the Relay task.
* @param {DescribeStreamIngestRequest} req
* @param {function(string, DescribeStreamIngestResponse):void} cb
* @public
*/
DescribeStreamIngest(req, cb) {
let resp = new DescribeStreamIngestResponse();
this.request("DescribeStreamIngest", req, resp, cb);
}
/**
* Stop an web-page recording task
* @param {StopWebRecordRequest} req
* @param {function(string, StopWebRecordResponse):void} cb
* @public
*/
StopWebRecord(req, cb) {
let resp = new StopWebRecordResponse();
this.request("StopWebRecord", req, resp, cb);
}
/**
* This API is used to disable or enable the audio and video of a user. It can be used by an anchor, room owner, or admin to block or unblock a user. It supports platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API if the room ID is a number.
* @param {SetUserBlockedRequest} req
* @param {function(string, SetUserBlockedResponse):void} cb
* @public
*/
SetUserBlocked(req, cb) {
let resp = new SetUserBlockedResponse();
this.request("SetUserBlocked", req, resp, cb);
}
/**
* Describe the AI conversation task status
* @param {DescribeAIConversationRequest} req
* @param {function(string, DescribeAIConversationResponse):void} cb
* @public
*/
DescribeAIConversation(req, cb) {
let resp = new DescribeAIConversationResponse();
this.request("DescribeAIConversation", req, resp, cb);
}
/**
* This API is used to change the parameters of a relaying task.
Note: For details about how to use this API, see the `StartPublishCdnStream` document.
* @param {UpdatePublishCdnStreamRequest} req
* @param {function(string, UpdatePublishCdnStreamResponse):void} cb
* @public
*/
UpdatePublishCdnStream(req, cb) {
let resp = new UpdatePublishCdnStreamResponse();
this.request("UpdatePublishCdnStream", req, resp, cb);
}
/**
* This API is used to perform text to speech.
* @param {TextToSpeechRequest} req
* @param {function(string, TextToSpeechResponse):void} cb
* @public
*/
TextToSpeech(req, cb) {
let resp = new TextToSpeechResponse();
this.request("TextToSpeech", req, resp, cb);
}
/**
* Push an online media stream to the TRTC room.
* @param {StartStreamIngestRequest} req
* @param {function(string, StartStreamIngestResponse):void} cb
* @public
*/
StartStreamIngest(req, cb) {
let resp = new StartStreamIngestResponse();
this.request("StartStreamIngest", req, resp, cb);
}
/**
* Start an AI conversation task. The AI Channel Robot joins the TRTC room and performs AI dialogue with specified members inside the room. Suitable for smart customer service, AI spoken language teacher, and other scenarios.
The TRTC AI dialogue function has built-in speech-to-text capability and provides both Channel Service, allowing customers to flexibly designate third-party AI model (LLM) services and Text-to-Audio (TTS) services.
* @param {StartAIConversationRequest} req
* @param {function(string, StartAIConversationResponse):void} cb
* @public
*/
StartAIConversation(req, cb) {
let resp = new StartAIConversationResponse();
this.request("StartAIConversation", req, resp, cb);
}
/**
* You can update the StreamUrl of the Relay task.
* @param {UpdateStreamIngestRequest} req
* @param {function(string, UpdateStreamIngestResponse):void} cb
* @public
*/
UpdateStreamIngest(req, cb) {
let resp = new UpdateStreamIngestResponse();
this.request("UpdateStreamIngest", req, resp, cb);
}
/**
* Stop AI Transcription task
* @param {StopAITranscriptionRequest} req
* @param {function(string, StopAITranscriptionResponse):void} cb
* @public
*/
StopAITranscription(req, cb) {
let resp = new StopAITranscriptionResponse();
this.request("StopAITranscription", req, resp, cb);
}
/**
* Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale Metrics (the following metrics will be returned) -userCount (Online users) -roomCount (Online rooms) Note: 1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481. 2. The query time range depends on the function version of the monitoring dashboard. The premium edition can query the last 1 hours
* @param {DescribeTRTCRealTimeScaleDataRequest} req
* @param {function(string, DescribeTRTCRealTimeScaleDataResponse):void} cb
* @public
*/
DescribeTRTCRealTimeScaleData(req, cb) {
let resp = new DescribeTRTCRealTimeScaleDataResponse();
this.request("DescribeTRTCRealTimeScaleData", req, resp, cb);
}
/**
* This API is used to remove a user from a room. It is applicable to scenarios where the anchor, room owner, or admin wants to kick out a user. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.
* @param {RemoveUserRequest} req
* @param {function(string, RemoveUserResponse):void} cb
* @public
*/
RemoveUser(req, cb) {
let resp = new RemoveUserResponse();
this.request("RemoveUser", req, resp, cb);
}
/**
* This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.
* @param {ModifyCloudRecordingRequest} req
* @param {function(string, ModifyCloudRecordingResponse):void} cb
* @public
*/
ModifyCloudRecording(req, cb) {
let resp = new ModifyCloudRecordingResponse();
this.request("ModifyCloudRecording", req, resp, cb);
}
/**
* This API (the old `DescribeDetailEvent`) is used to query the events of a call in the last 14 days, including user entry and exit, turning the camera on/off, etc.
**Note**:
1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/54481?product=pricing.
* @param {DescribeUserEventRequest} req
* @param {function(string, DescribeUserEventResponse):void} cb
* @public
*/
DescribeUserEvent(req, cb) {
let resp = new DescribeUserEventResponse();
this.request("DescribeUserEvent", req, resp, cb);
}
/**
* This API is used to trigger a page recording task. Specify parameters such as the recording URL, recording resolution, and recording result storage in the API parameter.
Because parameter or API logic issues will return immediate results. For page issues such as page unreachable, results will be returned in the callback, stay tuned.
* @param {StartWebRecordRequest} req
* @param {function(string, StartWebRecordResponse):void} cb
* @public
*/
StartWebRecord(req, cb) {
let resp = new StartWebRecordResponse();
this.request("StartWebRecord", req, resp, cb);
}
/**
* This API is used to terminate the transcription task after successful activation.
* @param {DeleteCloudTranscriptionRequest} req
* @param {function(string, DeleteCloudTranscriptionResponse):void} cb
* @public
*/
DeleteCloudTranscription(req, cb) {
let resp = new DeleteCloudTranscriptionResponse();
this.request("DeleteCloudTranscription", req, resp, cb);
}
/**
* Start up the transcription bot. The backend will pass the robot stream pulling to perform real-time speech recognition and deliver subtitles and transcription messages.
The transcription bot supports two stream pulling methods, controlled by the TranscriptionMode field.
- Pull the stream of all players in the room.
- Pull the stream for a specific user.
The server delivers subtitles and transcription messages in real time through TRTC custom messages, with CmdId fixed to 1. Clients just need to listen to the custom message callback, such as the C++ callback (https://www.tencentcloud.com/document/product/647/79637?from_cn_redirect=1#4cd82f4edb24992a15a25187089e1565). Other clients such as Android and Web can likewise find it at the same link.
**Note:**
When TranscriptionMode is 0, ensure only one task is initiated in a room. If multiple tasks are initiated, robots will subscribe with each other. Unless the task is stopped proactively, it will timeout exit after 10 hours. In such cases, it is advisable to fill in SessionId to ensure subsequent repeated task failures.
* @param {StartAITranscriptionRequest} req
* @param {function(string, StartAITranscriptionResponse):void} cb
* @public
*/
StartAITranscription(req, cb) {
let resp = new StartAITranscriptionResponse();
this.request("StartAITranscription", req, resp, cb);
}
/**
* Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics (will return userCount, roomCount, peakCurrentUsers, peakCurrentChannels)
- userCount: number of users in the call,
- roomCount: number of rooms in the call, counted as one call channel from the time a user joins the channel to the time all users leave the channel.
- peakCurrentChannels: peak number of channels online at the same time.
- peakCurrentUsers: peak number of users online at the same time.
Note:
1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling, for monitoring dashboard version features and billing overview: https://trtc.io/document/54481.
2. The query time range depends on the monitoring dashboard function version, premium edition can query up to 60 days.
* @param {DescribeTRTCMarketScaleDataRequest} req
* @param {function(string, DescribeTRTCMarketScaleDataResponse):void} cb
* @public
*/
DescribeTRTCMarketScaleData(req, cb) {
let resp = new DescribeTRTCMarketScaleDataResponse();
this.request("DescribeTRTCMarketScaleData", req, resp, cb);
}
/**
* This API is used to update the subscription blocklist and allowlist after the cloud moderation task is successfully started.
* @param {ModifyCloudModerationRequest} req
* @param {function(string, ModifyCloudModerationResponse):void} cb
* @public
*/
ModifyCloudModeration(req, cb) {
let resp = new ModifyCloudModerationResponse();
this.request("ModifyCloudModeration", req, resp, cb);
}
/**
* This API is used to query the status of the slicing task after it is started, which is valid only when the task is in progress. An error will be returned if the task is exited.
* @param {DescribeCloudSliceTaskRequest} req
* @param {function(string, DescribeCloudSliceTaskResponse):void} cb
* @public
*/
DescribeCloudSliceTask(req, cb) {
let resp = new DescribeCloudSliceTaskResponse();
this.request("DescribeCloudSliceTask", req, resp, cb);
}
/**
* API description:.
Start on-cloud recording to complete audio and video recording in the room and upload to designated cloud storage. This API is used to record each audio and video stream in the TRTC room separately or merge multiple video images into one stream.
Before official online operation, pay attention to the recording best practices (https://www.tencentcloud.com/document/product/647/76497?from_cn_redirect=1#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c). In conjunction with best practices, it can greatly improve API recording availability.
This API is used to achieve the following goals:.
Specify the subscription stream parameter (RecordParams) to specify the blocklist or allowlist of anchors that need to be recorded.
* This API is used to specify the storage parameter (StorageParams) to specify the cloud storage you want to upload to. Currently, Tencent Cloud Video on Demand (VOD), Cloud Object Storage (COS), and third-party AWS are supported.
Specify detailed parameters for audio and video transcoding in mixed-stream mode (MixTranscodeParams), including video resolution, video bitrate, video frame rate, and sound quality.
* Specify the position and layout of each stream in mixed-stream mode, or configure via an automatic Template.
Key nouns:.
* Single stream recording: Record the audio and video of subscribed UserIds in the room separately. The recording service uploads the files to your designated cloud storage in real time.
Mixed-stream recording: Mix the audio and video of subscribed UserId in the room into a video file and upload the recorded files to your designated cloud storage. (After recording ends, go to the VOD console https://console.cloud.tencent.com/vod/media or the object storage COS console https://console.cloud.tencent.com/cos/bucket to view files).
* @param {CreateCloudRecordingRequest} req
* @param {function(string, CreateCloudRecordingResponse):void} cb
* @public
*/
CreateCloudRecording(req, cb) {
let resp = new CreateCloudRecordingResponse();
this.request("CreateCloudRecording", req, resp, cb);
}
/**
* This API is used to stop submission for moderation after the cloud moderation task is successfully started.
* @param {DeleteCloudModerationRequest} req
* @param {function(string, DeleteCloudModerationResponse):void} cb
* @public
*/
DeleteCloudModeration(req, cb) {
let resp = new DeleteCloudModerationResponse();
this.request("DeleteCloudModeration", req, resp, cb);
}
/**
* This API (the old `DescribeHistoryScale`) is used to query the daily number of rooms and users of an application (`SDKAppID`) in the last 14 days. Data for the current day cannot be queried.
* @param {DescribeScaleInfoRequest} req
* @param {function(string, DescribeScaleInfoResponse):void} cb
* @public
*/
DescribeScaleInfo(req, cb) {
let resp = new DescribeScaleInfoResponse();
this.request("DescribeScaleInfo", req, resp, cb);
}
/**
* Stop AI conversation task
* @param {StopAIConversationRequest} req
* @param {function(string, StopAIConversationResponse):void} cb
* @public
*/
StopAIConversation(req, cb) {
let resp = new StopAIConversationResponse();
this.request("StopAIConversation", req, resp, cb);
}
/**
* This API is used to query the transcription status after starting a transcription task. It is effective only when the transcription task is in process. Querying after termination will return an error.
* @param {DescribeCloudTranscriptionRequest} req
* @param {function(string, DescribeCloudTranscriptionResponse):void} cb
* @public
*/
DescribeCloudTranscription(req, cb) {
let resp = new DescribeCloudTranscriptionResponse();
this.request("DescribeCloudTranscription", req, resp, cb);
}
/**
* This API is used to query your usage of TRTC’s relay to CDN service.
- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.
- The period queried per request cannot be longer than 31 days.
- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is five calls per second.
* @param {DescribeRelayUsageRequest} req
* @param {function(string, DescribeRelayUsageResponse):void} cb
* @public
*/
DescribeRelayUsage(req, cb) {
let resp = new DescribeRelayUsageResponse();
this.request("DescribeRelayUsage", req, resp, cb);
}
/**
* This API (the old `DescribeUserInformation`) is used to query the user list of a specified time range (up to four hours) in the last 14 days. The data of up to 100 users can be returned per page (six are returned by default).
**Note**:
1. You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
2. If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://trtc.io/document/60214?product=pricing.
* @param {DescribeUserInfoRequest} req
* @param {function(string, DescribeUserInfoResponse):void} cb
* @public
*/
DescribeUserInfo(req, cb) {
let resp = new DescribeUserInfoResponse();
this.request("DescribeUserInfo", req, resp, cb);
}
/**
* This API is used to update the slicing task after it is started. It can be used to update the allowlist or blocklist for the specified subscription stream.
* @param {ModifyCloudSliceTaskRequest} req
* @param {function(string, ModifyCloudSliceTaskResponse):void} cb
* @public
*/
ModifyCloudSliceTask(req, cb) {
let resp = new ModifyCloudSliceTaskResponse();
this.request("ModifyCloudSliceTask", req, resp, cb);
}
/**
* API description: Enable the cloud transcription feature.
* @param {CreateCloudTranscriptionRequest} req
* @param {function(string, CreateCloudTranscriptionResponse):void} cb
* @public
*/
CreateCloudTranscription(req, cb) {
let resp = new CreateCloudTranscriptionResponse();
this.request("CreateCloudTranscription", req, resp, cb);
}
/**
* Stop a Pull stream Relay task.
* @param {StopStreamIngestRequest} req
* @param {function(string, StopStreamIngestResponse):void} cb
* @public
*/
StopStreamIngest(req, cb) {
let resp = new StopStreamIngestResponse();
this.request("StopStreamIngest", req, resp, cb);
}
/**
* This API is used to clone sound.
* @param {VoiceCloneRequest} req
* @param {function(string, VoiceCloneResponse):void} cb
* @public
*/
VoiceClone(req, cb) {
let resp = new VoiceCloneResponse();
this.request("VoiceClone", req, resp, cb);
}
/**
* This API is used to query your TRTC recording usage.
- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.
- The period queried per request cannot be longer than 31 days.
- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is five calls per second.
* @param {DescribeRecordingUsageRequest} req
* @param {function(string, DescribeRecordingUsageResponse):void} cb
* @public
*/
DescribeRecordingUsage(req, cb) {
let resp = new DescribeRecordingUsageResponse();
this.request("DescribeRecordingUsage", req, resp, cb);
}
/**
* This API is used to remove a user from a room. It allows the anchor, room owner, or admin to kick out a user, and works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.
* @param {RemoveUserByStrRoomIdRequest} req
* @param {function(string, RemoveUserByStrRoomIdResponse):void} cb
* @public
*/
RemoveUserByStrRoomId(req, cb) {
let resp = new RemoveUserByStrRoomIdResponse();
this.request("RemoveUserByStrRoomId", req, resp, cb);
}
/**
* This API is used to query your usage of TRTC’s On-Cloud MixTranscoding service.
- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.
- The period queried per request cannot be longer than 31 days.
- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is five calls per second.
* @param {DescribeMixTranscodingUsageRequest} req
* @param {function(string, DescribeMixTranscodingUsageResponse):void} cb
* @public
*/
DescribeMixTranscodingUsage(req, cb) {
let resp = new DescribeMixTranscodingUsageResponse();
this.request("DescribeMixTranscodingUsage", req, resp, cb);
}
/**
* This API is used to remove all users from a room and dismiss the room. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.
* @param {DismissRoomRequest} req
* @param {function(string, DismissRoomResponse):void} cb
* @public
*/
DismissRoom(req, cb) {
let resp = new DismissRoomResponse();
this.request("DismissRoom", req, resp, cb);
}
/**
* This API is used to query usage data grouped by room.
- The queried period cannot exceed 24 hours. If the period spans two different days, the data returned may not be accurate due to a delay in data collection. You can make multiple calls to query the usage on different days.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is one call every 15 seconds.
* @param {DescribeTrtcRoomUsageRequest} req
* @param {function(string, DescribeTrtcRoomUsageResponse):void} cb
* @public
*/
DescribeTrtcRoomUsage(req, cb) {
let resp = new DescribeTrtcRoomUsageResponse();
this.request("DescribeTrtcRoomUsage", req, resp, cb);
}
/**
* This API is used to stop the slicing task after it is started. Successfully stopping the slicing does not mean that all files are fully transmitted; if the transmission is not completed, the backend will continue to upload files. After the upload is successful, a notification is sent to the customer, prompting that all files have been transmitted, through the event callback.
* @param {DeleteCloudSliceTaskRequest} req
* @param {function(string, DeleteCloudSliceTaskResponse):void} cb
* @public
*/
DeleteCloudSliceTask(req, cb) {
let resp = new DeleteCloudSliceTaskResponse();
this.request("DeleteCloudSliceTask", req, resp, cb);
}
/**
* This API is used to remove all users from a room and close the room. It works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.
* @param {DismissRoomByStrRoomIdRequest} req
* @param {function(string, DismissRoomByStrRoomIdResponse):void} cb
* @public
*/
DismissRoomByStrRoomId(req, cb) {
let resp = new DismissRoomByStrRoomIdResponse();
this.request("DismissRoomByStrRoomId", req, resp, cb);
}
/**
* This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned.
If a recording file is being uploaded to VOD, the response parameter `StorageFileList` will not contain the information of the recording file. Please listen for the recording file callback to get the information.
* @param {DescribeCloudRecordingRequest} req
* @param {function(string, DescribeCloudRecordingResponse):void} cb
* @public
*/
DescribeCloudRecording(req, cb) {
let resp = new DescribeCloudRecordingResponse();
this.request("DescribeCloudRecording", req, resp, cb);
}
/**
* Describe AI transcription task status
* @param {DescribeAITranscriptionRequest} req
* @param {function(string, DescribeAITranscriptionResponse):void} cb
* @public
*/
DescribeAITranscription(req, cb) {
let resp = new DescribeAITranscriptionResponse();
this.request("DescribeAITranscription", req, resp, cb);
}
/**
* Query TRTC Monitoring Dashboard - Real-Time Monitoring Quality Metrics (return the following metrics)
-Video stutter rate
-Audio stutter rate
Note:
1. To call the API, you need to activate the Monitoring Dashboard Standard Edition and Premium Edition. The Monitoring Dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481.
2. The query time range depends on the monitoring dashboard function version. The premium edition can query up to 1 hours
* @param {DescribeTRTCRealTimeQualityDataRequest} req
* @param {function(string, DescribeTRTCRealTimeQualityDataResponse):void} cb
* @public
*/
DescribeTRTCRealTimeQualityData(req, cb) {
let resp = new DescribeTRTCRealTimeQualityDataResponse();
this.request("DescribeTRTCRealTimeQualityData", req, resp, cb);
}
/**
* API description:
This API is used to enable the cloud slicing feature, completing audio and video slicing tasks in the room, and uploading them to the specified cloud storage.
This API is used to achieve the following goals:
* This API is used to specify the slicing parameter (SliceParams) to define the blocklist or allowlist of the anchors that require slicing.
* This API is used to specify the storage parameter (SliceStorageParams) to specify the cloud storage you want to upload to. Currently, Tencent Cloud Object Storage (COS) and third-party AWS are supported.
* @param {CreateCloudSliceTaskRequest} req
* @param {function(string, CreateCloudSliceTaskResponse):void} cb
* @public
*/
CreateCloudSliceTask(req, cb) {
let resp = new CreateCloudSliceTaskResponse();
this.request("CreateCloudSliceTask", req, resp, cb);
}
/**
* This API is used to stop a recording task. If a task is stopped successfully, but the uploading of recording files has not completed, the backend will continue to upload the files and will notify you via a callback when the upload is completed.
* @param {DeleteCloudRecordingRequest} req
* @param {function(string, DeleteCloudRecordingResponse):void} cb
* @public
*/
DeleteCloudRecording(req, cb) {
let resp = new DeleteCloudRecordingResponse();
this.request("DeleteCloudRecording", req, resp, cb);
}
/**
* This API is used to query the status of the moderation task and information about the subscription blocklist and allowlist after the task is started, which is valid only when the task is in progress. An error will be returned if the task is exited.
* @param {DescribeCloudModerationRequest} req
* @param {function(string, DescribeCloudModerationResponse):void} cb
* @public
*/
DescribeCloudModeration(req, cb) {
let resp = new DescribeCloudModerationResponse();
this.request("DescribeCloudModeration", req, resp, cb);
}
/**
* Query TRTC Monitoring Dashboard - Data Dashboard Quality Metrics (including the following metrics)
joinSuccessRate: Join channel success rate.
joinSuccessIn5sRate: Join channel success rate within 5s.
audioFreezeRate: Audio stutter rate.
videoFreezeRate: Video stutter rate.
networkDelay: Lag rate.
Note:
1. To call the API, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. Monitoring dashboard version features and billing overview: https://trtc.io/document/54481.
2. The query time range depends on the monitoring dashboard function version, premium edition can query the last 30 days.
* @param {DescribeTRTCMarketQualityDataRequest} req
* @param {function(string, DescribeTRTCMarketQualityDataResponse):void} cb
* @public
*/
DescribeTRTCMarketQualityData(req, cb) {
let resp = new DescribeTRTCMarketQualityDataResponse();
this.request("DescribeTRTCMarketQualityData", req, resp, cb);
}
/**
* This API is used to provide service for server-side robot control.
* @param {ControlAIConversationRequest} req
* @param {function(string, ControlAIConversationResponse):void} cb
* @public
*/
ControlAIConversation(req, cb) {
let resp = new ControlAIConversationResponse();
this.request("ControlAIConversation", req, resp, cb);
}
/**
* This API is used to stop a relaying task.
You can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.
* @param {StopPublishCdnStreamRequest} req
* @param {function(string, StopPublishCdnStreamResponse):void} cb
* @public
*/
StopPublishCdnStream(req, cb) {
let resp = new StopPublishCdnStreamResponse();
this.request("StopPublishCdnStream", req, resp, cb);
}
/**
* This API (the old `DescribeAbnormalEvent`) is used to query up to 20 random abnormal user experiences of an application (`SDK