tencentcloud-sdk-nodejs-intl-en 3.0.1218 → 3.0.1219

package/tencentcloud/trtc/v20190722/models.js

@@ -1678,6 +1678,55 @@ Example: user_custom
     }
 }
 
+/**
+ * DescribeWebRecord response structure.
+ * @class
+ */
+class DescribeWebRecordResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 1: Recording
+         * @type {number || null}
+         */
+        this.Status = null;
+
+        /**
+         * Returns when querying using RecordId
+         * @type {string || null}
+         */
+        this.TaskId = null;
+
+        /**
+         * Returned when querying using TaskId
+         * @type {string || null}
+         */
+        this.RecordId = 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.Status = 'Status' in params ? params.Status : null;
+        this.TaskId = 'TaskId' in params ? params.TaskId : null;
+        this.RecordId = 'RecordId' in params ? params.RecordId : null;
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
 /**
  * DescribeUserInfo request structure.
  * @class
@@ -1980,6 +2029,48 @@ class CreateCloudRecordingResponse extends  AbstractModel {
     }
 }
 
+/**
+ * DescribeWebRecord request structure.
+ * @class
+ */
+class DescribeWebRecordRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The task ID returned when starting web-page recording
+         * @type {string || null}
+         */
+        this.TaskId = null;
+
+        /**
+         * SdkAppId passed when initiating web-page recording
+         * @type {number || null}
+         */
+        this.SdkAppId = null;
+
+        /**
+         * RecordId passed when initiating recording. When passing this value, you need to pass SdkAppId
+         * @type {string || null}
+         */
+        this.RecordId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.TaskId = 'TaskId' in params ? params.TaskId : null;
+        this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
+        this.RecordId = 'RecordId' in params ? params.RecordId : null;
+
+    }
+}
+
 /**
  * DescribeTRTCRealTimeScaleData response structure.
  * @class
@@ -2166,6 +2257,41 @@ class CloudVod extends  AbstractModel {
     }
 }
 
+/**
+ * 
+ * @class
+ */
+class EmulateMobileParams extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 
+         * @type {number || null}
+         */
+        this.MobileDeviceType = null;
+
+        /**
+         * 
+         * @type {number || null}
+         */
+        this.ScreenOrientation = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.MobileDeviceType = 'MobileDeviceType' in params ? params.MobileDeviceType : null;
+        this.ScreenOrientation = 'ScreenOrientation' in params ? params.ScreenOrientation : null;
+
+    }
+}
+
 /**
  * DescribeCallDetailInfo response structure.
  * @class
@@ -3218,6 +3344,55 @@ class UpdateStreamIngestResponse extends  AbstractModel {
     }
 }
 
+/**
+ * 
+ * @class
+ */
+class WebRecordVideoParams extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * 
+         * @type {number || null}
+         */
+        this.Width = null;
+
+        /**
+         * 
+         * @type {number || null}
+         */
+        this.Height = null;
+
+        /**
+         * 
+         * @type {string || null}
+         */
+        this.Format = null;
+
+        /**
+         * 
+         * @type {number || null}
+         */
+        this.MaxMediaFileDuration = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.Width = 'Width' in params ? params.Width : null;
+        this.Height = 'Height' in params ? params.Height : null;
+        this.Format = 'Format' in params ? params.Format : null;
+        this.MaxMediaFileDuration = 'MaxMediaFileDuration' in params ? params.MaxMediaFileDuration : null;
+
+    }
+}
+
 /**
  * The information of the watermark image.
  * @class
@@ -4531,6 +4706,41 @@ class DescribeTRTCRealTimeQualityDataRequest extends  AbstractModel {
     }
 }
 
+/**
+ * StartWebRecord response structure.
+ * @class
+ */
+class StartWebRecordResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The unique ID of the recording 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;
+
+    }
+}
+
 /**
  * CreateCloudRecording request structure.
  * @class
@@ -5251,6 +5461,62 @@ class DeleteCloudRecordingRequest extends  AbstractModel {
     }
 }
 
+/**
+ * The video transcoding parameters for recording.
+ * @class
+ */
+class VideoParams extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The video width in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `360`.
+         * @type {number || null}
+         */
+        this.Width = null;
+
+        /**
+         * The video height in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `640`.
+         * @type {number || null}
+         */
+        this.Height = null;
+
+        /**
+         * The video frame rate. Value range: [1, 60]. Default: 15.
+         * @type {number || null}
+         */
+        this.Fps = null;
+
+        /**
+         * The video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
+         * @type {number || null}
+         */
+        this.BitRate = null;
+
+        /**
+         * The keyframe interval (seconds). Default value: 10.
+         * @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;
+
+    }
+}
+
 /**
  * SetUserBlockedByStrRoomId request structure.
  * @class
@@ -5766,10 +6032,10 @@ class StartAITranscriptionRequest extends  AbstractModel {
 }
 
 /**
- * StopStreamIngest response structure.
+ * DismissRoom response structure.
  * @class
  */
-class StopStreamIngestResponse extends  AbstractModel {
+class DismissRoomResponse extends  AbstractModel {
     constructor(){
         super();
 
@@ -5794,22 +6060,50 @@ class StopStreamIngestResponse extends  AbstractModel {
 }
 
 /**
- * The user information.
+ * StopStreamIngest response structure.
  * @class
  */
-class MixUserInfo extends  AbstractModel {
+class StopStreamIngestResponse extends  AbstractModel {
     constructor(){
         super();
 
         /**
-         * User ID.
+         * 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.UserId = null;
+        this.RequestId = null;
 
-        /**
-         * If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.
-         * @type {string || null}
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
+/**
+ * The user information.
+ * @class
+ */
+class MixUserInfo extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * User ID.
+         * @type {string || null}
+         */
+        this.UserId = null;
+
+        /**
+         * If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.
+         * @type {string || null}
          */
         this.RoomId = null;
 
@@ -5836,18 +6130,46 @@ class MixUserInfo extends  AbstractModel {
 }
 
 /**
- * DismissRoom response structure.
+ * The event information, including the timestamp and event ID.
  * @class
  */
-class DismissRoomResponse extends  AbstractModel {
+class EventMessage 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}
+         * The video stream type. Valid values:
+`0`: A non-video event
+`2`: The big video
+`3`: The small video
+`7`: A relayed video
+         * @type {number || null}
          */
-        this.RequestId = null;
+        this.Type = null;
+
+        /**
+         * The event reporting time in the format of UNIX timestamp (milliseconds), such as `1589891188801`.
+         * @type {number || null}
+         */
+        this.Time = null;
+
+        /**
+         * The event ID. Events are classified into SDK events and WebRTC events. For more information, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
+         * @type {number || null}
+         */
+        this.EventId = null;
+
+        /**
+         * The first event parameter, such as the video width.
+         * @type {number || null}
+         */
+        this.ParamOne = null;
+
+        /**
+         * The second event parameter, such as the video height.
+         * @type {number || null}
+         */
+        this.ParamTwo = null;
 
     }
 
@@ -5858,7 +6180,11 @@ class DismissRoomResponse extends  AbstractModel {
         if (!params) {
             return;
         }
-        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+        this.Type = 'Type' in params ? params.Type : null;
+        this.Time = 'Time' in params ? params.Time : null;
+        this.EventId = 'EventId' in params ? params.EventId : null;
+        this.ParamOne = 'ParamOne' in params ? params.ParamOne : null;
+        this.ParamTwo = 'ParamTwo' in params ? params.ParamTwo : null;
 
     }
 }
@@ -6041,6 +6367,113 @@ class UpdatePublishCdnStreamRequest extends  AbstractModel {
     }
 }
 
+/**
+ * StartWebRecord request structure.
+ * @class
+ */
+class StartWebRecordRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * URL of the web page to be recorded
+         * @type {string || null}
+         */
+        this.RecordUrl = null;
+
+        /**
+         * Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).
+         * @type {number || null}
+         */
+        this.MaxDurationLimit = null;
+
+        /**
+         * [Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.
+         * @type {StorageParams || null}
+         */
+        this.StorageParams = null;
+
+        /**
+         * web-page recording video parameters
+         * @type {WebRecordVideoParams || null}
+         */
+        this.WebRecordVideoParams = null;
+
+        /**
+         * [Required] The SDKAppID of the TRTC room 
+         * @type {number || null}
+         */
+        this.SdkAppId = null;
+
+        /**
+         * When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.
+         * @type {string || null}
+         */
+        this.RecordId = null;
+
+        /**
+         * If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.
+         * @type {Array.<McuPublishCdnParam> || null}
+         */
+        this.PublishCdnParams = null;
+
+        /**
+         * The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.
+         * @type {number || null}
+         */
+        this.ReadyTimeout = null;
+
+        /**
+         * Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.
+         * @type {EmulateMobileParams || null}
+         */
+        this.EmulateMobileParams = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.RecordUrl = 'RecordUrl' in params ? params.RecordUrl : null;
+        this.MaxDurationLimit = 'MaxDurationLimit' in params ? params.MaxDurationLimit : null;
+
+        if (params.StorageParams) {
+            let obj = new StorageParams();
+            obj.deserialize(params.StorageParams)
+            this.StorageParams = obj;
+        }
+
+        if (params.WebRecordVideoParams) {
+            let obj = new WebRecordVideoParams();
+            obj.deserialize(params.WebRecordVideoParams)
+            this.WebRecordVideoParams = obj;
+        }
+        this.SdkAppId = 'SdkAppId' in params ? params.SdkAppId : null;
+        this.RecordId = 'RecordId' in params ? params.RecordId : null;
+
+        if (params.PublishCdnParams) {
+            this.PublishCdnParams = new Array();
+            for (let z in params.PublishCdnParams) {
+                let obj = new McuPublishCdnParam();
+                obj.deserialize(params.PublishCdnParams[z]);
+                this.PublishCdnParams.push(obj);
+            }
+        }
+        this.ReadyTimeout = 'ReadyTimeout' in params ? params.ReadyTimeout : null;
+
+        if (params.EmulateMobileParams) {
+            let obj = new EmulateMobileParams();
+            obj.deserialize(params.EmulateMobileParams)
+            this.EmulateMobileParams = obj;
+        }
+
+    }
+}
+
 /**
  * The information of the large video in screen sharing or floating layout mode.
  * @class
@@ -6130,6 +6563,34 @@ class UpdateStreamIngestRequest extends  AbstractModel {
     }
 }
 
+/**
+ * StopWebRecord response structure.
+ * @class
+ */
+class StopWebRecordResponse 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;
+
+    }
+}
+
 /**
  * Speech-to-text parameters
  * @class
@@ -6196,42 +6657,18 @@ class STTConfig extends  AbstractModel {
 }
 
 /**
- * The video transcoding parameters for recording.
+ * StopWebRecord request structure.
  * @class
  */
-class VideoParams extends  AbstractModel {
+class StopWebRecordRequest extends  AbstractModel {
     constructor(){
         super();
 
         /**
-         * The video width in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `360`.
-         * @type {number || null}
-         */
-        this.Width = null;
-
-        /**
-         * The video height in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying `Width` and `Height` cannot exceed 1920 x 1080. The default value is `640`.
-         * @type {number || null}
-         */
-        this.Height = null;
-
-        /**
-         * The video frame rate. Value range: [1, 60]. Default: 15.
-         * @type {number || null}
-         */
-        this.Fps = null;
-
-        /**
-         * The video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
-         * @type {number || null}
-         */
-        this.BitRate = null;
-
-        /**
-         * The keyframe interval (seconds). Default value: 10.
-         * @type {number || null}
+         * The ID of the task that needs to be stopped
+         * @type {string || null}
          */
-        this.Gop = null;
+        this.TaskId = null;
 
     }
 
@@ -6242,11 +6679,7 @@ class VideoParams extends  AbstractModel {
         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;
+        this.TaskId = 'TaskId' in params ? params.TaskId : null;
 
     }
 }
@@ -6324,66 +6757,6 @@ class StopAIConversationRequest extends  AbstractModel {
     }
 }
 
-/**
- * The event information, including the timestamp and event ID.
- * @class
- */
-class EventMessage extends  AbstractModel {
-    constructor(){
-        super();
-
-        /**
-         * The video stream type. Valid values:
-`0`: A non-video event
-`2`: The big video
-`3`: The small video
-`7`: A relayed video
-         * @type {number || null}
-         */
-        this.Type = null;
-
-        /**
-         * The event reporting time in the format of UNIX timestamp (milliseconds), such as `1589891188801`.
-         * @type {number || null}
-         */
-        this.Time = null;
-
-        /**
-         * The event ID. Events are classified into SDK events and WebRTC events. For more information, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
-         * @type {number || null}
-         */
-        this.EventId = null;
-
-        /**
-         * The first event parameter, such as the video width.
-         * @type {number || null}
-         */
-        this.ParamOne = null;
-
-        /**
-         * The second event parameter, such as the video height.
-         * @type {number || null}
-         */
-        this.ParamTwo = null;
-
-    }
-
-    /**
-     * @private
-     */
-    deserialize(params) {
-        if (!params) {
-            return;
-        }
-        this.Type = 'Type' in params ? params.Type : null;
-        this.Time = 'Time' in params ? params.Time : null;
-        this.EventId = 'EventId' in params ? params.EventId : null;
-        this.ParamOne = 'ParamOne' in params ? params.ParamOne : null;
-        this.ParamTwo = 'ParamTwo' in params ? params.ParamTwo : null;
-
-    }
-}
-
 /**
  * UpdatePublishCdnStream response structure.
  * @class
@@ -7429,16 +7802,19 @@ module.exports = {
     DescribeCallDetailInfoRequest: DescribeCallDetailInfoRequest,
     DescribeTRTCMarketScaleDataResponse: DescribeTRTCMarketScaleDataResponse,
     McuTencentVod: McuTencentVod,
+    DescribeWebRecordResponse: DescribeWebRecordResponse,
     DescribeUserInfoRequest: DescribeUserInfoRequest,
     DescribeRelayUsageRequest: DescribeRelayUsageRequest,
     CloudStorage: CloudStorage,
     DescribeTrtcUsageResponse: DescribeTrtcUsageResponse,
     TimeValue: TimeValue,
     CreateCloudRecordingResponse: CreateCloudRecordingResponse,
+    DescribeWebRecordRequest: DescribeWebRecordRequest,
     DescribeTRTCRealTimeScaleDataResponse: DescribeTRTCRealTimeScaleDataResponse,
     DescribeRoomInfoRequest: DescribeRoomInfoRequest,
     StorageParams: StorageParams,
     CloudVod: CloudVod,
+    EmulateMobileParams: EmulateMobileParams,
     DescribeCallDetailInfoResponse: DescribeCallDetailInfoResponse,
     DescribeTRTCRealTimeQualityDataResponse: DescribeTRTCRealTimeQualityDataResponse,
     McuCustomCrop: McuCustomCrop,
@@ -7461,6 +7837,7 @@ module.exports = {
     DescribeUserInfoResponse: DescribeUserInfoResponse,
     RemoveUserByStrRoomIdResponse: RemoveUserByStrRoomIdResponse,
     UpdateStreamIngestResponse: UpdateStreamIngestResponse,
+    WebRecordVideoParams: WebRecordVideoParams,
     McuWaterMarkImage: McuWaterMarkImage,
     StartPublishCdnStreamResponse: StartPublishCdnStreamResponse,
     TrtcUsage: TrtcUsage,
@@ -7484,6 +7861,7 @@ module.exports = {
     SetUserBlockedByStrRoomIdResponse: SetUserBlockedByStrRoomIdResponse,
     TRTCDataResult: TRTCDataResult,
     DescribeTRTCRealTimeQualityDataRequest: DescribeTRTCRealTimeQualityDataRequest,
+    StartWebRecordResponse: StartWebRecordResponse,
     CreateCloudRecordingRequest: CreateCloudRecordingRequest,
     RecognizeConfig: RecognizeConfig,
     DeleteCloudRecordingResponse: DeleteCloudRecordingResponse,
@@ -7497,6 +7875,7 @@ module.exports = {
     DismissRoomByStrRoomIdRequest: DismissRoomByStrRoomIdRequest,
     StartStreamIngestResponse: StartStreamIngestResponse,
     DeleteCloudRecordingRequest: DeleteCloudRecordingRequest,
+    VideoParams: VideoParams,
     SetUserBlockedByStrRoomIdRequest: SetUserBlockedByStrRoomIdRequest,
     DescribeTrtcRoomUsageRequest: DescribeTrtcRoomUsageRequest,
     UserInformation: UserInformation,
@@ -7507,18 +7886,20 @@ module.exports = {
     ModifyCloudRecordingResponse: ModifyCloudRecordingResponse,
     DescribeCloudRecordingResponse: DescribeCloudRecordingResponse,
     StartAITranscriptionRequest: StartAITranscriptionRequest,
+    DismissRoomResponse: DismissRoomResponse,
     StopStreamIngestResponse: StopStreamIngestResponse,
     MixUserInfo: MixUserInfo,
-    DismissRoomResponse: DismissRoomResponse,
+    EventMessage: EventMessage,
     DescribeTRTCMarketQualityDataRequest: DescribeTRTCMarketQualityDataRequest,
     UpdatePublishCdnStreamRequest: UpdatePublishCdnStreamRequest,
+    StartWebRecordRequest: StartWebRecordRequest,
     MaxVideoUser: MaxVideoUser,
     UpdateStreamIngestRequest: UpdateStreamIngestRequest,
+    StopWebRecordResponse: StopWebRecordResponse,
     STTConfig: STTConfig,
-    VideoParams: VideoParams,
+    StopWebRecordRequest: StopWebRecordRequest,
     McuSeiParams: McuSeiParams,
     StopAIConversationRequest: StopAIConversationRequest,
-    EventMessage: EventMessage,
     UpdatePublishCdnStreamResponse: UpdatePublishCdnStreamResponse,
     McuWaterMarkText: McuWaterMarkText,
     TranscriptionParams: TranscriptionParams,