tencentcloud-sdk-nodejs-intl-en
Version:
1,901 lines (1,591 loc) • 194 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");
/**
* Mixed stream canvas parameter
* @class
*/
class Canvas extends AbstractModel {
constructor(){
super();
/**
* Width and height of the mixed stream canvas
* @type {LayoutParams || null}
*/
this.LayoutParams = null;
/**
* Background color, which is black by default. Its format is RGB. for example, "#FF0000" for the red color.
* @type {string || null}
*/
this.BackgroundColor = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.LayoutParams) {
let obj = new LayoutParams();
obj.deserialize(params.LayoutParams)
this.LayoutParams = obj;
}
this.BackgroundColor = 'BackgroundColor' in params ? params.BackgroundColor : null;
}
}
/**
* StopOnlineRecord response structure.
* @class
*/
class StopOnlineRecordResponse 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;
}
}
/**
* SetVideoGenerationTaskCallbackKey request structure.
* @class
*/
class SetVideoGenerationTaskCallbackKeyRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Callback authentication key for recording video generation. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted.
* @type {string || null}
*/
this.CallbackKey = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.CallbackKey = 'CallbackKey' in params ? params.CallbackKey : null;
}
}
/**
* DescribeTIWRoomDailyUsage request structure.
* @class
*/
class DescribeTIWRoomDailyUsageRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Subproduct usage to be queried. The following parameters are supported:
- sp_tiw_board: The duration of use of whiteboards, in minutes.
- sp_tiw_ric: The duration of real-time recording, in minutes.
* @type {string || null}
*/
this.SubProduct = null;
/**
* Start date in the format of YYYY-MM-DD. The start date is included in the query period.
* @type {string || null}
*/
this.StartTime = null;
/**
* End date in the format of YYYY-MM-DD. The end date is included in the query period. The period queried per request cannot be longer than 31 days.
* @type {string || null}
*/
this.EndTime = null;
/**
* Room IDs to be queried. If you leave this parameter empty, all room IDs are queried.
* @type {Array.<number> || null}
*/
this.RoomIDs = null;
/**
* Offset for query. Default value: `0`.
* @type {number || null}
*/
this.Offset = null;
/**
* Maximum number of entries returned per query. Default value: `20`.
* @type {number || null}
*/
this.Limit = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.SubProduct = 'SubProduct' in params ? params.SubProduct : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.RoomIDs = 'RoomIDs' in params ? params.RoomIDs : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
}
}
/**
* DescribeWhiteboardPush request structure.
* @class
*/
class DescribeWhiteboardPushRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* ID of the whiteboard push task.
* @type {string || null}
*/
this.TaskId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskId = 'TaskId' in params ? params.TaskId : null;
}
}
/**
* DescribeWhiteboardPushSearch response structure.
* @class
*/
class DescribeWhiteboardPushSearchResponse extends AbstractModel {
constructor(){
super();
/**
* The set of queried push tasks.
* @type {Array.<WhiteboardPushTaskSearchResult> || null}
*/
this.WhiteboardPushTaskSet = null;
/**
* Number of push tasks.
* @type {number || null}
*/
this.TotalCount = 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.WhiteboardPushTaskSet) {
this.WhiteboardPushTaskSet = new Array();
for (let z in params.WhiteboardPushTaskSet) {
let obj = new WhiteboardPushTaskSearchResult();
obj.deserialize(params.WhiteboardPushTaskSet[z]);
this.WhiteboardPushTaskSet.push(obj);
}
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ResumeOnlineRecord response structure.
* @class
*/
class ResumeOnlineRecordResponse 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;
}
}
/**
* Tencent Interactive Whiteboard usage information.
* @class
*/
class UsageDataItem extends AbstractModel {
constructor(){
super();
/**
* Start date in the format of YYYY-MM-DD.
* @type {string || null}
*/
this.Time = null;
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Subproduct usage information, which is consistent with the corresponding request parameters.
- sp_tiw_board: The duration of use of whiteboards.
- sp_tiw_dt: The number of pages dynamically transcoded.
- sp_tiw_st: The number of pages statically transcoded.
- sp_tiw_ric: The duration of real-time recording.
* @type {string || null}
*/
this.SubProduct = null;
/**
* Usage values.
- The unit of sp_tiw_dt and sp_tiw_st is pages.
- The unit of sp_tiw_board and sp_tiw_ric is minutes.
* @type {number || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Time = 'Time' in params ? params.Time : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.SubProduct = 'SubProduct' in params ? params.SubProduct : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* DescribeWhiteboardApplicationConfig response structure.
* @class
*/
class DescribeWhiteboardApplicationConfigResponse extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Task-related configurations of the whiteboard application.
* @type {Array.<WhiteboardApplicationConfig> || null}
*/
this.Configs = 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.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
if (params.Configs) {
this.Configs = new Array();
for (let z in params.Configs) {
let obj = new WhiteboardApplicationConfig();
obj.deserialize(params.Configs[z]);
this.Configs.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Whiteboard push task result.
* @class
*/
class WhiteboardPushResult extends AbstractModel {
constructor(){
super();
/**
* `AUTO`: Pushing automatically stops. `USER_CALL`: The API for stopping pushing is called.
* @type {string || null}
*/
this.FinishReason = null;
/**
* Number of exceptions.
* @type {number || null}
*/
this.ExceptionCnt = null;
/**
* Room ID.
* @type {number || null}
*/
this.RoomId = null;
/**
* IM group ID.
* @type {string || null}
*/
this.GroupId = null;
/**
* Actual push start time.
* @type {number || null}
*/
this.PushStartTime = null;
/**
* Push end time.
* @type {number || null}
*/
this.PushStopTime = null;
/**
* IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
* @type {number || null}
*/
this.IMSyncTime = null;
/**
* Task execution error code.
* @type {number || null}
*/
this.ErrorCode = null;
/**
* Error message.
* @type {string || null}
*/
this.ErrorMsg = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FinishReason = 'FinishReason' in params ? params.FinishReason : null;
this.ExceptionCnt = 'ExceptionCnt' in params ? params.ExceptionCnt : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
this.GroupId = 'GroupId' in params ? params.GroupId : null;
this.PushStartTime = 'PushStartTime' in params ? params.PushStartTime : null;
this.PushStopTime = 'PushStopTime' in params ? params.PushStopTime : null;
this.IMSyncTime = 'IMSyncTime' in params ? params.IMSyncTime : null;
this.ErrorCode = 'ErrorCode' in params ? params.ErrorCode : null;
this.ErrorMsg = 'ErrorMsg' in params ? params.ErrorMsg : null;
}
}
/**
* CreateSnapshotTask response structure.
* @class
*/
class CreateSnapshotTaskResponse extends AbstractModel {
constructor(){
super();
/**
* ID of the whiteboard snapshot task. This parameter is returned only if a task is created successfully.
* @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;
}
}
/**
* ModifyApplication response structure.
* @class
*/
class ModifyApplicationResponse 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;
}
}
/**
* CreateTranscode response structure.
* @class
*/
class CreateTranscodeResponse extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the document transcoding task, which is used to query the task progress and transcoding result
* @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;
}
}
/**
* DescribeUserResources response structure.
* @class
*/
class DescribeUserResourcesResponse 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;
}
}
/**
* Video information
* @class
*/
class VideoInfo extends AbstractModel {
constructor(){
super();
/**
* Video playback start time, in milliseconds
* @type {number || null}
*/
this.VideoPlayTime = null;
/**
* Video size, in bytes
* @type {number || null}
*/
this.VideoSize = null;
/**
* Video format
* @type {string || null}
*/
this.VideoFormat = null;
/**
* Video playback duration, in milliseconds
* @type {number || null}
*/
this.VideoDuration = null;
/**
* Video file URL
* @type {string || null}
*/
this.VideoUrl = null;
/**
* Video file ID
* @type {string || null}
*/
this.VideoId = null;
/**
* Video stream type - 0: camera video - 1: screen-sharing video - 2: whiteboard video - 3: mixed stream video - 4: audio-only (mp3)
* @type {number || null}
*/
this.VideoType = null;
/**
* ID of the user to which the camera video or screen-sharing video belongs (whiteboard video: null, mixed stream video: tic_mixstream_<Room ID>_<Mixed stream layout type>, auxiliary video: tic_substream_user ID)
* @type {string || null}
*/
this.UserId = null;
/**
* Width of the video resolution.
* @type {number || null}
*/
this.Width = null;
/**
* Height of the video resolution.
* @type {number || null}
*/
this.Height = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.VideoPlayTime = 'VideoPlayTime' in params ? params.VideoPlayTime : null;
this.VideoSize = 'VideoSize' in params ? params.VideoSize : null;
this.VideoFormat = 'VideoFormat' in params ? params.VideoFormat : null;
this.VideoDuration = 'VideoDuration' in params ? params.VideoDuration : null;
this.VideoUrl = 'VideoUrl' in params ? params.VideoUrl : null;
this.VideoId = 'VideoId' in params ? params.VideoId : null;
this.VideoType = 'VideoType' in params ? params.VideoType : null;
this.UserId = 'UserId' in params ? params.UserId : null;
this.Width = 'Width' in params ? params.Width : null;
this.Height = 'Height' in params ? params.Height : null;
}
}
/**
* Custom mixed stream layout parameter
* @class
*/
class CustomLayout extends AbstractModel {
constructor(){
super();
/**
* Mixed stream canvas parameter
* @type {Canvas || null}
*/
this.Canvas = null;
/**
* Stream layout. The layout of each stream cannot exceed the canvas area.
* @type {Array.<StreamLayout> || null}
*/
this.InputStreamList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Canvas) {
let obj = new Canvas();
obj.deserialize(params.Canvas)
this.Canvas = obj;
}
if (params.InputStreamList) {
this.InputStreamList = new Array();
for (let z in params.InputStreamList) {
let obj = new StreamLayout();
obj.deserialize(params.InputStreamList[z]);
this.InputStreamList.push(obj);
}
}
}
}
/**
* Number of video stream interruptions during real-time recording.
* @class
*/
class Interrupt extends AbstractModel {
constructor(){
super();
/**
* User ID.
Note: This parameter may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UserId = null;
/**
* Number of video stream interruptions.
Note: This parameter may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.Count = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UserId = 'UserId' in params ? params.UserId : null;
this.Count = 'Count' in params ? params.Count : null;
}
}
/**
* DescribeOnlineRecord request structure.
* @class
*/
class DescribeOnlineRecordRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the customer
* @type {number || null}
*/
this.SdkAppId = null;
/**
* ID of the real-time recording task
* @type {string || null}
*/
this.TaskId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskId = 'TaskId' in params ? params.TaskId : null;
}
}
/**
* Whiteboard room data returned for log queries.
* @class
*/
class RoomListItem extends AbstractModel {
constructor(){
super();
/**
* Room ID.
* @type {string || null}
*/
this.RoomId = null;
/**
* The first time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
* @type {number || null}
*/
this.StartTime = null;
/**
* The last time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
* @type {number || null}
*/
this.EndTime = null;
/**
* Number of users in the room.
* @type {number || null}
*/
this.UserNumber = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RoomId = 'RoomId' in params ? params.RoomId : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.UserNumber = 'UserNumber' in params ? params.UserNumber : null;
}
}
/**
* ModifyWhiteboardBucketConfig request structure.
* @class
*/
class ModifyWhiteboardBucketConfigRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Task type to be queried.
recording: Real-time recording.
transcode: Document transcoding.
* @type {string || null}
*/
this.TaskType = null;
/**
* Name of the COS bucket.
* @type {string || null}
*/
this.BucketName = null;
/**
* Region of the COS bucket.
* @type {string || null}
*/
this.BucketLocation = null;
/**
* Resource prefix of the bucket.
* @type {string || null}
*/
this.BucketPrefix = null;
/**
* Domain name of the URL of the bucket.
* @type {string || null}
*/
this.ResultDomain = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskType = 'TaskType' in params ? params.TaskType : null;
this.BucketName = 'BucketName' in params ? params.BucketName : null;
this.BucketLocation = 'BucketLocation' in params ? params.BucketLocation : null;
this.BucketPrefix = 'BucketPrefix' in params ? params.BucketPrefix : null;
this.ResultDomain = 'ResultDomain' in params ? params.ResultDomain : null;
}
}
/**
* SetOnlineRecordCallbackKey response structure.
* @class
*/
class SetOnlineRecordCallbackKeyResponse 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;
}
}
/**
* DescribeRecordSearch response structure.
* @class
*/
class DescribeRecordSearchResponse extends AbstractModel {
constructor(){
super();
/**
* The set of queried recording tasks.
* @type {Array.<RecordTaskSearchResult> || null}
*/
this.RecordTaskSet = null;
/**
* Number of recording tasks.
* @type {number || null}
*/
this.TotalCount = 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.RecordTaskSet) {
this.RecordTaskSet = new Array();
for (let z in params.RecordTaskSet) {
let obj = new RecordTaskSearchResult();
obj.deserialize(params.RecordTaskSet[z]);
this.RecordTaskSet.push(obj);
}
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeAPIService request structure.
* @class
*/
class DescribeAPIServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Supported services are cos:GetService and cdn:DescribeDomainsConfig.
* @type {string || null}
*/
this.Service = null;
/**
* Request parameters in JSON format.
* @type {string || null}
*/
this.Data = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Service = 'Service' in params ? params.Service : null;
this.Data = 'Data' in params ? params.Data : null;
}
}
/**
* DescribeQualityMetrics request structure.
* @class
*/
class DescribeQualityMetricsRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Start time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
* @type {number || null}
*/
this.StartTime = null;
/**
* End time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
* @type {number || null}
*/
this.EndTime = null;
/**
* Metrics to be queried. Valid values:
- image_load_total_count: The number of image loads.
- image_load_fail_count: The number of image load failures.
- image_load_success_rate: The success rate of image loading, in percentage.
- ppt_load_total_count: The number of PowerPoint file loads.
- ppt_load_fail_count: The number of PowerPoint file load failures.
- ppt_load_success_rate: The success rate of PowerPoint file loading, in percentage.
- verify_sdk_total_count: The number of SDK verifications.
- verify_sdk_fail_count: The number of SDK verification failures.
- verify_sdk_success_rate: The success rate of SDK verification, in percentage.
- verify_sdk_in_one_second_rate: The rate of SDK verification completed within one second, in percentage.
- verify_sdk_cost_avg: The average time taken by each SDK verification, in milliseconds.
* @type {string || null}
*/
this.Metric = null;
/**
* Aggregation interval. Valid value: `1h`.
* @type {string || null}
*/
this.Interval = 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.Metric = 'Metric' in params ? params.Metric : null;
this.Interval = 'Interval' in params ? params.Interval : null;
}
}
/**
* CreateVideoGenerationTask request structure.
* @class
*/
class CreateVideoGenerationTaskRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the recording task.
* @type {string || null}
*/
this.OnlineRecordTaskId = null;
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Whiteboard parameters of the recording video generation task, such as the width and height of the whiteboard.
This parameter conflicts with the Whiteboard parameter in the API for starting a recording task. If the two Whiteboard parameters are both specified, the Whiteboard parameter in this API takes priority for recording video generation. If the Whiteboard parameter in this API is not specified, the Whiteboard parameter specified in the API for starting a recording task is used for recording video generation.
* @type {Whiteboard || null}
*/
this.Whiteboard = null;
/**
* Video splicing parameters.
This parameter conflicts with the Concat parameter in the API for starting a recording task. If the two Concat parameters are both specified, the Concat parameter in this API takes priority for video splicing. If the Concat parameter in this API is not specified, the Concat parameter specified in the API for starting a recording task is used for video splicing.
* @type {Concat || null}
*/
this.Concat = null;
/**
* Video stream mixing parameters.
This parameter conflicts with the MixStream parameter in the API for starting a recording task. If the two MixStream parameters are both specified, the MixStream parameter in this API takes priority for video stream mixing. If the MixStream parameter in this API is not specified, the MixStream parameter specified in the API for starting a recording task is used for video stream mixing.
* @type {MixStream || null}
*/
this.MixStream = null;
/**
* A group of video generation parameters. It specifies the streams to be generated, whether to disable audio recording for a stream, and whether to record only low-resolution videos, etc.
This parameter conflicts with the RecordControl parameter in the API for starting a recording task. If the two RecordControl parameters are both specified, the RecordControl parameter in this API takes priority for video generation control. If the RecordControl parameter in this API is not specified, the RecordControl parameter specified in the API for starting a recording task is used for video generation control.
* @type {RecordControl || null}
*/
this.RecordControl = null;
/**
* Internal parameter.
* @type {string || null}
*/
this.ExtraData = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.OnlineRecordTaskId = 'OnlineRecordTaskId' in params ? params.OnlineRecordTaskId : null;
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
if (params.Whiteboard) {
let obj = new Whiteboard();
obj.deserialize(params.Whiteboard)
this.Whiteboard = obj;
}
if (params.Concat) {
let obj = new Concat();
obj.deserialize(params.Concat)
this.Concat = obj;
}
if (params.MixStream) {
let obj = new MixStream();
obj.deserialize(params.MixStream)
this.MixStream = obj;
}
if (params.RecordControl) {
let obj = new RecordControl();
obj.deserialize(params.RecordControl)
this.RecordControl = obj;
}
this.ExtraData = 'ExtraData' in params ? params.ExtraData : null;
}
}
/**
* DescribeTranscodeCallback request structure.
* @class
*/
class DescribeTranscodeCallbackRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the application
* @type {number || null}
*/
this.SdkAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
}
}
/**
* DescribeTranscodeSearch response structure.
* @class
*/
class DescribeTranscodeSearchResponse extends AbstractModel {
constructor(){
super();
/**
* The set of queried transcoding tasks.
* @type {Array.<TranscodeTaskSearchResult> || null}
*/
this.TranscodeTaskSet = null;
/**
* Number of transcoding tasks.
* @type {number || null}
*/
this.TotalCount = 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.TranscodeTaskSet) {
this.TranscodeTaskSet = new Array();
for (let z in params.TranscodeTaskSet) {
let obj = new TranscodeTaskSearchResult();
obj.deserialize(params.TranscodeTaskSet[z]);
this.TranscodeTaskSet.push(obj);
}
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ResumeOnlineRecord request structure.
* @class
*/
class ResumeOnlineRecordRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the customer
* @type {number || null}
*/
this.SdkAppId = null;
/**
* ID of the resumed real-time recording task
* @type {string || null}
*/
this.TaskId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskId = 'TaskId' in params ? params.TaskId : null;
}
}
/**
* SetWhiteboardPushCallbackKey response structure.
* @class
*/
class SetWhiteboardPushCallbackKeyResponse 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;
}
}
/**
* DescribeRoomList request structure.
* @class
*/
class DescribeRoomListRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
* @type {Array.<number> || null}
*/
this.TimeRange = null;
/**
* Extra query conditions.
* @type {string || null}
*/
this.Query = null;
/**
* Maximum number of data entries to be returned. Default value: 1000.
* @type {number || null}
*/
this.MaxSize = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TimeRange = 'TimeRange' in params ? params.TimeRange : null;
this.Query = 'Query' in params ? params.Query : null;
this.MaxSize = 'MaxSize' in params ? params.MaxSize : null;
}
}
/**
* SetWhiteboardPushCallback response structure.
* @class
*/
class SetWhiteboardPushCallbackResponse 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;
}
}
/**
* ApplyTiwTrial response structure.
* @class
*/
class ApplyTiwTrialResponse 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;
}
}
/**
* Duration to be ignored in the spliced video
* @class
*/
class OmittedDuration extends AbstractModel {
constructor(){
super();
/**
* Offset of the paused time in the spliced video, in milliseconds
* @type {number || null}
*/
this.VideoTime = null;
/**
* Recording pause timestamp, in milliseconds
* @type {number || null}
*/
this.PauseTime = null;
/**
* Recording resumption timestamp, in milliseconds
* @type {number || null}
*/
this.ResumeTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.VideoTime = 'VideoTime' in params ? params.VideoTime : null;
this.PauseTime = 'PauseTime' in params ? params.PauseTime : null;
this.ResumeTime = 'ResumeTime' in params ? params.ResumeTime : null;
}
}
/**
* PauseOnlineRecord request structure.
* @class
*/
class PauseOnlineRecordRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the customer
* @type {number || null}
*/
this.SdkAppId = null;
/**
* ID of the real-time recording task
* @type {string || null}
*/
this.TaskId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskId = 'TaskId' in params ? params.TaskId : null;
}
}
/**
* DescribeApplicationInfos response structure.
* @class
*/
class DescribeApplicationInfosResponse extends AbstractModel {
constructor(){
super();
/**
* Application list.
* @type {Array.<ApplicationItem> || null}
*/
this.ApplicationInfos = null;
/**
* Specifies whether all applications are included. The value 0 indicates no and 1 indicates yes.
* @type {number || null}
*/
this.AllOption = 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.ApplicationInfos) {
this.ApplicationInfos = new Array();
for (let z in params.ApplicationInfos) {
let obj = new ApplicationItem();
obj.deserialize(params.ApplicationInfos[z]);
this.ApplicationInfos.push(obj);
}
}
this.AllOption = 'AllOption' in params ? params.AllOption : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApplicationUsage response structure.
* @class
*/
class DescribeApplicationUsageResponse extends AbstractModel {
constructor(){
super();
/**
* Usage data required for drawing charts.
* @type {Array.<DataItem> || 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 DataItem();
obj.deserialize(params.Data[z]);
this.Data.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeAPIService response structure.
* @class
*/
class DescribeAPIServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Response data in JSON format.
* @type {string || null}
*/
this.ResponseData = 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.ResponseData = 'ResponseData' in params ? params.ResponseData : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Time series returned for the queried metric.
* @class
*/
class TimeValue extends AbstractModel {
constructor(){
super();
/**
* Unix timestamp in seconds.
* @type {number || null}
*/
this.Time = null;
/**
* Current value of the queried metric.
* @type {number || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Time = 'Time' in params ? params.Time : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* Real-time recording result.
* @class
*/
class RecordTaskResult extends AbstractModel {
constructor(){
super();
/**
* `AUTO`: Recording automatically stops. `USER_CALL`: The API for stopping recording is called.
* @type {string || null}
*/
this.FinishReason = null;
/**
* Number of exceptions.
* @type {number || null}
*/
this.ExceptionCnt = null;
/**
* Room ID.
* @type {number || null}
*/
this.RoomId = null;
/**
* Group ID.
* @type {string || null}
*/
this.GroupId = null;
/**
* Actual recording start time.
* @type {number || null}
*/
this.RecordStartTime = null;
/**
* Recording end time.
* @type {number || null}
*/
this.RecordStopTime = null;
/**
* Recording duration.
* @type {number || null}
*/
this.TotalTime = null;
/**
* List of video information.
* @type {Array.<VideoInfo> || null}
*/
this.VideoInfos = null;
/**
* Omitted video durations.
* @type {Array.<OmittedDuration> || null}
*/
this.OmittedDurations = null;
/**
* Details.
* @type {string || null}
*/
this.Details = null;
/**
* Task execution error code.
* @type {number || null}
*/
this.ErrorCode = null;
/**
* Error message.
* @type {string || null}
*/
this.ErrorMsg = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FinishReason = 'FinishReason' in params ? params.FinishReason : null;
this.ExceptionCnt = 'ExceptionCnt' in params ? params.ExceptionCnt : null;
this.RoomId = 'RoomId' in params ? params.RoomId : null;
this.GroupId = 'GroupId' in params ? params.GroupId : null;
this.RecordStartTime = 'RecordStartTime' in params ? params.RecordStartTime : null;
this.RecordStopTime = 'RecordStopTime' in params ? params.RecordStopTime : null;
this.TotalTime = 'TotalTime' in params ? params.TotalTime : null;
if (params.VideoInfos) {
this.VideoInfos = new Array();
for (let z in params.VideoInfos) {
let obj = new VideoInfo();
obj.deserialize(params.VideoInfos[z]);
this.VideoInfos.push(obj);
}
}
if (params.OmittedDurations) {
this.OmittedDurations = new Array();
for (let z in params.OmittedDurations) {
let obj = new OmittedDuration();
obj.deserialize(params.OmittedDurations[z]);
this.OmittedDurations.push(obj);
}
}
this.Details = 'Details' in params ? params.Details : null;
this.ErrorCode = 'ErrorCode' in params ? params.ErrorCode : null;
this.ErrorMsg = 'ErrorMsg' in params ? params.ErrorMsg : null;
}
}
/**
* DescribeWhiteboardBucketConfig request structure.
* @class
*/
class DescribeWhiteboardBucketConfigRequest extends AbstractModel {
constructor(){
super();
/**
* SdkAppId of the whiteboard application.
* @type {number || null}
*/
this.SdkAppId = null;
/**
* Task type to be queried.
recording: Real-time recording.
transcode: Document transcoding.
* @type {string || null}
*/
this.TaskType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
this.TaskType = 'TaskType' in params ? params.TaskType : null;
}
}
/**
* DescribeUsageSummary response structure.
* @class
*/
class DescribeUsageSummaryResponse 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;
}
}
/**
* DescribeApplicationInfos request structure.
* @class
*/
class DescribeApplicationInfosRe