tencentcloud-sdk-nodejs-intl-en
Version:
1,637 lines (1,377 loc) • 217 kB
JavaScript
/*
* Copyright (c) 2018 THL A29 Limited, a Tencent company. 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 AbstractModel = require("../../common/abstract_model");
/**
* Robot parameters
* @class
*/
class AgentConfig extends AbstractModel {
constructor(){
super();
/**
* The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.
* @type {string || null}
*/
this.UserId = null;
/**
* The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.
* @type {string || null}
*/
this.UserSig = null;
/**
* The UserId of the robot pulling the media stream. After filling in, the robot will pull the media stream of the UserId for real-time processing
* @type {string || null}
*/
this.TargetUserId = null;
/**
* If there is no streaming in the room for more than MaxIdleTime, the Service will automatically close the task. The default value is 60s.
* @type {number || null}
*/
this.MaxIdleTime = null;
/**
* Robot's welcome message
* @type {string || null}
*/
this.WelcomeMessage = null;
/**
* Intelligent interruption mode, the default value is 0, 0 means the server automatically interrupts, 1 means the server does not interrupt, and the client sends an interrupt signal to interrupt
* @type {number || null}
*/
this.InterruptMode = null;
/**
* Used when InterruptMode is 0, in milliseconds, with a default value of 500ms. This means that the server will interrupt when it detects a human voice that lasts for InterruptSpeechDuration milliseconds.
* @type {number || null}
*/
this.InterruptSpeechDuration = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UserId = 'UserId' in params ? params.UserId : null;
this.UserSig = 'UserSig' in params ? params.UserSig : null;
this.TargetUserId = 'TargetUserId' in params ? params.TargetUserId : null;
this.MaxIdleTime = 'MaxIdleTime' in params ? params.MaxIdleTime : null;
this.WelcomeMessage = 'WelcomeMessage' in params ? params.WelcomeMessage : null;
this.InterruptMode = 'InterruptMode' in params ? params.InterruptMode : null;
this.InterruptSpeechDuration = 'InterruptSpeechDuration' in params ? params.InterruptSpeechDuration : null;
}
}
/**
* DescribeRecordingUsage response structure.
* @class
*/
class DescribeRecordingUsageResponse extends AbstractModel {
constructor(){
super();
/**
* The usage type. Each element of this parameter corresponds to an element of `UsageValue` in the order they are listed.
* @type {Array.<string> || null}
*/
this.UsageKey = null;
/**
* The usage data in each time unit.
* @type {Array.<TrtcUsage> || null}
*/
this.UsageList = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsageKey = 'UsageKey' in params ? params.UsageKey : null;
if (params.UsageList) {
this.UsageList = new Array();
for (let z in params.UsageList) {
let obj = new TrtcUsage();
obj.deserialize(params.UsageList[z]);
this.UsageList.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Audio transcoding parameters
* @class
*/
class AudioEncodeParams extends AbstractModel {
constructor(){
super();
/**
* Audio Sample rate, Value range [48000, 44100], unit is Hz.
* @type {number || null}
*/
this.SampleRate = null;
/**
* Audio Channel number, Value range [1,2], 1 means Audio is Mono-channel, 2 means Audio is Dual-channel.
* @type {number || null}
*/
this.Channel = null;
/**
* Audio Bitrate, Value range [8,500], unit is kbps.
* @type {number || null}
*/
this.BitRate = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SampleRate = 'SampleRate' in params ? params.SampleRate : null;
this.Channel = 'Channel' in params ? params.Channel : null;
this.BitRate = 'BitRate' in params ? params.BitRate : null;
}
}
/**
* The server controls the AI conversation robot to broadcast the specified text
* @class
*/
class ServerPushText extends AbstractModel {
constructor(){
super();
/**
* Server push broadcast text
* @type {string || null}
*/
this.Text = null;
/**
* Allow this text to interrupt the robot
* @type {boolean || null}
*/
this.Interrupt = null;
/**
* After the text is finished, whether to automatically close the conversation task
* @type {boolean || null}
*/
this.StopAfterPlay = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Text = 'Text' in params ? params.Text : null;
this.Interrupt = 'Interrupt' in params ? params.Interrupt : null;
this.StopAfterPlay = 'StopAfterPlay' in params ? params.StopAfterPlay : null;
}
}
/**
* The custom layout parameters.
* @class
*/
class MixLayout extends AbstractModel {
constructor(){
super();
/**
* The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.
* @type {number || null}
*/
this.Top = null;
/**
* The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.
* @type {number || null}
*/
this.Left = null;
/**
* The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.
* @type {number || null}
*/
this.Width = null;
/**
* The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.
* @type {number || null}
*/
this.Height = null;
/**
* The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.
* @type {string || null}
*/
this.UserId = null;
/**
* The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.
* @type {number || null}
*/
this.Alpha = null;
/**
* 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted.
1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted.
2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window.
3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.
* @type {number || null}
*/
this.RenderMode = null;
/**
* The type of the stream subscribed to.
0: Primary stream (default)
1: Substream
* @type {number || null}
*/
this.MediaId = null;
/**
* The image layer. 0 is the default value and means the bottommost layer.
* @type {number || null}
*/
this.ImageLayer = null;
/**
* The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.
* @type {string || null}
*/
this.SubBackgroundImage = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Top = 'Top' in params ? params.Top : null;
this.Left = 'Left' in params ? params.Left : null;
this.Width = 'Width' in params ? params.Width : null;
this.Height = 'Height' in params ? params.Height : null;
this.UserId = 'UserId' in params ? params.UserId : null;
this.Alpha = 'Alpha' in params ? params.Alpha : null;
this.RenderMode = 'RenderMode' in params ? params.RenderMode : null;
this.MediaId = 'MediaId' in params ? params.MediaId : null;
this.ImageLayer = 'ImageLayer' in params ? params.ImageLayer : null;
this.SubBackgroundImage = 'SubBackgroundImage' in params ? params.SubBackgroundImage : null;
}
}
/**
* The video parameters for relaying.
* @class
*/
class McuVideoParams extends AbstractModel {
constructor(){
super();
/**
* The video encoding parameters.
* @type {VideoEncode || null}
*/
this.VideoEncode = null;
/**
* The layout parameters.
* @type {McuLayoutParams || null}
*/
this.LayoutParams = null;
/**
* The canvas color. Below are the values for some common colors:
Red: 0xcc0033
Yellow: 0xcc9900
Green: 0xcccc33
Blue: 0x99CCFF
Black: 0x000000
White: 0xFFFFFF
Grey: 0x999999
* @type {string || null}
*/
this.BackGroundColor = null;
/**
* The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.
* @type {string || null}
*/
this.BackgroundImageUrl = null;
/**
* The watermark information for the mixed stream.
* @type {Array.<McuWaterMarkParams> || null}
*/
this.WaterMarkList = null;
/**
* Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.
* @type {number || null}
*/
this.BackgroundRenderMode = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.VideoEncode) {
let obj = new VideoEncode();
obj.deserialize(params.VideoEncode)
this.VideoEncode = obj;
}
if (params.LayoutParams) {
let obj = new McuLayoutParams();
obj.deserialize(params.LayoutParams)
this.LayoutParams = obj;
}
this.BackGroundColor = 'BackGroundColor' in params ? params.BackGroundColor : null;
this.BackgroundImageUrl = 'BackgroundImageUrl' in params ? params.BackgroundImageUrl : null;
if (params.WaterMarkList) {
this.WaterMarkList = new Array();
for (let z in params.WaterMarkList) {
let obj = new McuWaterMarkParams();
obj.deserialize(params.WaterMarkList[z]);
this.WaterMarkList.push(obj);
}
}
this.BackgroundRenderMode = 'BackgroundRenderMode' in params ? params.BackgroundRenderMode : null;
}
}
/**
* DescribeTRTCRealTimeScaleData request structure.
* @class
*/
class DescribeTRTCRealTimeScaleDataRequest extends AbstractModel {
constructor(){
super();
/**
* User SDKAppId (e.g., 1400xxxxxx)
* @type {string || null}
*/
this.SdkAppId = null;
/**
* Start time, unix timestamp, Unit: seconds (Query time range depends on the function version of the monitoring dashboard, premium edition can query up to 1 hours)
* @type {number || null}
*/
this.StartTime = null;
/**
* End time, unix timestamp, Unit: seconds
* @type {number || null}
*/
this.EndTime = null;
/**
* Room ID
* @type {string || null}
*/
this.RoomId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
}
}
/**
* StartAIConversation response structure.
* @class
*/
class StartAIConversationResponse extends AbstractModel {
constructor(){
super();
/**
* Used to uniquely identify a conversation task.
* @type {string || null}
*/
this.TaskId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* StartAIConversation request structure.
* @class
*/
class StartAIConversationRequest extends AbstractModel {
constructor(){
super();
/**
* TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.
* @type {string || null}
*/
this.RoomId = null;
/**
* Robot parameters
* @type {AgentConfig || null}
*/
this.AgentConfig = null;
/**
* The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.
* @type {string || null}
*/
this.SessionId = null;
/**
* The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.
* @type {number || null}
*/
this.RoomIdType = null;
/**
* Speech recognition configuration.
* @type {STTConfig || null}
*/
this.STTConfig = null;
/**
* LLM configuration. It must comply with the openai specification and be a JSON string. The example is as follows: <pre> { <br>   "LLMType": "Large model type", // String required, such as: "openai" <br>   "Model": "Your model name", // String required, specify the model to be used<br> "APIKey": "Your LLM API key", // String required <br>   "APIUrl": "https://api.xxx.com/chat/completions", // String required, URL for LLM API access<br>   "Streaming": true // Boolean optional, specify whether to use streaming<br>  } </pre>
* @type {string || null}
*/
this.LLMConfig = null;
/**
* TTS configuration, which is a JSON string. The Tencent Cloud TTS example is as follows: <pre>{ <br>   "AppId": your application ID, // Integer Required<br>   "TTSType": "TTS type", // String TTS type, fixed to "tencent"<br>   "SecretId": "Your key ID", // String Required<br>   "SecretKey": "Your keyKey", // String Required<br>   "VoiceType": 101001, // Integer Required, voice ID, including standard voice and premium voice. Premium voice has higher fidelity and different price from standard voice. For details, please refer to <a href="https://cloud.tencent.com/document/product/1073/34112">Overview of Speech Synthesis Billing</a>. For a complete list of timbre IDs, see <a href="https://cloud.tencent.com/document/product/1073/92668#55924b56-1a73-4663-a7a1-a8dd82d6e823">List of speech synthesis timbre IDs</a>. <br>   "Speed": 1.25, // Integer Optional, speaking speed, range: [-2, 6], corresponding to different speaking speeds: -2: 0.6 times -1: 0.8 times 0: 1.0 times (default) 1: 1.2 times 2: 1.5 times 6: 2.5 times If a more detailed speaking speed is required, 2 decimal places can be retained, such as 0.5/1.25/2.81, etc. For the conversion between parameter value and actual speech speed, please refer to <a href="https://sdk-1300466766.cos.ap-shanghai.myqcloud.com/sample/speed_sample.tar.gz">Speed Conversion</a><br>   "Volume": 5, // Integer Optional, volume size, range: [0, 10], corresponding to 11 levels of volume, the default value is 0, representing normal volume. <br>   "PrimaryLanguage": "zh-CN" // String Optional, primary language<br>  }</pre>
* @type {string || null}
*/
this.TTSConfig = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
if (params.AgentConfig) {
let obj = new AgentConfig();
obj.deserialize(params.AgentConfig)
this.AgentConfig = obj;
}
this.SessionId = 'SessionId' in params ? params.SessionId : null;
this.RoomIdType = 'RoomIdType' in params ? params.RoomIdType : null;
if (params.STTConfig) {
let obj = new STTConfig();
obj.deserialize(params.STTConfig)
this.STTConfig = obj;
}
this.LLMConfig = 'LLMConfig' in params ? params.LLMConfig : null;
this.TTSConfig = 'TTSConfig' in params ? params.TTSConfig : null;
}
}
/**
* DescribeTRTCMarketScaleData request structure.
* @class
*/
class DescribeTRTCMarketScaleDataRequest extends AbstractModel {
constructor(){
super();
/**
* User SDKAppId
* @type {string || null}
*/
this.SdkAppId = null;
/**
* Query start time, format is YYYY-MM-DD. (The query time range depends on the monitoring dashboard function version, the premium edition can query up to 60 days)
* @type {string || null}
*/
this.StartTime = null;
/**
* Query end time, format is YYYY-MM-DD.
* @type {string || null}
*/
this.EndTime = null;
/**
* The granularity of the returned data, which can be set to the following values:
d: by day. This returns data for the entire UTC day of the query time range.
h: by hour. This returns data for the entire UTC hour of the query time range.
* @type {string || null}
*/
this.Period = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.Period = 'Period' in params ? params.Period : null;
}
}
/**
* The SEI parameters for audio volume layout. You can specify the `AppData` and `PayloadType`.
This parameter may be empty, in which case the default SEI parameters for audio volume layout will be used.
* @class
*/
class McuLayoutVolume extends AbstractModel {
constructor(){
super();
/**
* The application data, which will be embedded in the `app_data` field of the custom SEI. It must be shorter than 4,096 characters.
* @type {string || null}
*/
this.AppData = null;
/**
* The payload type of the SEI message. The default is 100. Value range: 100-254 (244 is used internally by Tencent Cloud for timestamps).
* @type {number || null}
*/
this.PayloadType = null;
/**
* The SEI sending interval (milliseconds). The default value is 1000.
* @type {number || null}
*/
this.Interval = null;
/**
* Valid values: `1`: SEI is guaranteed when keyframes are sent; `0` (default): SEI is not guaranteed when keyframes are sent.
* @type {number || null}
*/
this.FollowIdr = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AppData = 'AppData' in params ? params.AppData : null;
this.PayloadType = 'PayloadType' in params ? params.PayloadType : null;
this.Interval = 'Interval' in params ? params.Interval : null;
this.FollowIdr = 'FollowIdr' in params ? params.FollowIdr : null;
}
}
/**
* SetUserBlocked request structure.
* @class
*/
class SetUserBlockedRequest extends AbstractModel {
constructor(){
super();
/**
* The application ID.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* The room ID (number).
* @type {number || null}
*/
this.RoomId = null;
/**
* The user ID.
* @type {string || null}
*/
this.UserId = null;
/**
* Controls the activation state of audio and video.
0: Enable audio and video,
1: Disable audio and video,
2: Disable audio only,
3: Disable video only.
* @type {number || null}
*/
this.IsMute = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
this.UserId = 'UserId' in params ? params.UserId : null;
this.IsMute = 'IsMute' in params ? params.IsMute : null;
}
}
/**
* DescribeUserEvent request structure.
* @class
*/
class DescribeUserEventRequest extends AbstractModel {
constructor(){
super();
/**
* The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
* @type {string || null}
*/
this.CommId = null;
/**
* The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
Note: Only data in the last 14 days can be queried.
* @type {number || null}
*/
this.StartTime = null;
/**
* The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
Note: If you pass in an end time later than the room end time, the room end time will be used.
* @type {number || null}
*/
this.EndTime = null;
/**
* The user ID.
* @type {string || null}
*/
this.UserId = null;
/**
* The room ID, such as `223`.
* @type {string || null}
*/
this.RoomId = null;
/**
* The application ID, such as `1400xxxxxx`.
* @type {number || null}
*/
this.SdkAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CommId = 'CommId' in params ? params.CommId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.UserId = 'UserId' in params ? params.UserId : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
}
}
/**
* SetUserBlocked response structure.
* @class
*/
class SetUserBlockedResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
*
* @class
*/
class WaterMarkChar extends AbstractModel {
constructor(){
super();
/**
* The Y coordinate of the text watermark from the top left.
* @type {number || null}
*/
this.Top = null;
/**
* The X coordinate of the text watermark from the top left.
* @type {number || null}
*/
this.Left = null;
/**
* The watermark width (pixels).
* @type {number || null}
*/
this.Width = null;
/**
* The watermark height (pixels).
* @type {number || null}
*/
this.Height = null;
/**
* The text.
* @type {string || null}
*/
this.Chars = null;
/**
* The font size (pixels). The default value is `14`.
* @type {number || null}
*/
this.FontSize = null;
/**
* The text color. The default color is white.
* @type {string || null}
*/
this.FontColor = null;
/**
* The background color. If this parameter is empty, the background will be transparent (default).
* @type {string || null}
*/
this.BackGroundColor = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Top = 'Top' in params ? params.Top : null;
this.Left = 'Left' in params ? params.Left : null;
this.Width = 'Width' in params ? params.Width : null;
this.Height = 'Height' in params ? params.Height : null;
this.Chars = 'Chars' in params ? params.Chars : null;
this.FontSize = 'FontSize' in params ? params.FontSize : null;
this.FontColor = 'FontColor' in params ? params.FontColor : null;
this.BackGroundColor = 'BackGroundColor' in params ? params.BackGroundColor : null;
}
}
/**
* DescribeTrtcRoomUsage response structure.
* @class
*/
class DescribeTrtcRoomUsageResponse extends AbstractModel {
constructor(){
super();
/**
* The usage data grouped by room, in CSV format.
* @type {string || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Data = 'Data' in params ? params.Data : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* StopPublishCdnStream response structure.
* @class
*/
class StopPublishCdnStreamResponse extends AbstractModel {
constructor(){
super();
/**
* The task ID.
* @type {string || null}
*/
this.TaskId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* The information of an error event (the possible cause of an abnormal user experience).
* @class
*/
class AbnormalEvent extends AbstractModel {
constructor(){
super();
/**
* The error event ID. For details, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
* @type {number || null}
*/
this.AbnormalEventId = null;
/**
* The remote user ID. If this parameter is empty, it indicates that the error event is not associated with a remote user.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PeerId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AbnormalEventId = 'AbnormalEventId' in params ? params.AbnormalEventId : null;
this.PeerId = 'PeerId' in params ? params.PeerId : null;
}
}
/**
* The room and user number.
* @class
*/
class ScaleInfomation extends AbstractModel {
constructor(){
super();
/**
* Start time for each day
* @type {number || null}
*/
this.Time = null;
/**
* The number of users. If a user enters a room multiple times, it will be counted as one user.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.UserNumber = null;
/**
* The number of room entries. Every time a user enters a room, it will be counted as one room entry.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.UserCount = null;
/**
* The total number of rooms of the application on a day.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.RoomNumbers = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Time = 'Time' in params ? params.Time : null;
this.UserNumber = 'UserNumber' in params ? params.UserNumber : null;
this.UserCount = 'UserCount' in params ? params.UserCount : null;
this.RoomNumbers = 'RoomNumbers' in params ? params.RoomNumbers : null;
}
}
/**
* The information of the relaying robot in the room.
* @class
*/
class AgentParams extends AbstractModel {
constructor(){
super();
/**
* The [user ID](https://intl.cloud.tencent.com/document/product/647/37714) of the relaying robot in the TRTC room, which cannot be the same as a user ID already in use. We recommend you include the room ID in this user ID.
* @type {string || null}
*/
this.UserId = null;
/**
* The signature (similar to a login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104). |
* @type {string || null}
*/
this.UserSig = null;
/**
* The timeout period (seconds) for relaying to stop automatically after all the users whose streams are mixed leave the room. The value cannot be smaller than 5 or larger than 86400 (24 hours). Default value: 30.
* @type {number || null}
*/
this.MaxIdleTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UserId = 'UserId' in params ? params.UserId : null;
this.UserSig = 'UserSig' in params ? params.UserSig : null;
this.MaxIdleTime = 'MaxIdleTime' in params ? params.MaxIdleTime : null;
}
}
/**
* ControlAIConversation response structure.
* @class
*/
class ControlAIConversationResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* StopAITranscription request structure.
* @class
*/
class StopAITranscriptionRequest extends AbstractModel {
constructor(){
super();
/**
* Uniquely identifies a transcription task.
* @type {string || null}
*/
this.TaskId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
}
}
/**
* Video transcoding parameters
* @class
*/
class VideoEncodeParams extends AbstractModel {
constructor(){
super();
/**
* Width. Value range [0,1920], unit is pixel value.
* @type {number || null}
*/
this.Width = null;
/**
* Height. Value range [0,1080], unit is pixel value.
* @type {number || null}
*/
this.Height = null;
/**
* Frame Rate. Value range [1,60], indicating that the frame rate can be selected from 1 to 60fps.
* @type {number || null}
*/
this.Fps = null;
/**
* Bitrate. Value range [1,10000], unit is kbps.
* @type {number || null}
*/
this.BitRate = null;
/**
* Gop. Value range [1,2], unit is second.
* @type {number || null}
*/
this.Gop = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Width = 'Width' in params ? params.Width : null;
this.Height = 'Height' in params ? params.Height : null;
this.Fps = 'Fps' in params ? params.Fps : null;
this.BitRate = 'BitRate' in params ? params.BitRate : null;
this.Gop = 'Gop' in params ? params.Gop : null;
}
}
/**
* UpdateAIConversation response structure.
* @class
*/
class UpdateAIConversationResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeUserEvent response structure.
* @class
*/
class DescribeUserEventResponse extends AbstractModel {
constructor(){
super();
/**
* The event list. An empty array will be returned if no data is obtained.
* @type {Array.<EventList> || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Data) {
this.Data = new Array();
for (let z in params.Data) {
let obj = new EventList();
obj.deserialize(params.Data[z]);
this.Data.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* The video encoding parameters.
* @class
*/
class VideoEncode extends AbstractModel {
constructor(){
super();
/**
* The width of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1920].
* @type {number || null}
*/
this.Width = null;
/**
* The height of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1080].
* @type {number || null}
*/
this.Height = null;
/**
* The frame rate (fps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 60].
* @type {number || null}
*/
this.Fps = null;
/**
* The bitrate (Kbps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 10000].
* @type {number || null}
*/
this.BitRate = null;
/**
* The GOP (seconds) of the output stream. This parameter is required if audio and video are relayed. Value range: [1, 5].
* @type {number || null}
*/
this.Gop = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Width = 'Width' in params ? params.Width : null;
this.Height = 'Height' in params ? params.Height : null;
this.Fps = 'Fps' in params ? params.Fps : null;
this.BitRate = 'BitRate' in params ? params.BitRate : null;
this.Gop = 'Gop' in params ? params.Gop : null;
}
}
/**
* DescribeCallDetailInfo request structure.
* @class
*/
class DescribeCallDetailInfoRequest extends AbstractModel {
constructor(){
super();
/**
* The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
* @type {string || null}
*/
this.CommId = null;
/**
* The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
Note: Only data in the last 14 days can be queried.
* @type {number || null}
*/
this.StartTime = null;
/**
* The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
Note: If `DataType` is not null, the end time and start time cannot be more than one hour apart; if `DataType` is null, the end time and start time cannot be more than four hours apart.
* @type {number || null}
*/
this.EndTime = null;
/**
* The application ID, such as `1400xxxxxx`.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* The users to query. If you do not specify this, the data of six users will be returned.
* @type {Array.<string> || null}
*/
this.UserIds = null;
/**
* The metrics to query. If you do not specify this, only the user list will be returned. If you pass in `all`, all metrics will be returned.
`appCpu`: The CPU utilization of the application.
`sysCpu`: The CPU utilization of the system.
`aBit`: The upstream/downstream audio bitrate (bps).
`aBlock`: The audio stutter duration (ms).
`bigvBit`: The upstream/downstream video bitrate (bps).
`bigvCapFps`: The frame rate for capturing videos.
`bigvEncFps`: The frame rate for sending videos.
`bigvDecFps`: The rendering frame rate.
`bigvBlock`: The video stutter duration (ms).
`aLoss`: The upstream/downstream audio packet loss.
`bigvLoss`: The upstream/downstream video packet loss.
`bigvWidth`: The upstream/downstream resolution (width).
`bigvHeight`: The upstream/downstream resolution (height).
* @type {Array.<string> || null}
*/
this.DataType = null;
/**
* The page number. The default is 0.
Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
* @type {number || null}
*/
this.PageNumber = null;
/**
* The number of records per page. The default is `6`.
Value range: 1-100.
Note: If `DataType` is not null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `6`.
If `DataType` is null, the length of the array `UserIds` and the value of `PageSize` cannot exceed `100`.
* @type {number || null}
*/
this.PageSize = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CommId = 'CommId' in params ? params.CommId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.UserIds = 'UserIds' in params ? params.UserIds : null;
this.DataType = 'DataType' in params ? params.DataType : null;
this.PageNumber = 'PageNumber' in params ? params.PageNumber : null;
this.PageSize = 'PageSize' in params ? params.PageSize : null;
}
}
/**
* DescribeTRTCMarketScaleData response structure.
* @class
*/
class DescribeTRTCMarketScaleDataResponse extends AbstractModel {
constructor(){
super();
/**
* TRTC Data Dashboard output parameters
* @type {TRTCDataResult || null}
*/
this.Data = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Data) {
let obj = new TRTCDataResult();
obj.deserialize(params.Data)
this.Data = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeUserInfo request structure.
* @class
*/
class DescribeUserInfoRequest extends AbstractModel {
constructor(){
super();
/**
* The unique ID of a call, whose format is `SdkAppId_CreateTime`, such as `1400xxxxxx_218695_1590065777`. `createTime` is the UNIX timestamp (seconds) when the room was created. Its value can be obtained using the [DescribeRoomInfo](https://intl.cloud.tencent.com/document/product/647/44050?from_cn_redirect=1) API.
* @type {string || null}
*/
this.CommId = null;
/**
* The start time, which is a Unix timestamp (seconds) in local time, such as `1590065777`.
Note: Only data in the last 14 days can be queried.
* @type {number || null}
*/
this.StartTime = null;
/**
* The end time, which is a Unix timestamp (seconds) in local time, such as `1590065877`.
Note: The end and start time cannot be more than four hours apart.
* @type {number || null}
*/
this.EndTime = null;
/**
* The application ID, such as `1400xxxxxx`.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* The users to query. If you do not specify this, the information of six users will be returned.
Array length: 1-100.
* @type {Array.<string> || null}
*/
this.UserIds = null;
/**
* The page number. The default is 0.
Note: If `PageNumber` or `PageSize` is not specified, six records will be returned.
* @type {number || null}
*/
this.PageNumber = null;
/**
* The number of records per page. The default is `6`.
Array length: 1-100.
* @type {number || null}
*/
this.PageSize = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.CommId = 'CommId' in params ? params.CommId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.UserIds = 'UserIds' in params ? params.UserIds : null;
this.PageNumber = 'PageNumber' in params ? params.PageNumber : null;
this.PageSize = 'PageSize' in params ? params.PageSize : null;
}
}
/**
* DescribeRelayUsage request structure.
* @class
*/
class DescribeRelayUsageRequest extends AbstractModel {
constructor(){
super();
/**
* The start date in the format of YYYY-MM-DD.
* @type {string || null}
*/
this.StartTime = null;
/**
* The end date in the format of YYYY-MM-DD.
The period queried per request cannot be longer than 31 days.
* @type {string || null}
*/
this.EndTime = null;
/**
* The `SDKAppID` of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned.
* @type {number || null}
*/
this.SdkAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
}
}
/**
* The cloud storage information.
* @class
*/
class CloudStorage extends AbstractModel {
constructor(){
super();
/**
* The cloud storage provider.
`0`: Tencent Cloud COS; `1`: AWS storage. Other vendors are not supported currently.
* @type {number || null}
*/
this.Vendor = null;
/**
* The region of cloud storage.
* @type {string || null}
*/
this.Region = null;
/**
* The storage bucket.
* @type {string || null}
*/
this.Bucket = null;
/**
* The access_key of the cloud storage account.
* @type {string || null}
*/
this.AccessKey = null;
/**
* The secret_key of the cloud storage account.
* @type {string || null}
*/
this.SecretKey = null;