tencentcloud-sdk-nodejs-intl-en 3.0.1078 → 3.0.1079

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-intl-en",
3
- "version": "3.0.1078",
3
+ "version": "3.0.1079",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -8305,7 +8305,7 @@ class AssociateDDoSEipAddressRequest extends AbstractModel {
8305
8305
  this.InstanceId = null;
8306
8306
 
8307
8307
  /**
8308
- * EIP of the Anti-DDoS instance ID
8308
+ * EIP of the Anti-DDoS instance ID.
8309
8309
  * @type {string || null}
8310
8310
  */
8311
8311
  this.Eip = null;
@@ -2495,6 +2495,12 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2495
2495
  */
2496
2496
  this.Tags = null;
2497
2497
 
2498
+ /**
2499
+ * The Role Arn
2500
+ * @type {string || null}
2501
+ */
2502
+ this.RoleArn = null;
2503
+
2498
2504
  }
2499
2505
 
2500
2506
  /**
@@ -2523,6 +2529,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2523
2529
  this.Tags.push(obj);
2524
2530
  }
2525
2531
  }
2532
+ this.RoleArn = 'RoleArn' in params ? params.RoleArn : null;
2526
2533
 
2527
2534
  }
2528
2535
  }
@@ -6668,7 +6675,7 @@ class GetRoleResponse extends AbstractModel {
6668
6675
  this.RoleInfo = null;
6669
6676
 
6670
6677
  /**
6671
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
6678
+ * 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.
6672
6679
  * @type {string || null}
6673
6680
  */
6674
6681
  this.RequestId = null;
@@ -897,7 +897,6 @@ Modify events related with the IPs/domains in the blocked/allowed list
897
897
 
898
898
  /**
899
899
  * This API is used to get blocked IP data.
900
-
901
900
  * @param {DescribeBlockByIpTimesListRequest} req
902
901
  * @param {function(string, DescribeBlockByIpTimesListResponse):void} cb
903
902
  * @public
@@ -5153,12 +5153,6 @@ class DescribeBlockByIpTimesListRequest extends AbstractModel {
5153
5153
  constructor(){
5154
5154
  super();
5155
5155
 
5156
- /**
5157
- * Start time
5158
- * @type {string || null}
5159
- */
5160
- this.StartTime = null;
5161
-
5162
5156
  /**
5163
5157
  * End time
5164
5158
  * @type {string || null}
@@ -5172,10 +5166,10 @@ class DescribeBlockByIpTimesListRequest extends AbstractModel {
5172
5166
  this.Ip = null;
5173
5167
 
5174
5168
  /**
5175
- * Region
5169
+ * Start time
5176
5170
  * @type {string || null}
5177
5171
  */
5178
- this.Zone = null;
5172
+ this.StartTime = null;
5179
5173
 
5180
5174
  /**
5181
5175
  * Direction
@@ -5183,12 +5177,6 @@ class DescribeBlockByIpTimesListRequest extends AbstractModel {
5183
5177
  */
5184
5178
  this.Direction = null;
5185
5179
 
5186
- /**
5187
- * Source
5188
- * @type {string || null}
5189
- */
5190
- this.Source = null;
5191
-
5192
5180
  /**
5193
5181
  * Inter-VPC firewall toggle edge ID
5194
5182
  * @type {string || null}
@@ -5201,6 +5189,18 @@ class DescribeBlockByIpTimesListRequest extends AbstractModel {
5201
5189
  */
5202
5190
  this.LogSource = null;
5203
5191
 
5192
+ /**
5193
+ * Source
5194
+ * @type {string || null}
5195
+ */
5196
+ this.Source = null;
5197
+
5198
+ /**
5199
+ * Region
5200
+ * @type {string || null}
5201
+ */
5202
+ this.Zone = null;
5203
+
5204
5204
  }
5205
5205
 
5206
5206
  /**
@@ -5210,14 +5210,14 @@ class DescribeBlockByIpTimesListRequest extends AbstractModel {
5210
5210
  if (!params) {
5211
5211
  return;
5212
5212
  }
5213
- this.StartTime = 'StartTime' in params ? params.StartTime : null;
5214
5213
  this.EndTime = 'EndTime' in params ? params.EndTime : null;
5215
5214
  this.Ip = 'Ip' in params ? params.Ip : null;
5216
- this.Zone = 'Zone' in params ? params.Zone : null;
5215
+ this.StartTime = 'StartTime' in params ? params.StartTime : null;
5217
5216
  this.Direction = 'Direction' in params ? params.Direction : null;
5218
- this.Source = 'Source' in params ? params.Source : null;
5219
5217
  this.EdgeId = 'EdgeId' in params ? params.EdgeId : null;
5220
5218
  this.LogSource = 'LogSource' in params ? params.LogSource : null;
5219
+ this.Source = 'Source' in params ? params.Source : null;
5220
+ this.Zone = 'Zone' in params ? params.Zone : null;
5221
5221
 
5222
5222
  }
5223
5223
  }
@@ -5822,13 +5822,13 @@ class DescribeBlockByIpTimesListResponse extends AbstractModel {
5822
5822
  super();
5823
5823
 
5824
5824
  /**
5825
- * Response data
5825
+ * Response data
5826
5826
  * @type {Array.<IpStatic> || null}
5827
5827
  */
5828
5828
  this.Data = null;
5829
5829
 
5830
5830
  /**
5831
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
5831
+ * 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.
5832
5832
  * @type {string || null}
5833
5833
  */
5834
5834
  this.RequestId = null;
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.1078";
1
+ const sdkVersion = "3.0.1079";
2
2
  module.exports = sdkVersion
@@ -5193,7 +5193,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
5193
5193
  this.TotalCount = null;
5194
5194
 
5195
5195
  /**
5196
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
5196
+ * 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.
5197
5197
  * @type {string || null}
5198
5198
  */
5199
5199
  this.RequestId = null;
@@ -26,6 +26,7 @@ const DetectLiveFaceResponse = models.DetectLiveFaceResponse;
26
26
  const SearchPersonsReturnsByGroupResponse = models.SearchPersonsReturnsByGroupResponse;
27
27
  const DeleteFaceRequest = models.DeleteFaceRequest;
28
28
  const HeadPose = models.HeadPose;
29
+ const DetectFaceSimilarityResponse = models.DetectFaceSimilarityResponse;
29
30
  const ModifyPersonGroupInfoRequest = models.ModifyPersonGroupInfoRequest;
30
31
  const GetGroupListResponse = models.GetGroupListResponse;
31
32
  const GroupInfo = models.GroupInfo;
@@ -40,7 +41,7 @@ const GetGroupListRequest = models.GetGroupListRequest;
40
41
  const DeleteGroupRequest = models.DeleteGroupRequest;
41
42
  const CreateFaceResponse = models.CreateFaceResponse;
42
43
  const DetectFaceAttributesResponse = models.DetectFaceAttributesResponse;
43
- const GroupCandidate = models.GroupCandidate;
44
+ const DetectFaceSimilarityRequest = models.DetectFaceSimilarityRequest;
44
45
  const SearchPersonsResponse = models.SearchPersonsResponse;
45
46
  const DetectLiveFaceAccurateRequest = models.DetectLiveFaceAccurateRequest;
46
47
  const CompareFaceResponse = models.CompareFaceResponse;
@@ -68,6 +69,7 @@ const FaceShape = models.FaceShape;
68
69
  const DetectFaceResponse = models.DetectFaceResponse;
69
70
  const CopyPersonRequest = models.CopyPersonRequest;
70
71
  const GetPersonListNumRequest = models.GetPersonListNumRequest;
72
+ const GroupCandidate = models.GroupCandidate;
71
73
  const SearchPersonsReturnsByGroupRequest = models.SearchPersonsReturnsByGroupRequest;
72
74
  const DeletePersonFromGroupResponse = models.DeletePersonFromGroupResponse;
73
75
  const VerifyPersonResponse = models.VerifyPersonResponse;
@@ -351,6 +353,18 @@ This API recognizes each face image of a person as an independent one. By contra
351
353
  this.request("CreatePerson", req, resp, cb);
352
354
  }
353
355
 
356
+ /**
357
+ * Compare the faces in the two pictures for similarity and return the face similarity score. If you need to determine "whether this person is someone", that is, to verify whether the person in a picture is someone with a known identity, such as a common face login scenario, it is recommended to use [VerifyFace] (https://www.tencentcloud.com/document/product/1059/36972) or [VerifyPerson] (https://www.tencentcloud.com/document/product/1059/36971) inferface.
358
+ Please use the V3 version for the signature method in the public parameters, that is, configure the SignatureMethod parameter to TC3-HMAC-SHA256
359
+ * @param {DetectFaceSimilarityRequest} req
360
+ * @param {function(string, DetectFaceSimilarityResponse):void} cb
361
+ * @public
362
+ */
363
+ DetectFaceSimilarity(req, cb) {
364
+ let resp = new DetectFaceSimilarityResponse();
365
+ this.request("DetectFaceSimilarity", req, resp, cb);
366
+ }
367
+
354
368
  /**
355
369
  * This API is used to get the group information.
356
370
  * @param {GetGroupInfoRequest} req
@@ -539,6 +539,41 @@ class HeadPose extends AbstractModel {
539
539
  }
540
540
  }
541
541
 
542
+ /**
543
+ * DetectFaceSimilarity response structure.
544
+ * @class
545
+ */
546
+ class DetectFaceSimilarityResponse extends AbstractModel {
547
+ constructor(){
548
+ super();
549
+
550
+ /**
551
+ * The value range is [0.00, 100.00]. It is recommended that when the similarity is greater than or equal to 70, the person can be judged to be the same person, and the threshold can be adjusted according to the specific scenario (the false pass rate for a threshold of 70 is one in 1,000, and the false pass rate for a threshold of 80 is one in 10,000).
552
+ * @type {number || null}
553
+ */
554
+ this.Score = null;
555
+
556
+ /**
557
+ * 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.
558
+ * @type {string || null}
559
+ */
560
+ this.RequestId = null;
561
+
562
+ }
563
+
564
+ /**
565
+ * @private
566
+ */
567
+ deserialize(params) {
568
+ if (!params) {
569
+ return;
570
+ }
571
+ this.Score = 'Score' in params ? params.Score : null;
572
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
573
+
574
+ }
575
+ }
576
+
542
577
  /**
543
578
  * ModifyPersonGroupInfo request structure.
544
579
  * @class
@@ -1483,24 +1518,64 @@ class DetectFaceAttributesResponse extends AbstractModel {
1483
1518
  }
1484
1519
 
1485
1520
  /**
1486
- * Recognition result items by group
1521
+ * DetectFaceSimilarity request structure.
1487
1522
  * @class
1488
1523
  */
1489
- class GroupCandidate extends AbstractModel {
1524
+ class DetectFaceSimilarityRequest extends AbstractModel {
1490
1525
  constructor(){
1491
1526
  super();
1492
1527
 
1493
1528
  /**
1494
- * Group ID.
1529
+ * A image base64 data.
1530
+ - The size after base64 encoding cannot exceed 5M.
1531
+ - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels.
1532
+ - If the picture contains multiple faces, only the face with the highest confidence is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images.
1495
1533
  * @type {string || null}
1496
1534
  */
1497
- this.GroupId = null;
1535
+ this.ImageA = null;
1498
1536
 
1499
1537
  /**
1500
- * Most matching candidate recognized
1501
- * @type {Array.<Candidate> || null}
1538
+ * B image base64 data.
1539
+ - The size after base64 encoding cannot exceed 5M.
1540
+ - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels.
1541
+ - If the picture contains multiple faces, only the face with the highest confidence is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images.
1542
+ * @type {string || null}
1502
1543
  */
1503
- this.Candidates = null;
1544
+ this.ImageB = null;
1545
+
1546
+ /**
1547
+ * A URL for the image.
1548
+ - The size of the corresponding image after base64 encoding cannot exceed 5M.
1549
+ - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels.
1550
+ - A The URL and Image of the picture must be provided. If both are provided, only the Url will be used.
1551
+ - Images stored in Tencent Cloud's Url can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud.
1552
+ - The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
1553
+ - If the picture contains multiple faces, only the face with the largest face area is selected.
1554
+ - Supports PNG, JPG, JPEG, BMP, but does not support GIF images.
1555
+ * @type {string || null}
1556
+ */
1557
+ this.UrlA = null;
1558
+
1559
+ /**
1560
+ * B The URL of the image.
1561
+ - The size of the corresponding image after base64 encoding cannot exceed 5M.
1562
+ - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels.
1563
+ - B The URL and Image of the picture must be provided. If both are provided, only the Url will be used.
1564
+ - Images stored in Tencent Cloud's Url can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud.
1565
+ - The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
1566
+ - If the picture contains multiple faces, only the face with the largest face area is selected.
1567
+ - Supports PNG, JPG, JPEG, BMP, but does not support GIF images.
1568
+ * @type {string || null}
1569
+ */
1570
+ this.UrlB = null;
1571
+
1572
+ /**
1573
+ * Image quality control.
1574
+ - Value range: 0: No control; 1: Lower quality requirements, the image is very blurry, and the eyes, nose, and mouth cover at least one or more of them; 2: General quality requirements, the image is bright, Dark, blurry or generally blurred, eyebrows covered, cheeks covered, chin covered, at least three of them; 3: High quality requirements, the image may be brighter, darker, generally blurry, eyebrows blocked, cheeks blocked, chin blocked, one or two of them; 4: Very high quality requirements, all dimensions are the best or the most , there is a slight problem in one dimension; default is 0.
1575
+ - If the image quality does not meet the requirements, the returned result will prompt that the image quality test does not meet the requirements.
1576
+ * @type {number || null}
1577
+ */
1578
+ this.QualityControl = null;
1504
1579
 
1505
1580
  }
1506
1581
 
@@ -1511,16 +1586,11 @@ class GroupCandidate extends AbstractModel {
1511
1586
  if (!params) {
1512
1587
  return;
1513
1588
  }
1514
- this.GroupId = 'GroupId' in params ? params.GroupId : null;
1515
-
1516
- if (params.Candidates) {
1517
- this.Candidates = new Array();
1518
- for (let z in params.Candidates) {
1519
- let obj = new Candidate();
1520
- obj.deserialize(params.Candidates[z]);
1521
- this.Candidates.push(obj);
1522
- }
1523
- }
1589
+ this.ImageA = 'ImageA' in params ? params.ImageA : null;
1590
+ this.ImageB = 'ImageB' in params ? params.ImageB : null;
1591
+ this.UrlA = 'UrlA' in params ? params.UrlA : null;
1592
+ this.UrlB = 'UrlB' in params ? params.UrlB : null;
1593
+ this.QualityControl = 'QualityControl' in params ? params.QualityControl : null;
1524
1594
 
1525
1595
  }
1526
1596
  }
@@ -3212,6 +3282,49 @@ class GetPersonListNumRequest extends AbstractModel {
3212
3282
  }
3213
3283
  }
3214
3284
 
3285
+ /**
3286
+ * Recognition result items by group
3287
+ * @class
3288
+ */
3289
+ class GroupCandidate extends AbstractModel {
3290
+ constructor(){
3291
+ super();
3292
+
3293
+ /**
3294
+ * Group ID.
3295
+ * @type {string || null}
3296
+ */
3297
+ this.GroupId = null;
3298
+
3299
+ /**
3300
+ * Most matching candidate recognized
3301
+ * @type {Array.<Candidate> || null}
3302
+ */
3303
+ this.Candidates = null;
3304
+
3305
+ }
3306
+
3307
+ /**
3308
+ * @private
3309
+ */
3310
+ deserialize(params) {
3311
+ if (!params) {
3312
+ return;
3313
+ }
3314
+ this.GroupId = 'GroupId' in params ? params.GroupId : null;
3315
+
3316
+ if (params.Candidates) {
3317
+ this.Candidates = new Array();
3318
+ for (let z in params.Candidates) {
3319
+ let obj = new Candidate();
3320
+ obj.deserialize(params.Candidates[z]);
3321
+ this.Candidates.push(obj);
3322
+ }
3323
+ }
3324
+
3325
+ }
3326
+ }
3327
+
3215
3328
  /**
3216
3329
  * SearchPersonsReturnsByGroup request structure.
3217
3330
  * @class
@@ -4948,6 +5061,7 @@ module.exports = {
4948
5061
  SearchPersonsReturnsByGroupResponse: SearchPersonsReturnsByGroupResponse,
4949
5062
  DeleteFaceRequest: DeleteFaceRequest,
4950
5063
  HeadPose: HeadPose,
5064
+ DetectFaceSimilarityResponse: DetectFaceSimilarityResponse,
4951
5065
  ModifyPersonGroupInfoRequest: ModifyPersonGroupInfoRequest,
4952
5066
  GetGroupListResponse: GetGroupListResponse,
4953
5067
  GroupInfo: GroupInfo,
@@ -4962,7 +5076,7 @@ module.exports = {
4962
5076
  DeleteGroupRequest: DeleteGroupRequest,
4963
5077
  CreateFaceResponse: CreateFaceResponse,
4964
5078
  DetectFaceAttributesResponse: DetectFaceAttributesResponse,
4965
- GroupCandidate: GroupCandidate,
5079
+ DetectFaceSimilarityRequest: DetectFaceSimilarityRequest,
4966
5080
  SearchPersonsResponse: SearchPersonsResponse,
4967
5081
  DetectLiveFaceAccurateRequest: DetectLiveFaceAccurateRequest,
4968
5082
  CompareFaceResponse: CompareFaceResponse,
@@ -4990,6 +5104,7 @@ module.exports = {
4990
5104
  DetectFaceResponse: DetectFaceResponse,
4991
5105
  CopyPersonRequest: CopyPersonRequest,
4992
5106
  GetPersonListNumRequest: GetPersonListNumRequest,
5107
+ GroupCandidate: GroupCandidate,
4993
5108
  SearchPersonsReturnsByGroupRequest: SearchPersonsReturnsByGroupRequest,
4994
5109
  DeletePersonFromGroupResponse: DeletePersonFromGroupResponse,
4995
5110
  VerifyPersonResponse: VerifyPersonResponse,
@@ -4482,15 +4482,18 @@ Default value: 0.
4482
4482
  this.Comment = null;
4483
4483
 
4484
4484
  /**
4485
- * Whether it is an audio-only template. 0: video template. 1: audio-only template.When the value is 1:
4485
+ * Indicates whether it is audio-only. 0 means video template, 1 means audio-only template.
4486
+ When the value is 1.
4486
4487
  1. StreamInfos.N.RemoveVideo=1
4487
4488
  2. StreamInfos.N.RemoveAudio=0
4488
4489
  3. StreamInfos.N.Video.Codec=copy
4489
-
4490
- When the value is 0:
4491
-
4490
+ When the value is 0.
4492
4491
  1. StreamInfos.N.Video.Codec cannot be copy.
4493
4492
  2. StreamInfos.N.Video.Fps cannot be null.
4493
+
4494
+ Note:
4495
+
4496
+ This value only distinguishes template types. The task uses the values of RemoveAudio and RemoveVideo.
4494
4497
  * @type {number || null}
4495
4498
  */
4496
4499
  this.PureAudio = null;
@@ -10068,35 +10071,31 @@ Note: This field may return null, indicating that no valid value can be obtained
10068
10071
  this.GopUnit = null;
10069
10072
 
10070
10073
  /**
10071
- * Filling mode. When the configured aspect ratio parameter for video streams differs from the aspect ratio of the original video, the processing method for transcoding is "filling". Optional filling modes:
10072
- <li>stretch: Each frame is stretched to fill the entire screen, which may cause the transcoded video to be "flattened" or "stretched".</li>
10073
- <li>black: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with black.</li>
10074
- <li>white: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with white.</li>
10075
- <li>gauss: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with a Gaussian blur.</li>
10074
+ * Padding method. When the video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the transcoding processing method is "padding". Optional filling method:
10075
+ <li> stretch: Stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";</li>
10076
+ <li>black: Fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.</li>
10077
+ <li>white: Fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.</li>
10078
+ <li>gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.</li>
10076
10079
 
10077
10080
  <li>smarttailor: Video images are smartly selected to ensure proportional image cropping.</li>
10078
10081
  Default value: black.
10079
- Note: Only stretch and black are supported for adaptive bitrate streaming.
10080
10082
  * @type {string || null}
10081
10083
  */
10082
10084
  this.FillType = null;
10083
10085
 
10084
10086
  /**
10085
- * Control factor for constant video bitrate. Value range: [0, 51].
10086
- If this parameter is specified, the bitrate control mode for the CRF will be used for transcoding (the video bitrate will no longer take effect).
10087
- It is recommended not to specify this parameter if there are no special requirements.
10088
-
10089
- Note:
10090
- If Mode is set to ABR, the Vcrf value does not need to be configured.
10091
- If Mode is set to CBR, the Vcrf value does not need to be configured.
10087
+ * Specifies the constant bitrate control factor for the video. Value range: [0, 51]. Leaving this parameter blank sets it to "Automatic". It is recommended not to specify this parameter unless necessary.
10088
+ If the Mode parameter is set to VBR and the Vcrf value is also configured, MPS will process the video in VBR mode, considering both Vcrf and Bitrate parameters to balance video quality, bitrate, transcoding efficiency, and file size.
10089
+ If the Mode parameter is set to CRF, the Bitrate setting will be invalid, and encoding will be based on the Vcrf value.
10090
+ If the Mode parameter is set to ABR or CBR, the Vcrf value does not need to be configured.
10092
10091
  Note: This field may return null, indicating that no valid value can be obtained.
10093
10092
  * @type {number || null}
10094
10093
  */
10095
10094
  this.Vcrf = null;
10096
10095
 
10097
10096
  /**
10098
- * Average segment duration. Value range: (0-10], unit: second
10099
- Default value: 10
10097
+ * Average segment duration. Value range: (0-10], unit: second.
10098
+ This parameter will be set to automatic if not specified. The segment duration will be automatically selected based on the GOP and other characteristics of the video.
10100
10099
  Note: It can be used only in the container format of hls.
10101
10100
  Note: This field may return null, indicating that no valid value can be obtained.
10102
10101
  * @type {number || null}
@@ -10105,13 +10104,14 @@ Note: This field may return null, indicating that no valid value can be obtained
10105
10104
 
10106
10105
  /**
10107
10106
  * HLS segment type. Valid values:
10108
- <li>0: HLS+TS segment.</li>
10109
- <li>2: HLS+TS byte range.</li>
10110
- <li>7: HLS+MP4 segment.</li>
10111
- <li>5: HLS+MP4 byte range.</li>
10107
+ <li>0: HLS+TS segment</li>
10108
+ <li>2: HLS+TS byte range</li>
10109
+ <li>7: HLS+MP4 segment</li>
10110
+ <li>5: HLS+MP4 byte range</li>
10112
10111
  Default value: 0
10113
10112
 
10114
- Note: This field may return null, indicating that no valid values can be obtained.
10113
+ Note: This field is used for normal/TSC transcoding settings and does not apply to adaptive bitrate streaming. To configure the segment type for adaptive bitrate streaming, use the outer field.
10114
+ Note: This field may return null, indicating that no valid value can be obtained.
10115
10115
  * @type {number || null}
10116
10116
  */
10117
10117
  this.SegmentType = null;
@@ -10221,46 +10221,49 @@ Note: This field may return null, indicating that no valid value can be obtained
10221
10221
  this.Compress = null;
10222
10222
 
10223
10223
  /**
10224
- * Special segment configuration
10224
+ * Segment duration at startup.
10225
10225
  Note: This field may return null, indicating that no valid value can be obtained.
10226
10226
  * @type {SegmentSpecificInfo || null}
10227
10227
  */
10228
10228
  this.SegmentSpecificInfo = null;
10229
10229
 
10230
10230
  /**
10231
- * Whether to enable scenario-based settings for the template
10232
- 0: disable
10231
+ * Whether the template enables scenario-based settings.
10232
+ 0: disable.
10233
10233
  1: enable
10234
10234
 
10235
10235
  Default value: 0
10236
10236
 
10237
+ Note: The values of SceneType and CompressType fields only take effect when this field value is 1.
10237
10238
  Note: This field may return null, indicating that no valid value can be obtained.
10238
10239
  * @type {number || null}
10239
10240
  */
10240
10241
  this.ScenarioBased = null;
10241
10242
 
10242
10243
  /**
10243
- * Video scenario. Optional values:
10244
+ * Video scenario. Valid values:
10244
10245
  normal: General transcoding scenario: General transcoding and compression scenario.
10245
10246
  pgc: PGC HD TV shows and movies: At the time of compression, focus is placed on the viewing experience of TV shows and movies and ROI encoding is performed according to their characteristics, while high-quality contents of videos and audio are retained.
10246
10247
  materials_video: HD materials: Scenario involving material resources, where requirements for image quality are extremely high and there are many transparent images, with almost no visual loss during compression.
10247
10248
  ugc: UGC content: It is suitable for a wide range of UGC/short video scenarios, with an optimized encoding bitrate for short video characteristics, improved image quality, and enhanced business QOS/QOE metrics.
10248
10249
  e-commerce_video: Fashion show/e-commerce: At the time of compression, emphasis is placed on detail clarity and ROI enhancement, with a particular focus on maintaining the image quality of the face region.
10249
10250
  educational_video: Education: At the time of compression, emphasis is placed on the clarity and readability of text and images to help students better understand the content, ensuring that the teaching content is clearly conveyed.
10250
- Default value: normal
10251
+ Default value: normal.
10252
+ Note: To use this value, the value of ScenarioBased must be 1; otherwise, this value will not take effect.
10251
10253
  Note: This field may return null, indicating that no valid value can be obtained.
10252
10254
  * @type {string || null}
10253
10255
  */
10254
10256
  this.SceneType = null;
10255
10257
 
10256
10258
  /**
10257
- * Transcoding policy. Optional values:
10259
+ * Transcoding policy. Valid values:
10258
10260
  ultra_compress: Extreme compression: Compared to standard compression, this policy can maximize bitrate compression while ensuring a certain level of image quality, thus greatly saving bandwidth and storage costs.
10259
- standard_compress: Comprehensively optimal: The compression ratio and image quality are balanced, and files are compressed as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy.
10260
- high_compress: Bitrate priority: Priority is given to reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy.
10261
- low_compress: Image quality priority: Priority is given to ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy.
10262
- Default value: standard_compress
10263
- Note: If you need to watch videos on TV, it is recommended no to use the ultra_compress policy. The billing standard for the ultra_compress policy is TSC transcoding + audio and video enhancement - artifacts removal.
10261
+ standard_compress: Comprehensively optimal: Balances compression ratio and image quality, compressing files as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy.
10262
+ high_compress: Bitrate priority: Prioritizes reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy.
10263
+ low_compress: Image quality priority: Prioritizes ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy.
10264
+ Default value: standard_compress.
10265
+ Note: If you need to watch videos on TV, it is recommended not to use the ultra_compress policy. The billing standard for the ultra_compress policy is TSC transcoding + audio and video enhancement - artifacts removal.
10266
+ Note: To use this value, the value of ScenarioBased must be 1; otherwise, this value will not take effect.
10264
10267
  Note: This field may return null, indicating that no valid value can be obtained.
10265
10268
  * @type {string || null}
10266
10269
  */
@@ -11178,7 +11181,11 @@ class ModifyAdaptiveDynamicStreamingTemplateRequest extends AbstractModel {
11178
11181
 
11179
11182
  /**
11180
11183
  * Parameter information of input streams for transcoding to adaptive bitrate streaming. Up to 10 streams can be input.
11181
- Note: the frame rate of each stream must be consistent; otherwise, the frame rate of the first stream is used as the output frame rate.
11184
+
11185
+ Note:
11186
+
11187
+ 1. The frame rate of each stream must be consistent; otherwise, the frame rate of the first stream is used as the output frame rate.
11188
+ 2. When modifying substream information, all field values must be fully modified and added; otherwise, fields not filled in will use default values.
11182
11189
  * @type {Array.<AdaptiveStreamTemplate> || null}
11183
11190
  */
11184
11191
  this.StreamInfos = null;
@@ -11190,15 +11197,18 @@ Note: the frame rate of each stream must be consistent; otherwise, the frame rat
11190
11197
  this.Comment = null;
11191
11198
 
11192
11199
  /**
11193
- * Whether it is an audio-only template. 0: video template. 1: audio-only template.When the value is 1:
11200
+ * Indicates whether it is audio-only. 0 means video template, 1 means audio-only template.
11201
+ When the value is 1.
11194
11202
  1. StreamInfos.N.RemoveVideo=1
11195
11203
  2. StreamInfos.N.RemoveAudio=0
11196
11204
  3. StreamInfos.N.Video.Codec=copy
11197
-
11198
- When the value is 0:
11199
-
11205
+ When the value is 0.
11200
11206
  1. StreamInfos.N.Video.Codec cannot be copy.
11201
11207
  2. StreamInfos.N.Video.Fps cannot be null.
11208
+
11209
+ Note:
11210
+
11211
+ This value only distinguishes template types. The task uses the values of RemoveAudio and RemoveVideo.
11202
11212
  * @type {number || null}
11203
11213
  */
11204
11214
  this.PureAudio = null;
@@ -21290,11 +21300,12 @@ class VideoTemplateInfoForUpdate extends AbstractModel {
21290
21300
  <li>dnxhd: DNxHD encoding</li>
21291
21301
  <li>mv-hevc: MV-HEVC encoding</li>
21292
21302
 
21293
- Note: AV1 encoding containers currently only support mp4, webm, and mkv.
21294
- Note: H.266 encoding containers currently only support mp4, hls, ts, and mov.
21295
- Note: VP8 and VP9 encoding containers currently only support webm and mkv.
21296
- Note: MPEG2 and DNxHD encoding containers currently only support mxf.
21297
- Note: MV-HEVC encoding containers only support mp4, hls, and mov. Among them, the hls format only supports mp4 segmentation format.
21303
+ Note:
21304
+ AV1 encoding containers currently only support mp4, webm, and mkv.
21305
+ H.266 encoding containers currently only support mp4, hls, ts, and move.
21306
+ VP8 and VP9 encoding containers currently only support webm and mkv.
21307
+ MPEG2 and DNxHD encoding containers currently only support mxf.
21308
+ MV-HEVC encoding containers only support mp4, hls, and mov. Also, the hls format only supports mp4 segmentation format.
21298
21309
 
21299
21310
  Note: This field may return null, indicating that no valid value can be obtained.
21300
21311
  * @type {string || null}
@@ -21360,30 +21371,27 @@ Note: This field may return null, indicating that no valid value can be obtained
21360
21371
  this.GopUnit = null;
21361
21372
 
21362
21373
  /**
21363
- * Filling mode. When the configured aspect ratio parameter for video streams differs from the aspect ratio of the original video, the processing method for transcoding is "filling". Optional filling modes:
21374
+ * Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. Valid values:
21364
21375
  <li>stretch: Each frame is stretched to fill the entire screen, which may cause the transcoded video to be "flattened" or "stretched".</li>
21365
- <li>black: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with black.</li>
21376
+ <li>black: Keep the image's original aspect ratio and fill the blank space with black bars.</li>
21366
21377
  <li>white: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with white.</li>
21367
- <li>gauss: The aspect ratio of the video is kept unchanged, and the rest of the edges is filled with a Gaussian blur.</li>
21378
+ <li>gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.</li>
21368
21379
 
21369
21380
  <li>smarttailor: Video images are smartly selected to ensure proportional image cropping.</li>
21370
21381
  Default value: black.
21371
21382
 
21372
- Note: Only stretch and black are supported for adaptive bitrate streaming.
21373
-
21374
21383
  Note: This field may return null, indicating that no valid value can be obtained.
21375
21384
  * @type {string || null}
21376
21385
  */
21377
21386
  this.FillType = null;
21378
21387
 
21379
21388
  /**
21380
- * Control factor for constant video bitrate. Value range: [0, 51] and 100.
21381
- It is recommended not to specify this parameter if there are no special requirements.
21389
+ * The control factor of video constant bitrate. Value range: [0, 51]. If not specified, it means "auto". It is recommended not to specify this parameter unless necessary.
21390
+ When the Mode parameter is set to VBR, if the Vcrf value is also configured, MPS will process the video in VBR mode, considering both Vcrf and Bitrate parameters to balance video quality, bitrate, transcoding efficiency, and file size.
21391
+ When the Mode parameter is set to CRF, the Bitrate setting will be invalid, and the encoding will be based on the Vcrf value.
21392
+ When the Mode parameter is set to ABR or CBR, the Vcrf value does not need to be configured.
21393
+ Note: When you need to set it to auto, fill in 100.
21382
21394
 
21383
- Note:
21384
- When you need to set it to auto, fill in 100.
21385
- If Mode is set to ABR, the Vcrf value does not need to be configured.
21386
- If Mode is set to CBR, the Vcrf value does not need to be configured.
21387
21395
  Note: This field may return null, indicating that no valid value can be obtained.
21388
21396
  * @type {number || null}
21389
21397
  */
@@ -21409,13 +21417,14 @@ Note: This field may return null, indicating that no valid value can be obtained
21409
21417
 
21410
21418
  /**
21411
21419
  * HLS segment type. Valid values:
21412
- <li>0: HLS+TS segment.</li>
21413
- <li>2: HLS+TS byte range.</li>
21414
- <li>7: HLS+MP4 segment.</li>
21415
- <li>5: HLS+MP4 byte range.</li>
21420
+ <li>0: HLS+TS segment</li>
21421
+ <li>2: HLS+TS byte range</li>
21422
+ <li>7: HLS+MP4 segment</li>
21423
+ <li>5: HLS+MP4 byte range</li>
21416
21424
  Default value: 0
21417
21425
 
21418
- Note: This field may return null, indicating that no valid values can be obtained.
21426
+ Note: This field is used for normal/Top Speed Codec transcoding settings and does not apply to adaptive bitrate streaming. To configure the segment type for adaptive bitrate streaming, use the outer field.
21427
+ Note: This field may return null, indicating that no valid value can be obtained.
21419
21428
  * @type {number || null}
21420
21429
  */
21421
21430
  this.SegmentType = null;
@@ -21527,46 +21536,48 @@ Note: This field may return null, indicating that no valid value can be obtained
21527
21536
  this.Compress = null;
21528
21537
 
21529
21538
  /**
21530
- * Special segment configuration
21539
+ * Segment duration at startup.
21531
21540
  Note: This field may return null, indicating that no valid value can be obtained.
21532
21541
  * @type {SegmentSpecificInfo || null}
21533
21542
  */
21534
21543
  this.SegmentSpecificInfo = null;
21535
21544
 
21536
21545
  /**
21537
- * Whether to enable scenario-based settings for the template
21538
- 0: disable
21546
+ * Indicates whether to enable scenario-based settings for the template.
21547
+ 0: Disable.
21539
21548
  1: enable
21540
21549
 
21541
21550
  Default value: 0
21542
21551
 
21552
+ Note: This value takes effect only when the value of this field is 1.
21543
21553
  Note: This field may return null, indicating that no valid value can be obtained.
21544
21554
  * @type {number || null}
21545
21555
  */
21546
21556
  this.ScenarioBased = null;
21547
21557
 
21548
21558
  /**
21549
- * Video scenario. Optional values:
21550
- normal: General transcoding scenario: General transcoding and compression scenario
21551
- pgc: PGC HD TV shows and movies: At the time of compression, focus is placed on the viewing experience of TV shows and movies and ROI encoding is performed according to their characteristics, while high-quality contents of videos and audio are retained.
21559
+ * Video scenario. Valid values:
21560
+ normal: General transcoding scenario: General transcoding and compression scenario. pgc: PGC HD film and television: Emphasis is placed on the viewing experience of films and TV shows during compression, with ROI encoding based on the characteristics of films and TV shows, while maintaining high-quality video and audio content.
21552
21561
  materials_video: HD materials: Scenario involving material resources, where requirements for image quality are extremely high and there are many transparent images, with almost no visual loss during compression.
21553
21562
  ugc: UGC content: It is suitable for a wide range of UGC/short video scenarios, with an optimized encoding bitrate for short video characteristics, improved image quality, and enhanced business QOS/QOE metrics.
21554
21563
  e-commerce_video: Fashion show/e-commerce: At the time of compression, emphasis is placed on detail clarity and ROI enhancement, with a particular focus on maintaining the image quality of the face region.
21555
21564
  educational_video: Education: At the time of compression, emphasis is placed on the clarity and readability of text and images to help students better understand the content, ensuring that the teaching content is clearly conveyed.
21556
- Default value: normal
21565
+ Default value: normal.
21566
+ Note: To use this value, the value of ScenarioBased must be 1; otherwise, this value will not take effect.
21557
21567
  Note: This field may return null, indicating that no valid value can be obtained.
21558
21568
  * @type {string || null}
21559
21569
  */
21560
21570
  this.SceneType = null;
21561
21571
 
21562
21572
  /**
21563
- * Transcoding policy. Optional values:
21573
+ * Transcoding policy. Valid values:
21564
21574
  ultra_compress: Extreme compression: Compared to standard compression, this policy can maximize bitrate compression while ensuring a certain level of image quality, thus greatly saving bandwidth and storage costs.
21565
- standard_compress: Comprehensively optimal: The compression ratio and image quality are balanced, and files are compressed as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy.
21566
- high_compress: Bitrate priority: Priority is given to reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy.
21567
- low_compress: Image quality priority: Priority is given to ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy.
21568
- Default value: standard_compress
21569
- Note: If you need to watch videos on TV, it is recommended no to use the ultra_compress policy. The billing standard for the ultra_compress policy is TSC transcoding + audio and video enhancement - artifacts removal.
21575
+ standard_compress: Comprehensively optimal: Balances compression ratio and image quality, compressing files as much as possible without a noticeable reduction in subjective image quality. This policy only charges audio and video TSC transcoding fees.
21576
+ high_compress: Bitrate priority: Prioritizes reducing file size, which may result in some image quality loss. This policy only charges audio and video TSC transcoding fees.
21577
+ low_compress: Image quality priority: Prioritizes ensuring image quality, and the size of compressed files may be relatively large. This policy only charges audio and video TSC transcoding fees.
21578
+ Default value: standard_compress.
21579
+ Note: If you need to watch videos on TV, it is recommended not to use the ultra_compress policy. The billing standard for the ultra_compress policy is TSC transcoding + audio and video enhancement - artifacts removal.
21580
+ Note: To use this value, the value of ScenarioBased must be 1; otherwise, this value will not take effect.
21570
21581
  Note: This field may return null, indicating that no valid value can be obtained.
21571
21582
  * @type {string || null}
21572
21583
  */
@@ -24851,7 +24862,8 @@ Note: This field may return null, indicating that no valid values can be obtaine
24851
24862
  this.Subtitle = null;
24852
24863
 
24853
24864
  /**
24854
- * Subtitle name.
24865
+ * Subtitle name.
24866
+ Note: supports Chinese characters, letters, digits, spaces, underscores (_), hyphens (-), periods (.), and parentheses. Max 64 characters.
24855
24867
  Note: This field may return null, indicating that no valid value can be obtained.
24856
24868
  * @type {string || null}
24857
24869
  */
@@ -43,7 +43,7 @@ class TextToVoiceResponse extends AbstractModel {
43
43
  this.Subtitles = null;
44
44
 
45
45
  /**
46
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
46
+ * 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.
47
47
  * @type {string || null}
48
48
  */
49
49
  this.RequestId = null;