tencent cloud

APIs

DokumentasiAPIsVideo on DemandData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-25 16:40:12

AIAnalysisTemplateItem

AI-based intelligent analysis template details

Used by actions: DescribeAIAnalysisTemplates.

Name Type Description
Definition Integer Unique ID of intelligent analysis template.
Name String Intelligent analysis template name.
Comment String Intelligent analysis template description.
ClassificationConfigure ClassificationConfigureInfo Intelligent Classification Task Control Parameters.
TagConfigure TagConfigureInfo Intelligent tag task control parameter.
CoverConfigure CoverConfigureInfo Intelligent Cover Task Control Parameters.
FrameTagConfigure FrameTagConfigureInfo Intelligent frame tagging task control parameter.
HighlightConfigure HighlightsConfigureInfo Control parameter of an intelligent highlight generating task.
CreateTime String Creation time of template in ISO date format.
UpdateTime String Last modified time of template in ISO date format.

AIRecognitionTemplateItem

Video content recognition template details.

Used by actions: DescribeAIRecognitionTemplates.

Name Type Description
Definition Integer Unique ID of video content recognition template.
Name String Video content recognition template name.
Comment String Video content recognition template description.
Type String Template type. Valid values:
  • Preset: system preset template;
  • Custom: User-defined template.
    		•
    HeadTailConfigure HeadTailConfigureInfo Head and tail recognition control parameter.
    SegmentConfigure SegmentConfigureInfo Segmentation recognition control parameter.
    FaceConfigure FaceConfigureInfo Face recognition control parameter.
    OcrFullTextConfigure OcrFullTextConfigureInfo Text Full-text Recognition Control Parameters.
    OcrWordsConfigure OcrWordsConfigureInfo Text keyword recognition control parameter.
    AsrFullTextConfigure AsrFullTextConfigureInfo Voice full-text recognition control parameters.
    Note: This parameter is no longer maintained. Use the AsrTranslateConfigure parameter to trigger speech translation recognition (when DstLanguage is empty or a fill-in string, no translation is performed, and the billing item is the same as full speech recognition).
    AsrWordsConfigure AsrWordsConfigureInfo Voice keyword recognition control parameters.
    AsrTranslateConfigure AsrTranslateConfigureInfo Voice translation recognition control parameters.
    ObjectConfigure ObjectConfigureInfo Object recognition control parameter.
    ScreenshotInterval Float Screencapturing interval in seconds.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.

    AbnormalLightingConfigureInfo

    Control parameters for detecting low brightness and overexposure of video.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes low brightness and overexposure inspection switch, optional values:
  • ON: enabled;

  • OFF: disabled.
    		•

    AbnormalLightingConfigureInfoForUpdate

    Control parameters for detecting low brightness and overexposure of video.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No low brightness and overexposure inspection switch, optional values:
  • ON: enabled;

  • OFF: disabled.
    		•

    AccelerateAreaInfo

    Acceleration region information of the domain name

    Used by actions: DescribeVodDomains.

    Name Type Description
    Area String Acceleration region. Valid values:
  • Chinese Mainland
  • Outside Chinese Mainland
    		•
    TencentDisableReason String Reason why acceleration is disabled by Tencent Cloud. Valid values:
  • ForLegalReasons: legal reasons
  • ForOverdueBills: overdue payment
    		•
    TencentEdgeDomain String CNAME of the acceleration domain name

    AdaptiveDynamicStreamingInfoItem

    Adaptive bitrate streaming information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer

    Convert to adaptive bitrate streaming specification.
    Package String

    Packaging format. Value ranges from:

  • HLS;
  • DASH.
    		•
    DrmType String

    Encryption type.
    Url String

    Playback address.
    Size Integer

    Media file size, unit: byte.

  • When the media file is HLS, the size is the sum of m3u8 and ts file sizes.
  • When the media file is DASH, the size is the sum of mpd and fragment file sizes.
  • Note: This field is 0 for adaptive bitrate stream files generated through pre-processing before 2022-01-10T16:00:00Z.
    		•
    DigitalWatermarkType String

    Watermark type. Available values:

  • Trace means transit watermark processing;
  • CopyRight means copyright watermark processing;
  • None means no watermark processing.
    		•
    SubStreamSet Array of MediaSubStreamInfoItem

    Substream info list.
    CopyRightWatermarkText String

    Copyright information.
    BlindWatermarkDefinition Integer

    Digital watermark template id.
    SubtitleSet Array of MediaSubtitleItem

    Subtitle information list.
    DefaultSubtitleId String

    Unique identifier for default subtitle.
    DrmEncryptType String

    DRM encryption method.

    AdaptiveDynamicStreamingTaskInput

    Input parameter type of adaptive bitrate streaming

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes

    Adaptive bitrate streaming template ID.
    WatermarkSet Array of WatermarkInput No

    Watermark list. Up to 10 image or text watermarks are supported.
    TraceWatermark TraceWatermarkInput No

    Traceable watermark.
    CopyRightWatermark CopyRightWatermarkInput No

    Copyright watermark.
    BlindWatermark BlindWatermarkInput No

    Digital watermark.
    SubtitleSet Array of String No

    External subtitle file, with subtitle ID as the element, supports multiple subtitles, up to 16.
    SubtitleInfoSet Array of SubtitleInfoInput No

    List of subtitle suppression information. A maximum of 2 are supported.

    AdaptiveDynamicStreamingTemplate

    Details of a transcoding to adaptive bitrate streaming template

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

    Name Type Description
    Definition Integer

    Unique ID of the adaptive bitrate streaming template.
    Type String

    Template type. Valid values:

  • Preset: preset template.
  • Custom: custom template.
    		•
    Name String

    Adaptive bitrate streaming template name.
    Comment String

    Adaptive bitrate streaming template description.
    Format String

    Adaptive Transcoding Format. Value ranges from:

  • HLS.
    		•
    DrmType String

    DRM type. Value ranges from:

  • SimpleAES
  • Widevine
  • FairPlay
  • Widevine+FairPlay
    • If the value is an empty string, it represents no DRM protection for the video.
    DrmKeyProvider String

    DRM key provider. Permissible range:

  • SDMC: SDMC;
  • VOD: video on demand.
    • Default value is VOD.

    SDMC service will be gradually phased out subsequently. Please use VOD DRM encryption service.
    DrmEncryptType String

    DRM encryption type, value ranges from "cbcs" to "cenc".
    StreamInfos Array of AdaptiveStreamTemplate

    Adaptive Transcoding Input Stream Parameter Information. Up to 10 entries.
    DisableHigherVideoBitrate Integer

    Whether to prohibit video low bitrate to high bitrate conversion. Value ranges from:

  • 0: No,
  • 1: Yes.
    		•
    DisableHigherVideoResolution Integer

    Whether to prohibit video resolution to high resolution conversion. Value ranges from:

  • 0: No,
  • 1: Yes.
    		•
    CreateTime String

    Template creation time, in ISO date format.
    UpdateTime String

    Last template modification time, in ISO date format.
    SegmentType String

    Segment type. Valid only when Format is HLS.

    AdaptiveStreamTemplate

    Adaptive bitrate streaming parameter template

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Video VideoTemplateInfo Yes

    Video parameter information.
    Audio AudioTemplateInfo Yes

    Audio parameter info.
    RemoveAudio Integer No

    Remove audio stream. Parameter value range:

  • 0: no,
  • 1: yes.
    		•
    RemoveVideo Integer No

    Remove video stream. Parameter value range:

  • 0: no,
  • 1: yes.
    		•
    TEHDConfig TEHDConfig No

    TSC transcoding parameter.


    Note: This field may return null, indicating that no valid values can be obtained.
    EnhanceConfig EnhanceConfig No

    Audio/Video enhancement configuration.


    Note: This field may return null, indicating that no valid values can be obtained.
    StdExtInfo String No

    Extended parameter.

    AdvancedElementInfo

    Custom entity information

    Used by actions: DescribeTaskDetail.

    Name Type Description
    ElementId String

    Subject ID.
    ElementInfo String

    Entity information.

    AdvancedSuperResolutionConfig

    Super-resolution configuration.

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Switch String No Capability configuration switch. Valid values:
  • ON: enabled;
  • OFF: Disabled.

    • Default value: ON.
    Type String No Type, available values:
  • standard: common super resolution
  • super: advanced super-resolution.

    • Default value: standard.
    Mode String No Image output mode. The default value is percent.
  • aspect: obtain a larger rectangle with specified width and height through super-resolution.
  • fixed: obtain images of fixed width and height through super-resolution, with forced scaling supported.
  • percent: Super-resolution multiplication rate, which can be a decimal.
    		•
    Percent Float No Super-resolution multiplication rate, can be decimal.
    Width Integer No Target image width must not exceed 4096.
    Height Integer No Target image height must not exceed 4096.
    LongSide Integer No The long edge length of the target image must not exceed 4096.
    Note: This configuration is used when Mode equals aspect or fixed and the Width and Height fields are unconfigured.
    ShortSide Integer No The short side length of the target image must not exceed 4096.
    Note: This configuration is used when Mode equals aspect or fixed and the Width and Height fields are unconfigured.

    AiAnalysisResult

    Intelligent analysis result

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Task type. Valid values:
  • Classification: intelligent categorization
  • Cover: intelligent cover generating
  • Tag: intelligent tagging
  • FrameTag: intelligent frame tagging
  • Highlight: intelligent highlight generating
    		•
    ClassificationTask AiAnalysisTaskClassificationResult Query result of the intelligent video content analysis classification task. Valid when the task type is Classification.
    CoverTask AiAnalysisTaskCoverResult Query result of the Intelligent Cover Task for video content analysis. Valid when the task type is Cover.
    TagTask AiAnalysisTaskTagResult Query result of the video content analysis intelligent tag task. Valid at that time when the task type is Tag.
    FrameTagTask AiAnalysisTaskFrameTagResult Query result of the intelligent frame-specific tagging task for video content analysis. Valid when the task type is FrameTag.
    HighlightTask AiAnalysisTaskHighlightResult Query result of the intelligent video content analysis highlight task. Valid when the task type is Highlight.

    AiAnalysisTaskClassificationInput

    Input type of intelligent categorization task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Intelligent video categorization template ID.

    AiAnalysisTaskClassificationOutput

    Result information of intelligent categorization

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ClassificationSet Array of MediaAiAnalysisClassificationItem List of intelligently generated video categories
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by ClassificationSetFileUrl.
    ClassificationSetFileUrl String URL to the file for intelligently generated video categories. The file is in JSON format and has the same data structure as ClassificationSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by ClassificationSetFileUrlExpireTime.
    ClassificationSetFileUrlExpireTime String Expiration time of the URL to the file for intelligently generated video categories, in ISO date format

    AiAnalysisTaskClassificationResult

    Result type of intelligent categorization task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiAnalysisTaskClassificationInput Input of intelligent categorization task.
    Output AiAnalysisTaskClassificationOutput Intelligent classification task output.
    Progress Integer The progress of an intelligent categorization task. Value range: 0-100.
    BeginProcessTime String The time when the intelligent classification task started to be executed, using ISO date format.
    FinishTime String The time when the intelligent classification task is completed, using ISO date format.

    AiAnalysisTaskCoverInput

    Input type of intelligent categorization task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Intelligent video cover generating template ID.

    AiAnalysisTaskCoverOutput

    Result information of intelligent cover generating

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    CoverSet Array of MediaAiAnalysisCoverItem List of intelligently generated thumbnails
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by CoverSetFileUrl.
    CoverSetFileUrl String URL to the file for intelligently generated thumbnails. The file is in JSON format and has the same data structure as CoverSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by CoverSetFileUrlExpireTime.
    CoverSetFileUrlExpireTime String Expiration time of the URL to the file for intelligently generated thumbnails, in ISO date format

    AiAnalysisTaskCoverResult

    Result type of intelligent cover generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiAnalysisTaskCoverInput Input of intelligent cover generating task.
    Output AiAnalysisTaskCoverOutput Intelligent Cover Task output.
    Progress Integer The progress of an intelligent thumbnail generation task. Value range: 0-100.
    BeginProcessTime String The time when the smart cover task started to be executed, using ISO date format.
    FinishTime String The time when the smart cover task is completed, using ISO date format.

    AiAnalysisTaskFrameTagInput

    Input type of intelligent frame-specific tagging task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Intelligent frame-specific video tagging template ID.

    AiAnalysisTaskFrameTagOutput

    Result information of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SegmentSet Array of MediaAiAnalysisFrameTagSegmentItem List of frame-specific video tags
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for frame-specific video tags. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for frame-specific video tags, in ISO date format

    AiAnalysisTaskFrameTagResult

    Result type of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiAnalysisTaskFrameTagInput Input of intelligent frame-specific tagging task.
    Output AiAnalysisTaskFrameTagOutput Intelligent frame-specific tagging task output.
    Progress Integer The progress of an intelligent labeling by frame task. Value range: 0-100.
    BeginProcessTime String The time when the intelligent frame labeling task started execution, using ISO date format.
    FinishTime String The time when the intelligent frame labeling task is completed, using ISO date format.

    AiAnalysisTaskHighlightInput

    Input type of an intelligent highlight generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of an intelligent highlight generating template.

    AiAnalysisTaskHighlightOutput

    Information of the intelligent highlight generating result

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    HighlightSet Array of MediaAiAnalysisHighlightItem List of intelligently generated highlights
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by HighlightSetFileUrl.
    HighlightSetFileUrl String URL to the file for intelligently generated highlights. The file is in JSON format and has the same data structure as HighlightSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by HighlightSetFileUrlExpireTime.
    HighlightSetFileUrlExpireTime String Expiration time of the URL to the file for intelligently generated highlights, in ISO date format

    AiAnalysisTaskHighlightResult

    Result type of an intelligent highlight generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiAnalysisTaskHighlightInput Input for an intelligent highlight generating task.
    Output AiAnalysisTaskHighlightOutput Intelligent Highlight Task output.
    Progress Integer The progress of an intelligent highlight generation task. Value range: 0-100.
    BeginProcessTime String The time when the smart highlight task started execution, in ISO date format.
    FinishTime String The time the smart highlight task completed, in ISO date format.

    AiAnalysisTaskInput

    Input parameter type of AI-based intelligent video analysis

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Video content analysis template ID.

    AiAnalysisTaskTagInput

    Input type of intelligent tagging task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Intelligent video tagging template ID.

    AiAnalysisTaskTagOutput

    Result information of intelligent tagging

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TagSet Array of MediaAiAnalysisTagItem List of intelligently generated video tags
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by TagSetFileUrl.
    TagSetFileUrl String URL to the file for intelligently generated video tags. The file is in JSON format and has the same data structure as TagSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by TagSetFileUrlExpireTime.
    TagSetFileUrlExpireTime String Expiration time of the URL to the file for intelligently generated video tags, in ISO date format

    AiAnalysisTaskTagResult

    Result type of intelligent tagging task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiAnalysisTaskTagInput Input of intelligent tagging task.
    Output AiAnalysisTaskTagOutput Intelligent tag task output.
    Progress Integer The progress of an intelligent labeling task. Value range: 0-100.
    BeginProcessTime String The time when the smart label task started executing, using ISO date format.
    FinishTime String The time when the smart label task is completed, using ISO date format.

    AiContentReviewResult

    Intelligent recognition result

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Task type. Valid values:
  • Porn: porn information recognition in images
  • Terrorism: terrorism information recognition in images
  • Political: politically sensitive information recognition in images
  • Porn.Asr: ASR-based porn information recognition in speech
  • Porn.Ocr: OCR-based porn information recognition in text
  • Political.Asr: ASR-based politically sensitive information recognition in speech
  • Political.Ocr: OCR-based politically sensitive information recognition in text
  • Terrorism.Ocr: OCR-based terrorism information recognition in text
  • Prohibited.Asr: ASR-based prohibited information recognition in speech
  • Prohibited.Ocr: OCR-based prohibited information recognition in text
    		•
    PornTask AiReviewTaskPornResult Result for intelligent recognition of pornographic content in images. This parameter is valid when Type is Porn.
    Note: This field may return null, indicating that no valid value can be found.
    TerrorismTask AiReviewTaskTerrorismResult Result for intelligent recognition of terrorism content in images. This parameter is valid when Type is Terrorism.
    Note: This field may return null, indicating that no valid value can be found.
    PoliticalTask AiReviewTaskPoliticalResult Result for intelligent recognition of politically sensitive content in images. This parameter is valid when Type is Political.
    Note: This field may return null, indicating that no valid value can be found.
    PornAsrTask AiReviewTaskPornAsrResult Result for ASR-based recognition of pornographic content. This parameter is valid when Type is Porn.Asr.
    Note: This field may return null, indicating that no valid value can be found.
    PornOcrTask AiReviewTaskPornOcrResult Result for OCR-based recognition of pornographic content. This parameter is valid when Type is Porn.Ocr.
    Note: This field may return null, indicating that no valid value can be found.
    PoliticalAsrTask AiReviewTaskPoliticalAsrResult Result for ASR-based recognition of politically sensitive content. This parameter is valid when Type is Political.Asr.
    Note: This field may return null, indicating that no valid value can be found.
    PoliticalOcrTask AiReviewTaskPoliticalOcrResult Result for OCR-based recognition of politically sensitive content. This parameter is valid when Type is Political.Ocr.
    Note: This field may return null, indicating that no valid value can be found.
    TerrorismOcrTask AiReviewTaskTerrorismOcrResult Result for OCR-based recognition of terrorism content. This parameter is valid when Type is Terrorism.Ocr.
    Note: This field may return null, indicating that no valid value can be found.
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult Result for OCR-based recognition of banned content. This parameter is valid when Type is Prohibited.Ocr.
    Note: This field may return null, indicating that no valid value can be found.
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult Result for ASR-based recognition of banned content. This parameter is valid when Type is Prohibited.Asr.
    Note: This field may return null, indicating that no valid value can be found.

    AiContentReviewTaskInput

    Type of intelligent recognition task

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Intelligent recognition template ID

    AiRecognitionResult

    Intelligent recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Task type. Valid values:
  • FaceRecognition: face recognition.
  • AsrWordsRecognition: speech keyword recognition.
  • OcrWordsRecognition: text keyword recognition.
  • AsrFullTextRecognition: full speech recognition.
  • AsrTranslateRecognition: Speech translation recognition,
  • OcrFullTextRecognition: full text recognition.
  • HeadTailRecognition: Video start and end recognition,
  • ObjectRecognition: Object recognition.
    		•
    HeadTailTask AiRecognitionTaskHeadTailResult Video opening and closing credits recognition result when Type is
    HeadTailRecognition.
    SegmentTask AiRecognitionTaskSegmentResult Video splitting recognition result, which is valid when Type is
    Valid at SegmentRecognition.
    FaceTask AiRecognitionTaskFaceResult Face recognition result, which is valid when Type is
    FaceRecognition.
    AsrWordsTask AiRecognitionTaskAsrWordsResult Speech keyword recognition result when Type is
    Valid at AsrWordsRecognition.
    AsrFullTextTask AiRecognitionTaskAsrFullTextResult Full speech recognition result. When Type is
    Set to AsrFullTextRecognition, this parameter takes effect.
    AsrTranslateTask AiRecognitionTaskAsrTranslateResult Voice translation result. Valid when Type is AsrTranslateRecognition.
    OcrWordsTask AiRecognitionTaskOcrWordsResult Text keyword recognition result when Type is
    Valid at OcrWordsRecognition.
    OcrFullTextTask AiRecognitionTaskOcrFullTextResult Full text recognition result. When Type is
    OcrFullTextRecognition.
    ObjectTask AiRecognitionTaskObjectResult Object recognition result, which is valid when Type is
    Valid at ObjectRecognition.

    AiRecognitionTaskAsrFullTextResult

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskAsrFullTextResultInput Input information of full speech recognition task.
    Output AiRecognitionTaskAsrFullTextResultOutput Output information on the speech full-text recognition task.
    Progress Integer Speech full-text recognition task progress, value range [0-100].
    BeginProcessTime String The time when the full-text speech recognition task started, using ISO date format.
    FinishTime String The time when the speech full-text recognition task was completed, using ISO date format.

    AiRecognitionTaskAsrFullTextResultInput

    Input of full speech recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Full speech recognition template ID.

    AiRecognitionTaskAsrFullTextResultOutput

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem List of full-text speech recognition segments
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file of the list for full-text speech recognition segments. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    SegmentSetFileUrlExpireTime String The expiration time of the URLs of full-text speech recognition segments in ISO date format.
    SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem The subtitle files generated, whose format is determined by the SubtitleFormats parameter of AsrFullTextConfigureInfo.
    SubtitleUrl String The URLs of the subtitle files generated, whose format is determined by the SubtitleFormats parameter of AsrFullTextConfigureInfo.

    AiRecognitionTaskAsrFullTextResultOutputSubtitleItem

    Subtitle information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Id String Media asset subtitle ID, used for media asset subtitle management. Valid only when Format is vtt.
    Note: This field is invalid for tasks before 2024-11-01T10:00:00Z.
    Name String Media Asset Subtitle Name for player display. Valid only when Format is vtt.
    Note: This field is invalid for tasks before 2024-11-01T10:00:00Z.
    Language String Subtitle language.
    Format String The format of the subtitle files. Valid values:
  • vtt
  • srt
    		•
    Url String The URL of a subtitle file.

    AiRecognitionTaskAsrFullTextSegmentItem

    Full speech recognition segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence of recognized segment. Value range: 0-100.
    StartTimeOffset Float Start time offset of recognized segment in seconds.
    EndTimeOffset Float End time offset of recognition segment in seconds.
    Text String Recognized text.

    AiRecognitionTaskAsrTranslateResult

    Voice translation result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates success, and additional values indicate failure. For values, see the video processing error code list (https://www.tencentcloud.com/document/product/266/50368?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskAsrTranslateResultInput Voice translation task input information.
    Output AiRecognitionTaskAsrTranslateResultOutput Voice translation task output information.
    Progress Integer Voice translation task progress, with a value range of [0-100].
    BeginProcessTime String Voice Translation Task Start Time in ISO datetime format.
    FinishTime String Time for voice translation task completion in ISO datetime format.

    AiRecognitionTaskAsrTranslateResultInput

    Input for voice translation.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Speech translation template ID.

    AiRecognitionTaskAsrTranslateResultOutput

    Voice translation result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskAsrTranslateSegmentItem Voice translation clip list.
    Note: The list only displays the first 100 elements. To obtain the complete result, refer to the corresponding file in SegmentSetFileUrl.
    SegmentSetFileUrl String URL of Speech Translation Clip List File. The content of the file is JSON, consistent with the fields of SegmentSet. (The file will not be retained permanently and will be deleted when reaching SegmentSetFileUrlExpireTime.)
    SegmentSetFileUrlExpireTime String Expiration time of the URL for the speech translation clip list file, in ISO date format.
    SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem Generated subtitle list.

    AiRecognitionTaskAsrTranslateSegmentItem

    Speech translation recognition clip.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence of a speech translation segment. Value range: 0-100.
    StartTimeOffset Float Start time offset of a recognized segment in speech translation, in seconds.
    EndTimeOffset Float End time offset of a recognized segment in speech translation, in seconds.
    Text String Recognized text.
    Translation String Translated text.

    AiRecognitionTaskAsrWordsResult

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskAsrWordsResultInput Input information of speech keyword recognition task.
    Output AiRecognitionTaskAsrWordsResultOutput Speech keyword recognition task output information.
    Progress Integer The progress of a speech keyword recognition task. Value range: 0-100.
    BeginProcessTime String The time when the speech keyword recognition task started, using ISO date format.
    FinishTime String The time when the speech keyword recognition task is completed, using ISO date format.

    AiRecognitionTaskAsrWordsResultInput

    Input of speech keyword recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Speech keyword recognition template ID.

    AiRecognitionTaskAsrWordsResultItem

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Word String Speech keyword.
    SegmentSet Array of AiRecognitionTaskAsrWordsSegmentItem List of time segments that contain the speech keyword.

    AiRecognitionTaskAsrWordsResultOutput

    Output of speech keyword recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ResultSet Array of AiRecognitionTaskAsrWordsResultItem Speech keyword recognition result set
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    ResultSetFileUrl String URL to the file of the speech keyword recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    ResultSetFileUrlExpireTime String Expiration time of the URL to the file of the speech keyword recognition result set, in ISO date format

    AiRecognitionTaskAsrWordsSegmentItem

    Speech recognition segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of recognized segment in seconds.
    EndTimeOffset Float End time offset of recognition segment in seconds.
    Confidence Float Confidence of recognized segment. Value range: 0-100.

    AiRecognitionTaskFaceResult

    Face recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskFaceResultInput Input information of face recognition task.
    Output AiRecognitionTaskFaceResultOutput Face recognition task output information.
    Progress Integer The progress of a face recognition task. Value range: 0-100.
    BeginProcessTime String The time when the face recognition task started, using ISO date format.
    FinishTime String The time when the face recognition task was completed, using ISO date format.

    AiRecognitionTaskFaceResultInput

    Face recognition input.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Face recognition template ID.

    AiRecognitionTaskFaceResultItem

    Face recognition result

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Id String Unique ID of figure.
    Type String Figure library type, indicating to which figure library the recognized figure belongs:
  • Default: default figure library;
  • UserDefine: custom figure library.
    		•
    Name String Figure name.
    SegmentSet Array of AiRecognitionTaskFaceSegmentItem Result set of segments that contain a figure.

    AiRecognitionTaskFaceResultOutput

    Output of intelligent face recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ResultSet Array of AiRecognitionTaskFaceResultItem Intelligent face recognition result set
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    ResultSetFileUrl String URL to the file of the intelligent face recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    ResultSetFileUrlExpireTime String Expiration time of the URL to the file of the intelligent face recognition result set, in ISO date format

    AiRecognitionTaskFaceSegmentItem

    Face recognition result segment

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of recognized segment in seconds.
    EndTimeOffset Float End time offset of recognition segment in seconds.
    Confidence Float Confidence of recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of recognition result. The array contains four elements: [x1,y1,x2,y2], i.e., the horizontal and vertical coordinates of the top-left and bottom-right corners.

    AiRecognitionTaskHeadTailResult

    Video opening and ending credits recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskHeadTailResultInput Input information of video opening and ending credits recognition task.
    Output AiRecognitionTaskHeadTailResultOutput Video opening and closing credits recognition task output information.
    Progress Integer The progress of an opening/closing segment recognition task. Value range: 0-100.
    BeginProcessTime String The time when the video start and end recognition task starts, using ISO date format.
    FinishTime String The time when the video start and end recognition task is completed, using ISO date format.

    AiRecognitionTaskHeadTailResultInput

    Input of video opening and ending credits recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Video opening and ending credits recognition template ID.

    AiRecognitionTaskHeadTailResultOutput

    Output of video opening and ending credits recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    HeadConfidence Float Confidence of recognized opening credits. Value range: 0-100.
    HeadTimeOffset Float End time point of video opening credits in seconds.
    TailConfidence Float Confidence of recognized closing credits. Value range: 0-100.
    TailTimeOffset Float Start time point of video closing credits in seconds.

    AiRecognitionTaskInput

    Input parameter type of video content recognition

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Intelligent video recognition template ID.

    AiRecognitionTaskObjectResult

    Object recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskObjectResultInput Input information of object recognition task.
    Output AiRecognitionTaskObjectResultOutput Object recognition task output information.
    Progress Integer The progress of an object recognition task. Value range: 0-100.
    BeginProcessTime String The time when the object recognition task started execution, using ISO date format.
    FinishTime String The time when the object recognition task is completed, using ISO date format.

    AiRecognitionTaskObjectResultInput

    Input type of object recognition task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Object recognition template ID.

    AiRecognitionTaskObjectResultItem

    Single-object recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Name String Name of recognized object.
    RecognitionSegmentSet Array of AiRecognitionTaskObjectSegmentItem List of fragments in which the object appears.

    AiRecognitionTaskObjectResultOutput

    Output of intelligent object recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ResultSet Array of AiRecognitionTaskObjectResultItem Intelligent object recognition result set
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    ResultSetFileUrl String URL to the file of the object recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    ResultSetFileUrlExpireTime String Expiration time of the URL to the object recognition result set, in ISO date format

    AiRecognitionTaskObjectSegmentItem

    Object recognition result fragment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Identifies the offset time of the beginning of the segment, in seconds.
    EndTimeOffset Float Offset time to identify the end of the segment, in seconds.
    Confidence Float Identify segment confidence. Value: 0~100.
    AreaCoordSet Array of Integer The area coordinates of the recognition result. The array contains 4 elements [x1, y1, x2, y2], which in turn represent the horizontal and vertical coordinates of the upper left point and lower right point of the area.

    AiRecognitionTaskOcrFullTextResult

    Full text recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskOcrFullTextResultInput Input information of full text recognition task.
    Output AiRecognitionTaskOcrFullTextResultOutput Full text recognition task output information.
    Progress Integer The progress of a full text recognition task. Value range: 0-100.
    BeginProcessTime String The time when the full text recognition task started, using ISO date format.
    FinishTime String The time when the full text recognition task was completed, using ISO date format.

    AiRecognitionTaskOcrFullTextResultInput

    Input of full text recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Full text recognition template ID.

    AiRecognitionTaskOcrFullTextResultOutput

    Output of full text recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskOcrFullTextSegmentItem Full-text recognition result set
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file of the full-text recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file of the full-text recognition result set, in ISO date format

    AiRecognitionTaskOcrFullTextSegmentItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of recognized segment in seconds.
    EndTimeOffset Float End time offset of recognition segment in seconds.
    TextSet Array of AiRecognitionTaskOcrFullTextSegmentTextItem Recognition segment result set.

    AiRecognitionTaskOcrFullTextSegmentTextItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence of recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of recognition result. The array contains four elements: [x1,y1,x2,y2], i.e., the horizontal and vertical coordinates of the top-left and bottom-right corners.
    Text String Recognized text.

    AiRecognitionTaskOcrWordsResult

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskOcrWordsResultInput Input information of text keyword recognition task.
    Output AiRecognitionTaskOcrWordsResultOutput Text keyword recognition task output information.
    Progress Integer The progress of a text keyword recognition task. Value range: 0-100.
    BeginProcessTime String The time when the text keyword recognition task started, using ISO date format.
    FinishTime String The time when the text keyword recognition task is completed, using ISO date format.

    AiRecognitionTaskOcrWordsResultInput

    Input of text keyword recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Text keyword recognition template ID.

    AiRecognitionTaskOcrWordsResultItem

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Word String Text keyword.
    SegmentSet Array of AiRecognitionTaskOcrWordsSegmentItem List of segments that contain a text keyword.

    AiRecognitionTaskOcrWordsResultOutput

    Output of text keyword recognition.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ResultSet Array of AiRecognitionTaskOcrWordsResultItem Text keyword recognition result set
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    ResultSetFileUrl String URL to the file of the text keyword recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    ResultSetFileUrlExpireTime String Expiration time of the URL to the file of the text keyword recognition result set, in ISO date format

    AiRecognitionTaskOcrWordsSegmentItem

    Text recognition segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of recognized segment in seconds.
    EndTimeOffset Float End time offset of recognition segment in seconds.
    Confidence Float Confidence of recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of recognition result. The array contains four elements: [x1,y1,x2,y2], i.e., the horizontal and vertical coordinates of the top-left and bottom-right corners.

    AiRecognitionTaskSegmentResult

    Video splitting results.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiRecognitionTaskSegmentResultInput Video splitting task input.
    Output AiRecognitionTaskSegmentResultOutput Video splitting task output information.
    Progress Integer The progress of a video splitting task. Value range: 0-100.
    BeginProcessTime String The time when the video detachment task started, using ISO date format.
    FinishTime String The time when the video stripping task is completed is in ISO date format.

    AiRecognitionTaskSegmentResultInput

    Input of video splitting.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Video splitting template ID.

    AiRecognitionTaskSegmentResultOutput

    Output of video splitting.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskSegmentSegmentItem List of split video segments
    Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file of the list for split video segments. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file of the list for split video segments, in ISO date format

    AiRecognitionTaskSegmentSegmentItem

    Split video segment.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String File ID, which is valid only when a VOD file is processed and the subsegments generated through segmentation are also VOD files.
    SegmentUrl String Split video segment URL.
    Confidence Float Confidence of split segment. Value range: 0-100.
    StartTimeOffset Float Start time offset of split segment in seconds.
    EndTimeOffset Float End time offset of split segment in seconds.
    CovImgUrl String Split cover image URL.
    SpecialInfo String Special field, which should be ignored.

    AiReviewPoliticalAsrTaskInput

    Input parameters for ASR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of politically sensitive content

    AiReviewPoliticalAsrTaskOutput

    Output for ASR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the ASR-detected politically sensitive content. Value range: 0-100
    Suggestion String Processing suggestion for the ASR-detected politically sensitive content. Valid values:
  • pass
  • review
  • block
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem List of video segments that contain ASR-detected politically sensitive content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain ASR-detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain ASR-detected politically sensitive content, in ISO date format

    AiReviewPoliticalOcrTaskInput

    Input parameters for OCR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of politically sensitive content

    AiReviewPoliticalOcrTaskOutput

    Output for OCR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the OCR-detected politically sensitive content. Value range: 0-100
    Suggestion String Processing suggestion for the OCR-detected politically sensitive content. Valid values:
  • pass
  • review
  • block
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected politically sensitive content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain OCR-detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain OCR-detected politically sensitive content, in ISO date format

    AiReviewPoliticalTaskInput

    Input parameters for intelligent recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of politically sensitive content

    AiReviewPoliticalTaskOutput

    Output for intelligent recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the detected politically sensitive content. Value range: 0-100
    Suggestion String Processing suggestion for the detected politically sensitive content
  • pass
  • review
  • block
    		•
    Label String Labels for the detected politically sensitive content. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows:
    violation_photo:
  • violation_photo: banned images

    • Other values (politician/entertainment/sport/entrepreneur/scholar/celebrity/military):
  • politician: politically sensitive people
    		•
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem List of video segments that contain detected politically sensitive content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain politically sensitive content, in ISO date format

    AiReviewPornAsrTaskInput

    Input parameters for ASR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of pornographic content

    AiReviewPornAsrTaskOutput

    Output for ASR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the ASR-detected pornographic content
    Suggestion String Processing suggestion for the ASR-detected pornographic content
  • pass
  • review
  • block
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem List of video segments that contain ASR-detected pornographic content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain ASR-detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain ASR-detected pornographic content, in ISO date format

    AiReviewPornOcrTaskInput

    Input parameters for OCR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of pornographic content

    AiReviewPornOcrTaskOutput

    Output for OCR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the OCR-detected pornographic content
    Suggestion String Processing suggestion for the OCR-detected pornographic content
  • pass
  • review
  • block
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected pornographic content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain OCR-detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain OCR-detected pornographic content, in ISO date format

    AiReviewPornTaskInput

    Input parameters for intelligent recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Definition Integer Yes ID of the template for recognition of pornographic content

    AiReviewPornTaskOutput

    Output for intelligent recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the detected pornographic content. Value range: 0-100
    Suggestion String Processing suggestion for the detected pornographic content. Valid values:
  • pass
  • review
  • block
    		•
    Label String Labels for the detected pornographic content. Valid values:
  • porn
  • sexy
  • vulgar
  • intimacy
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain detected pornographic content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain detected pornographic content, in ISO date format

    AiReviewProhibitedAsrTaskInput

    Input parameters for ASR-based recognition of banned content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Prohibited information detection template ID.

    AiReviewProhibitedAsrTaskOutput

    ASR-detected prohibited information in speech

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Score of ASR-detected prohibited information in speech between 0 and 100.
    Suggestion String Suggestion for ASR-detected prohibited information in speech. Valid values:
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem List of video segments that contain ASR-detected prohibited information
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain ASR-detected prohibited information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain ASR-detected prohibited information, in ISO date format

    AiReviewProhibitedOcrTaskInput

    Input parameters for OCR-based recognition of banned content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Prohibited information detection template ID.

    AiReviewProhibitedOcrTaskOutput

    OCR-detected prohibited information in text

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Score of OCR-detected prohibited information in text between 0 and 100.
    Suggestion String Suggestion for OCR-detected prohibited information in text. Valid values:
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected prohibited information
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain OCR-detected prohibited information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL for video segments that contain OCR-detected prohibited information, in ISO date format

    AiReviewTaskPoliticalAsrResult

    Result for ASR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalAsrTaskInput Input for ASR-based recognition of politically sensitive content
    Output AiReviewPoliticalAsrTaskOutput Output for ASR-based recognition of politically sensitive content
    Progress Integer The progress of an ASR-based moderation task (politically sensitive content). Value range: 0-100.

    AiReviewTaskPoliticalOcrResult

    Result for OCR-based recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalOcrTaskInput Input for OCR-based recognition of politically sensitive content
    Output AiReviewPoliticalOcrTaskOutput Video moderation Ocr text involves inappropriate information in task output.
    Progress Integer Audio and video review OCR text involves the task progress of inappropriate information, the value range is [0-100].

    AiReviewTaskPoliticalResult

    Result for intelligent recognition of politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalTaskInput Input for intelligent recognition of politically sensitive content
    Output AiReviewPoliticalTaskOutput Video moderation involves inappropriate information in task output.
    Progress Integer The progress of a moderation task (politically sensitive content). Value range: 0-100.

    AiReviewTaskPornAsrResult

    Result for ASR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornAsrTaskInput Input for ASR-based recognition of pornographic content
    Output AiReviewPornAsrTaskOutput Video moderation involves offensive content in Asr text task output.
    Progress Integer The progress of an ASR-based moderation task (pornographic content). Value range: 0-100.

    AiReviewTaskPornOcrResult

    Result for OCR-based recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornOcrTaskInput Input for OCR-based recognition of pornographic content
    Output AiReviewPornOcrTaskOutput Video moderation Ocr text involves offensive content in task output.
    Progress Integer The progress of an OCR-based moderation task (pornographic content). Value range: 0-100.

    AiReviewTaskPornResult

    Result for intelligent recognition of pornographic content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornTaskInput Input for intelligent recognition of pornographic content
    Output AiReviewPornTaskOutput Video moderation involves offensive content in task output.
    Progress Integer The progress of a moderation task (pornographic content). Value range: 0-100.

    AiReviewTaskProhibitedAsrResult

    Result for ASR-based recognition of banned content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiReviewProhibitedAsrTaskInput Input for ASR-based recognition of banned content
    Output AiReviewProhibitedAsrTaskOutput Audio/video moderation Asr text prohibited task output.
    Progress Integer The progress of an ASR-based moderation task (banned content). Value range: 0-100.

    AiReviewTaskProhibitedOcrResult

    Result for OCR-based recognition of banned content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiReviewProhibitedOcrTaskInput Input for OCR-based recognition of banned content
    Output AiReviewProhibitedOcrTaskOutput Video moderation Ocr text prohibited information recognition task output.
    Progress Integer The progress of an OCR-based moderation task (banned content). Value range: 0-100.

    AiReviewTaskTerrorismOcrResult

    Result for OCR-based recognition of terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Input AiReviewTerrorismOcrTaskInput Input for OCR-based recognition of terrorism content
    Output AiReviewTerrorismOcrTaskOutput Video moderation Ocr text involves unsafe information in task output.
    Progress Integer The progress of an OCR-based moderation task (terrorist content). Value range: 0-100.

    AiReviewTaskTerrorismResult

    Result for intelligent recognition of terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewTerrorismTaskInput Input for intelligent recognition of terrorism content
    Output AiReviewTerrorismTaskOutput Video moderation involves unsafe information in task output.
    Progress Integer The progress of a moderation task (terrorist content). Value range: 0-100.

    AiReviewTerrorismOcrTaskInput

    Input parameters for OCR-based recognition of terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of terrorism content

    AiReviewTerrorismOcrTaskOutput

    Output for OCR-based recognition of terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Confidence score for the OCR-detected terrorism content. Value range: 0-100
    Suggestion String Processing suggestion for the OCR-detected terrorism content
  • pass
  • review
  • block
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected terrorism content
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain OCR-detected terrorism content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain OCR-detected terrorism content, in ISO date format

    AiReviewTerrorismTaskInput

    Input parameters for intelligent recognition of terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer ID of the template for recognition of terrorism content

    AiReviewTerrorismTaskOutput

    Terrorism information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float Score of detected terrorism information in a video between 0 and 100.
    Note: this field may return null, indicating that no valid values can be obtained.
    Suggestion String Suggestion for detected terrorism information. Valid values:
  • pass.
  • review.
  • block.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Label String Tag of the detected terrorism information in a video. Valid values:
  • guns: weapons and guns
  • crowd: crowds
  • police: police forces
  • bloody: bloody images
  • banners: terrorism flags
  • militant: militants
  • explosion: explosions and fires
  • terrorists: terrorists
  • scenario: terrorism images
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain terrorism information
    Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
    SegmentSetFileUrl String URL to the file for video segments that contain terrorism information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
    SegmentSetFileUrlExpireTime String Expiration time of the URL to the file for video segments that contain terrorism information, in ISO date format

    AiSampleFaceInfo

    AI-based sample management - face information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

    Name Type Description
    FaceId String Face image ID.
    Url String Face image address.

    AiSampleFaceOperation

    AI-based sample management - face data operation.

    Used by actions: ModifyPersonSample.

    Name Type Required Description
    Type String Yes Operation type. Valid values: add, delete, reset. The reset operation will clear the existing face data of a figure and add FaceContents as the specified face data.
    FaceIds Array of String No Face ID set, which is required if Type is delete.
    FaceContents Array of String No Face image Base64 Encoded string collection, only supports jpeg and png image formats.
  • When Type is add or reset, this field is required;
  • Array length limit: 5 pictures.

    • Note: The picture must be a clear frontal photo of a single person, with a pixel size of no less than 200*200.

    AiSampleFailFaceInfo

    AI-based sample management - face information failed to be processed.

    Used by actions: CreatePersonSample, ModifyPersonSample.

    Name Type Description
    Index Integer It corresponds to incorrect image subscripts in the FaceContents input parameter, starting from 0.
    ErrCode Integer Error code. Valid values:
  • 0: success;
  • Other values: failure.
    		•
    Message String Error message.

    AiSamplePerson

    AI-based sample management - figure information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

    Name Type Description
    PersonId String Figure ID.
    Name String Figure name.
    Description String Figure description.
    FaceInfoSet Array of AiSampleFaceInfo Face information.
    TagSet Array of String Figure tag.
    UsageSet Array of String Use case.
    CreateTime String Creation time in ISO date format.
    UpdateTime String Last modified time in ISO date format.

    AiSampleTagOperation

    AI-based sample management - tag operation.

    Used by actions: ModifyPersonSample, ModifyWordSample.

    Name Type Required Description
    Type String Yes Operation type. Valid values: add, delete, reset.
    Tags Array of String Yes Tag. Length limit: 128 characters.

    AiSampleWord

    AI-based sample management - keyword output information.

    Used by actions: DescribeWordSamples.

    Name Type Description
    Keyword String Keyword.
    TagSet Array of String Keyword tag.
    UsageSet Array of String Keyword use case.
    CreateTime String Creation time in ISO date format.
    UpdateTime String Last modified time in ISO date format.

    AiSampleWordInfo

    AI-based sample management - keyword input information.

    Used by actions: CreateWordSamples.

    Name Type Required Description
    Keyword String Yes Keyword. Length limit: 20 characters.
    Tags Array of String No Keyword tag
  • Array length limit: 20 tags;
  • Tag length limit: 128 characters.
    		•

    AigcAdvancedCustomElementInfo

    Advanced AIGC Custom Entity Information

    Used by actions: DescribeAigcAdvancedCustomElements.

    Name Type Description
    Id String

    Subject ID.
    Name String

    Subject name.
    VoiceId String

    Voice ID.
    Description String

    Subject description.
    CreateTime String

    Subject creation time. Format according to ISO 8601 standard. For details, see ISO date format description.

    AigcAudioCloneInputFileInfo

    AIGC voice clone input file information

    Used by actions: CreateAigcAudioClone, DescribeTaskDetail.

    Name Type Required Description
    Type String No

    Input video file type. Valid values:

  • File: On-demand media file;
  • Url: Accessible URL;


    • Note: This field may return null, indicating that no valid values can be obtained.
    FileId String No

    Media file ID, the globally unique identifier of the file in VOD, is assigned by the VOD backend after successful upload. You can get this field in the video upload completion event notification or the VOD console. This parameter is valid when Type value is File. Description: 1. Image less than 10M is recommended. 2. Image format values: jpeg, jpg, png.


    Note: This field may return null, indicating that no valid values can be obtained.
    Url String No

    Accessible file URL. This parameter is valid when Type value is Url. Description: 1. Recommended for use with images less than 10M; 2. Image format value: jpeg, jpg, png.


    Note: This field may return null, indicating that no valid values can be obtained.

    AigcAudioOutputConfig

    Output media file configuration of the AIGC sound effect task.

    Used by actions: CreateAigcAudioTask, DescribeTaskDetail.

    Name Type Required Description
    StorageMode String No

    Storage mode

    Enumeration value:

    • Temporary: Temporary storage. The generated video file will not be stored in VOD. You can obtain the temporary access URL from the event notification, with a valid period of 7 days.
    • Permanent: Permanent storage. The generated video file will be stored in VOD. You can obtain the FileId from the event notification.

    Default value: Temporary
    MediaName String No

    Output filename, up to 64 characters. Default filename is specified by the system.
    ClassId Integer No

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.

  • Default value: 0, indicating other categories.
    		•
    ExpireTime String No

    The expiry date of the output file. Files will be deleted longer than this time. Default is never expire, format according to ISO 8601. For details, see ISO date format description.
    Duration Integer No

    Audio duration. Not filled in by default.

    Value ranges from 0 to 60.
    OutputAudioFormat String No

    Output audio format, not filled in by default

    AigcAudioReferenceAudioInfo

    See audio content.

    Used by actions: CreateAigcAudioTask.

    Name Type Required Description
    Type String No

    Accessible file URL. This parameter is valid when Type value is Url. Description: 1. Recommended image less than 7M; 2. Image format value: jpeg, jpg, png, webp.
    FileId String No

    The media file ID of the audio file, which is the globally unique identifier of this file on VOD, is assigned by the VOD backend after a successful upload. You can retrieve this field in the video upload completion event notification or the VOD console. This parameter is valid when the Type value is File.
    Url String No

    Audio file URL, which must be external network accessible. This parameter is valid when the Type value is Url.

    AigcAudioReferenceVideoInfo

    Reference video asset for AIGC video generation.

    Used by actions: CreateAigcAudioTask.

    Name Type Required Description
    Type String No

    Input video file type. Valid values:

  • File: on-demand media file;
  • Url: accessible Url;

    		•
    FileId String No

    The media file ID of the video file, which is the globally unique identifier of the file in VOD, is assigned by the VOD backend after a successful upload. You can get this field in the video upload completion event notification or the VOD console. This parameter is valid when the Type value is File.
    Url String No

    Reference video URL must be external network accessible. This parameter is valid when Type value is Url.

    AigcAudioTask

    Create AIGC sound effect task info.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status. Valid values:

  • PROCESSING: Processing;
  • FINISH: Completed.

    		•
    ErrCode Integer

    Error code. Returns a non-zero error code for source errors. For zero returns, please use the ErrCode of each specific task.
    ErrCodeExt String

    Error code extension. A null string indicates success, while other values indicate failure.
    Message String

    Error message.
    Progress Integer

    Task progress, in the range of [0-100].
    Input AigcAudioTaskInput

    Input info of the AIGC audio task.
    Output AigcAudioTaskOutput

    AIGC audio task output information.

    AigcAudioTaskInput

    Input of the AIGC sound effect generation task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    ModelName String

    Model name.
    ModelVersion String

    Model version.
    SceneType String

    Scenario type. Values as follows:

  • When ModelName is Kling, value motion_control means action control;
  • Other ModelName not currently supported.

    		•
    Prompt String

    Prompt for video generation. Supports a maximum of 1000 characters. This parameter is required when FileInfos is empty.
    NegativePrompt String

    To prevent the model from generating video prompt content. Supports a maximum of 1000 characters.
    EnhancePrompt Boolean

    Whether to optimize Prompt content automatically. When Enabled, the passed in Prompt will be optimized automatically to enhance generation quality. Valid values:

  • Enabled: turn on;
  • Disabled: turn off;

    		•
    OutputConfig AigcAudioOutputConfig

    Output file of the AIGC image generation result.
    AdditionalParameters String

    Additional parameter

    AigcAudioTaskOutput

    Output message of the AIGC sound effect task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    AudioInfos Array of AigcAudioTaskOutputFileInfo

    Output audio content
    VideoInfos Array of AigcAudioTaskOutputFileInfo

    Output video information.

    AigcAudioTaskOutputFileInfo

    Output file information of the AIGC sound effect task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    StorageMode String

    Storage mode. Valid values:

  • Permanent: permanent storage;
  • Temporary: temporary storage;

    • Default value: Temporary
    MediaName String

    Output filename, up to 64 characters. Default filename is specified by the system. Valid when StorageMode is Permanent.
    ClassId Integer

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API. Valid when StorageMode is Permanent.
    ExpireTime String

    The expiry date of the output file. Files will be deleted longer than this time. Default is never expire, format according to ISO 8601. For details, see ISO date format description.
    FileType String

    File type, such as mp4 or flv.
    FileUrl String

    Media file playback address.
    FileId String

    Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData

    Output video meta information. Valid when StorageMode is Permanent.
    Duration Float

    Duration

    Unit: second

    AigcFaceIdentityInfo

    Human face identity information.

    Used by actions: DescribeAigcFaceInfo.

    Name Type Description
    FaceId String Face ID in the video. The same human face is considered a different ID when the interval in the middle of the video exceeds 1s.
    FaceImage String Schematic diagram of human face extracted from the video.
    StartTime Integer The starting time of the lip-sync interval can be used as the best start time for lip-sync. Unit: ms.
    EndTime Integer The end time of the lip-sync interval for this face. Note: This result may have millisecond-level deviation and could be longer than the actual interval end. Unit: ms.

    AigcFaceInfo

    AIGC human face information

    Used by actions: DescribeAigcFaceInfo.

    Name Type Description
    SessionId String Principal ID. Need to do it yourself to record the returned principal ID.
    FaceInfoList Array of AigcFaceIdentityInfo Face information list.

    AigcFaceInputFileInfo

    AIGC human face input file information

    Used by actions: DescribeAigcFaceInfo.

    Name Type Required Description
    Type String No Input video file type. Valid values:
  • File: On-demand media file;
  • Url: Accessible URL;
    		•
    FileId String No Media file ID, the globally unique identifier of this file in VOD, is assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification or VOD console. This parameter is valid when Type value is File.
    Url String No Accessible file URL. This parameter is valid when the Type value is Url.

    AigcImageOutputConfig

    Output media file configuration for the AIGC image generation task.

    Used by actions: CreateAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StorageMode String No

    Storage mode

    Enumeration value:

    • Temporary: Temporary storage. The generated video file will not be stored in VOD. You can obtain the temporary access URL from event notification. The valid period is 7 days.
    • Permanent: Permanent storage. The generated video file will be stored in VOD. You can obtain the FileId from event notification.

    Default value: Temporary
    MediaName String No

    Output filename, up to 64 characters. Default filename is specified by the system.
    ClassId Integer No

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.

  • Default value: 0, indicate other categories.
    		•
    ExpireTime String No

    The expiry date of the output file. The file will be deleted longer than this time. It defaults to no expiration, format according to ISO 8601 standard. For details, see ISO date format description.
    Resolution String No

    Resolution of the generated image. Available values for each model:

    • OG: 1K, 2K, 4K, default 1K;
    • GG 2.5: 1K, 2K, 4K, default 1K;
    • GG 3.0: 1K, 2K, 4K, default 1K;
    • GG 3.1: 512, 1K, 2K, 4K, default 1K;
    • Kling 2.1: 1k, 2k, default 1k;
    • Kling 3.0: 1k, 2k, default 1k;
    • Kling 3.0-Omni: 1k, 2k, 4k, default 1k;
    • Kling O1: 1k, 2k, 4k, default 1k;
    • SI 4.0: 1K, 2K, 4K, default 1K;
    • SI 4.5: 2K, 4K, default 2K;
    • SI 5.0-lite: 2K, 3K, default 2K;
    • Vidu q2: 1080p, 2K, 4K, default 1080p;
    • Hunyuan 3.0: This field is not currently supported. Set resolution via the ExtInfo field;
    • Qwen 0925: This field is not currently supported. Set resolution via the ExtInfo field;
    AspectRatio String No

    Specify the aspect ratio of the generated image.

    • OG: 1:1, 3:2, 2:3, 3:4, 4:3, 16:9, 9:16, 21:9, 9:21;
    • GG 2.5: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9;
    • GG 3.0: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9;
    • GG 3.1: 1:1, 1:4, 1:8, 2:3, 3:2, 3:4, 4:1, 4:3, 4:5, 5:4, 8:1, 9:16, 16:9, 21:9;
    • Kling 2.1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
    • Kling 3.0: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
    • Kling 3.0-Omni: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto;
    • Kling O1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto;
    • Vidu q2: 16:9, 9:16, 1:1, 3:4, 4:3, 21:9, 2:3, 3:2;
    • SI 4.0: unsupported. Use prompt to specify 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
    • SI 4.5: unsupported. Use prompt to specify 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
    • SI 5.0-lite: unsupported. Use prompt to specify 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
    • Hunyuan 3.0: unsupported;
    • Qwen 2.0: unsupported;
    • Qwen 0925: unsupported;
    PersonGeneration String No

    Whether to allow figure or human face generation. Valid values:

  • AllowAdult: Allow adult generation;
  • Disallowed: Forbid including figure or human face in the image;

    		•
    InputComplianceCheck String No

    Whether to enable compliance check for input content. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    OutputComplianceCheck String No

    Whether to enable compliance check for output content. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    OutputImageCount Integer No

    Number of images generated. Available values for each model:

    • Kling: value range 1-9;
    • OG: value range 1-8;

    Other models are disabled.
    OutputFormat String No

    Specify the image format of the model output. If not specified, it follows the default value of the model. Available values:

    • jpeg
    • png
    LogoAdd String No

    Indicates whether to enable the icon watermark. Default is Disabled. Valid values:

    • Enabled: Enable;
    • Disabled: Disable;

    AigcImageSceneInfo

    Scenario-Based AIGC image generation configuration.

    Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String Yes

    AI image generation scenario type. Available values:

    • change_clothes: Change clothes in regular scenes.
    • change_clothes_under: Change clothes in special scenarios.
    • change_clothes_top_wear: Change upper body clothes.
    • change_clothes_bottom_wear: Change lower body clothes.
    • change_clothes_full_wear: Change full body clothes.
    • product_image: AI-generated product image.
    • outpainting: AI image outpainting.
    ChangeClothesConfig ChangeClothesConfig No

    When the Type is one of the following column types, this item is required and represents the AI clothing change image generation config:

    • change_clothes
    • change_clothes_under
    • change_clothes_full_wear
    • change_clothes_top_wear
    • change_clothes_bottom_wear
    ProductImageConfig ProductImageConfig No

    Valid when Type is product_image, indicating AI-generated product image config.

    AigcImageTask

    AIGC image generation task info

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status. Value:

  • PROCESSING: Processing;
  • FINISH: Completed.

    		•
    ErrCode Integer

    Error code. A non-zero error code is returned back when a source error occurs. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Extended error codes. An empty string indicates success, other values indicate failure.

    Enumeration values:

    • RequestLimitExceeded: Model invocation exceeds the concurrency limit.
    • InvalidParameter.VoilationContent: The input prompt violates the Content Security Policy.
    • InvalidParameterValue: Parameter error.
    • FailedOperation: Model tasks accumulate.
    • InternalError: Internal error.
    Message String

    Error message.
    Progress Integer

    Task progress, with a value range of [0-100].
    Input AigcImageTaskInput

    Input of the AIGC image generation task.
    Output AigcImageTaskOutput

    Output information of the AIGC image generation task.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    AigcImageTaskInput

    Input of the AIGC image generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ModelName String

    Model name.
    ModelVersion String

    Model version.
    FileInfos Array of AigcImageTaskInputFileInfo

    File information for AIGC image generation task input.
    Prompt String

    Prompt for image generation. Supports up to 1000 characters. This parameter is required when FileInfos is empty.
    NegativePrompt String

    To prevent the model from generating images, set a prompt. Supports a maximum of 1000 characters.
    EnhancePrompt String

    Whether to optimize Prompt content automatically. When Enabled, the passed in Prompt will be optimized automatically to enhance generation quality. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    GenerationMode String

    Generation mode. Valid values:

  • Standard: standard mode;
  • Professional: high-quality mode;

    		•
    OutputConfig AigcImageOutputConfig

    Output result file for AIGC image generation.
    Seed Integer

    Random seed of the model.
    SceneType String

    Scenario type. Values as follows:

  • When ModelName is Hunyuan: 3d_panorama means Panoramic View;
  • Other ModelName is not currently supported.

    		•

    AigcImageTaskInputFileInfo

    AIGC image generation task input file information.

    Used by actions: CreateAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String No Input video file type. Valid values:
  • File: on-demand media file;
  • Url: accessible URL;
    		•
    FileId String No The media File ID of the image File, which is the globally unique identifier of the File in vod, is assigned by the vod backend after successful upload. you can get this field in the video upload completion event notification or vod console. this parameter is valid when the Type value is File.
    Description:.
    1. recommended for use: image less than 7 mb.
    2. Valid values of image format: jpeg, jpg, png, and webp.
    Url String No Accessible file URL. this parameter is valid when the Type value is URL.
    Description:.
    1. recommended for use: image less than 7 mb.
    2. Valid values of image format: jpeg, jpg, png, and webp.
    Text String No Description of the input image, used to help the model understand the image. valid for GEM 2.5 and GEM 3.0 only.

    AigcImageTaskOutput

    Output of the AIGC image generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileInfos Array of AigcImageTaskOutputFileInfo Output file information of the AIGC image generation task.

    AigcImageTaskOutputFileInfo

    Output file information of the AIGC image generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StorageMode String

    Storage mode. Valid values:

  • Permanent: permanent storage;
  • Temporary: temporary storage;

    		•
    MediaName String

    Output file name, up to 64 characters. Default filename is specified by the system. Valid when StorageMode is Permanent.
    ClassId Integer

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API. Valid at that time when StorageMode is Permanent.
    ExpireTime String

    The expiry date of the output file. The file will be deleted longer than this time. It defaults to no expiration, format according to ISO 8601 standard. For details, see ISO date format description.
    FileType String

    File type, such as png or jpg.
    FileUrl String

    Media file playback address.
    FileId String

    Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData

    Output image meta-information. Valid when StorageMode is Permanent.

    AigcUsageDataItem

    AIGC stats

    Used by actions: DescribeAigcUsageData.

    Name Type Description
    Specification String

    AIGC specification.
    Valid values:

  • Qwen2.0
  • Hunyuan3.0_1K
  • Hunyuan3.0_2K
  • Hunyuan3.0_4K
  • Mingmou1.0_1K
  • Mingmou1.0_2K
  • Mingmou1.0_4K
  • ViduQ2_T2i_1080P
  • ViduQ2_T2i_2K
  • ViduQ2_T2i_4K
  • ViduQ2_I2i_1080P
  • ViduQ2_I2i_2K
  • ViduQ2_I2i_4K
  • ViduQ2_Refer2i_1080P
  • ViduQ2_Refer2i_2K
  • ViduQ2_Refer2i_4K
  • Kling2.1_T2i_1K2K
  • Kling2.1_T2i_4K
  • Kling2.1_Refer2i_1K
  • Kling2.1_Refer2i_2K
  • Kling2.1_Refer2i_4K
  • Veo3.1Standard
  • Veo3.1Fast
  • Kling2.0&2.1std_720P
  • Kling2.0&2.1pro_1080P
  • Kling2.5pro_720P
  • Kling2.5pro_1080P
  • KlingO1_720P
  • KlingO1_1080P
  • KlingO1_NoVideo_720P
  • KlingO1_NoVideo_1080P
  • Kling2.6
  • Kling2.6Sound
  • Kling2.6MotionControl_720P
  • Kling2.6MotionControl_1080P
  • Kling3.0_720P
  • Kling3.0Sound_720P
  • Kling3.0CustomVoice_720P
  • Kling3.0_1080P
  • Kling3.0Sound_1080P
  • Kling3.0CustomVoice_1080P
  • Kling3.0CustomVoice_2K
  • Kling3.0CustomVoice_4K
  • Kling3.0MotionControl_720P
  • Kling3.0MotionControl_1080P
  • Kling3.0MotionControl_2K
  • Kling3.0MotionControl_4K
  • Kling_Avatar_I2v_720P
  • Kling_Avatar_I2v_1080P
  • Kling_Identifyface
  • Hailuo02&2.3_768P
  • Hailuo02&2.3_1080P
  • Hailuo2.3fast_768P
  • Hailuo2.3fast_1080P
  • ViduQ2_720P
  • ViduQ2_720P_OffPeak
  • ViduQ2_1080P
  • ViduQ2_1080P_OffPeak
  • ViduQ2_Refer_540P
  • ViduQ2_Refer_540P_OffPeak
  • ViduQ2_Refer_720P
  • ViduQ2_Refer_720P_OffPeak
  • ViduQ2_Refer_1080P
  • ViduQ2_Refer_1080P_OffPeak
  • ViduQ2pro_720P
  • ViduQ2pro_720P_OffPeak
  • ViduQ2pro_1080P
  • ViduQ2pro_1080P_OffPeak
  • ViduQ2pro_Refer_720P
  • ViduQ2pro_Refer_720P_OffPeak
  • ViduQ2pro_Refer_720P
  • ViduQ2pro_Refer_720P_OffPeak
  • ViduQ2pro_Refer_1080P
  • ViduQ2pro_Refer_1080P_OffPeak
  • ViduQ2turbo_720P
  • ViduQ2turbo_720P_OffPeak
  • ViduQ2turbo_1080P
  • ViduQ2turbo_1080P_OffPeak
  • ViduQ3_Refer_720P
  • ViduQ3_Refer_720P_OffPeak
  • ViduQ3_Refer_1080P
  • ViduQ3_Refer_1080P_OffPeak
  • ViduQ3_Refer_2K
  • ViduQ3_Refer_2K_OffPeak
  • ViduQ3_Refer_4K
  • ViduQ3_Refer_4K_OffPeak
  • ViduQ3pro_540P
  • ViduQ3pro_540P_OffPeak
  • ViduQ3pro_720P
  • ViduQ3pro_720P_OffPeak
  • ViduQ3pro_1080P
  • ViduQ3pro_1080P_OffPeak
  • ViduQ3turbo_540P
  • ViduQ3turbo_540P_OffPeak
  • ViduQ3turbo_720P
  • ViduQ3turbo_720P_OffPeak
  • ViduQ3turbo_1080P
  • ViduQ3turbo_1080P_OffPeak
  • ViduQ3turbo_2K
  • ViduQ3turbo_2K_OffPeak
  • ViduQ3turbo_4K
  • ViduQ3turbo_4K_OffPeak
  • Vidu_TemplateEffect
  • Hunyuan1.5_720P
  • Hunyuan1.5_1080P
  • Mingmou1.0_720P
  • Mingmou1.0_1080P
  • ImageProductImage
  • ImageChangeClothes
  • VideoProductShowcase
  • ImageOutPainting
  • FaceInfo
  • CustomVoice
  • Subject
  • unknown
    		•
    DataSet Array of TaskStatDataItem

    Usage data.

    AigcVideoOutputConfig

    Output media file configuration for AIGC video task.

    Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StorageMode String No

    Storage mode

    Enumeration value:

    • Temporary: Temporary storage. The generated video file will not be stored in VOD. You can obtain the temporary access URL from event notification. The valid period is 7 days.
    • Permanent: Permanent storage. The generated video file will be stored in VOD. You can obtain the FileId from event notification.

    Default value: Temporary
    MediaName String No

    Output media file name, up to 64 characters. Default filename is specified by the system.
    ClassId Integer No

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.

  • Default value: 0, indicate other categories.
    		•
    ExpireTime String No

    The expiry date of the output file. The file will be deleted longer than this time. It defaults to no expiration, format according to ISO 8601 standard. For details, see ISO date format description.
    Duration Float No

    Duration of the generated video, unit: seconds.

  • When ModelName is Kling, available values are 5 and 10, default is 5;
  • When ModelName is Hailuo, available values are 6 and 10, default is 6;
  • When ModelName is Vidu, specify 1-10;
  • When ModelName is GV, available values are 8, default is 8;
  • When ModelName is OS, available values are 4, 8, and 12, default is 8;
  • When ModelName is PixVerse, specify 1-15, default is 5;
    		•
    Resolution String No

    Resolution of the generated video.

  • When ModelName is Kling, available values are 720P and 1080P, default is 720P;
  • When ModelName is Hailuo, available values are 768P and 1080P, default is 768P;
  • When ModelName is Vidu, available values are 720P and 1080P, default is 720P;
  • When ModelName is GV, available values are 720P and 1080P, default is 720P;
  • When ModelName is OS, available value is 720P;
  • When ModelName is PixVerse, available values are 540p, 720p, 1080p, 2k, and 4k, default is 720p;
    		•
    AspectRatio String No

    Specify the aspect ratio of the generated video.

  • When ModelName is Kling, for text-to-video, the optional values are 16:9, 9:16, and 1:1, with a default value of 16:9.
  • When ModelName is Vidu, for text-to-video and reference image-to-video, the optional values are 16:9, 9:16, 4:3, 3:4, and 1:1. Only version q2 supports 4:3 and 3:4.
  • When ModelName is GV, the optional values are 16:9 and 9:16, with a default value of 16:9.
  • When ModelName is OS, for text-to-video, the optional values are 16:9 and 9:16, with a default value of 16:9.
  • When ModelName is Hailuo, this parameter is not currently supported.
  • When ModelName is PixVerse, the optional values are 16:9, 4:3, 1:1, 3:4, 9:16, 2:3, 3:2, and 21:9.
    		•
    AudioGeneration String No

    Whether to generate audio. Supported models include GV, OS, Vidu, Jimeng, and Kling.

    Enumeration value:

    • Enabled: Enable
    • Disabled: Disable

    Default value: Disabled
    PersonGeneration String No

    Whether to allow figure or human face generation. Valid values:

  • AllowAdult: Allow adult generation;
  • Disallowed: Forbid including figure or human face in the image;

    		•
    InputComplianceCheck String No

    Whether to enable compliance check for input content. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    OutputComplianceCheck String No

    Whether to enable compliance check for output content. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    EnhanceSwitch String No

    Whether to enable video enhancement. Valid values:

  • Enabled: Turn on;
  • Disabled: Turn off;

    • Description:

    1. For selected resolution exceeding the resolution the model can generate, enhancement is enabled by default.
    2. For resolutions the model can directly output, you can also proactively select the model to directly output low-resolution and use enhancement to obtain the specified resolution.
    OffPeak String No

    Whether peak shaving is enabled. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    FrameInterpolate String No

    Whether to enable vidu intelligent frame interpolation. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    LogoAdd String No

    Indicates whether to enable the icon watermark. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    • Currently supported models include Vidu. Other models are not supported.
    EnableBGM String No

    Whether to add background music to the generated video.

    Enumeration value:

    • Enabled: The system will automatically select suitable music from the preset BGM library and add it.
    • Disabled: Do not add BGM.

    Default value: Disabled

    AigcVideoRedrawOutputConfig

    Output media file config of the AIGC video conversion task.

    Used by actions: CreateAigcVideoRedrawTask, DescribeTaskDetail.

    Name Type Required Description
    StorageMode String No

    Storage mode. Valid values:

  • Permanent: permanent storage. The generated video file will be stored in VOD, and the FileId can be obtained in the event notification;
  • Temporary: temporary storage. The generated video file will not be stored in VOD, and the URL for temporary access can be obtained in the event notification;
    • Default value: Temporary
    MediaName String No

    Output media filename, up to 64 characters. Default filename is specified by the system.
    ClassId Integer No

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.

  • Default value: 0, indicating other categories.
    		•
    ExpireTime String No

    The expiry date of the output file. Files will be deleted longer than this time. Default is never expire, format according to ISO 8601. For details, see ISO date format description.

    Parameter format: 2025-12-28T00:35:00Z.

    AigcVideoRedrawOutputFileInfo

    Output file info of the AIGC video conversion task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    StorageMode String

    Storage mode. Valid values:

  • Permanent: permanent storage;
  • Temporary: temporary storage;
    • Default value: Temporary
    MediaName String

    Output filename, up to 64 characters. Default filename is specified by the system. Valid when StorageMode is Permanent.
    ClassId Integer

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API. Valid when StorageMode is Permanent.
    ExpireTime String

    The expiry date of the output file. Files will be deleted longer than this time. Default is never expire, format according to ISO 8601. For details, see ISO date format description.
    FileType String

    File type, such as mp4 or flv.
    FileUrl String

    Media file playback address.
    FileId String

    Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData

    Output video meta information. Valid when StorageMode is Permanent.

    AigcVideoRedrawTask

    AIGC video conversion task info

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status. Valid values:

  • PROCESSING: Processing;
  • FINISH: Completed.

    		•
    ErrCode Integer

    Error code. Returns a non-zero error code in case of source error. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Error code expansion.
    Message String

    Error message.
    Progress Integer

    Task progress, value ranges from 0 to 100.
    Input AigcVideoRedrawTaskInput

    Input information for AIGC video conversion task.
    Output AigcVideoRedrawTaskOutput

    Output information for AIGC video conversion task.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    AigcVideoRedrawTaskInput

    Input of the AIGC video conversion task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfo AigcVideoRedrawTaskInputFileInfo

    Input info of the AIGC video conversion task.
    OutputConfig AigcVideoRedrawOutputConfig

    AIGC video conversion output configuration.

    AigcVideoRedrawTaskInputFileInfo

    Input file info for AIGC video conversion tasks.

    Used by actions: CreateAigcVideoRedrawTask, DescribeTaskDetail.

    Name Type Required Description
    Type String No

    Input video file type. Valid values:

  • File: on-demand media file;
  • Url: accessible Url;

    		•
    FileId String No

    Media file ID, the globally unique identifier of this file in VOD, is assigned by the VOD backend after a successful upload. You can obtain this field in the video upload completion event notification or the VOD console. This parameter is valid when the Type value is File. Description: 1. Recommended image size is less than 10M. 2. Image format values: jpeg, jpg, png.
    Url String No

    Accessible file URL. This parameter is valid when Type value is Url. Description: 1. Recommended image less than 10M; 2. Image format value is jpeg, jpg, png.

    AigcVideoRedrawTaskOutput

    Output information of the AIGC video conversion task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfo AigcVideoRedrawOutputFileInfo

    Output file information for AIGC video conversion task.

    AigcVideoSceneInfo

    Scenario-based AIGC image generation configuration.

    Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

    Name Type Required Description
    Type String Yes AI video scenario type. Optional values:
    -product_showcase: Show the product in 360 degrees.
    ProductShowcaseConfig ProductShowcaseConfig No Product display parameter

    AigcVideoTask

    AIGC video generation task info

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status. Value:

  • PROCESSING: Processing;
  • FINISH: Completed.

    		•
    ErrCode Integer

    Error code. A non-zero error code is returned back when a source error occurs. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Extended error codes.

    Enumeration values:

    • RequestLimitExceeded: API call exceeds the concurrency limit.
    • InvalidParameter.VoilationContent: User-submitted input prompt violates the Content Security Policy.
    • InvalidParameterValue: Parameter error.
    • FailedOperation: Model tasks accumulate.
    • InternalError: Internal error.
    Message String

    Error message.
    Progress Integer

    Task progress, with a value range of [0-100].
    Input AigcVideoTaskInput

    Input of the AIGC video generation task.
    Output AigcVideoTaskOutput

    Output information of the AIGC video task.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    AigcVideoTaskInput

    Input of the AIGC video generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ModelName String

    Model name.
    ModelVersion String

    Model version.
    FileInfos Array of AigcVideoTaskInputFileInfo

    Input file information of the AIGC video generation task.
    SubjectInfos Array of AigcVideoTaskInputSubjectInfo

    Fixed entity input information for AIGC tasks.
    LastFrameFileId String

    Media file ID used as the end frame to generate video. This file has a globally unique ID on VOD, assigned by the VOD backend after successful upload. You can get this field in the video upload completion event notification or the VOD console.
    LastFrameUrl String

    Media file URL used as the tail frame to generate video. Description:

    1. Only support models GV, Kling, and Vidu. Other models are not currently supported. When ModelName is GV, if you specify this parameter, you must simultaneously specify FileInfos as the head frame for video generation. When ModelName is Kling, ModelVersion is 2.1, and output resolution Resolution is specified as 1080P, you can specify this parameter. When ModelName is Vidu and ModelVersion is q2-pro or q2-turbo, you can specify this parameter.
    2. Image size must be less than 5M.
      1. Image format value: jpeg, jpg, png, webp.
    Prompt String

    Prompt for video generation. Supports a maximum of 1000 characters. This parameter is required when FileInfos is empty.
    NegativePrompt String

    To prevent the model from generating video prompts. Supports a maximum of 1000 characters.
    EnhancePrompt String

    Whether to optimize Prompt content automatically. When enabled, the passed in Prompt will be optimized automatically to enhance generation quality. Valid values:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    GenerationMode String

    Generation mode. Valid values:

  • Standard: standard mode;
  • Professional: high-quality mode;

    		•
    OutputConfig AigcVideoOutputConfig

    Output the result file of the AIGC image generation.
    InputRegion String

    Region information of the input file. When the file url is an overseas address, selectable Oversea. Default Mainland.
    SceneType String

    Scenario type. Values as follows:

  • When ModelName is Kling, value motion_control means action control;
  • Other ModelName not currently supported.

    		•
    Seed Integer

    Random seed of the model.

    AigcVideoTaskInputFileInfo

    Image file info for AIGC video task input.

    Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String No

    Input video file type. Valid values:

  • File: On-demand media file;
  • Url: Accessible URL;

    		•
    Category String No

    File category. Value is:

    • Image: image. Note that the Usage field defines the image type.
    • Video: video.
    FileId String No

    Media file ID, the globally unique identifier of the file in VOD, is assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification or the VOD console. This parameter is valid when the Type value is File. Description:

    1. Images less than 10M are recommended;
    2. Image format values: jpeg, jpg, png.
    Url String No

    Accessible file URL. This parameter is valid when the Type value is URL.
    Description:

    1. Images less than 10M are recommended.
    2. Image format values: jpeg, jpg, png.
    Base64 String No
    ReferenceType String No

    Reference Type, applicable to GV, Kling, and PixVerse models.
    Note:
    When using the GV model, it can be used as a reference method, available values: asset means material, style means style;
    When using the Kling model and Category is Video, distinct reference video types can be identified, feature means feature reference video, base means video to be edited;
    When using the PixVerse model, applicable to multi-image (subject) reference generation mode, available values: subject means subject, background means background;
    ObjectId String No

    Usage: Vidu subject Id.
    Vidu subject Id: prompt can be used via @subject Id. Valid at that time when Category is Image.
    VoiceId String No

    Suitable for the Vidu-q2 model.
    When all images carry the subject Id, you can set the timbre Id targeting the subject. Valid when Category is Image. Supported timbre list: https://shengshu.feishu.cn/sheets/EgFvs6DShhiEBStmjzccr5gonOg
    KeepOriginalSound String No

    Whether to retain the original sound of the video. Valid when Category is Video. Values are as follows:

  • Enabled: Retain
  • Disabled: Not retain
    		•
    Usage String No

    Used to distinguish whether the input image is for first (last) frame to video, image to video, or reference to video. Available values:

    • FirstFrame: For first (last) frame to video or image to video;
    • Reference: For reference to video;

    Note: FirstFrame is selected by default
    Text String No

    Only the multi-image (subject) reference mode of the PixVerse model takes effect. Specify a name for the image to achieve more precise results. Usage: When the field value is "kitten", use @kitten in the Prompt to accurately describe the scenario. There must be a space after @Text, for example, @kitten run. The name referenced in the Prompt must be the same as the field value.

    AigcVideoTaskInputSubjectInfo

    Input information of the AIGC subject.

    Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Id String No

    Fixed subject Id.

    • Kling subject required;
    • Vidu subject selectable.
    Name String No

    Fixed name.

    • Vidu subject is required, can be used by adding [@name] in prompt. For example, when name is Xiao Ming, describe it as [@Xiao Ming] in prompt.
    • Kling subject is selectable.
    VoiceId String No

    Valid only for Vidu. Voice type ID is used to determine the sound timbre in the video. If left empty, the system will automatically recommend one.
    ImageUrls Array of String No

    Valid for Vidu only. Temporary subject images, up to 3 images
    Note 1: Support passing image URL (ensure it is accessible);
    Note 2: Images support png, jpeg, jpg, webp format;
    Note 3: Image pixel cannot be less than 128*128, and the ratio must be less than 1:4 or 4:1.
    VideoUrls Array of String No

    Valid for Vidu only. Temporary subject video, a maximum of one 5-second video. Note 1: Only the viduq2-pro model supports the use of video subject; Note 2: Supports up to one 5-second video upload; Note 3: Video supports mp4, avi, mov format; Note 4: Video pixel cannot be less than 128*128, and the ratio must be less than 1:4 or 4:1.

    AigcVideoTaskOutput

    Output info of the AIGC video generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileInfos Array of AigcVideoTaskOutputFileInfo Output file information of the AIGC video task.

    AigcVideoTaskOutputFileInfo

    Output file info of the AIGC video generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StorageMode String

    Storage mode. Valid values:

  • Permanent: permanent storage;
  • Temporary: temporary storage;

    • Default value: Temporary
    MediaName String

    Output file name, up to 64 characters. Default filename is specified by the system. Valid when StorageMode is Permanent.
    ClassId Integer

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API. Valid at that time when StorageMode is Permanent.
    ExpireTime String

    The expiry date of the output file. The file will be deleted longer than this time. It defaults to no expiration, format according to ISO 8601 standard. For details, see ISO date format description.
    FileType String

    File type, such as mp4 or flv.
    FileUrl String

    Media file playback address.
    FileContent String

    File content. Return value is available when UsageType is position_info.
    FileId String

    Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData

    Output video meta-information. Valid when StorageMode is Permanent.
    UsageType String

    Purpose type of the file.

    Enumeration value:

    • scene_url: 3D scene file. The FileUrl field has a return value.
    • point_url: Point cloud file. The FileUrl field has a return value.
    • mesh_url: Original grid model file. The FileUrl field has a return value.
    • mesh_simplified_url: Simplified grid model file. The FileUrl field has a return value.
    • position_info: Spatial position info of the scenario. The FileContent field has a return value.
    • image_url: Generated image. The FileUrl field has a return value.

    AnimatedGraphicTaskInput

    Animated image generating task type

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Animated image generating template ID
    StartTimeOffset Float Yes Start time offset of an animated image in the video, in seconds.
  • If this parameter is left empty or set to 0, the animated image will start at the same time as the video.
  • If this parameter is set to a positive number (n for example), the animated image will start at the nth second of the video.
  • If this parameter is set to a negative number (-n for example), the animated image will start at the nth second before the end of the video.
    		•
    EndTimeOffset Float Yes End time offset of an animated image in the video, in seconds.
  • If this parameter is left empty or set to 0, the animated image will end at the same time as the video.
  • If this parameter is set to a positive number (n for example), the animated image will end at the nth second of the video.
  • If this parameter is set to a negative number (-n for example), the animated image will end at the nth second before the end of the video.
    		•

    AnimatedGraphicsTemplate

    Details of an animated image generating template.

    Used by actions: DescribeAnimatedGraphicsTemplates.

    Name Type Description
    Definition Integer Unique ID of an animated image generating template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of an animated image generating template.
    Comment String Description of an animated image generating template.
    Width Integer Maximum value of the width (or long side) of an animated image in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    Height Integer Maximum value of the height (or short side) of an animated image in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    ResolutionAdaptive String Resolution adaption. Valid values:
  • open: enabled. In this case, Width represents the long side of a video, while Height the short side;
  • close: disabled. In this case, Width represents the width of a video, while Height the height.

    • Default value: open.
    Format String Animated image format.
    Fps Integer Frame rate.
    Quality Float Image quality.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.

    ArtifactRepairInfo

    Artifact removal (smoothing) configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable artifact removal. Valid values:
  • ON
  • `OFF
    		•
    Type String No The artifact removal type. This parameter is valid only if Switch is ON. Valid values:
  • weak
  • strong

    • Default value: weak.

    AsrFullTextConfigureInfo

    Control parameter of the speech full-text recognition task.
    Note: This parameter is no longer maintained. Use the AsrTranslateConfigure parameter to trigger speech translation recognition (when DstLanguage is empty or a fill-in string, no translation is performed, and the billing item matches full text recognition).

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Voice full-text recognition task switch. Available values:
  • ON: Enable intelligent voice full-text recognition task.
  • OFF: Disable the intelligent voice full-text recognition task.
    		•
    SubtitleFormats Array of String No Generated subtitle file format list. Leaving it as an empty array means no subtitle file will be generated. Available values:
  • vtt: Generate a WebVTT subtitle file.
  • srt: Generate SRT subtitle file.
    • Note: VOD media asset information only supports adding vtt subtitles. When and only when SubtitleFormats includes vtt, VOD will be generated subtitles add to media assets.
    SrcLanguage String No Media source language. Valid values:
  • zh: Mandarin;
  • en: English;
  • ja: Japanese;
  • zh-ca: Cantonese.

    • Note: Fill in an empty string or leave the parameter blank for automatic recognition (effectiveness difficult to guarantee. Recommended to fill in the language corresponding to the original media to improve recognition accuracy).
    SubtitleName String No Specify subtitle name. Length limit: 64 characters. This value will be used for player display. If left blank, VOD will auto generate.
    Note: This field is valid only when SubtitleFormats contains vtt.

    AsrFullTextConfigureInfoForUpdate

    Control parameter of full speech recognition task.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Voice full-text recognition task switch. Available values:
  • ON: enable intelligent voice full-text recognition task.
  • OFF: disable intelligent voice full-text recognition task
    		•
    SubtitleFormatsOperation SubtitleFormatsOperation No Subtitle format list operation information.
    SrcLanguage String No Media source language. Valid values:
  • zh: Mandarin;
  • en: English;
  • ja: Japanese;
  • zh-ca: Cantonese.
    		•
    SubtitleName String No Specify subtitle name. Length limit: 64 characters. This value will be used for player display.

    AsrTranslateConfigureInfo

    Speech translation recognition task control parameter

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Voice translation recognition task switch. Available values:
  • ON: enabled;
  • OFF: Disable.
    • Note: The speech translation recognition task itself will return ASR full-text recognition results. To avoid duplicate charges, it is forbidden to enable speech translation recognition and ASR full-text recognition functions simultaneously.
    SrcLanguage String No Media source language. This parameter is required when Switch is ON. Value ranges from...to...
  • zh: Chinese;
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • vi: Vietnamese;
  • ms: Malay.
  • th: Thai;
  • pt: Portuguese;
  • tr: Turkish;
  • ar: Arabic;
  • es: Spanish;
  • hi: Hindi;
  • fr: French.
    		•
    DstLanguage String No Translation target language. This parameter is valid when Switch is ON.
    If this parameter is left empty or filled with an empty string, it means that only full speech recognition is performed, and no translation is performed (the billing item matches that of AsrFullTextConfigure full speech recognition).
    Otherwise, the parameter value range is divided into the following cases:
    When SrcLanguage is zh (Chinese), the value ranges from...to...
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • fr: French;
  • es: Spanish;
  • it: Italian;
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese;
  • vi: Vietnamese;
  • id: Indonesian;
  • th: Thai;
  • ms: Malay.

    • When SrcLanguage is en (English), the value ranges from...to...
  • zh: Chinese;
  • ja: Japanese;
  • ko: Korean;
  • fr: French;
  • es: Spanish;
  • it: Italian;
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese;
  • vi: Vietnamese;
  • id: Indonesian;
  • th: Thai;
  • ms: Malay.
  • ar: Arabic;
  • hi: Hindi.

    • When SrcLanguage is ja (Japanese), the value ranges from...to...
  • zh: Chinese;
  • en: English;
  • ko: Korean.

    • When SrcLanguage is ko (Korean), the parameter value range is
  • zh: Chinese;
  • en: English;
  • ja: Japanese.

    • When SrcLanguage is vi (Vietnamese), ms (Malay), or th (Thai), the parameter value range is
  • zh: Chinese;
  • en: English.

    • When SrcLanguage is pt (Portuguese), the value ranges from...to...
  • zh: Chinese;
  • en: English;
  • fr: French;
  • es: Spanish;
  • it: Italian;
  • de: German;
  • tr: Turkish;
  • ru: Russian.

    • When SrcLanguage is tr (Turkish), the value ranges from...to...
  • zh: Chinese;
  • en: English;
  • fr: French;
  • es: Spanish;
  • it: Italian;
  • de: German;
  • ru: Russian;
  • pt: Portuguese.

    • When SrcLanguage is es (Spanish), the value ranges from...to...
  • zh: Chinese;
  • en: English;
  • fr: French;
  • it: Italian;
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese.

    • When SrcLanguage is ar (Arabic) or hi (Hindi), the value ranges from...to...
  • en: English.

    • When SrcLanguage is fr (French), the value ranges from...to...
  • zh: Chinese;
  • en: English;
  • es: Spanish;
  • it: Italian;
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese.
    		•
    SubtitleFormats Array of String No Generated subtitle file format list. Leaving it as an empty array means no subtitle file will be generated. Available values:
  • vtt: Generate a WebVTT subtitle file.
  • srt: Generate SRT subtitle file.
    • Note: VOD media asset information only supports adding vtt subtitles. When and only when SubtitleFormats includes vtt, VOD will add generated subtitles to media assets.
    SubtitleName String No Specify subtitle name. Length limit: 64 characters. This value will be used for player display. If left blank, VOD will auto generate.
    Note: This field is valid only when SubtitleFormats contains vtt.

    AsrTranslateConfigureInfoForUpdate

    Voice Translation Recognition Control Parameter

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Voice translation recognition task switch. Available values:
  • ON: enabled;
  • OFF: Disabled.
    • Note: The speech translation recognition task itself will return ASR full text recognition results. To avoid duplicate charges, it is forbidden to enable both speech translation recognition and ASR full text recognition feature items simultaneously.
    SrcLanguage String No Media source language. Valid values:
  • zh: Chinese.
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • vi: Vietnamese;
  • ms: Malay;
  • th: Thai;
  • pt: Portuguese;
  • tr: Turkish;
  • ar: Arabic;
  • es: Spanish;
  • hi: Hindi;
  • fr: French.
    		•
    DstLanguage String No Target language.
    If this parameter is filled in with an empty string, it means that only full speech recognition is performed without translation (the billing item is the same as AsrFullTextConfigure full speech recognition).
    Otherwise, the parameter value range is divided into the following cases:
    When SrcLanguage is zh (Chinese), the value ranges from...to...
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • fr: French;
  • es: Spanish;
  • it: Italian.
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese;
  • vi: Vietnamese;
  • id: Indonesian;
  • th: Thai;
  • ms: Malay.

    • When SrcLanguage is en (English), the value ranges from...to...
  • zh: Chinese.
  • ja: Japanese;
  • ko: Korean;
  • fr: French;
  • es: Spanish;
  • it: Italian.
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese;
  • vi: Vietnamese;
  • id: Indonesian;
  • th: Thai;
  • ms: Malay;
  • ar: Arabic;
  • hi: Hindi.

    • When SrcLanguage is ja (Japanese), the parameter value range is
  • zh: Chinese.
  • en: English;
  • ko: Korean.

    • When SrcLanguage is ko (Korean), the value ranges from...to...
  • zh: Chinese.
  • en: English;
  • ja: Japanese.

    • When SrcLanguage is vi (Vietnamese), ms (Malay), or th (Thai), the value ranges from...to...
  • zh: Chinese.
  • en: English.

    • When SrcLanguage is pt (Portuguese), the value ranges from...to...
  • zh: Chinese.
  • en: English;
  • fr: French;
  • es: Spanish;
  • it: Italian.
  • de: German;
  • tr: Turkish;
  • ru: Russian.

    • When SrcLanguage is tr (Turkish), the value ranges from...to...
  • zh: Chinese.
  • en: English;
  • fr: French;
  • es: Spanish;
  • it: Italian.
  • de: German;
  • ru: Russian;
  • pt: Portuguese.

    • When SrcLanguage is es (Spanish), the parameter value range is
  • zh: Chinese.
  • en: English;
  • fr: French;
  • it: Italian.
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese.

    • When SrcLanguage is ar (Arabic) or hi (Hindi), the value ranges from...to...
  • en: English.

    • When SrcLanguage is fr (French), the value ranges from...to...
  • zh: Chinese.
  • en: English;
  • es: Spanish;
  • it: Italian.
  • de: German;
  • tr: Turkish;
  • ru: Russian;
  • pt: Portuguese.
    		•
    SubtitleFormatsOperation SubtitleFormatsOperation No Subtitle format list operation information.
    SubtitleName String No Specify subtitle name. Length limit: 64 characters. This value will be used for player display.

    AsrWordsConfigureInfo

    Speech keyword recognition control parameter.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of speech keyword recognition task. Valid values:
  • ON: enables speech keyword recognition task;
  • OFF: disables speech keyword recognition task.
    		•
    LabelSet Array of String No Keyword filter tag, which specifies the keyword tag that needs to be returned. If this parameter is left empty, all results will be returned.
    There can be up to 10 tags, each with a length limit of 16 characters.

    AsrWordsConfigureInfoForUpdate

    Control parameter of speech keyword recognition.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of speech keyword recognition task. Valid values:
  • ON: enables speech keyword recognition task;
  • OFF: disables speech keyword recognition task.
    		•
    LabelSet Array of String No Keyword filter tag, which specifies the keyword tag that needs to be returned. If this parameter is left empty or a blank value is entered, all results will be returned.
    There can be up to 10 tags, each with a length limit of 16 characters.

    AudioBeautifyInfo

    Audio beautification configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Audio beautification control switch. Available values:
  • ON: enable audio beautification
  • OFF: disable audio beautification
    		•
    Types Array of String No Type. Multiple selections allowed. Valid values:
  • declick: noise removal
  • deesser: de-ess

    • Default value: declick.

    AudioDenoiseInfo

    Noise removal configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable noise removal. Valid values:
  • ON
  • OFF

    • Default value: OFF.
    Type String No Audio noise reduction type. Valid only when the audio noise reduction control switch is ON. Available values:
  • normal: normal audio noise reduction.

    • Default value: normal.

    AudioEnhanceConfig

    Audio enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Denoise AudioDenoiseInfo No Audio noise reduction configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    Separate AudioSeparateInfo No Audio separation configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    VolumeBalance AudioVolumeBalanceInfo No Volume equalization configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    Beautify AudioBeautifyInfo No Volume beautification configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    AudioSeparateInfo

    Audio separation configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Audio separation control switch. Available values:
  • ON: enable audio separation;
  • OFF: Disable audio separation.
    		•
    Type String No Scenario type. Valid values:
  • normal: Voice background sound scenario
  • music: Singing accompaniment scenario

    • Default value: normal.
    Track String No Output audio track. Available values:
  • vocal: output voice
  • Background: Output background audio when the scenario is normal, and output accompaniment when the scenario is music.

    • Default value: vocal.

    AudioTemplateInfo

    Audio stream configuration parameter

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Codec String Yes The audio codec.
    If Container is mp3, the valid value is:
  • libmp3lame

    • If Container is ogg or flac, the valid value is:
  • flac

    • If Container is m4a, the valid values are:
  • libfdk_aac
  • libmp3lame
  • ac3

    • If Container is mp4 or flv, the valid values are:
  • libfdk_aac (Recommended for MP4)
  • libmp3lame (Recommended for FLV)
  • mp2

    • If Container is hls, the valid value is:
  • libfdk_aac

    • If Format is HLS or MPEG-DASH, the valid value is:
  • libfdk_aac

    • If Container is wav, the valid value is:
  • pcm16
    		•
    Bitrate Integer Yes Bitrate of the audio stream, value ranges from 0 to [26, 256], measurement unit: kbps.
    When the value is 0, it means VOD automatically sets the bitrate.
    SampleRate Integer Yes The audio sample rate. Valid values:
  • 16000 (valid only if Codec is pcm16)
  • 32000
  • 44100
  • 48000

    • Unit: Hz.
    AudioChannel Integer No Audio channel system. Valid values:
  • 1: mono-channel
  • 2: dual-channel
  • 6: stereo

    • You cannot set the sound channel as stereo for media files in container formats for audios (FLAC, OGG, MP3, M4A).
    Default value: 2

    AudioTemplateInfoForUpdate

    Audio stream configuration parameter

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    Codec String No The audio codec.
    If Container is mp3, the valid value is:
  • libmp3lame

    • If Container is ogg or flac, the valid value is:
  • flac

    • If Container is m4a, the valid values are:
  • libfdk_aac
  • libmp3lame
  • ac3

    • If Container is mp4 or flv, the valid values are:
  • libfdk_aac (Recommended for MP4)
  • libmp3lame (Recommended for FLV)
  • mp2

    • If Container is hls, the valid value is:
  • libfdk_aac

    • If Format is HLS or MPEG-DASH, the valid value is:
  • libfdk_aac

    • If Container is wav, the valid value is:
  • pcm16
    		•
    Bitrate Integer No Bitrate of the audio stream, value ranges from 0 to [26, 256], measurement unit: kbps. When value is 0, it means VOD automatically sets bitrate.
    SampleRate Integer No The audio sample rate. Valid values:
  • 16000 (valid only if Codec is pcm16)
  • 32000
  • 44100
  • 48000

    • Unit: Hz.
    AudioChannel Integer No Audio channel system. Valid values:
  • 1: mono-channel
  • 2: dual-channel
  • 6: stereo

    • You cannot set the sound channel as stereo for media files in container formats for audios (FLAC, OGG, MP3, M4A).

    AudioTrackItem

    Audio segment information of audio track.

    Used by actions: ComposeMedia.

    Name Type Required Description
    SourceMedia String Yes Source of media material for audio segment, which can be:
  • ID of VOD media files
  • Download URL of other media files

    • Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
    SourceMediaStartTime Float No Start time of audio segment in material file in seconds. Default value: 0, which means to start capturing from the beginning position of the material.
    Duration Float No Audio segment duration in seconds. By default, the length of the material will be used, which means that the entire material will be captured.
    TargetDuration Float No The target audio duration, in seconds.
  • If TargetDuration is empty or 0, the target duration is the same as Duration.
  • If TargetDuration is a value greater than 0, the playback speed will be changed to make the final audio duration the same as the value of TargetDuration.
    		•
    AudioOperations Array of AudioTransform No Operation on audio segment, such as volume adjustment.
    Note: this field may return null, indicating that no valid values can be obtained.

    AudioTransform

    Audio operation

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes Audio operation type. Valid values:
  • Volume: volume adjustment.
    		•
    VolumeParam AudioVolumeParam No Audio volume adjustment parameter. Valid when Type = Volume.

    AudioVolumeBalanceInfo

    Volume equalization configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Volume equalization control switch. Available values:
  • ON: enable volume equalization;
  • OFF: Disable volume normalization.
    		•
    Type String No Type, available values:
  • loudNorm: Loudness normalization
  • gainControl: Reduce abrupt change

    • Default value: loudNorm.

    AudioVolumeParam

    Audio gain adjustment parameter

    Used by actions: ComposeMedia.

    Name Type Required Description
    Mute Integer No Whether to mute. Valid values: 0, 1.
  • 0: not muted.
  • 1: muted.

    • Default value: 0.
    Gain Float No Audio gain. Value range: 0-10.
  • If the value is greater than 1, the volume will be increased.
  • If the value is smaller than 1, the volume will be decreased.
  • 0 and 1: no change.

    • Default value: 0.

    Authentication

    Timestamp hotlink protection configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Anti-hotlink configuration switch, value:
  • on: on;
  • off: off.
    • TypeA AuthenticationTypeA No Configure timestamp hotlink protection mode A.
    TypeB AuthenticationTypeB No Timestamp hotlink protection mode B configuration.
    TypeC AuthenticationTypeC No Timestamp hotlink protection mode C configuration.
    TypeD AuthenticationTypeD No Timestamp hotlink protection mode D configuration.

    AuthenticationTypeA

    Configuration of timestamp anti-hotlinking mode A; The access URL format of timestamp anti-hotlinking mode A is: http://DomainName/Filename?sign=timestamp-rand-uid-md5hash; where timestamp is a decimal UNIX timestamp; rand is a random character String, consisting of 0 ~ 100 uppercase and lowercase letters and numbers; uid is 0; md5hash: MD5 (file path-timestamp-rand-uid-custom key).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes The key to calculate the signature; only uppercase and lowercase letters and numbers are allowed, with a length of 6~32 characters.
    SignParam String Yes Signature parameter name setting; only uppercase and lowercase letters, numbers or underscores are allowed, the length is 1~100 characters, and it cannot start with a number.
    ExpireTime Integer Yes Signature expiration time setting; the unit is seconds, and the maximum value can be set to 630720000.
    FileExtensions Array of String Yes File extension list settings for authentication/non-authentication; if the character * is included, it means all files.
    FilterType String Yes whitelist: whitelist, indicating that all types except the FileExtensions list will be authenticated; blacklist: blacklist, indicating that only the types in FileExtensions will be authenticated.
    BackupSecretKey String No Alternate key for calculating signature; only uppercase and lowercase letters and numbers are allowed, length 6~32 characters.

    AuthenticationTypeB

    Timestamp hotlink protection mode B configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes The key to calculate the signature; only uppercase and lowercase letters and numbers are allowed, with a length of 6~32 characters.
    ExpireTime Integer Yes Signature expiration time setting; the unit is seconds, and the maximum value can be set to 630720000.
    FileExtensions Array of String Yes File extension list settings for authentication/non-authentication; if the character * is included, it means all files.
    FilterType String Yes whitelist: whitelist, indicating that all types except the FileExtensions list will be authenticated; blacklist: blacklist, indicating that only the types in FileExtensions will be authenticated.
    BackupSecretKey String No Alternate key for calculating signature; only uppercase and lowercase letters and numbers are allowed, length 6~32 characters.

    AuthenticationTypeC

    Timestamp anti-hotlinking mode C configuration; The access URL format of timestamp anti-hotlinking mode C is: http://DomainName/md5hash/timestamp/FileName; where timestamp is a hexadecimal UNIX timestamp; md5hash: MD5 (custom password key + file path + timestamp).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes The key to calculate the signature; only uppercase and lowercase letters and numbers are allowed, with a length of 6~32 characters.
    ExpireTime Integer Yes Signature expiration time setting; the unit is seconds, and the maximum value can be set to 630720000.
    FileExtensions Array of String Yes File extension list settings for authentication/non-authentication; if the character * is included, it means all files.
    FilterType String Yes whitelist: whitelist, indicating that all types except the FileExtensions list will be authenticated; blacklist: blacklist, indicating that only the types in FileExtensions will be authenticated.
    TimeFormat String Yes Timestamp base setting:
  • dec: decimal
  • hex: hexadecimal
    		•
    BackupSecretKey String No Alternate key for calculating signature; only uppercase and lowercase letters and numbers are allowed, length 6~32 characters.

    AuthenticationTypeD

    Timestamp anti-hotlinking mode D configuration; The access URL format of timestamp anti-hotlinking mode D is: http://DomainName/FileName?sign=md5hash&t=timestamp; where timestamp is a decimal or hexadecimal UNIX timestamp; md5hash: MD5 (custom key + file path + timestamp).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes The key to calculate the signature; only uppercase and lowercase letters and numbers are allowed, with a length of 6~32 characters.
    ExpireTime Integer Yes Signature expiration time setting; the unit is seconds, and the maximum value can be set to 630720000.
    FileExtensions Array of String Yes File extension list settings for authentication/non-authentication; if the character * is included, it means all files.
    FilterType String Yes whitelist: whitelist, indicating that all types except the FileExtensions list will be authenticated; blacklist: blacklist, indicating that only the types in FileExtensions will be authenticated.
    SignParam String Yes Signature parameter name setting; only uppercase and lowercase letters, numbers or underscores are allowed, the length is 1~100 characters, and it cannot start with a number.
    TimeParam String Yes Timestamp parameter name setting; only uppercase and lowercase letters, numbers or underscores are allowed, the length is 1~100 characters, and it cannot start with a number.
    TimeFormat String Yes Timestamp base setting:
  • dec: decimal
  • hex: hexadecimal
    		•
    BackupSecretKey String No Alternate key for calculating signature; only uppercase and lowercase letters and numbers are allowed, length 6~32 characters.

    AwsPrivateAccess

    Origin access authentication for S3 bucket.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes AWS S3 return-to-origin authentication configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No BucketName.

    BlackWhiteEdgeConfigureInfo

    Control parameters for video screen black border, white border, black screen, and white screen detection.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video screen black border, white border, black screen, white screen detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • BlackWhiteEdgeConfigureInfoForUpdate

    Control parameters for video screen black border, white border, black screen, and white screen detection.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video screen black border, white border, black screen, white screen detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • BlindWatermarkInput

    Digital watermark parameter type in the MPS task.

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Digital watermark template ID.

    BlindWatermarkTemplate

    Digital watermark template details.

    Used by actions: DescribeBlindWatermarkTemplates.

    Name Type Description
    Definition Integer Unique identifier of the digital watermark template.
    Type String Digital watermark type. Valid values:
  • blind-basic: basic copyright digital watermark;
  • blind-nagra: NAGRA forensics watermark.
    		•
    Name String Digital watermark template name.
    TextContent String Text content of the digital watermark template. The length cannot exceed 64 characters.
    Comment String Description information of the digital watermark template.
    CreateTime String Creation time of the digital watermark template in ISO date and time format.
    UpdateTime String Last modification time of the digital watermark template in ISO date and time format.

    BlurConfigureInfo

    Control parameters for video blur detection.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video screen blur detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • BlurConfigureInfoForUpdate

    Control parameters for video blur detection.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video screen blur detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • CDNCertInfo

    Domain https acceleration configuration, the default is off

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    CertId String No The server certificate ID is automatically generated during certificate hosting by SSL Certificate Management.
    Certificate String No Server certificate information.
    PrivateKey String No Server key information.
    ExpireTime Timestamp ISO8601 No Certificate expiration time; no need to fill in when configured as an input parameter.

    CDNDomainConfig

    CDN Domain Config

    Used by actions: CreateCDNDomain, DescribeCDNDomains.

    Name Type Required Description
    Area String Yes Domain name acceleration areas:
  • mainland: acceleration within China;
  • overseas: acceleration outside China;
  • global: global acceleration.
    • Origin Origin Yes Origin server configuration.
    IpFilter IpFilter No IP allowlist/blocklist configuration.
    UserAgentFilter UserAgentFilter No UA Blocklist/Allowlist Configuration.
    FollowRedirect FollowRedirect No 301/302 origin follow configuration.
    RequestHeader RequestHeader No Request header configuration.
    ResponseHeader ResponseHeader No Response header configuration.
    Cache Cache No Cache expiration time settings.
    Https Https No Https configuration.
    Authentication Authentication No Timestamp hotlink protection configuration.
    ForceRedirect ForceRedirect No Access protocol force redirection configuration.
    Referer Referer No Referer Anti-leech Configuration.
    MaxAge MaxAge No Browser cache configuration.
    Ipv6Access Ipv6Access No Ipv6 access configuration
    Quic Quic No Quic access configuration.
    AwsPrivateAccess AwsPrivateAccess No AWS S3 origin authentication configuration.
    OssPrivateAccess OssPrivateAccess No Alibaba Cloud OSS authentication configuration.
    HwPrivateAccess HwPrivateAccess No Huawei cloud object storage back-to-origin authentication configuration.
    OthersPrivateAccess OthersPrivateAccess No Authentication configuration for cross-origin access to object storage of other vendors.

    CDNDomainConfigForUpdate

    CDN domain config for update

    Used by actions: ModifyCDNDomainConfig.

    Name Type Required Description
    Area String No Domain name acceleration areas:
  • mainland: acceleration within China;
  • overseas: acceleration outside China;
  • global: global acceleration.
    • Origin Origin No Origin Server Configuration.
    IpFilter IpFilter No IP blocklist/allowlist configuration. This is disabled by default.
    UserAgentFilter UserAgentFilter No UserAgent:blacklist/whitelist configuration.
    FollowRedirect FollowRedirect No Back to the source 301/302 status code automatically follows the configuration, the default is off
    RequestHeader RequestHeader No Custom request header configuration. This is disabled by default.
    ResponseHeader ResponseHeader No Custom response header configuration. This is disabled by default.
    Cache Cache No Node cache expiration time configuration.
    Https Https No Domain name HTTPS acceleration configuration. This is disabled by default.
    Authentication Authentication No Timestamp hotlink protection configuration.
    ForceRedirect ForceRedirect No Access protocol forced redirect configuration. This is disabled by default.
    Referer Referer No Referer blacklist/whitelist configuration. This is disabled by default.
    MaxAge MaxAge No Browser cache rule configuration, which is used to set the default value of MaxAge and is disabled by default.
    Ipv6Access Ipv6Access No IPv6 access configuration.
    Quic Quic No QUIC configuration item.
    AwsPrivateAccess AwsPrivateAccess No Origin access authentication for S3 bucket.
    OssPrivateAccess OssPrivateAccess No Access authentication configuration for OSS origin.
    HwPrivateAccess HwPrivateAccess No Access authentication for Huawei Cloud OBS origin
    OthersPrivateAccess OthersPrivateAccess No Origin-pull authentication for other origins.

    CDNDomainInfo

    CDN domain name information

    Used by actions: DescribeCDNDomains.

    Name Type Description
    Domain String Domain.
    DeployStatus String Deployment status.
    Cname String Cname record.
    CreateTime String Create Time
    Config CDNDomainConfig cdn domain configuration information.

    CLSLogsetInfo

    Used by actions: DescribeCLSLogsets.

    Name Type Description
    LogsetId String
    LogsetName String

    CLSTopicInfo

    Used by actions: DescribeCLSTopics.

    Name Type Description
    TopicId String Log topic ID.
    TopicName String Log topic name.
    LogsetId String Log Set ID.

    Cache

    Node cache expiration time configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleCache Array of RuleCache No Path cache configuration.

    CacheConfigCache

    Path cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Path cache configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • CacheTime Integer Yes Cache expiration time settings
  • Unit: second. The maximum value is 365 days.
    		•
    CompareMaxAge String Yes Advanced cache expiration configuration. When enabled, the max-age value returned by the origin site will be compared with the cache expiration time set in CacheRules, and the minimum value will be used to cache the node. Values:
  • on: enabled;
  • off: off.
    • IgnoreCacheControl String Yes Force caching, values:
  • on: on;
  • off: off.
    • IgnoreSetCookie String Yes When the origin site returns the Set-Cookie header, whether the node caches the header and body:
  • on: on, does not cache the header and body;
  • off: off, follows user customization Node caching rules.

    • CacheConfigFollowOrigin

    Path cache configuration follows the origin server configuration.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes The path cache follows the origin site configuration switch. The values u200bu200bare:
  • on: on;
  • off: off.
    • HeuristicCache HeuristicCache No Heuristic cache configuration.

    CacheConfigNoCache

    Path cache/no cache configuration.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Path cache does not cache configuration configuration switch, value:
  • on: on;
  • off: off.
    • Revalidate String Yes Always return to the origin site for verification, value:
  • on: on;
  • off: off.

    • Canvas

    Canvas information. When a video is composed, if the source material (video or image) cannot fill the output video window, the background will be drawn with the set canvas.

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Color String No Background color. Valid values:
  • Black: black background
  • White: white background

    • Default value: Black.
    Width Integer No Canvas width, that is, the width of the output video, value range: 0~3840, unit: px.
    Default value: 0, which means the video width is the same as the first video clip of the first video track.
    Height Integer No Canvas height, that is, the height (or long side) of the output video, value range: 0~3840, unit: px.
    Default value: 0, which means the video height is consistent with the first video clip of the first video track.

    CdnLogInfo

    CDN log information

    Used by actions: DescribeCdnLogs.

    Name Type Description
    Date String

    Date the log belongs to, format: yyyy-MM-dd, for example 2018-03-01.
    Name String

    Log name, format: date hr-domain name
    For example, example.com.
    Url String

    Log download link, valid for 24 hours.
    StartTime String

    Log start time, in ISO date format.
    EndTime String

    Log end time. Use the ISO date format.

    ChangeClothesConfig

    AI outfit change parameter configuration.

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    ClothesFileInfos Array of SceneAigcImageTaskInputFileInfo No

    Input the image list of clothing that need to be replaced. Maximum support for each kind:

    • change_clothes: 4 images;
    • change_clothes_under: 1 image;
    • change_clothes_full_wear: 1 image;
    • change_clothes_top_wear: 1 image;
    • change_clothes_bottom_wear: 1 image;
    Prompt String No

    Prompt for AI clothing change. Valid only when Type is change_clothes.

    ClassificationConfigureInfo

    Control parameter of intelligent categorization task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Switch of intelligent categorization task. Valid values:
  • ON: enables intelligent categorization task;
  • OFF: disables intelligent categorization task.
    		•

    ClassificationConfigureInfoForUpdate

    Control parameter of intelligent categorization task

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No Switch of intelligent categorization task. Valid values:
  • ON: enables intelligent categorization task;
  • OFF: disables intelligent categorization task.
    		•

    ClipFileInfo2017

    Information of file generated by video clipping (v2017)

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error description.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String Output target file ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileUrl String Output target file address.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileType String Output target file type.
    Note: this field may return null, indicating that no valid values can be obtained.

    ClipTask2017

    The details of a video editing task. This parameter is only valid for tasks initiated by the v2017 video editing API.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Video clipping task ID.
    SrcFileId String ID of source file for video clipping task.
    FileInfo ClipFileInfo2017 Information of file output by video clipping.

    ColorEnhanceInfo

    Color enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable color enhancement. Valid values:
  • ON
  • OFF
    		•
    Type String No The color enhancement type. This parameter is valid only if Switch is ON.
  • weak
  • normal
  • strong

    • Default value: weak.

    ComplexAdaptiveDynamicStreamingTask

    Adaptive bitrate task information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
  • PROCESSING: Processing;
  • FINISH: completed

    		•
    ComplexAdaptiveDynamicStreamingTaskResultSet Array of ComplexAdaptiveDynamicStreamingTaskResult Task execution status and results of adaptive bitrate streaming. Each element corresponds to an adaptive bitrate template.

    ComplexAdaptiveDynamicStreamingTaskAudioInput

    Input parameter of multilingual audio stream for adaptive bitrate streaming.

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask.

    Name Type Required Description
    FileId String Yes

    Media ID of the audio source. The first audio stream in the media source file is used by default. The video stream and other audio streams (if any) will be ignored.
    Name String Yes

    Name of the audio stream in the output adaptive bitrate stream. Length limit is 16 characters.
    Language String Yes

    The language of the audio stream in the output adaptive bitrate stream, with a length limit of 16 characters. It must comply with RFC5646.
    Default String No

    Set as default audio for adaptive bitrate. Value:

  • YES: Set as default audio;
  • NO: Do not set as default audio (default value).
    		•
    AudioTrackIdx Integer No

    Audio track serial number, which means selecting the nth audio track in the audio source, counting begins from 0. Default value is 0, means selecting the audio track positioned towards the front.

    ComplexAdaptiveDynamicStreamingTaskInput

    Input parameters of the adaptive bitrate streaming task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StreamPara ComplexAdaptiveDynamicStreamingTaskStreamPara Yes Adaptive Bitrate Parameters.

    ComplexAdaptiveDynamicStreamingTaskOutput

    Output result of adaptive bitrate streaming.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer Adaptive bitrate template ID.
    Format String Adaptive bitrate stream packaging format. Optional values:
  • HLS;
  • MPEG-DASH.
    		•
    DrmType String DRM solution type. Available values:
  • Empty string: Unencrypted.
  • SimpleAES;
  • Widevine;
  • FairPlay.
    		•
    Url String Playback address of the adaptive bitrate stream.

    ComplexAdaptiveDynamicStreamingTaskResult

    Adaptive bitrate task information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values:
  • PROCESSING: Processing;
  • SUCCESS: Completed;
  • FAIL: Failed.
    		•
    ErrCodeExt String Error code. An empty string indicates success, and additional values indicate failure. For values, see the video processing error code list (https://www.tencentcloud.com/document/product/266/50368?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String Error message.
    Progress Integer Transcoding progress, with a value range of [0-100].
    Input ComplexAdaptiveDynamicStreamingTaskInput Input of adaptive bitrate streaming.
    Output ComplexAdaptiveDynamicStreamingTaskOutput Output of adaptive bitrate streaming.

    ComplexAdaptiveDynamicStreamingTaskStreamPara

    Stream parameters of the adaptive bitrate streaming task.

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Definition Integer Yes Adaptive bitrate template ID.

    ComplexAdaptiveDynamicStreamingTaskSubtitleInput

    Input parameter of adaptive bitrate task multilingual subtitles.

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask.

    Name Type Required Description
    Id String Yes Subtitle ID. The subtitle must belong to the input main media of the adaptive bitrate task.
    Default String No Set as the default subtitle for adaptive bitrate. Value:
  • YES: Set as default subtitle;
  • NO: Not set as default subtitle (default value).
    		•

    ComposeMediaOutput

    Information of output media file.

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    FileName String Yes Filename of up to 64 characters.
    Description String No Description, which can contain up to 128 characters.
    ClassId Integer No Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API.
  • Default value: 0, which means "Other".
    		•
    ExpireTime String No Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format.
    Container String No Container. Valid values: mp4, mp3. mp3 is for audio files.
    VideoStream OutputVideoStream No Information of output video.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioStream OutputAudioStream No Information of output audio.
    Note: this field may return null, indicating that no valid values can be obtained.
    RemoveVideo Integer No Whether to remove video data. Valid values:
  • 0: retain
  • 1: remove

    • Default value: 0.
    RemoveAudio Integer No Whether to remove audio data. Valid values:
  • 0: retain
  • 1: remove

    • Default value: 0.

    ComposeMediaTask

    Media file composing task information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.

    • Note: this field may return null, indicating that no valid values can be obtained.
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer Progress of a media file composing task. Value range: [0, 100]
    Input ComposeMediaTaskInput Input of the media file creation task.
    Output ComposeMediaTaskOutput Output of the media file creation task.
    MetaData MediaMetaData The metadata of the output video.
    Note: This field may return null, indicating that no valid value was found.
    SessionId String ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is not carried or is left empty, no deduplication will be performed.
    SessionContext String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this parameter. It can contain up to 1000 characters.

    ComposeMediaTaskInput

    Input of media file composing task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tracks Array of MediaTrack List of input media tracks, i.e., information of multiple tracks composed of video, audio, image, and other materials.
    Canvas Canvas Canvas used for composing video file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Output ComposeMediaOutput Information of output media file.

    ComposeMediaTaskOutput

    Output of media file composing task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String File type, such as mp4 and mp3.
    FileId String Media file ID.
    FileUrl String Media file playback address.
    MediaName String Filename of up to 64 characters.
    ClassId Integer Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API.
  • Default value: 0, which means "Other".
    		•
    ExpireTime String Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format.

    ConcatFileInfo2017

    Information of source file for video splicing (v2017)

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String ID of source file for video splicing.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileUrl String Address of source file for video splicing.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileType String Format of source file for video splicing.
    Note: this field may return null, indicating that no valid values can be obtained.

    ConcatTask2017

    The details of a video splicing task. This parameter is only valid for tasks initiated by the v2017 video splicing API.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Video splicing task ID.
    FileInfoSet Array of ConcatFileInfo2017 Information of source file for video splicing.

    ContentReviewTemplateItem

    Intelligent recognition template details

    Used by actions: DescribeContentReviewTemplates.

    Name Type Description
    Definition Integer Unique ID of an intelligent recognition template
    Name String Name of an intelligent recognition template. Max 64 characters
    Comment String Description of an intelligent recognition template. Max 256 characters
    PornConfigure PornConfigureInfo Authentication involves control parameters for offensive information.
    TerrorismConfigure TerrorismConfigureInfo Authentication involves control parameters for unsafe information.
    PoliticalConfigure PoliticalConfigureInfo Authentication involves control parameters for inappropriate information.
    ProhibitedConfigure ProhibitedConfigureInfo Prohibited control parameters. Prohibited content includes:
  • Abuse;
  • Drug-related illegal activities.
    		•
    UserDefineConfigure UserDefineConfigureInfo Customize video moderation control parameters.
    ReviewWallSwitch String Whether to subject the recognition result to human review
  • ON
  • OFF
    		•
    ScreenshotInterval Float Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.

    CopyRightWatermarkInput

    Copyright watermark parameters

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Text String Yes Copyright information, maximum length is 200 characters.

    CoverBySnapshotTaskInput

    Input parameter type of cover generating task

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Time point screencapturing template ID.
    PositionType String Yes Screencapturing mode. Valid values:
  • Time: screencaptures by time point
  • Percent: screencaptures by percentage
    		•
    PositionValue Float Yes Screenshot position:
  • For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
  • For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
    		•
    WatermarkSet Array of WatermarkInput No List of up to 10 image or text watermarks.
    Note: this field may return null, indicating that no valid values can be obtained.

    CoverBySnapshotTaskOutput

    Output type of cover generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    CoverUrl String Cover URL.

    CoverConfigureInfo

    Control parameter of intelligent cover generating task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Switch of intelligent cover generating task. Valid values:
  • ON: enables intelligent cover generating task;
  • OFF: disables intelligent cover generating task.
    		•

    CoverConfigureInfoForUpdate

    Control parameter of intelligent cover generating task

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No Switch of intelligent cover generating task. Valid values:
  • ON: enables intelligent cover generating task;
  • OFF: disables intelligent cover generating task.
    		•

    CrashScreenConfigureInfo

    Control parameters for video screen blur detection.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video screen distortion detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • CrashScreenConfigureInfoForUpdate

    Control parameters for video screen blur detection.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video screen distortion detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • CreateAigcAdvancedCustomElementInput

    Create custom input.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    ElementName String

    Subject name.
    ElementDescription String

    Subject description.
    ReferenceType String

    Subject reference method.
    ElementVoiceId String

    Main voice type.
    ElementVideoList String

    Reference video.
    ElementImageList String

    Subject reference diagram.
    TagList String

    Subject configuration tag.

    CreateAigcAdvancedCustomElementOutput

    Create custom callback output

    Used by actions: DescribeTaskDetail.

    Name Type Description
    InfoList Array of AdvancedElementInfo

    Custom subject list.

    CreateAigcAdvancedCustomElementTask

    Create custom subject task info.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status.

    Enumeration value:

    • PROCESSING: Processing
    • FINISH: Completed
    ErrCode Integer

    Error code. A non-zero error code is returned back when a source error occurs. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Extended error code. A null string indicates success, other values indicate failure.
    Message String

    Error message.
    Progress Integer

    Task progress, with a value range of [0-100].
    Input CreateAigcAdvancedCustomElementInput

    Input of the task to create a custom AIGC subject.
    Output CreateAigcAdvancedCustomElementOutput

    Create custom AIGC task output information.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    CreateAigcAudioCloneInput

    Create AIGC voice clone input.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    AudioFileInfo AigcAudioCloneInputFileInfo

    The original audio file. The model will clone the voice type based on the audio timbre passed in this parameter as an example.
    VoiceId String

    Custom voice ID.
    Text String

    Clone audition parameters.
    PromptAudioFileInfo AigcAudioCloneInputFileInfo

    Example audio for voice replication.
    PromptText String

    Text content of the sample audio.
    Payload String

    Pass-through parameter.

    CreateAigcAudioCloneOutput

    Create AIGC voice clone output information.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    State String

    Processing status.
    VoiceId String

    voice_id customized by users. Do not return if the task fails.
    DemoAudio String

    If the audition text is passed in the request body, this parameter returns the audio audition in link format, otherwise this parameter is empty.
    Payload String

    Pass-through parameter passed in this call.
    CreatedAt String

    Task creation time.

    CreateAigcAudioCloneTask

    Create AIGC voice clone task info.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status. Valid values:

  • PROCESSING: Processing;
  • FINISH: Completed.

    		•
    ErrCode Integer

    Error code. Returns a non-zero error code in case of a source error. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Error code expansion. A null string indicates success, while other values indicate failure.
    Message String

    Error message.
    Progress Integer

    Task progress, value ranges from 0 to 100.
    Input CreateAigcAudioCloneInput

    Input information for the AIGC audio clone task.
    Output CreateAigcAudioCloneOutput

    Output information for the AIGC audio clone task.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    CreateAigcCustomVoiceInput

    Create custom voice type callback input.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    VoiceName String

    Timbre name.
    VoiceUrl String

    Access link for the voice type data file.
    VideoId String

    History works ID. Audio material can be provided by referring to historic works.

    CreateAigcCustomVoiceOutput

    Create custom voice type callback output.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    InfoList Array of CustomVoiceInfo

    Custom timbre list.

    CreateAigcCustomVoiceTask

    Create custom voice type task info.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status.

    Enumeration value:

    • PROCESSING: Processing
    • FINISH: Completed
    ErrCode Integer

    Error code. A non-zero error code is returned back when a source error occurs. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Extended error code. A null string indicates success, other values indicate failure.
    Message String

    Error message.
    Progress Integer

    Task progress, with a value range of [0-100].
    Input CreateAigcCustomVoiceInput

    Create AIGC custom timbre input.
    Output CreateAigcCustomVoiceOutput

    Create custom voice type output message for AIGC.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    CreateAigcSubjectInput

    Create subject input message.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SubjectName String

    Subject name.
    SubjectImages Array of String

    Subject image.
    SubjectVideos Array of String

    Main video.
    VoiceId String

    Primary voice ID.

    CreateAigcSubjectOutput

    Create subject output message.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SubjectId String

    Subject ID.
    SubjectInfo String

    Entity information.

    CreateAigcSubjectTask

    Create subject task info.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String

    Task ID.
    Status String

    Task status.

    Enumeration value:

    • PROCESSING: Processing
    • FINISH: Completed
    ErrCode Integer

    Error code. A non-zero error code is returned back when a source error occurs. Please use the ErrCode of each specific task when 0 is returned.
    ErrCodeExt String

    Extended error code. A null string indicates success, other values indicate failure.
    Message String

    Error message.
    Input CreateAigcSubjectInput

    Input of the task to create an AIGC subject.
    Output CreateAigcSubjectOutput

    Output of the task to create an AIGC subject.
    SessionId String

    Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String

    Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

    CreateImageSpriteTask2017

    The details of an image sprite task. This parameter is only valid for tasks initiated by the v2017 image sprite API.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Image sprite generating task ID.
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String ID of generated image sprite file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Definition Integer Image sprite specification. For more information, please see Image Sprite Generating Template.
    Note: this field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of subimages in image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageSpriteUrlSet Array of String Address of output image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    WebVttUrl String Address of WebVtt file for the position-time relationship among subimages in an image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.

    CustomVoiceInfo

    Custom tone information.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    VoiceId String

    Voice ID.
    VoiceInfo String

    Tone information.

    DNSVerifyInfo

    DNS verification information

    Used by actions: CreateDomainVerifyRecord.

    Name Type Description
    SubDomain String sub-parsing.
    Record String parse value.
    RecordType String parsing type.

    DescribeFileAttributesTask

    The information of a task to get file attributes.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCode Integer The error code. 0 indicates the task is successful. Other values indicate that the task failed.
  • 40000: Invalid input parameter.
  • 60000: Source file error (e.g., video data is corrupted).
  • 70000: Internal server error. Please try again.
    		•
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Message String The error message.
    Progress Integer The task progress. Value range: 0-100.
    FileId String The file ID
    Output DescribeFileAttributesTaskOutput The output of the task to get file attributes.
    Note: This field may return null, indicating that no valid values can be obtained.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.

    DescribeFileAttributesTaskOutput

    The output of a task to get file attributes.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Md5 String The MD5 hash of the file.
    Sha1 String The Sha1 value of the media file.

    DiffusionEnhanceInfo

    LLM enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Large model enhancement switch. Available values:
  • ON: enabled
  • OFF: disabled
    		•
    Type String No Intensity type. Valid only when the large model enhancement control switch is ON. Value range:
  • weak: weak;
  • NORMAL: The scaling group is normal.
  • strong: strong.

    • Default value: normal.

    DomainDetailInfo

    Domain name information

    Used by actions: DescribeVodDomains.

    Name Type Description
    Domain String

    Domain name.
    AccelerateAreaInfos Array of AccelerateAreaInfo

    Acceleration region information.
    DeployStatus String

    Deployment state. Valid values:

  • Online: Goes live.
  • Deploying: Deployment in progress.
  • Locked: Locked. When this state occurs, unable to perform deployment change on that domain name.
    		•
    HTTPSConfig DomainHTTPSConfig

    HTTPS configuration message.
    UrlSignatureAuthPolicy UrlSignatureAuthPolicy

    Key hotlink protection configuration message.
    RefererAuthPolicy RefererAuthPolicy

    Referer hotlink protection configuration message.
    CreateTime String

    The time when the domain name is added to the Tencent Cloud VOD system.

  • Format according to ISO 8601 standard. For details, see ISO date format description.
    		•
    QUICConfig DomainQUICConfig

    Domain name QUIC configuration message.
    IPFilterPolicy IPFilterPolicy

    IP access restriction configuration message.
    Type String

    Domain type. Valid values:

  • VOD: Domain name distributed by using the VOD product;
  • EdgeOne: Domain name distributed by using the EdgeOne product.

    		•

    DomainHTTPSConfig

    HTTPS configuration information of the domain name

    Used by actions: DescribeVodDomains.

    Name Type Required Description
    CertExpireTime String Yes

    Certificate expiration time.

  • Format according to ISO 8601 standard. For details, see ISO date format description.

    • Parameter format: YYYY-MM-DDThh:mm:ss+08:00
    CloudCertId String No

    Certificate ID in Tencent Cloud SSL product.

    DomainQUICConfig

    The QUIC configuration of a domain.

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes The QUIC status. Valid values:
  • Enabled
  • Disabled
    		•

    DrmStreamingsInfo

    DRM-protected adaptive bitstream playback information

    Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs.

    Name Type Required Description
    SimpleAesDefinition Integer No ID of the adaptive bitrate streaming template whose protection type is SimpleAES.
    WidevineDefinition Integer No The ID of the adaptive bitrate streaming template that encrypts the streams by Widewine.
    FairPlayDefinition Integer No The ID of the adaptive bitrate streaming template that encrypts the streams by FairPlay.

    DrmStreamingsInfoForUpdate

    Modification object of DRM-protected adaptive bitstream playback information

    Used by actions: ModifySuperPlayerConfig.

    Name Type Required Description
    SimpleAesDefinition Integer No ID of the adaptive bitrate streaming template whose protection type is SimpleAES.
    WidevineDefinition Integer No The ID of the adaptive bitrate streaming template that encrypts the streams by Widewine.
    FairPlayDefinition Integer No The ID of the adaptive bitrate streaming template that encrypts the streams by FairPlay.

    DynamicRangeInfo

    Dynamic range information.

    Used by actions: LiveRealTimeClip, SimpleHlsClip.

    Name Type Description
    Type String The dynamic range information. Valid values:
  • SDR: Standard Dynamic Range
  • HDR: High Dynamic Range
    		•
    HDRType String The HDR type. This parameter is valid only if Type is HDR. Valid values:
  • hdr10
  • hlg
    		•

    EditMediaFileInfo

    VOD video file editing information

    Used by actions: DescribeTaskDetail, EditMedia, PullEvents.

    Name Type Required Description
    FileId String Yes Video ID.
    StartTimeOffset Float No Offset time of the start of the video clip, unit: seconds.
    EndTimeOffset Float No Offset time at the end of the video clip, unit: seconds.

    EditMediaOutputConfig

    Result file output of edited video.

    Used by actions: EditMedia.

    Name Type Required Description
    MediaName String No Output file name, up to 64 characters. By default, the generated file name is specified by the system.
    Type String No Output file format, optional values: mp4, hls. The default is mp4.
    ClassId Integer No Classification ID is used to classify media. You can create a classification through the Create Classification interface to obtain the classification ID.
  • Default value: 0, indicating other categories.
    • ExpireTime String No The expiration time of the output file. The file will be deleted after this time. The default is permanent and not expired. The format is expressed in accordance with the ISO 8601 standard. For details, see ISO Date Format Description.
    VideoStream EditMediaVideoStream No Output video information.
    TEHDConfig EditMediaTEHDConfig No TSC Transcoding Config.

    EditMediaStreamInfo

    Video stream editing information

    Used by actions: DescribeTaskDetail, EditMedia, PullEvents.

    Name Type Required Description
    StreamId String Yes ID of recorded stream
    StartTime String No Start time of stream clipping in ISO date format.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTime String No End time of stream clipping in ISO date format.
    Note: this field may return null, indicating that no valid values can be obtained.

    EditMediaTEHDConfig

    EditMediaT TSC Transcoding Config.

    Used by actions: EditMedia.

    Name Type Required Description
    Type String Yes TSC Transcoding type, optional values:
  • TEHD-100 means TSC Transcoding-definition-100;
  • OFF means turning off TSC Transcoding-definition.
    • Leave it blank to indicate OFF.
    MaxVideoBitrate Integer No Maximum video bitrate. Valid when Type is specified as top speed Codec.
    Leave it blank or enter 0 to let VOD automatically set the bitrate cap.

    EditMediaTask

    Video editing task information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.

    • Note: this field may return null, indicating that no valid values can be obtained.
    ErrCode Integer Error code. 0: success; other values: failure.
  • 40000: invalid input parameter. Please check it;
  • 60000: invalid source file (e.g., video data is corrupted). Please check whether the source file is normal;
  • 70000: internal service error. Please try again.

    • Note: this field may return null, indicating that no valid values can be obtained.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer Progress of a video editing task. Value range: [0, 100]
    Input EditMediaTaskInput Video editing task input.
    Output EditMediaTaskOutput Output of the video editing task.
    MetaData MediaMetaData The metadata of the output video.
    ProcedureTaskId String The task ID for the task type Procedure. If a task flow (ProcedureName) is specified by EditMedia, and the task flow includes one or more of MediaProcessTask, AiAnalysisTask, and AiRecognitionTask, the task specified by this parameter will be executed.
    ReviewAudioVideoTaskId String The task ID for the task type ReviewAudioVideo. If a task flow (ProcedureName) is specified by EditMedia, and the task flow includes ReviewAudioVideoTask, the task specified by this parameter will be executed.
    SessionId String The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
    Note: this field may return null, indicating that no valid values can be obtained.
    SessionContext String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
    Note: this field may return null, indicating that no valid values can be obtained.

    EditMediaTaskInput

    Input of video editing task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    InputType String Input video source type. Valid values: File, Stream.
    FileInfoSet Array of EditMediaFileInfo Information of input video file. This field has a value only when InputType is File.
    Note: this field may return null, indicating that no valid values can be obtained.
    StreamInfoSet Array of EditMediaStreamInfo Input stream information. This field has a value only when InputType is Stream.
    Note: this field may return null, indicating that no valid values can be obtained.

    EditMediaTaskOutput

    Output of video editing task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String File type, such as mp4 and flv.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileUrl String Media file playback address.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String Media file ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    MediaName String Output filename of up to 64 characters, which is generated by the system by default.
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassId Integer Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API.
  • Default value: 0, which means "Other".

    • Note: this field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format.
    Note: this field may return null, indicating that no valid values can be obtained.

    EditMediaVideoStream

    Video stream configuration information

    Used by actions: EditMedia.

    Name Type Required Description
    Codec String No The encoding format of the video stream, optional values:
  • libx264: H.264 encoding;
  • libx265: H.265 encoding;
  • av1: AOMedia Video 1 encoding;
  • H.266: H.266 encoding.
    • Bitrate Integer No Bitrate of video stream, value ranges from 0 to [128, 100000], measurement unit: kbps.
    When the value is 0 or left blank, VOD automatically sets the bitrate.
    ResolutionAdaptive String No Resolution adaptive, optional values:
  • open: open, at this time, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed, at this time , Width represents the width of the video, and Height represents the height of the video.

    • Default value: open.
    Width Integer No Resolution adaptive, optional values:
  • open: open, at this time, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed, at this time , Width represents the width of the video, and Height represents the height of the video.

    • Default value: open.
    Height Integer No The maximum value of the video stream height (or short side), value range: 0 and [128, 4096], unit: px.
  • When Width and Height are both 0, the resolution is based on the base resolution;
  • When Width is 0 and Height is non-0, Width is scaled according to the base resolution;
    • li>
  • When Width is non-0 and Height is 0, the Height is scaled according to the base resolution;
  • When both Width and Height are non-0, the resolution is specified by the user.

    • Default value: 0.
    Fps Integer No Video frame rate, value range: [0, 100], unit: Hz.
    When the value is 0, the frame rate will be automatically set for the video.
    The default value is 0.

    ElementReferInfo

    Reference information of the subject.

    Used by actions: CreateAigcCustomElement.

    Name Type Required Description
    ImageUrl String No Image URLs of subjects from different perspectives.
    Image format. Valid values: .jpg, .jpeg, and .png.
    The image file size must not exceed 10MB, with image width and height not less than 300px and image aspect ratio between 1:2.5 and 2.5:1.

    EmptyTrackItem

    Empty track segment used as placeholder on time axis. If you want a period of silence between two audio segments, you can use EmptyTrackItem to hold the place.

    Used by actions: ComposeMedia.

    Name Type Required Description
    Duration Float Yes Duration in seconds.

    EnhanceConfig

    audio/video enhancement configuration

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    VideoEnhance VideoEnhanceConfig No Video enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioEnhance AudioEnhanceConfig No Audio enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    EnhanceConfigForUpdate

    audio/video enhancement configuration

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    VideoEnhance VideoEnhanceConfig No Video enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioEnhance AudioEnhanceConfig No Audio enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    EnhanceMediaQualityOutputConfig

    Remaster result file output

    Used by actions: EnhanceMediaQuality.

    Name Type Required Description
    MediaName String No Output file name, up to 64 characters. The system will specify the file name by default
    ClassId Integer No Category ID, used for media classification management, can be obtained by creating a category interface, create a category, get the category ID.
  • Default value: 0, which means other categories.
    		•
    ExpireTime String No The expiration time of the output file, the file will be deleted after this time, the default is never to expire, the format is in accordance with the ISO 8601 standard, see ISO date format description.

    EventContent

    Event notification content, where TranscodeCompleteEvent, ConcatCompleteEvent, ClipCompleteEvent, CreateImageSpriteCompleteEvent, and SnapshotByTimeOffsetCompleteEvent are event notifications for tasks that are initiated by v2017-compatible APIs.

    Used by actions: PullEvents.

    Name Type Description
    EventHandle String Event handler. The caller must call ConfirmEvents to acknowledge the message has been received. Confirmed Valid Time is 30 seconds. After expiration, the event can be retrieved again.
    EventType String Supported event types:
  • NewFileUpload: Video upload completed;
  • ProcedureStateChanged: Task flow status change.
  • FileDeleted: Video deletion completed;
  • RestoreMediaComplete: Video retrieval completion;
  • PullComplete: Video conversion pull completed.
  • EditMediaComplete: Video editing completed;
  • SplitMediaComplete: Video splitting completed;
  • ComposeMediaComplete: Media file creation completion;
  • WechatMiniProgramPublishComplete: WeChat Mini Program Publishing Completed.
  • RemoveWatermark: Intelligent watermark removal completion.
  • RebuildMediaComplete: Audio and video quality rebirth completion event (This is not recommended).
  • ReviewAudioVideoComplete: Audio/video moderation completed;
  • ExtractTraceWatermarkComplete: Traceability watermark extraction completed;
  • ExtractCopyRightWatermarkComplete: Extracting copyright watermark completion.
  • DescribeFileAttributesComplete: File attribute acquisition completion.
  • QualityInspectComplete: Audio and video quality inspection completed;
  • QualityEnhanceComplete: Audio and video quality rebirth task completion;
  • PersistenceComplete: Edit completed.
  • ComplexAdaptiveDynamicStreamingComplete: complex adaptive bitstream task completed.
  • ProcessMediaByMPSComplete: MPS video processing is completed.
  • AigcImageTaskComplete: AIGC image generation task complete.
  • AigcVideoTaskComplete: AIGC video generation task completed.

    • Event types compatible with the 2017 version:
  • TranscodeComplete: video transcoding completion;
  • ConcatComplete: Video splicing completion.
  • ClipComplete: Video editing completed;
  • CreateImageSpriteComplete: Video thumbnail capture completion.
  • CreateSnapshotByTimeOffsetComplete: Video screenshot by time point.
    		•
    FileUploadEvent FileUploadTask Video upload completion event. Valid when the event type is NewFileUpload.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcedureStateChangeEvent ProcedureTask Task flow status change event. Valid when the event type is ProcedureStateChanged.
    Note: This field may return null, indicating that no valid values can be obtained.
    FileDeleteEvent FileDeleteTask File deletion event. Valid when the event type is FileDeleted.
    Note: This field may return null, indicating that no valid values can be obtained.
    PullCompleteEvent PullUploadTask Video pull completion event. Valid when the event type is PullComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    EditMediaCompleteEvent EditMediaTask Video editing completion event. Valid when the event type is EditMediaComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    SplitMediaCompleteEvent SplitMediaTask Video splitting completion event. Valid when the event type is SplitMediaComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ComposeMediaCompleteEvent ComposeMediaTask Media file creation task completion event. Valid when the event type is ComposeMediaComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClipCompleteEvent ClipTask2017 Video editing completion event. Valid when the event type is ClipComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    TranscodeCompleteEvent TranscodeTask2017 Video transcoding completion event, valid when the event type is TranscodeComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017 Video thumbnail capture completion event. Valid when the event type is CreateImageSpriteComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ConcatCompleteEvent ConcatTask2017 Video splicing completion event. Valid when the event type is ConcatComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017 Video screenshot by time point completion event. Valid when the event type is CreateSnapshotByTimeOffsetComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    WechatPublishCompleteEvent WechatPublishTask WeChat Publishing Completion Event. Valid when the event type is WechatPublishComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    WechatMiniProgramPublishCompleteEvent WechatMiniProgramPublishTask WeChat Mini Program Publishing Task Completion Event. Valid when the event type is WechatMiniProgramPublishComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    RemoveWatermarkCompleteEvent RemoveWatermarkTask Intelligent Watermark Removal Completion Event is valid when the event type is RemoveWatermark.
    Note: This field may return null, indicating that no valid values can be obtained.
    RestoreMediaCompleteEvent RestoreMediaTask Video retrieval completion event. Valid when the event type is RestoreMediaComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    RebuildMediaCompleteEvent RebuildMediaTask Audio and video quality rebirth completion event. Valid when the event type is RebuildMediaComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExtractTraceWatermarkCompleteEvent ExtractTraceWatermarkTask Traceability watermark extraction completion event. Valid when the event type is ExtractTraceWatermarkComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExtractCopyRightWatermarkCompleteEvent ExtractCopyRightWatermarkTask Copyright watermark extraction completion event. Valid when the event type is ExtractCopyRightWatermarkComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ReviewAudioVideoCompleteEvent ReviewAudioVideoTask Audio/video moderation completed event. Valid when the event type is ReviewAudioVideoComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ReduceMediaBitrateCompleteEvent ReduceMediaBitrateTask This field is invalid.
    Note: This field may return null, indicating that no valid values can be obtained.
    DescribeFileAttributesCompleteEvent DescribeFileAttributesTask File attribute acquisition completion event. Valid when the event type is DescribeFileAttributesComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    QualityInspectCompleteEvent QualityInspectTask Audio and video quality detection completion event. Valid when the event type is QualityInspectComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    QualityEnhanceCompleteEvent QualityEnhanceTask Audio and video quality rebirth completion event. Valid when the event type is QualityEnhanceComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    MediaCastStatusChangedEvent MediaCastEvent MediaCastStatus changed event, valid when the event type is MediaCastStatusChanged.
    Pay attention to: this field may return null, indicating that no valid value can be obtained.
    PersistenceCompleteEvent PersistenceCompleteTask Editing solidification completion event. Valid when the event type is PersistenceComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ComplexAdaptiveDynamicStreamingCompleteEvent ComplexAdaptiveDynamicStreamingTask Adaptive bitrate task information, valid only when EventType is ComplexAdaptiveDynamicStreamingComplete.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcessMediaByMPSCompleteEvent ProcessMediaByMPS MPS video processing task information. Valid only when EventType is ProcessMediaByMPSComplete.
    AigcImageCompleteEvent AigcImageTask AIGC image generation task info. Valid only when EventType is AigcImageTaskComplete.
    AigcVideoCompleteEvent AigcVideoTask AIGC video task info. Valid only when EventType is AigcVideoTaskComplete.
    ExtractBlindWatermarkComplete ExtractBlindWatermarkTask Extract digital watermark information. Valid at that time only when EventType is ExtractBlindWatermarkComplete.
    SceneAigcImageCompleteEvent SceneAigcImageTask AIGC scenario-based image generation task info, valid only when EventType is SceneAigcImageCompleteEvent.
    ProcessImageAsyncCompleteEvent ProcessImageAsyncTask Image asynchronous task processing info, valid only when EventType is ProcessImageAsyncCompleteEvent.

    ExtractBlindWatermarkInputInfo

    Extract blind watermark input

    Used by actions: DescribeTaskDetail, ExtractBlindWatermark, PullEvents.

    Name Type Required Description
    Type String Yes Extract digital watermark input type, value range:
  • FILEID: File media asset ID;
  • URL: File URL;
    		•
    FileId String No Media file ID to extract
    Url String No Video file url to extract

    ExtractBlindWatermarkTask

    Extract digital watermark from video task info

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Media processing task ID.
    Status String Task flow status. Valid values:
  • WAITING: waiting.
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCode Integer Error code. 0 indicates success, other values indicate failure.
    Message String Error message.
    InputInfo ExtractBlindWatermarkInputInfo Extract digital watermark file input.
    Type String Digital watermark type. Valid values:
  • blind-basic: basic copyright digital watermark;
  • blind-ab: ab copyright digital watermark.
    		•
    IsDetected Boolean Tag whether watermark is detected. If this parameter is true, the Result field will return the extraction Result. If this parameter is false, the Result field will not be returned.
    Result String The extracted watermark content. This field will not be returned if no detection.
    ResultUV String Player's ID fetched from the traceable watermark, represented in hexadecimal, 6 digits in total.
    ExtractBlindWatermarkConfig ExtractBlindWatermarkTaskConfig Extract digital watermark configuration.
    SessionContext String Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters.
    SessionId String Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.

    ExtractBlindWatermarkTaskConfig

    Extract digital watermark from video transcoding task configuration

    Used by actions: DescribeTaskDetail, ExtractBlindWatermark, PullEvents.

    Name Type Required Description
    SegmentDuration Integer Yes Valid when the watermark type is blind-abseq, used to specify the segment duration of the input video. Unit: ms.
    If left blank, the segment duration is 5 seconds by default.

    ExtractCopyRightWatermarkTask

    Extract copyright watermark

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status, values:
  • PROCESSING: Processing;
  • FINISH: Completed.
    • ErrCode Integer Error code, 0 means success, other values u200bu200bmean failure:
  • 40000: The input parameters are illegal, please check the input parameters;
  • 60000: Source file error (such as video data damage), Please confirm whether the source file is normal;
  • 70000: Internal service error, it is recommended to try again.
    • Message String Error message.
    ErrCodeExt String Error code. An empty string indicates success. Other values u200bu200bindicate failure. For values, please refer to Video Processing Error Code list.
    Input ExtractCopyRightWatermarkTaskInput Input of the copyright watermark extraction task.
    Output ExtractCopyRightWatermarkTaskOutput Output message of the Copyright Watermark Extraction Task.
    SessionId String Identification code used for deduplication. If there is a request for the same identification code within seven days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.
    SessionContext String Source context, used to transparently transmit user request information. The task flow status change callback will return the value of this field, which can be up to 1000 characters.

    ExtractCopyRightWatermarkTaskInput

    Extract copyright watermark task input

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String The media URL from which the watermark needs to be extracted.

    ExtractCopyRightWatermarkTaskOutput

    Extract copyright watermark output information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Text String Copyright information

    ExtractTraceWatermarkTask

    A digital watermark extraction task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task status. Valid values:
  • PROCESSING
  • FINISH
    		•
    ErrCode Integer The error code. 0 indicates the task is successful. Other values indicate that the task failed.
  • 40000: Invalid input parameter.
  • 60000: Source file error (e.g., video data is corrupted).
  • 70000: Internal server error. Please try again.
    		•
    Message String The error message.
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Input ExtractTraceWatermarkTaskInput The information of a digital watermark extraction task.
    Output ExtractTraceWatermarkTaskOutput The output of a digital watermark extraction task.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.

    ExtractTraceWatermarkTaskInput

    The input of digital watermark extraction.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String The URL of the media on which digital watermark extraction is to be performed.
    FileId String Media file ID. The original media file ID corresponding to the URL.

    ExtractTraceWatermarkTaskOutput

    The output of digital watermark extraction.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Uv String Player's ID, represented in hexadecimal, 6 digits in total.

    FaceConfigureInfo

    Control parameter of face recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of face recognition task. Valid values:
  • ON: enables intelligent face recognition task;
  • OFF: disables intelligent face recognition task.
    		•
    Score Float No Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100. Default value: 95.
    DefaultLibraryLabelSet Array of String No Default face filter labels, which specify the types of faces to return. If this parameter is left empty, the recognition results for all labels are returned. Valid values:
  • entertainment: people in the entertainment industry
  • sport: sports celebrities
  • politician: politically sensitive people
    		•
    UserDefineLibraryLabelSet Array of String No Custom face labels for filtering. After you specify a label, callbacks of face images without this label will be returned. If this parameter is not specified or left empty, callbacks of all face images will be returned.
    You can specify up to 100 labels, with each containing up to 16 characters.
    FaceLibrary String No Figure library. Valid values:
  • Default: default figure library;
  • UserDefine: custom figure library.
  • All: both default and custom figure libraries will be used.

    • Default value: All (both default and custom figure libraries will be used.)

    FaceConfigureInfoForUpdate

    Control parameter of face recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of face recognition task. Valid values:
  • ON: enables intelligent face recognition task;
  • OFF: disables intelligent face recognition task.
    		•
    Score Float No Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100.
    DefaultLibraryLabelSet Array of String No Default face filter labels, which specify the types of faces to return. If this parameter is left empty or an empty value is entered, the recognition results for all labels are returned. Valid values:
  • entertainment: people in the entertainment industry
  • sport: sports celebrities
  • politician: politically sensitive people
    		•
    UserDefineLibraryLabelSet Array of String No Custom face labels for filtering. After you specify a label, callbacks of face images without this label will be returned. If this parameter is not specified or left empty, callbacks of all face images will be returned.
    You can specify up to 100 labels, with each containing up to 16 characters.
    FaceLibrary String No Figure library. Valid values:
  • Default: default figure library;
  • UserDefine: custom figure library.
  • All: both default and custom figure libraries will be used.
    		•

    FaceEnhanceInfo

    Face enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable face enhancement. Valid values:
  • ON
  • OFF
    		•
    Intensity Float No The face enhancement strength. This parameter is valid only if Switch is ON. Value range: 0.0 – 1.0.
    Default value: 0.0.

    FaceRecognitionInfo

    Face recognition media information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FaceRecognitionTasks Array of FaceRecognitionTask

    Face recognition task list

    FaceRecognitionOutputFileInfo

    Face recognition output file information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FileType String

    Face recognition output file type

    Enumeration value:

    • Output: Result output of task generation. The file corresponds to the result in the face recognition task return and is generated in JSON format.
    Url String

    File URL of face recognition output

    FaceRecognitionTask

    face recognition task

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer

    Face identification template No.
    OutputFile Array of FaceRecognitionOutputFileInfo

    Output file information

    FastEditMediaFileInfo

    VOD fast media editing information

    Used by actions: FastEditMedia.

    Name Type Required Description
    FileId String Yes Media ID.
    AudioVideoType String Yes Audio and video type for operation. Valid values:
  • Transcode: transcoding output;
  • Original: original audio/video.

    • Note: The audio and video to operate must be in HLS format.
    TranscodeDefinition Integer No Valid when AudioVideoType is Transcode. Represents the transcoding template ID for media operation.
    StartTimeOffset Float No Start time offset of media editing, in seconds.
    EndTimeOffset Float No End time offset of media editing, in seconds.

    FileContent

    Files stored in VOD.

    Used by actions: ListFiles.

    Name Type Description
    Key String Object key.
    LastModified String Last modification time in ISO8601 format, such as 2019-05-24T10:56:40Z.
    ETag String The Entity Tag of an object is an information Tag that identifies the object content when the object is created. It can be used to check whether the object content has changed.
    Size Integer Object size in bytes.
    StorageClass String For enumeration values, please refer to the storage type document (https://www.tencentcloud.com/document/product/436/33417?from_cn_redirect=1), such as STANDARD_IA and ARCHIVE.
    FileId String Unique identifier of the media file for this file.
    Category String File classification:
  • Video: video file
  • Audio: audio file
  • Image: image file
  • Other: other files
    		•
    FileType String Optional values:
    -OriginalFiles: source file
    -TranscodeFiles: transcoded file
    -AdaptiveDynamicStreamingFiles: Convert to adaptive bitrate stream file.
    -SubtitleFiles: Subtitle file
    -SampleSnapshotFiles: sampled screenshot files.
    -ImageSpriteFiles: Sprite image screenshot files
    -SnapshotByTimeOffsetFiles: Time point screenshot files.
    Definition Integer Video template ID. For template definition, please refer to transcoding template.
    SubtitleID String Subtitle ID.
    Only valid when FileType=SubtitleFiles.

    FileDeleteResultItem

    The result of file deletion.

    Used by actions: PullEvents.

    Name Type Description
    FileId String The ID of the file deleted.
    DeleteParts Array of MediaDeleteItem Part of the file deleted this time.

    FileDeleteTask

    File deleting task

    Used by actions: PullEvents.

    Name Type Description
    FileIdSet Array of String List of IDs of deleted files.
    FileDeleteResultInfo Array of FileDeleteResultItem The information of the files deleted.

    FileReviewInfo

    File moderation information.

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    MediaReviewInfo ReviewInfo Audio/Video moderation details*.

    * This parameter only contains the information of moderation tasks initiated by the ReviewAudioVideo or ReviewImage API.
    Note: This field may return null, indicating that no valid values can be obtained.
    CoverReviewInfo ReviewInfo Thumbnail moderation details*.

    * This parameter only contains the information of moderation tasks initiated by the ReviewAudioVideo or ReviewImage API.
    Note: This field may return null, indicating that no valid values can be obtained.

    FileUploadTask

    File upload task information

    Used by actions: PullEvents.

    Name Type Description
    FileId String Unique file ID.
    MediaBasicInfo MediaBasicInfo Basic information of media file generated after upload is completed.
    ProcedureTaskId String The task ID for the task type Procedure. If a task flow is specified for uploaded media, and the task flow includes one or more of MediaProcessTask, AiAnalysisTask, and AiRecognitionTask, the task specified by this parameter will be executed.
    ReviewAudioVideoTaskId String The task ID for the task type ReviewAudioVideo. If a task flow is specified for uploaded media, and the task flow includes ReviewAudioVideoTask, the task specified by this parameter will be executed.
    MetaData MediaMetaData Metadata, such as size, duration, video stream information, audio stream information, etc.
    Note: this field may return null, indicating that no valid values can be obtained.

    FileVerifyInfo

    File verification information

    Used by actions: CreateDomainVerifyRecord.

    Name Type Description
    FileVerifyUrl String File verification URL guidance.
    FileVerifyDomains Array of String File verification domain name list.
    FileVerifyName String File verification file name.

    FollowRedirect

    Back to the source 301/302 status code automatically follows the configuration, the default is off

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Back-to-origin follow configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.

    • ForceRedirect

    Access protocol forced redirect configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Access forced jump configuration switch, value:
  • on: on;
  • off: off.
    • RedirectType String No Access forced jump type:
  • http: forced http jump
  • https: forced https jump
    		•
    RedirectStatusCode Integer No Status code returned for forced redirect Supports 301, 302.
    CarryHeaders String No Whether to return the newly added header during force redirection.

    FrameRateWithDenInfo

    Frame interpolation frame rate configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Frame interpolation frame rate control switch. Available values:
  • ON: enabled
  • OFF: disabled
    		•
    FpsNum Integer No Frame rate numerator. Value range: non-negative number, which should be less than 100 when divided by the denominator, and in the unit of Hz. The default value is 0. Note: For transcoding, this parameter will override the Fps in the VideoTemplate.
    FpsDen Integer No Frame rate denominator. Value range: numbers equal to or greater than 1. The default value is 1.

    FrameTagConfigureInfo

    Control parameter of intelligent frame-specific tagging task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Switch of intelligent frame-specific tagging task. Valid values:
  • ON: enables intelligent frame-specific tagging task;
  • OFF: disables intelligent frame-specific tagging task.
    		•
    ScreenshotInterval Float No Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.

    FrameTagConfigureInfoForUpdate

    Control parameter of intelligent frame-specific tagging task

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No Switch of intelligent frame-specific tagging task. Valid values:
  • ON: enables intelligent frame-specific tagging task;
  • OFF: disables intelligent frame-specific tagging task.
    		•
    ScreenshotInterval Float No Frame capturing interval in seconds. Minimum value: 0.5 seconds.

    HDRInfo

    High dynamic range (HDR) configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable HDR. Valid values:
  • ON
  • OFF

    • Default value: OFF.
    Type String No High dynamic range type. Valid values:
  • hdr10: means the hdr10 standard;
  • hlg: refers to the hlg standard.


    • Note:
  • Valid only when the high dynamic range type control switch is ON.
  • Valid when the video stream encoding format Codec of the video output parameter specified in the target parameter is libx264 or libx265.
    		•

    HeadTailConfigureInfo

    Control parameter of video opening and ending credits recognition task.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of video opening and ending credits recognition task. Valid values:
  • ON: enables video opening and ending credits recognition task;
  • OFF: disables video opening and ending credits recognition task.
    		•

    HeadTailConfigureInfoForUpdate

    Control parameter of video opening and ending credits recognition task.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of video opening and ending credits recognition task. Valid values:
  • ON: enables video opening and ending credits recognition task;
  • OFF: disables video opening and ending credits recognition task.
    		•

    HeadTailTaskInput

    Input parameters for a video opening/closing credits generation task

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask, CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Video opening/closing credits configuration template ID

    HeadTailTemplate

    Head Tail Template Details

    Used by actions: DescribeHeadTailTemplates.

    Name Type Description
    Definition Integer Head Tail Template Number.
    Name String Template name, supports up to 64 characters.
    Comment String Template description, up to 256 characters.
    HeadCandidateSet Array of String Title candidate list. When using it, the one closest to the resolution of the feature film will be selected. When the same candidate exists, the first one will be selected. A maximum of 5 are supported.
    TailCandidateSet Array of String Ending candidate list. When using it, the one closest to the resolution of the feature film will be selected. When the same candidate exists, the first one will be selected. A maximum of 5 are supported.
    FillType String 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:
  • stretch: stretch, stretch each frame to fill the entire screen, which may cause the transcoded video to be "squashed" or "stretched";

  • gauss: Gaussian blur, keep the video aspect ratio unchanged, use Gaussian blur for the remaining edges;
  • white: leave blank, keep the video aspect ratio unchanged, use the remaining edges for the edge Use white filling;
  • black: Leave black, keep the video aspect ratio unchanged, and fill the remaining edges with black.

    • Default value: stretch.
    CreateTime String Template creation time, using ISO date format.
    UpdateTime String The last modification time of the template, using ISO date format.

    HeuristicCache

    Heuristic cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Heuristic cache configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • CacheConfig HeuristicCacheConfig No Custom heuristic cache time configuration.

    HeuristicCacheConfig

    Heuristic cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    HeuristicCacheTimeSwitch String Yes Heuristic custom time cache configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • HeuristicCacheTime Integer Yes Unit: seconds.

    HighlightSegmentItem

    List of intelligently generated highlights.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float

    Confidence degree.
    StartTimeOffset Float

    Segment start time offset.

    Measurement unit: seconds.
    EndTimeOffset Float

    Segment end time offset.

    Unit: seconds

    HighlightsConfigureInfo

    Control parameter of an intelligent highlight generating task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Switch of an intelligent highlight generating task. Valid values:
  • ON: enable an intelligent highlight generating task;
  • OFF: disable an intelligent highlight generating task.
    		•

    HighlightsConfigureInfoForUpdate

    Control parameter of an intelligent highlight generating task

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No Switch of an intelligent highlight generating task. Valid values:
  • ON: enable an intelligent highlight generating task;
  • OFF: disable an intelligent highlight generating task.
    		•

    HttpHeaderPathRule

    HTTP header setting rules. Up to 100 entries can be set.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    HeaderMode String Yes http header setting method:
  • set: setting. Change the value of the specified header parameter to the set value; if the set header does not exist, the header will be added; if there are multiple duplicate header parameters, all will be changed and merged into one header. ;
  • del: delete. Delete the specified header parameter;
  • add: add. Add the specified header parameters. By default, repeated addition is allowed, that is, the same header is added repeatedly (note: repeated addition may affect the browser response, please use the set operation first).
    • HeaderName String Yes HTTP header name. Up to 100 characters can be set.
    HeaderValue String Yes http header value, up to 1000 characters can be set; optional when Mode is del; required when Mode is add/set.
    RuleType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.

    • Https

    Domain name HTTPS acceleration configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes https configuration switch, value:
  • on: on;
  • off: off.
    • Http2 String No http2 configuration switch, value:
  • on: on;
  • off: off.
    • CertInfo CDNCertInfo No Cert configuration message.

    HwPrivateAccess

    Access authentication for Huawei Cloud OBS origin

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Huawei Cloud Object Storage back-to-origin authentication configuration switch, the value is:
  • on: on;
  • off: off.
    • AccessKey String No Access ID
    SecretKey String No Key
    Bucket String No BucketName

    IPFilterPolicy

    IP access restriction rules currently support configuring IP blocklist and allowlist.

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes IP access restriction status. Available values:
  • Enabled: enabled;
  • Disabled: Disabled.
    		•
    FilterType String No IP access restriction Type:
  • Black: blocklist method verification. Only IP requests that come from IPList in the list be intercepted.
  • White: Whitelist method verification. Only IP requests from the IPList are allowed.
    • When the Status value is Enabled, the FilterType must be assigned a value.
    IPList Array of String No IP list, supports IPV4 addresses in X.X.X.X format, IPV6 addresses in X:X:X:X:X:X:X:X format, or ranges in /N format (IPV4:1≤N≤32; IPV6:1≤N≤128). Up to 200 IPs or ranges can be filled. When Status value is Enabled, IPList must assign value.

    ImageBlur

    Image blurring parameters.

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes The blur type. Valid values:
  • Gaussian
    		•
    Radius Integer No The radius of the blur. Value range: 1-50. This parameter is valid if Type is Gaussian.
    Sigma Integer No The standard deviation of the Gaussian distribution, which must be greater than 0. This parameter is valid if Type is Gaussian.

    ImageCenterCut

    Image cropping details.

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes The cropping type. Valid values:
  • Circle: Cropping to circle. Radius specifies the radius of the output image.
  • Rectangle: Cropping to rectangle. Width and Height specify the width and height of the output image.
    		•
    Width Integer No The width (pixels) of the output image. This parameter is valid if Type is Rectangle.
    Height Integer No The height (pixels) of the output image. This parameter is valid if Type is Rectangle.
    Radius Integer No The radius of the output image. This parameter is valid if Type is Circle.

    ImageDenoiseConfig

    Image denoising configuration.

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Switch String No Capability configuration switch. Valid values:
  • ON: enabled;
  • OFF: Disabled.

    • Default value: ON.
    Type String No Type, available values:
  • weak
  • strong

    • Default value: weak.

    ImageEncodeConfig

    Image encoding format parameters

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Format String No Image format. Valid values: JPEG, PNG, BMP, and WebP. Defaults to the original image format. Animation is not supported.
    Quality Integer No Relative image quality. Value ranges from 1 to 100. The numeric value is based on the original image quality and defaults to the original image quality.

    ImageEnhanceConfig

    Image enhancement parameters

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    SuperResolution SuperResolutionInfo No Super-resolution configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedSuperResolution AdvancedSuperResolutionConfig No Advanced super-resolution configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    Denoise ImageDenoiseConfig No Denoising configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageQualityEnhance ImageQualityEnhanceInfo No Comprehensive enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ColorEnhance ColorEnhanceInfo No Color enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    SharpEnhance SharpEnhanceInfo No Detail enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    FaceEnhance FaceEnhanceInfo No Face enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    LowLightEnhance LowLightEnhanceInfo No Low-light enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    ImageOperation

    An image operation.

    Used by actions: CreateImageProcessingTemplate, DescribeImageProcessingTemplates.

    Name Type Required Description
    Type String Yes Image processing type. Optional types are:
  • Scale: image thumbnail processing;
  • CenterCut: image cropping processing;
  • Blur: image blur processing.
    • Scale ImageScale No The scaling details. This parameter is valid only if Type is Scale.
    CenterCut ImageCenterCut No The cropping details. This parameter is valid only if Type is CenterCut.
    Blur ImageBlur No Image blurring. This parameter is valid only if Type is Blur.

    ImageProcessingTemplate

    An image processing template, which can contain at most three operations, for example, cropping, scaling, and cropping again.

    Used by actions: DescribeImageProcessingTemplates.

    Name Type Description
    Definition Integer The template ID.
    Type String The template type. Valid values:
  • Preset
  • Custom
    		•
    Name String The template name.
    Comment String The template description.
    Operations Array of ImageOperation An array of image processing operations. The operations will be performed in the specified order.
  • Length limit: 3.
    		•
    CreateTime String The template creation time in ISO date format.

    ImageQualityEnhanceInfo

    Comprehensive enhancement control

    Used by actions: CreateProcessImageAsyncTemplate, CreateTranscodeTemplate, ModifyProcessImageAsyncTemplate, ModifyTranscodeTemplate, PullEvents.

    Name Type Required Description
    Switch String Yes Comprehensive enhancement control switch. Valid values:
  • ON: enable comprehensive enhancement
  • OFF: disable comprehensive enhancement
    		•
    Type String No Comprehensive enhancement type. Valid only when the control switch is ON. Available values:
  • weak: light comprehensive enhancement.
  • NORMAL: Comprehensive enhancement is normal.
  • strong: comprehensive enhancement.

    • Default value: weak.

    ImageReviewUsageDataItem

    The usage statistics for the image recognition feature.

    Used by actions: DescribeImageReviewUsageData.

    Name Type Description
    Time String The start time (in ISO date format) of the data returned. For example, if the granularity is a day, 2018-12-01T00:00:00+08:00 indicates that the data is for the whole day of December 1, 2018.
    Count Integer The number of times the image recognition feature is used.

    ImageScale

    Image scaling details.

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes The scaling type. Valid values:
  • WidthFirst: Specify the width and proportionally scale the height.
  • HeightFirst: Specify the height and proportionally scale the width.
  • LongEdgeFirst: Specify the long side (LongEdge) and proportionally scale the short side.
  • ShortEdgeFirst: Specify the short side (ShortEdge) and proportionally scale the long side.
  • Force: Specify both the height and width. The output image may be distorted.
    		•
    Height Integer No The image height (pixels). This parameter is valid only if Type is HeightFirst or Force.
    Width Integer No The image width (pixels). This parameter is valid only if Type is WidthFirst or Force.
    LongEdge Integer No The long side of the output image (pixels). This parameter is valid only if Type is LongEdgeFirst.
    ShortEdge Integer No The short side of the output image (pixels). This parameter is valid only if Type is ShortEdgeFirst.

    ImageSceneAigcEncodeConfig

    Image encoding format parameters.

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    Format String No Image format. Valid values: JPEG and PNG. Defaults to the original image format. Animation is not supported.
    Quality Integer No Relative image quality. Value ranges from 1 to 100. The numeric value is based on the original image quality and defaults to the original image quality.

    ImageSpriteTaskInput

    Input parameter type of image sprite generating task

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Image sprite generating template ID.

    ImageSpriteTemplate

    Details of an image sprite generating template

    Used by actions: DescribeImageSpriteTemplates.

    Name Type Description
    Definition Integer Unique ID of an image sprite generating template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of an image sprite generating template.
    Width Integer Maximum value of the width (or long side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    Height Integer Maximum value of the height (or short side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    ResolutionAdaptive String Resolution adaption. Valid values:
  • open: enabled. In this case, Width represents the long side of a video, while Height the short side;
  • close: disabled. In this case, Width represents the width of a video, while Height the height.

    • Default value: open.
    SampleType String Sampling type.
    SampleInterval Integer Sampling interval.
    RowCount Integer Subimage row count of an image sprite.
    ColumnCount Integer Subimage column count of an image sprite.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    FillType String Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
  • 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";
  • 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.

    • Default value: black.
    Comment String Template description.
    Format String The image format.

    ImageTransform

    Operation such as image rotation and flipping

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes Type. Valid values:
  • Rotate: image rotation.
  • Flip: image flipping.
    		•
    RotateAngle Float No Rotation angle of image with its center point as origin. Value range: 0-360. This parameter is valid if Type is Rotate.
    Flip String No Image flipping action. Valid values:
  • Horizental: horizontal flipping, i.e., horizontally mirrored.
  • Vertical: vertical flipping, i.e., vertically mirrored.

    • This is valid if Type is Flip.

    ImageUnderstandingInfo

    Image understanding information.

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    ImageUnderstandingSet Array of ImageUnderstandingItem Image understanding collection.

    ImageUnderstandingItem

    Image understanding information item.

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer Template id.
    OutputFile Array of MPSOutputFileInfo Task output file.

    ImageWatermarkInput

    Input parameter of image watermarking template

    Used by actions: CreateWatermarkTemplate.

    Name Type Required Description
    ImageContent String Yes The Base64 encoded string of a watermark image. Only JPEG, PNG, and GIF images are supported.
    Width String No Watermark width. % and px formats are supported:
  • If the string ends in %, the Width of the watermark will be the specified percentage of the video width. For example, 10% means that Width is 10% of the video width;
  • If the string ends in px, the Width of the watermark will be in pixels. For example, 100px means that Width is 100 pixels. Value range: [8, 4096].

    • Default value: 10%.
    Height String No Watermark height. % and px formats are supported:
  • If the string ends in %, the Height of the watermark will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height;
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px. Valid values: 0 or [8,4096].

    • Default value: 0 px, which means that Height will be proportionally scaled according to the aspect ratio of the original watermark image.
    RepeatType String No Repeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
    		•
    Transparency Integer No

    ImageWatermarkInputForUpdate

    Input parameter of image watermarking template

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    ImageContent String No String generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
    Width String No Watermark width. % and px formats are supported:
  • If the string ends in %, the Width of the watermark will be the specified percentage of the video width. For example, 10% means that Width is 10% of the video width;
  • If the string ends in px, the Width of the watermark will be in pixels. For example, 100px means that Width is 100 pixels. Value range: [8, 4096].
    		•
    Height String No Watermark height. % and px formats are supported:
  • If the string ends in %, the Height of the watermark will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height;
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px. Valid values: 0 or [8,4096].
    		•
    RepeatType String No Repeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
    		•
    Transparency Integer No

    ImageWatermarkTemplate

    Image watermarking template

    Used by actions: DescribeWatermarkTemplates.

    Name Type Description
    ImageUrl String Watermark image address.
    Width String Watermark width. % and px formats are supported:
  • If the string ends in %, the Width of the watermark will be the specified percentage of the video width; for example, 10% means that Width is 10% of the video width;
  • If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px.
    		•
    Height String Watermark height. % and px formats are supported:
  • If the string ends in %, the Height of the watermark will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height;
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px;

    • 0px means that Height will be proportionally scaled according to the video width.
    RepeatType String Repeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
    		•
    Transparency Integer

    ImportMediaKnowledgeTask

    Import knowledge base task for media

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Value:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. 0 indicates success, other values indicate failure.
    Message String Error message.

    IpFilter

    IP blocklist/allowlist configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes IP black and white list configuration switch, value:
  • on: on;
  • off: off.
    • FilterType String No IP blacklist and whitelist types:
  • whitelist: whitelist;
  • blacklist: blacklist.
    • Filters Array of String No IP black and white list, supports: IP in the form of X.X.X.X, or network segment in the form of /8, /16, /24; Can populate up to 50 whitelists or 50 blacklists.
    FilterRules Array of IpFilterPathRule No IP blocklist/allowlist path-based configuration. This feature is only available to selected beta customers.

    IpFilterPathRule

    IP blocklist/allowlist path-based configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    FilterType String Yes IP blacklist and whitelist types:
  • whitelist: whitelist;
  • blacklist: blacklist.
    • Filters Array of String Yes IP black and white list, supports: IP in the form of X.X.X.X, or network segment in the form of /8, /16, /24; Can populate up to 50 whitelists or 50 blacklists.
    RuleType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.

    • Ipv6Access

    IPv6 access configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Domain name enables ipv6 access configuration switch. The value is:
  • on: on;
  • off: off.

    • JitterConfigureInfo

    Control parameters for video jitter and ghost detection.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video shake and ghost detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • JitterConfigureInfoForUpdate

    Control parameters for video jitter and ghost detection.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video shake and ghost detection switch, optional values:
  • ON: turn on;
  • OFF: turn off.

    • JustInTimeTranscodeTemplate

    Just In Time transcoding template details.

    Used by actions: DescribeJustInTimeTranscodeTemplates.

    Name Type Description
    Type String Template type.
    Name String Template name.
    Comment String Template description.
    VideoConfigure VideoConfigureInfo Video parameter configuration.
    WatermarkConfigure WatermarkConfigureData Watermark parameter configuration.

    KnowledgeBasesInfo

    Intelligent knowledge base info for media assets

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Bases Array of String

    Current library list of media assets to import

    LLMComprehendAsr

    Large model parse text transcribe parse configuration

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes Text transcription task switch. Available values:
    -ON: Enable the transcription task.
    -OFF: Disable text transcription task.

    LLMComprehendAsrForUpdate

    Large model parse text transcribe parse configuration

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No Text transcription task switch. Available values:
    -ON: Enable the transcription task.
    -OFF: Disable text transcription task.

    LLMComprehendFaceRecognition

    Large model parses face identification configuration

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes

    Face recognition task switch

    Enumeration value:

    • ON: Enable intelligent face recognition task
    • OFF: Disable intelligent face recognition task

    Default value: OFF
    Score Float No

    Face recognition filter score. The recognition result is returned when it reaches or exceeds this score.

    Value ranges from 0 to 100.

    Default value: 95.
    DefaultLibraryLabelSet Array of String No

    Default character filter tag. Specifies the tag of the default character to return. If left blank or empty, all default character results are returned.

    Enumeration value:

    • entertainment: entertainment star
    • sport: sports celebrity
    • politician: political figure
    UserDefineLibraryLabelSet Array of String No

    User-defined character filter tag specifies the tags of user-defined characters to return. If left blank or empty, all customized figure results are returned.

    Input limit: The number of tags is limited to 100, and each tag is limited to 16 characters in length.
    FaceLibrary String No

    Figure library selection

    Enumeration value:

    • Default: Use default figure library
    • UserDefine: Use user-defined figure library
    • All: Use default and user-defined figure libraries simultaneously

    Default value: All

    LLMComprehendFaceRecognitionForUpdate

    Large model parses face identification configuration

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No

    Face recognition task switch

    Enumeration value:

    • ON: Enable intelligent face recognition task
    • OFF: Disable intelligent face recognition task

    Default value: OFF
    Score Float No

    Face recognition filter score. The recognition result is returned when it reaches or exceeds this score.

    Value ranges from 0 to 100.
    DefaultLibraryLabelSet Array of String No

    Default character filter tag. Specifies the tag of the default character to return. If left blank or empty, all default character results are returned.

    Enumeration value:

    • entertainment: entertainment star
    • sport: sports celebrity
    • politician: political figure
    UserDefineLibraryLabelSet Array of String No

    User-defined character filter tag specifies the tags of user-defined characters to return. If left blank or empty, all customized figure results are returned.

    Input limit: The number of tags is limited to 100, and each tag is limited to 16 characters in length.
    FaceLibrary String No

    Figure library selection

    Enumeration value:

    • Default: Use default figure library
    • UserDefine: Use user-defined figure library
    • All: Use default and user-defined figure libraries simultaneously

    Default value: All

    LLMComprehendSummary

    Large model parsing segment summary parse configuration

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes Segment summary task switch, available values:
    -ON: Enable segment summary task.
    -OFF: Disable segment summary.
    ExtendedParameter String No Extended parameter, which is a serialized json string. See Extended Parameter description.

    LLMComprehendSummaryForUpdate

    Large model parsing segment summary parse configuration

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No Segment summary task switch, available values:
    -ON: Enable segment summary task.
    -OFF: Disable segment summary.
    ExtendedParameter String No Extended parameter, which is a serialized json string. See Extended Parameter description.

    LLMComprehendTemplateItem

    Large model parses template detail.

    Used by actions: DescribeLLMComprehendTemplates.

    Name Type Description
    Definition Integer

    Unique identifier of the image asynchronous processing template.
    Name String

    Image asynchronous processing template name.
    Comment String

    Description information of the image asynchronous processing template.
    Level String

    Resolution level, optional values:

    • Audio: Audio-level resolution
    • Video: Video-level resolution
    Summary LLMComprehendSummary

    Segment summary parse configuration
    Asr LLMComprehendAsr

    Text transcription parse configuration
    FaceRecognition LLMComprehendFaceRecognition

    Face recognition parse configuration
    CreateTime Timestamp ISO8601

    Template creation time, in ISO date format.
    UpdateTime Timestamp ISO8601

    Last template modification time, in ISO date format.

    LicenseUsageDataItem

    The license request statistics.

    Used by actions: DescribeLicenseUsageData.

    Name Type Description
    Time String The start time (in ISO date format) of the data returned. For example, if the granularity is a day, 2018-12-01T00:00:00+08:00 indicates that the data is for the whole day of December 1, 2018.
    Count Integer The number of license requests.

    LiveRealTimeClipMediaSegmentInfo

    The information of the segment clipped.

    Used by actions: LiveRealTimeClip.

    Name Type Description
    StartTime String Segment start time. Format reference ISO date format description.
    EndTime String Segment end time. Format reference ISO date format description.

    LiveRealTimeClipStreamInfo

    The information of the live stream to clip.

    Used by actions: LiveRealTimeClip.

    Name Type Required Description
    Type String No The type of live stream to clip. Valid values:
  • Original (default)
  • Transcoding
    		•
    TemplateId Integer No The transcoding template ID.
    This is required if Type is Transcoding.

    LiveRecordInfo

    Live recording information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Domain String

    Live streaming Recording domain name
    Path String

    Live streaming Recording Path
    StreamId String

    Live recording stream ID.
    RecordStartTime String

    Recording start time in ISO datetime format.
    RecordEndTime String

    Recording end time, using ISO date format.

    LowLightEnhanceInfo

    Low-light enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable low-light enhancement. Valid values:
  • ON
  • OFF
    		•
    Type String No The low-light enhancement type. This parameter is valid only if Switch is ON.
  • normal

    • Default value: normal.

    MPSAIAnalysisConfigureInfo

    MPS intelligent analysis template configuration options

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    Switch String No

    Task switch for intelligent classification. Available values:

  • ON: Enable intelligent classification task;
  • OFF: Disable intelligent classification task.

    		•

    MPSAIAnalysisTemplate

    MPS intelligent analysis template input

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes

    Video analysis template name. The length cannot exceed 64 characters.
    Comment String Yes

    Video analysis template description, with a length limit of 256 characters.
    ClassificationConfigure MPSAIAnalysisConfigureInfo No

    Parameters for the intelligent classification task.
    TagConfigure MPSAIAnalysisConfigureInfo No

    Control parameters for the intelligent tag task.
    CoverConfigure MPSAIAnalysisConfigureInfo No

    Intelligent Cover Task Control Parameters.
    FrameTagConfigure MPSAIAnalysisConfigureInfo No

    Control parameters for the intelligent frame-specific tagging task.
    SplitConfigure MPSAIAnalysisConfigureInfo No

    Task control parameters for video splitting.
    HighlightConfigure MPSAIAnalysisConfigureInfo No

    Control parameters for the intelligent highlights task.
    OpeningAndEndingConfigure MPSAIAnalysisConfigureInfo No

    Intelligent Opening and Closing Credits Task Control Parameters.

    MPSAIAnalysisTemplateForUpdate

    MPS intelligent analysis template input

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes

    Unique identifier of a video analysis template.
    Name String Yes

    Video analysis template name. The length cannot exceed 64 characters.
    Comment String Yes

    Video analysis template description, with a length limit of 256 characters.
    ClassificationConfigure MPSAIAnalysisConfigureInfo No

    Intelligent Classification Task Control Parameters.
    TagConfigure MPSAIAnalysisConfigureInfo No

    Intelligent tag task control parameter.
    CoverConfigure MPSAIAnalysisConfigureInfo No

    Parameters for the intelligent cover task.
    FrameTagConfigure MPSAIAnalysisConfigureInfo No

    Task control parameters for intelligent frame tagging.
    SplitConfigure MPSAIAnalysisConfigureInfo No

    Task control parameter for intelligent splitting.
    HighlightConfigure MPSAIAnalysisConfigureInfo No

    Intelligent highlights task control parameter.
    OpeningAndEndingConfigure MPSAIAnalysisConfigureInfo No

    Parameters for the intelligent video opening/closing credits task.

    MPSAiAnalysisTaskInput

    AI smart video analysis input parameter type

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer Yes

    ID of the video analysis template.
    ExtendedParameter String No

    Additional parameters, whose value is a serialized json string. Note: This parameter is for customization requirements. See the following: Intelligent ErasureIntelligent SplittingHighlightIntelligent Landscape-to-Portrait

    MPSAiMediaInfo

    Intelligent media information processed with MPS

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AiMediaList Array of MPSAiMediaItem List of intelligent media information processed by MPS

    MPSAiMediaItem

    MPS AI media task item

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TaskType String MPS intelligent processing task type. Valid values:
  • AiAnalysis.ClassificationTask: intelligent classification task.
  • AiAnalysis.CoverTask: intelligent thumbnail generating.
  • AiAnalysis.TagTask: intelligent tag task.
  • AiAnalysis.FrameTagTask: intelligent frame-by-frame tagging task.
  • AiAnalysis.HighlightTask: Intelligent highlight task.
  • AiAnalysis.SegmentTask: Intelligent video splitting task.
  • AiAnalysis.HeadTailTask: Intelligent opening and closing credits task.
  • AiAnalysis.DescriptionTask: Intelligent summary task.
  • AiAnalysis.HorizontalToVerticalTask: Intelligent Landscape to Portrait Task.
  • AiAnalysis.DubbingTask: Intelligent dubbing task.
  • AiAnalysis.VideoRemakeTask: Intelligent deduplication task.
  • AiAnalysis.VideoComprehensionTask: Video understanding task.
  • SmartSubtitle.AsrFullTextTask: Intelligent speech full-text recognition task.
  • SmartSubtitle.TransTextTask: Translation result.
  • SmartSubtitle.PureSubtitleTransTask: Returns the pure subtitle file translation result.
  • SmartSubtitle.OcrFullTextTask: Intelligent text extraction subtitle task.
    		•
    AiMediaTasks Array of MPSAiMediaTask MPS intelligent processing task result set

    MPSAiMediaTask

    MPS intelligent task

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer MPS intelligent task template ID
    OutputFile Array of MPSOutputFileInfo MPS intelligent task output file collection
    OutputText String The returned result of the MPS intelligent task. This field corresponds to the Output result in the MPS task return and is returned in JSON format.
    Different MPS task output results have different structures. For the specific return content, see the MPS task output struct.
    Intelligent classification result
    Intelligent cover result
    Intelligent Tag Result
    Intelligent frame tagging classification result
    Intelligent Highlight Result
    Video Splitting Result
    Intelligent video opening/closing credits result
    Intelligent summary result
    Horizontal-to-Vertical Video Transformation Result
    Intelligent dubbing result
    Intelligent video understanding result
    Intelligent caption full speech recognition result
    Intelligent caption translation result
    Intelligent caption pure srt translation result
    Smart subtitling text extraction result

    MPSEraseArea

    Intelligent erasure. Coordinate configuration of the erasure area.
    The region is determined by the coordinates of the top-left and bottom-right corners.
    The coordinate origin is the top-left corner of the image. Coordinate points can be specified using pixel values or percentage units.
    For auto-erase areas:
    When the unit is %, the coordinate range is [0,1].
    When the unit is px, the X range is [0, video image width], and the Y range is [0, screen height].
    For the designated erase area:
    When the unit is %, the coordinate range is [0,1).
    When the unit is px, the X range is [0, video image width], and the Y range is [0, video image height].

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    LeftTopX Float Yes

    Top-left X-axis coordinate of the region. When Unit is set to 1 (using percentage unit), 0.05 means the horizontal distance from the top-left corner of the region to the top-left corner of the entire image is 5% of the image width.
    LeftTopY Float Yes

    Y-axis coordinate of the top-left corner. For example, when Unit is set to 1 (using percentage), 0.1 means the vertical distance from the top-left corner of the region to the top-left corner of the entire frame is 10% of the screen height.
    RightBottomX Float Yes

    X coordinate of the bottom-right corner of the region. For example, when Unit is 1 (using percentage as the measurement unit), 0.75 means the horizontal distance from the bottom-right corner of the region to the top-left corner of the entire frame is 75% of the frame width.
    RightBottomY Float Yes

    Y-axis coordinate of the bottom-right corner. For example, when Unit is 1 (using percentage), 0.9 means the vertical distance from the top-left corner to the bottom-right corner is 90% of the screen height.
    Unit Integer Yes

    Coordinate unit - 1 percentage - 2 pixel value

    MPSEraseTimeArea

    Intelligent erasure, specify region configuration.
    Perform erasure directly in the designated region within a specified period.
    When both BeginMs and EndMs are set to 0, directly perform erase on the designated region in the entire video.

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    BeginMs Integer Yes

    Start time, unit: ms
    EndMs Integer Yes

    End time, unit: ms
    Areas Array of MPSEraseArea Yes

    Domain list for erasure within the period

    MPSOutputFile

    For description of the returned file in an MPS video processing task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String File type. Used to identify specific return files in the execution result of an MPS video processing task.
    Value:
  • AiAnalysis.DeLogo.Video: The erased video file generated in the intelligent erasure task, stored in the original file type by default;
  • AiAnalysis.DeLogo.OriginSubtitle: The subtitle file extracted from video in the intelligent erasure task;
  • AiAnalysis.DeLogo.TranslateSubtitle: The translation file of subtitles extracted from video in the intelligent erasure task.
  • MediaProcess.Transcode.Video: The enhanced audio and video file in the audio and video enhancement task, stored in the transcoded file type by default.
  • AiAnalysis.HorizontalToVerticalTask.Video: The generated video file in the horizontal to vertical task is stored as an intelligent media type by default.
  • AiAnalysis.VideoRemakeTaskk.Video: The generated video file in the intelligent deduplication task, stored as an intelligent media type by default.
  • AiAnalysis.SegmentTask.Video: Generated video file in the intelligent video splitting task, stored as intelligent media type by default.
  • SmartErase.Video: Generated video file in the intelligent erasure task, stored as intelligent media type by default.

    		•
    StorageMode String Storage format. To represent the storage format of the result file. Valid values:
  • Permanent: permanent storage;
  • Temporary: temporary storage.
    		•
    FileId String Media file ID. Valid when Type is Permanent, indicating that the result file is stored as a media asset on the VOD platform, with the field value being the FileId of the media asset.
    Url String Downloadable Url of the result file.
    Definition String Transcoding specification ID. Valid when FileType equals MediaProcess.Transcode.Video. A value of 0 means the original file.
    ExpiredTime Integer Expiration time. Valid when StorageMode is Temporary, indicates the expiry date of the Url, in seconds.

    MPSOutputFileInfo

    MPS output file information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FileType String MPS output file type. Valid values:
  • Video: the generated video file of the task.
  • Cover: cover file generated by task generation.
  • Audio: audio file generated by task generation.
  • Output: The result output of task generation. The file corresponds to the Output result in the MPS task response and is generated in JSON format.


    • Output file. Different MPS tasks have different output results. For specific return content, refer to the MPS task output struct. The struct is JSON-serialized to generate the Output file.
    Intelligent classification result
    Intelligent cover result
    Intelligent Tag Result
    Intelligent frame tagging classification result
    Intelligent Highlight Result
    Video Splitting Result
    Intelligent video opening/closing credits result
    Intelligent summary result
    Horizontal-to-Vertical Video Transformation Result
    Intelligent dubbing result
    Intelligent video understanding result
    Intelligent caption full speech recognition result
    Intelligent caption translation result
    Intelligent caption pure srt translation result
    Smart subtitling text extraction result
    Url String MPS output file URL

    MPSOverrideEraseParameter

    Custom parameters for smart erasing.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    EraseType String No

    Removal Type

    • subtitle removal
    • watermark removal
    • privacy protection
    EraseSubtitleConfig MPSUpdateSmartEraseSubtitleConfig No

    Subtitle erasing configuration;
    This field is required when the value of EraseType is set to subtitle.
    EraseWatermarkConfig MPSUpdateSmartEraseWatermarkConfig No

    Watermark erasing configuration.
    This field is required when the value of EraseType is set to watermark.
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No

    Privacy protection configuration.
    This field is required when the value of EraseType is privacy.
    SubtitleEmbedId Integer No

    id of the subtitle removal suppression template.

    MPSRawSmartEraseParameter

    Custom parameters for smart erasing.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    EraseType String Yes

    Removal Type

    • subtitle removal
    • watermark removal
    • privacy protection
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No

    Subtitle erasing configuration;
    This field is required when the value of EraseType is set to subtitle.
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No

    Watermark erasing configuration.
    This field is required when the value of EraseType is set to watermark.
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No

    Privacy protection configuration.
    This field is required when the value of EraseType is privacy.
    SubtitleEmbedId Integer No

    id of the subtitle removal suppression template.
    UseOriginalPos Integer No

    Suppression configuration, enabled by default, moves subtitles back to the original subtitle position.
    UseOriginalSize Integer No

    Suppression configuration, enabled by default. When enabled, use the original subtitle font size.

    MPSRawSmartSubtitleParameter

    Custom smart subtitle parameter.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    SubtitleType Integer Yes

    Intelligent caption subtitle language type.

    Enumeration value:

    • 0: Source language
    • 1: Target language
    • 2: Source language + target language

    Only 0 is supported when TranslateSwitch is OFF. Only 1 or 2 is supported when TranslateSwitch is ON.
    VideoSrcLanguage String Yes

    Smart subtitling video source language
    OCR recognition supports the following languages:
    zh_en: Chinese-English
    multi: Other
    ASR recognition and pure caption translation currently support the following languages:
    auto: Auto-identification
    zh: Simplified Chinese
    en: English
    ja: Japanese
    ko: Korean
    zh-PY: Chinese-English-Cantonese
    zh_medical: Chinese health care
    vi: Vietnamese
    ms: Malay
    id: Indonesian
    fil: Filipino
    th: Thai
    pt: Portuguese
    tr: Turkish
    ar: Arabic
    es: Spanish
    hi: Hindi
    fr: French
    de: German
    it: Italian
    zh_dialect: Chinese dialect
    zh_en: Chinese-English
    yue: Cantonese
    ru: Russian
    prime_zh: Chinese-English dialect
    af-ZA: Afrikaans (South Africa)
    sq-AL: Albanian (Albania)
    am-ET: Amharic (Ethiopia)
    ar-DZ: Arabic (Algeria)
    ar-BH: Arabic (Bahrain)
    ar-EG: Arabic (Egypt)
    ar-IQ: Arabic (Iraq)
    ar-IL: Arabic (Israel)
    ar-JO: Arabic (Jordan)
    ar-KW: Arabic (Kuwait)
    ar-LB: Arabic (Lebanon)
    ar-MR: Arabic (Mauritania)
    ar-MA: Arabic (Morocco)
    ar-OM: Arabic (Oman)
    ar-QA: Arabic (Qatar)
    ar-SA: Arabic (Saudi Arabia)
    ar-PS: Arabic (State of Palestine)
    ar-SY: Arabic (Syria)
    ar-TN: Arabic (Tunisia)
    ar-AE: Arabic (United Arab Emirates)
    ar-YE: Arabic (Yemen)
    hy-AM: Armenian (Armenia)
    az-AZ: Azerbaijani (Azerbaijan)
    eu-ES: Basque (Spain)
    bn-BD: Bengali (Bangladesh)
    bn-IN: Bengali (India)
    bs-BA: Bosnian (Bosnia and Herzegovina)
    bg-BG: Bulgarian (Bulgaria)
    my-MM: Burmese (Myanmar)
    ca-ES: Catalan (Spain)
    hr-HR: Croatian (Croatia)
    cs-CZ: Czech (Czech Republic)
    da-DK: Danish (Denmark)
    nl-BE: Dutch (Belgium)
    nl-NL: Dutch (Netherlands)
    en-AU: English (Australia)
    en-CA: English (Canada)
    en-GH: English (Ghana)
    en-HK: English (Hong Kong (China))
    en-IN: English (India)
    en-IE: English (Ireland)
    en-KE: English (Kenya)
    en-NZ: English (New Zealand)
    en-NG: English (Nigeria)
    en-PK: English (Pakistan)
    en-PH: English (Philippines)
    en-SG: English (Singapore)
    en-ZA: English (South Africa)
    en-TZ: English (Tanzania)
    en-GB: English (UK)
    en-US: English (United States)
    et-EE: Estonian (Estonia)
    fil-PH: Filipino (Philippines)
    fi-FI: Finnish (Finland)
    fr-BE: French (Belgium)
    fr-CA: French (Canada)
    fr-FR: French (France)
    fr-CH: French (Switzerland)
    gl-ES: Galician (Spain)
    ka-GE: Georgian (Georgia)
    el-GR: Greek (Greece)
    gu-IN: Gujarati (India)
    iw-IL: Hebrew (Israel)
    hi-IN: Hindi (India)
    hu-HU: Hungarian (Hungary)
    is-IS: Icelandic (Iceland)
    id-ID: Indonesian (Indonesia)
    it-IT: Italian (Italy)
    it-CH: Italian (Switzerland)
    ja-JP: Japanese (Japan)
    jv-ID: Javanese (Indonesia)
    kn-IN: Kannada (India)
    kk-KZ: Kazakh (Kazakhstan)
    km-KH: Khmer (Cambodia)
    rw-RW: Kinyarwanda (Rwanda)
    ko-KR: Korean (South Korea)
    lo-LA: Lao (Laos)
    lv-LV: Latvian (Latvia)
    lt-LT: Lithuanian (Lithuania)
    mk-MK: Macedonian (North Macedonia)
    ms-MY: Malay (Malaysia)
    ml-IN: Malayalam (India)
    mr-IN: Marathi (India)
    mn-MN: Mongolian (Mongolia)
    ne-NP: Nepali (Nepal)
    no-NO: Norwegian Bokmål (Norway)
    fa-IR: Persian (Iran)
    pl-PL: Polish (Poland)
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    ro-RO: Romanian (Romania)
    ru-RU: Russian (Russia)
    sr-RS: Serbian (Serbia)
    si-LK: Sinhalese (Sri Lanka)
    sk-SK: Slovak (Slovakia)
    sl-SI: Slovenian (Slovenia)
    st-ZA: Southern Sotho (South Africa)
    es-AR: Spanish (Argentina)
    es-BO: Spanish (Bolivia)
    es-CL: Spanish (Chile)
    es-CO: Spanish (Colombia)
    es-CR: Spanish (Costa Rica)
    es-DO: Spanish (Dominican Republic)
    es-EC: Spanish (Ecuador)
    es-SV: Spanish (El Salvador)
    es-GT: Spanish (Guatemala)
    es-HN: Spanish (Honduras)
    es-MX: Spanish (Mexico)
    es-NI: Spanish (Nicaragua)
    es-PA: Spanish (Panama)
    es-PY: Spanish (Paraguay)
    es-PE: Spanish (Peru)
    es-PR: Spanish (Puerto Rico)
    es-ES: Spanish (Spain)
    es-US: Spanish (United States)
    es-UY: Spanish (Uruguay)
    es-VE: Spanish (Venezuela)
    su-ID: Sundanese (Indonesia)
    sw-KE: Swahili (Kenya)
    sw-TZ: Swahili (Tanzania)
    sv-SE: Swedish (Sweden)
    ta-IN: Tamil (India)
    ta-MY: Tamil (Malaysia)
    ta-SG: Tamil (Singapore)
    ta-LK: Tamil (Sri Lanka)
    te-IN: Telugu (India)
    th-TH: Thai (Thailand)
    ts-ZA: Tsonga (South Africa)
    tr-TR: Turkish (Türkiye)
    uk-UA: Ukrainian (Ukraine)
    ur-IN: Urdu (India)
    ur-PK: Urdu (Pakistan)
    uz-UZ: Uzbek (Uzbekistan)
    ve-ZA: Venda (South Africa)vi-VN: Vietnamese (Vietnam)
    xh-ZA: Xhosa (South Africa)
    zu-ZA: Zulu (South Africa)
    SubtitleFormat String No

    Intelligent subtitle file format:

    • For ASR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
      • Blank or fill in the blank: no subtitle file generated
    • For pure caption translation processing type:
      • original: consistent with the source file
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
    • For OCR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle

    Note:

    • For ASR recognition method, passing blank or unspecified is not allowed when translating at least 2 languages.
    • For pure caption translation and OCR recognition translation methods, passing blank or unspecified is not allowed.
    • For OCR type tasks, passing blank or unspecified is allowed when suppression is enabled.
    TranslateSwitch String No

    Subtitle translation switch
    ON: Enable translation
    OFF: Disable translation

    Note: For pure subtitle translation mode, the default value is enabled if the field is unspecified. The field cannot be left blank or set to OFF.
    TranslateDstLanguage String No

    Subtitle target language
    Take effect when TranslateSwitch is ON. Translation language list:
    ab: Abkhaz
    ace: Acehnese
    ach: Acholi
    af: Afrikaans
    ak: Akan
    am: Amharic
    ar: Arabic
    as: Assamese
    ay: Aymara
    az: Azerbaijani
    ba: Bashkir
    ban: Balinese
    bbc: Batak Toba
    bem: Bemba
    bew: Betawi
    bg: Bulgarian
    bho: Bhojpuri
    bik: Bikol
    bm: Bambara
    bn: Bengali
    br: Breton
    bs: Bosnian
    btx: Batak Karo
    bts: Batak Simalungun
    bua: Buryat
    ca: Catalan
    ceb: Cebuano
    cgg: Kiga
    chm: Meadow Mari
    ckb: Kurdish (Sorani)
    cnh: Hakha Chin
    co: Corsican
    crh: Crimean Tatar
    crs: Seychellois Creole
    cs: Czech
    cv: Chuvash
    cy: Welsh
    da: Danish
    de: German
    din: Dinka
    doi: Dogri
    dov: Dombe
    dv: Dhivehi
    dz: Dzongkha
    ee: Ewe
    el: Greek
    en: English
    eo: Esperanto
    es: Spanish
    et: Estonian
    eu: Basque
    fa: Persian
    ff: Fula
    fi: Finnish
    fil: Filipino (Tagalog)
    fj: Fijian
    fr: French
    fr-CA: French (Canada)
    fr-FR: French (France)
    fy: Frisian
    ga: Irish
    gaa: Ga Language
    gd: Scottish Gaelic
    gl: Galician
    gn: Guarani
    gom: Konkani
    gu: Gujarati
    gv: Manx
    ha: Hausa
    haw: Hawaiian
    he: Hebrew
    hi: Hindi
    hil: Hiligaynon
    hmn: Hmong
    hr: Croatian
    hrx: Hunsrik
    ht: Haitian Creole
    hu: Hungarian
    hy: Armenian
    id: Indonesian
    ig: Igbo
    ilo: Ilocano
    is: Icelandic
    it: Italian
    iw: Hebrew
    ja: Japanese
    jv: Javanese
    ka: Georgian
    kk: Kazakh
    km: Khmer
    kn: Kannada
    ko: Korean
    kri: Krio
    ku: Kurdish (Kurmanji)
    ktu: Kituba
    ky: Kyrgyz
    la: Latin
    lb: Luxembourgish
    lg: Ganda (Luganda)
    li: Limburgish
    lij: Ligurian
    lmo: Lombard
    ln: Lingala
    lo: Lao
    lt: Lithuanian
    ltg: Latgalian
    luo: Luo
    lus: Mizo
    lv: Latvian
    mai: Maithili
    mak: Makassar
    mg: Malagasy
    mi: Maori
    min: Minangkabau
    mk: Macedonian
    ml: Malayalam
    mn: Mongolian
    mr: Marathi
    ms: Malay
    mt: Maltese
    my: Burmese
    ne: Nepali
    new: Newari
    nl: Dutch
    no: Norwegian
    nr: Southern Ndebele
    nso: Northern Sotho (Sepedi)
    nus: Nuer
    ny: Chichewa (Nyanja)
    oc: Occitan
    om: Oromo
    or: Odia
    pa: Punjabi
    pag: Pangasinan
    pam: Kapampangan
    pap: Papiamento
    pl: Polish
    ps: Pashto
    pt: Portuguese
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    qu: Quechua
    ro: Romanian
    rom: Romani
    rn: Rundi
    ru: Russian
    rw: Kinyarwanda
    sa: Sanskrit
    scn: Sicilian
    sd: Sindhi
    sg: Sango
    shn: Shan
    si: Sinhalese
    sk: Slovak
    sl: Slovenian
    sm: Samoan
    sn: Shona
    so: Somali
    sq: Albanian
    sr: Serbian
    ss: Swati
    st: Sesotho
    su: Sundanese
    sv: Swedish
    sw: Swahili
    szl: Silesian
    ta: Tamil
    te: Telugu
    tet: Tetum
    tg: Tajik
    th: Thai
    ti: Tigrinya
    tk: Turkmen
    tn: Tswana
    tr: Turkish
    ts: Tsonga
    tt: Tatar
    ug: Uyghur
    uk: Ukrainian
    ur: Urdu
    uz: Uzbek
    vi: Vietnamese
    xh: Xhosa
    yi: Yiddish
    yo: Yoruba
    yua: Yucatec Maya
    yue: Cantonese
    zh: Simplified Chinese
    zh-TW: Traditional Chinese
    zu: Zulu

    Note: Use the multilingual method. / to separate, such as en/ja, which indicates English and Japanese.
    ExtInfo String No

    Custom parameter
    ProcessType Integer No

    Subtitle processing type:

    • 0: ASR recognition subtitle
    • 1: Pure caption translation
    • 2: OCR recognition subtitle

    Note: The default type is ASR recognition subtitle if the field is unspecified.

    MPSSelectingSubtitleAreasConfig

    Area configurations for the subtitle OCR extraction box.

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    AutoAreas Array of MPSEraseArea No

    Automatically select a custom region. For the selected areas, the AI model is used to automatically detect and extract the target content.
    SampleWidth Integer No

    Width of the sample video or image, in pixels.
    SampleHeight Integer No

    Height of the sample video or image, in pixels.

    MPSSmartErasePrivacyConfig

    Privacy protection configuration for the smart erasing template.

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    PrivacyModel String Yes

    Privacy protection removal method.

    Enumeration value:

    • blur: Blurry
    • mosaic: Mosaic
    PrivacyTargets Array of String Yes

    Privacy protection objective (no need to input an array when in use on API Explorer, just add the corresponding item and fill in the value).

    Enumeration value:

    • face: human face
    • plate: license plate

    MPSSmartEraseSubtitleConfig

    Subtitle removal configuration for the smart erasing template.

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    SubtitleEraseMethod String Yes

    Subtitle erasure method.
    Automatic erasing: Video subtitles are automatically recognized using an AI model and are erased without traces to generate a new video. However, missed or incorrect erasing may occur due to image interference and special subtitle styles. In this case, you can specify the erasing area.
    When using automatic erasing, if you do not specify AutoAreas, the default region (lower middle part of the frame) will be erased automatically. If AutoAreas is specified, the designated region will be erased instead.
    Specified area erasure: If your subtitle position is fixed, it is recommended to directly specify the erasure area to minimize missed erasures.
    When choosing specified area erasure, please input at least one designated region in CustomAreas.

    • auto: Automatic erasing
    • custom: Specified area erasure
    SubtitleModel String Yes

    Subtitle erasure model.
    Standard version (recommended): If your subtitles have a standard style, it is usually recommended to select this version for better effectiveness in seamless detail removal.
    Area edition: If the subtitles have special styles, such as calligraphy, shadow, or motion effects, you are recommended to select this edition to ensure a larger erasing area. However, the erasing effect in the details is not as good as the standard edition.

    • standard Standard model
    • area Regional model
    OcrSwitch String No

    Whether OCR subtitle extraction is enabled. The default value is OFF.
    OCR subtitle extraction is supported if and only if SubtitleEraseMethod is set to auto. When enabled, it identifies the text region that appears most persistently and stably within the automatic erasing area as the subtitle area. The text within the subtitle area is extracted and erased.

    • ON Enable
    • OFF Disable
    SubtitleLang String No

    Subtitle language, used to guide OCR recognition, default value is zh_en. This parameter is valid only when OcrSwitch is "ON".

    • zh_en Chinese and English
    • multi Other
      Other supported recognition languages are as follows:
      Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, Hindi, Arabic, India-Bengali, India-Gujarati, India-Kannada, India-Malayalam, India-Tamil, India-Telugu, Slovenian, Polish, Catalonia, Bosnia, Czech, Estonian, Croatian, Punjabi, Marathi, Azerbaijan, Indonesian, Luxembourg, Lithuanian, Latvian, Malta, Slovak, Turkish, Kazakh, Greek, Irish, Belarus, Khmer, Tagalog, Pashto, Persian, Tajikistan
    SubtitleFormat String No

    Subtitle file format. Default value is vtt. This parameter is valid only when OcrSwitch takes value "ON".

    • srt srt format
    • vtt WebVTT format
    • When SubtitleEmbedId is filled, empty string can be taken to indicate no output subtitles.
    TransSwitch String No

    Whether caption translation is enabled or not. The default value is OFF. This parameter is valid only when OcrSwitch is set to "ON".

    • ON Enable
    • OFF Disable
    TransDstLang String No

    The target language for subtitles, default value is en; this parameter is valid only when TransSwitch is set to "ON".
    Currently support the following languages:
    zh: Simplified Chinese
    en: English
    ja: Japanese
    ko: Korean
    fr: French
    es: Spanish
    it: Italian
    de: German
    tr: Turkish
    ru: Russian
    pt: Portuguese
    vi: Vietnamese
    id: Indonesian
    ms: Malay
    th: Thai
    ar: Arabic
    hi: Hindi
    AutoAreas Array of MPSEraseArea No

    Automatically erase custom regions.
    For selected regions, use the AI model to automatically detect and erase existing targets.
    Note: When the erase method is set to custom, this parameter will not take effect. To modify the template, input [] for region cleanup. If not provided, the template region information remains unchanged.
    CustomAreas Array of MPSEraseTimeArea No

    Designate the removal of custom regions.
    For specified regions, directly perform erasure without detection and recognition within a selected time range.
    Note: When modifying the template, import [] to clear regions. The template region information remains unchanged if not imported.
    UseOriginalPos Integer No

    Suppression configuration, enabled by default, compresses subtitles back to their original position. It can be filled only when OCR translation is turned on. A value of 0 indicates disabled suppression.
    UseOriginalSize Integer No

    Suppression configuration, enabled by default. After being turned on, the original subtitle font size is used. It can only be filled when OCR translation is enabled. Setting it to 0 means non-use of the original font size.

    MPSSmartEraseTaskInput

    Intelligent erasure task

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer No

    id of the intelligent erasing template.
    RawParameter MPSRawSmartEraseParameter No

    Custom parameters for intelligent erasure. Valid when Definition is set to 0. This parameter is used in highly customized scenarios. It is recommended to prioritize using Definition to specify intelligent erasure parameters.
    OverrideParameter MPSOverrideEraseParameter No

    Custom parameters for smart erasing. When the value of Definition is not 0, this parameter is valid. When certain erasing parameters in this structure are specified, the specified parameters will be used to overwrite those in the smart erasing template. This parameter is used in highly customized scenarios. It is recommended to use only Definition to specify smart erasing parameters.

    MPSSmartEraseTemplate

    MPS intelligent erasure template input

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes

    Length limit for the smart erasing template name: 64 characters.
    EraseType String Yes

    Removal Type

    • subtitle removal
    • watermark removal
    • privacy protection
    Comment String No

    Length limit for the description information of the smart erasing template: 256 characters.
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No

    Subtitle erasing configuration. This parameter is required and valid only when the value of EraseType is set to subtitle.
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No

    Watermark erasing configuration. This parameter is required and valid only when the value of EraseType is set to watermark.
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No

    Privacy protection configuration. This parameter is required and valid only when the value of EraseType is set to privacy.
    SampleWidth Integer No

    Width of the sample video or image, in pixels.
    SampleHeight Integer No

    Height of the sample video or image, in pixels.

    MPSSmartEraseTemplateForUpdate

    MPS intelligent erasure template input

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes

    Unique identifier of the intelligent erasure template
    Name String Yes

    Length limit for the smart erasing template name: 64 characters.
    EraseType String Yes

    Removal Type

    • subtitle removal
    • watermark removal
    • privacy protection
    Comment String No

    Length limit for the description information of the smart erasing template: 256 characters.
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No

    Subtitle erasing configuration. It takes effect when the value of EraseType is set to subtitle, or when the value of EraseType is left unspecified but the original EraseType value of the modified template is subtitle.
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No

    Watermark erasing configuration. The value of EraseType can be set to watermark or left unspecified. This parameter is valid only when the value of EraseType of the corresponding template is set to watermark.
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No

    Privacy protection configuration. The value of EraseType can be set to privacy or left unspecified. This parameter is valid only when the value of EraseType of the corresponding template is set to privacy.
    SampleWidth Integer No

    Width of the sample video or image, in pixels.
    SampleHeight Integer No

    Height of the sample video or image, in pixels.

    MPSSmartEraseWatermarkConfig

    Watermark removal configuration for the smart erasing template.

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    WatermarkEraseMethod String Yes

    Watermark removal method. Auto erasure: Automatically identify watermarks in the video through Model A and generate a new video after removal. Suitable for dynamic watermarks. When using auto erasure, if you do not specify AutoAreas, the system will perform full-screen auto erasure on the video; if AutoAreas are specified, it will change to auto erasure on your designated regions. Specified area erasure: For static watermarks with fixed positions, it is recommended to directly specify the removal area. When you choose specified area erasure, import at least one designated region. - auto Auto erasure - custom Specified area erasure
    WatermarkModel String Yes

    Watermark removal model. basic Edition: provides average effects and high cost performance. It applies to animations or videos with clean backgrounds. advanced Edition: offers better effectiveness and is suitable for mini-dramas or reality-style videos. - basic Edition - advanced Edition
    AutoAreas Array of MPSEraseArea No

    Automatically erase custom regions. For selected regions, use the AI model to automatically detect and erase existing targets. Note: When the erase method is set to custom, this parameter will not take effect. To clear regions, input []. If not provided, the template region information remains unchanged.
    CustomAreas Array of MPSEraseTimeArea No

    Specify the removal of custom regions. For specified regions, directly perform erasure without detection and recognition within a selected time range. Note: Import [] to clear regions. The template region information remains unchanged if not imported.

    MPSSmartSubtitleTemplate

    MPS smart subtitling template input

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes

    Intelligent subtitle template name
    Length limit: 64 characters.
    Comment String Yes

    Intelligent caption template description information
    Length limit: 256 characters.
    SubtitleType Integer Yes

    Smart subtitle language type.
    0: source language.
    1: target language.
    2: source language and target language.
    Only 0 is supported when TranslateSwitch is OFF.
    Only 1 or 2 is supported when TranslateSwitch is ON.
    VideoSrcLanguage String No

    Smart subtitling video source language
    OCR recognition supports the following languages:
    zh_en: Chinese-English
    multi: Other
    ASR recognition and pure caption translation currently support the following languages:
    auto: Auto-identification
    zh: Simplified Chinese
    en: English
    ja: Japanese
    ko: Korean
    zh-PY: Chinese-English-Cantonese
    zh_medical: Chinese health care
    vi: Vietnamese
    ms: Malay
    id: Indonesian
    fil: Filipino
    th: Thai
    pt: Portuguese
    tr: Turkish
    ar: Arabic
    es: Spanish
    hi: Hindi
    fr: French
    de: German
    it: Italian
    zh_dialect: Chinese dialect
    zh_en: Chinese-English
    yue: Cantonese
    ru: Russian
    prime_zh: Chinese-English dialect
    af-ZA: Afrikaans (South Africa)
    sq-AL: Albanian (Albania)
    am-ET: Amharic (Ethiopia)
    ar-DZ: Arabic (Algeria)
    ar-BH: Arabic (Bahrain)
    ar-EG: Arabic (Egypt)
    ar-IQ: Arabic (Iraq)
    ar-IL: Arabic (Israel)
    ar-JO: Arabic (Jordan)
    ar-KW: Arabic (Kuwait)
    ar-LB: Arabic (Lebanon)
    ar-MR: Arabic (Mauritania)
    ar-MA: Arabic (Morocco)
    ar-OM: Arabic (Oman)
    ar-QA: Arabic (Qatar)
    ar-SA: Arabic (Saudi Arabia)
    ar-PS: Arabic (State of Palestine)
    ar-SY: Arabic (Syria)
    ar-TN: Arabic (Tunisia)
    ar-AE: Arabic (United Arab Emirates)
    ar-YE: Arabic (Yemen)
    hy-AM: Armenian (Armenia)
    az-AZ: Azerbaijani (Azerbaijan)
    eu-ES: Basque (Spain)
    bn-BD: Bengali (Bangladesh)
    bn-IN: Bengali (India)
    bs-BA: Bosnian (Bosnia and Herzegovina)
    bg-BG: Bulgarian (Bulgaria)
    my-MM: Burmese (Myanmar)
    ca-ES: Catalan (Spain)
    hr-HR: Croatian (Croatia)
    cs-CZ: Czech (Czech Republic)
    da-DK: Danish (Denmark)
    nl-BE: Dutch (Belgium)
    nl-NL: Dutch (Netherlands)
    en-AU: English (Australia)
    en-CA: English (Canada)
    en-GH: English (Ghana)
    en-HK: English (Hong Kong (China))
    en-IN: English (India)
    en-IE: English (Ireland)
    en-KE: English (Kenya)
    en-NZ: English (New Zealand)
    en-NG: English (Nigeria)
    en-PK: English (Pakistan)
    en-PH: English (Philippines)
    en-SG: English (Singapore)
    en-ZA: English (South Africa)
    en-TZ: English (Tanzania)
    en-GB: English (UK)
    en-US: English (United States)
    et-EE: Estonian (Estonia)
    fil-PH: Filipino (Philippines)
    fi-FI: Finnish (Finland)
    fr-BE: French (Belgium)
    fr-CA: French (Canada)
    fr-FR: French (France)
    fr-CH: French (Switzerland)
    gl-ES: Galician (Spain)
    ka-GE: Georgian (Georgia)
    el-GR: Greek (Greece)
    gu-IN: Gujarati (India)
    iw-IL: Hebrew (Israel)
    hi-IN: Hindi (India)
    hu-HU: Hungarian (Hungary)
    is-IS: Icelandic (Iceland)
    id-ID: Indonesian (Indonesia)
    it-IT: Italian (Italy)
    it-CH: Italian (Switzerland)
    ja-JP: Japanese (Japan)
    jv-ID: Javanese (Indonesia)
    kn-IN: Kannada (India)
    kk-KZ: Kazakh (Kazakhstan)
    km-KH: Khmer (Cambodia)
    rw-RW: Kinyarwanda (Rwanda)
    ko-KR: Korean (South Korea)
    lo-LA: Lao (Laos)
    lv-LV: Latvian (Latvia)
    lt-LT: Lithuanian (Lithuania)
    mk-MK: Macedonian (North Macedonia)
    ms-MY: Malay (Malaysia)
    ml-IN: Malayalam (India)
    mr-IN: Marathi (India)
    mn-MN: Mongolian (Mongolia)
    ne-NP: Nepali (Nepal)
    no-NO: Norwegian Bokmål (Norway)
    fa-IR: Persian (Iran)
    pl-PL: Polish (Poland)
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    ro-RO: Romanian (Romania)
    ru-RU: Russian (Russia)
    sr-RS: Serbian (Serbia)
    si-LK: Sinhalese (Sri Lanka)
    sk-SK: Slovak (Slovakia)
    sl-SI: Slovenian (Slovenia)
    st-ZA: Southern Sotho (South Africa)
    es-AR: Spanish (Argentina)
    es-BO: Spanish (Bolivia)
    es-CL: Spanish (Chile)
    es-CO: Spanish (Colombia)
    es-CR: Spanish (Costa Rica)
    es-DO: Spanish (Dominican Republic)
    es-EC: Spanish (Ecuador)
    es-SV: Spanish (El Salvador)
    es-GT: Spanish (Guatemala)
    es-HN: Spanish (Honduras)
    es-MX: Spanish (Mexico)
    es-NI: Spanish (Nicaragua)
    es-PA: Spanish (Panama)
    es-PY: Spanish (Paraguay)
    es-PE: Spanish (Peru)
    es-PR: Spanish (Puerto Rico)
    es-ES: Spanish (Spain)
    es-US: Spanish (United States)
    es-UY: Spanish (Uruguay)
    es-VE: Spanish (Venezuela)
    su-ID: Sundanese (Indonesia)
    sw-KE: Swahili (Kenya)
    sw-TZ: Swahili (Tanzania)
    sv-SE: Swedish (Sweden)
    ta-IN: Tamil (India)
    ta-MY: Tamil (Malaysia)
    ta-SG: Tamil (Singapore)
    ta-LK: Tamil (Sri Lanka)
    te-IN: Telugu (India)
    th-TH: Thai (Thailand)
    ts-ZA: Tsonga (South Africa)
    tr-TR: Turkish (Türkiye)
    uk-UA: Ukrainian (Ukraine)
    ur-IN: Urdu (India)
    ur-PK: Urdu (Pakistan)
    uz-UZ: Uzbek (Uzbekistan)
    ve-ZA: Venda (South Africa)vi-VN: Vietnamese (Vietnam)
    xh-ZA: Xhosa (South Africa)
    zu-ZA: Zulu (South Africa)
    SubtitleFormat String No

    Intelligent subtitle file format:

    • For ASR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
      • Leave blank or fill in the blank: no subtitle file generated
    • For pure subtitle translation processing type:
      • original: consistent with the source file
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
    • For OCR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle

    Note:

    • For ASR recognition method, do not leave blank or not pass when translating 2 or more languages.
    • For pure subtitle translation method, do not leave blank or not pass.
    • For OCR tasks, it is allowed to leave blank or not pass when suppression is enabled.
    TranslateSwitch String No

    Subtitle translation switch
    ON: Enable translation
    OFF: Disable translation

    Note: For pure subtitle translation mode, the default value is enabled if the field is unspecified. The field cannot be left blank or set to OFF.
    TranslateDstLanguage String No

    Subtitle target language
    Take effect when TranslateSwitch is ON. Translation language list:
    ab: Abkhaz
    ace: Acehnese
    ach: Acholi
    af: Afrikaans
    ak: Akan
    am: Amharic
    ar: Arabic
    as: Assamese
    ay: Aymara
    az: Azerbaijani
    ba: Bashkir
    ban: Balinese
    bbc: Batak Toba
    bem: Bemba
    bew: Betawi
    bg: Bulgarian
    bho: Bhojpuri
    bik: Bikol
    bm: Bambara
    bn: Bengali
    br: Breton
    bs: Bosnian
    btx: Batak Karo
    bts: Batak Simalungun
    bua: Buryat
    ca: Catalan
    ceb: Cebuano
    cgg: Kiga
    chm: Meadow Mari
    ckb: Kurdish (Sorani)
    cnh: Hakha Chin
    co: Corsican
    crh: Crimean Tatar
    crs: Seychellois Creole
    cs: Czech
    cv: Chuvash
    cy: Welsh
    da: Danish
    de: German
    din: Dinka
    doi: Dogri
    dov: Dombe
    dv: Dhivehi
    dz: Dzongkha
    ee: Ewe
    el: Greek
    en: English
    eo: Esperanto
    es: Spanish
    et: Estonian
    eu: Basque
    fa: Persian
    ff: Fula
    fi: Finnish
    fil: Filipino (Tagalog)
    fj: Fijian
    fr: French
    fr-CA: French (Canada)
    fr-FR: French (France)
    fy: Frisian
    ga: Irish
    gaa: Ga Language
    gd: Scottish Gaelic
    gl: Galician
    gn: Guarani
    gom: Konkani
    gu: Gujarati
    gv: Manx
    ha: Hausa
    haw: Hawaiian
    he: Hebrew
    hi: Hindi
    hil: Hiligaynon
    hmn: Hmong
    hr: Croatian
    hrx: Hunsrik
    ht: Haitian Creole
    hu: Hungarian
    hy: Armenian
    id: Indonesian
    ig: Igbo
    ilo: Ilocano
    is: Icelandic
    it: Italian
    iw: Hebrew
    ja: Japanese
    jv: Javanese
    ka: Georgian
    kk: Kazakh
    km: Khmer
    kn: Kannada
    ko: Korean
    kri: Krio
    ku: Kurdish (Kurmanji)
    ktu: Kituba
    ky: Kyrgyz
    la: Latin
    lb: Luxembourgish
    lg: Ganda (Luganda)
    li: Limburgish
    lij: Ligurian
    lmo: Lombard
    ln: Lingala
    lo: Lao
    lt: Lithuanian
    ltg: Latgalian
    luo: Luo
    lus: Mizo
    lv: Latvian
    mai: Maithili
    mak: Makassar
    mg: Malagasy
    mi: Maori
    min: Minangkabau
    mk: Macedonian
    ml: Malayalam
    mn: Mongolian
    mr: Marathi
    ms: Malay
    mt: Maltese
    my: Burmese
    ne: Nepali
    new: Newari
    nl: Dutch
    no: Norwegian
    nr: Southern Ndebele
    nso: Northern Sotho (Sepedi)
    nus: Nuer
    ny: Chichewa (Nyanja)
    oc: Occitan
    om: Oromo
    or: Odia
    pa: Punjabi
    pag: Pangasinan
    pam: Kapampangan
    pap: Papiamento
    pl: Polish
    ps: Pashto
    pt: Portuguese
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    qu: Quechua
    ro: Romanian
    rom: Romani
    rn: Rundi
    ru: Russian
    rw: Kinyarwanda
    sa: Sanskrit
    scn: Sicilian
    sd: Sindhi
    sg: Sango
    shn: Shan
    si: Sinhalese
    sk: Slovak
    sl: Slovenian
    sm: Samoan
    sn: Shona
    so: Somali
    sq: Albanian
    sr: Serbian
    ss: Swati
    st: Sesotho
    su: Sundanese
    sv: Swedish
    sw: Swahili
    szl: Silesian
    ta: Tamil
    te: Telugu
    tet: Tetum
    tg: Tajik
    th: Thai
    ti: Tigrinya
    tk: Turkmen
    tn: Tswana
    tr: Turkish
    ts: Tsonga
    tt: Tatar
    ug: Uyghur
    uk: Ukrainian
    ur: Urdu
    uz: Uzbek
    vi: Vietnamese
    xh: Xhosa
    yi: Yiddish
    yo: Yoruba
    yua: Yucatec Maya
    yue: Cantonese
    zh: Simplified Chinese
    zh-TW: Traditional Chinese
    zu: Zulu

    Note: Use the multilingual method. / to separate, such as en/ja, which indicates English and Japanese.
    ProcessType Integer No

    Subtitle processing type:

    • 0: ASR recognition subtitle
    • 1: Pure caption translation
    • 2: OCR recognition subtitle

    Note: The default type is ASR recognition subtitle if the field is unspecified.
    SelectingSubtitleAreasConfig MPSSelectingSubtitleAreasConfig No

    Area configurations for the subtitle OCR extraction box
    SpeakerMode Integer No

    Speaker identification switch. Valid values:
    0: Speaker identification is disabled.
    1: Speaker identification is enabled.
    By default, speaker identification is disabled.
    SpeakerLabel Integer No

    Indicates whether to output the identified speaker to the subtitle file. Valid values:
    0: The speaker is not output to the subtitle file.
    1: The speaker is output to the VTT subtitle file.
    Note: To use this parameter, the value of SpeakerMode cannot be 0.
    By default, the speaker is not output to the subtitle file.

    MPSSmartSubtitleTemplateForUpdate

    MPS smart subtitling template input

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes

    Unique identifier of the smart subtitle template.
    Name String Yes

    Intelligent subtitle template name
    Length limit: 64 characters.
    Comment String Yes

    Intelligent caption template description information
    Length limit: 256 characters.
    SubtitleType Integer Yes

    Smart subtitle language type.
    0: source language.
    1: target language.
    2: source language and target language.
    Only 0 is supported when TranslateSwitch is OFF.
    Only 1 or 2 is supported when TranslateSwitch is ON.
    VideoSrcLanguage String No

    Smart subtitling video source language
    OCR recognition supports the following languages:
    zh_en: Chinese-English
    multi: Other
    ASR recognition and pure caption translation currently support the following languages:
    auto: Auto-identification
    zh: Simplified Chinese
    en: English
    ja: Japanese
    ko: Korean
    zh-PY: Chinese-English-Cantonese
    zh_medical: Chinese health care
    vi: Vietnamese
    ms: Malay
    id: Indonesian
    fil: Filipino
    th: Thai
    pt: Portuguese
    tr: Turkish
    ar: Arabic
    es: Spanish
    hi: Hindi
    fr: French
    de: German
    it: Italian
    zh_dialect: Chinese dialect
    zh_en: Chinese-English
    yue: Cantonese
    ru: Russian
    prime_zh: Chinese-English dialect
    af-ZA: Afrikaans (South Africa)
    sq-AL: Albanian (Albania)
    am-ET: Amharic (Ethiopia)
    ar-DZ: Arabic (Algeria)
    ar-BH: Arabic (Bahrain)
    ar-EG: Arabic (Egypt)
    ar-IQ: Arabic (Iraq)
    ar-IL: Arabic (Israel)
    ar-JO: Arabic (Jordan)
    ar-KW: Arabic (Kuwait)
    ar-LB: Arabic (Lebanon)
    ar-MR: Arabic (Mauritania)
    ar-MA: Arabic (Morocco)
    ar-OM: Arabic (Oman)
    ar-QA: Arabic (Qatar)
    ar-SA: Arabic (Saudi Arabia)
    ar-PS: Arabic (State of Palestine)
    ar-SY: Arabic (Syria)
    ar-TN: Arabic (Tunisia)
    ar-AE: Arabic (United Arab Emirates)
    ar-YE: Arabic (Yemen)
    hy-AM: Armenian (Armenia)
    az-AZ: Azerbaijani (Azerbaijan)
    eu-ES: Basque (Spain)
    bn-BD: Bengali (Bangladesh)
    bn-IN: Bengali (India)
    bs-BA: Bosnian (Bosnia and Herzegovina)
    bg-BG: Bulgarian (Bulgaria)
    my-MM: Burmese (Myanmar)
    ca-ES: Catalan (Spain)
    hr-HR: Croatian (Croatia)
    cs-CZ: Czech (Czech Republic)
    da-DK: Danish (Denmark)
    nl-BE: Dutch (Belgium)
    nl-NL: Dutch (Netherlands)
    en-AU: English (Australia)
    en-CA: English (Canada)
    en-GH: English (Ghana)
    en-HK: English (Hong Kong (China))
    en-IN: English (India)
    en-IE: English (Ireland)
    en-KE: English (Kenya)
    en-NZ: English (New Zealand)
    en-NG: English (Nigeria)
    en-PK: English (Pakistan)
    en-PH: English (Philippines)
    en-SG: English (Singapore)
    en-ZA: English (South Africa)
    en-TZ: English (Tanzania)
    en-GB: English (UK)
    en-US: English (United States)
    et-EE: Estonian (Estonia)
    fil-PH: Filipino (Philippines)
    fi-FI: Finnish (Finland)
    fr-BE: French (Belgium)
    fr-CA: French (Canada)
    fr-FR: French (France)
    fr-CH: French (Switzerland)
    gl-ES: Galician (Spain)
    ka-GE: Georgian (Georgia)
    el-GR: Greek (Greece)
    gu-IN: Gujarati (India)
    iw-IL: Hebrew (Israel)
    hi-IN: Hindi (India)
    hu-HU: Hungarian (Hungary)
    is-IS: Icelandic (Iceland)
    id-ID: Indonesian (Indonesia)
    it-IT: Italian (Italy)
    it-CH: Italian (Switzerland)
    ja-JP: Japanese (Japan)
    jv-ID: Javanese (Indonesia)
    kn-IN: Kannada (India)
    kk-KZ: Kazakh (Kazakhstan)
    km-KH: Khmer (Cambodia)
    rw-RW: Kinyarwanda (Rwanda)
    ko-KR: Korean (South Korea)
    lo-LA: Lao (Laos)
    lv-LV: Latvian (Latvia)
    lt-LT: Lithuanian (Lithuania)
    mk-MK: Macedonian (North Macedonia)
    ms-MY: Malay (Malaysia)
    ml-IN: Malayalam (India)
    mr-IN: Marathi (India)
    mn-MN: Mongolian (Mongolia)
    ne-NP: Nepali (Nepal)
    no-NO: Norwegian Bokmål (Norway)
    fa-IR: Persian (Iran)
    pl-PL: Polish (Poland)
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    ro-RO: Romanian (Romania)
    ru-RU: Russian (Russia)
    sr-RS: Serbian (Serbia)
    si-LK: Sinhalese (Sri Lanka)
    sk-SK: Slovak (Slovakia)
    sl-SI: Slovenian (Slovenia)
    st-ZA: Southern Sotho (South Africa)
    es-AR: Spanish (Argentina)
    es-BO: Spanish (Bolivia)
    es-CL: Spanish (Chile)
    es-CO: Spanish (Colombia)
    es-CR: Spanish (Costa Rica)
    es-DO: Spanish (Dominican Republic)
    es-EC: Spanish (Ecuador)
    es-SV: Spanish (El Salvador)
    es-GT: Spanish (Guatemala)
    es-HN: Spanish (Honduras)
    es-MX: Spanish (Mexico)
    es-NI: Spanish (Nicaragua)
    es-PA: Spanish (Panama)
    es-PY: Spanish (Paraguay)
    es-PE: Spanish (Peru)
    es-PR: Spanish (Puerto Rico)
    es-ES: Spanish (Spain)
    es-US: Spanish (United States)
    es-UY: Spanish (Uruguay)
    es-VE: Spanish (Venezuela)
    su-ID: Sundanese (Indonesia)
    sw-KE: Swahili (Kenya)
    sw-TZ: Swahili (Tanzania)
    sv-SE: Swedish (Sweden)
    ta-IN: Tamil (India)
    ta-MY: Tamil (Malaysia)
    ta-SG: Tamil (Singapore)
    ta-LK: Tamil (Sri Lanka)
    te-IN: Telugu (India)
    th-TH: Thai (Thailand)
    ts-ZA: Tsonga (South Africa)
    tr-TR: Turkish (Türkiye)
    uk-UA: Ukrainian (Ukraine)
    ur-IN: Urdu (India)
    ur-PK: Urdu (Pakistan)
    uz-UZ: Uzbek (Uzbekistan)
    ve-ZA: Venda (South Africa)vi-VN: Vietnamese (Vietnam)
    xh-ZA: Xhosa (South Africa)
    zu-ZA: Zulu (South Africa)
    SubtitleFormat String No

    Intelligent subtitle file format:

    • For ASR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
      • Leave blank or fill in the blank: no subtitle file generated
    • For pure subtitle translation processing type:
      • original: consistent with the source file
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle
    • For OCR recognition translation processing type:
      • vtt: WebVTT format subtitle
      • srt: SRT format subtitle

    Note:

    • For ASR recognition method, do not leave blank or not pass when translating 2 or more languages.
    • For pure subtitle translation method, do not leave blank or not pass.
    • For OCR tasks, it is allowed to leave blank or not pass when suppression is enabled.
    TranslateSwitch String No

    Subtitle translation switch
    ON: Enable translation
    OFF: Disable translation

    Note: For pure subtitle translation mode, the default value is enabled if the field is unspecified. The field cannot be left blank or set to OFF.
    TranslateDstLanguage String No

    Subtitle target language
    Take effect when TranslateSwitch is ON. Translation language list:
    ab: Abkhaz
    ace: Acehnese
    ach: Acholi
    af: Afrikaans
    ak: Akan
    am: Amharic
    ar: Arabic
    as: Assamese
    ay: Aymara
    az: Azerbaijani
    ba: Bashkir
    ban: Balinese
    bbc: Batak Toba
    bem: Bemba
    bew: Betawi
    bg: Bulgarian
    bho: Bhojpuri
    bik: Bikol
    bm: Bambara
    bn: Bengali
    br: Breton
    bs: Bosnian
    btx: Batak Karo
    bts: Batak Simalungun
    bua: Buryat
    ca: Catalan
    ceb: Cebuano
    cgg: Kiga
    chm: Meadow Mari
    ckb: Kurdish (Sorani)
    cnh: Hakha Chin
    co: Corsican
    crh: Crimean Tatar
    crs: Seychellois Creole
    cs: Czech
    cv: Chuvash
    cy: Welsh
    da: Danish
    de: German
    din: Dinka
    doi: Dogri
    dov: Dombe
    dv: Dhivehi
    dz: Dzongkha
    ee: Ewe
    el: Greek
    en: English
    eo: Esperanto
    es: Spanish
    et: Estonian
    eu: Basque
    fa: Persian
    ff: Fula
    fi: Finnish
    fil: Filipino (Tagalog)
    fj: Fijian
    fr: French
    fr-CA: French (Canada)
    fr-FR: French (France)
    fy: Frisian
    ga: Irish
    gaa: Ga Language
    gd: Scottish Gaelic
    gl: Galician
    gn: Guarani
    gom: Konkani
    gu: Gujarati
    gv: Manx
    ha: Hausa
    haw: Hawaiian
    he: Hebrew
    hi: Hindi
    hil: Hiligaynon
    hmn: Hmong
    hr: Croatian
    hrx: Hunsrik
    ht: Haitian Creole
    hu: Hungarian
    hy: Armenian
    id: Indonesian
    ig: Igbo
    ilo: Ilocano
    is: Icelandic
    it: Italian
    iw: Hebrew
    ja: Japanese
    jv: Javanese
    ka: Georgian
    kk: Kazakh
    km: Khmer
    kn: Kannada
    ko: Korean
    kri: Krio
    ku: Kurdish (Kurmanji)
    ktu: Kituba
    ky: Kyrgyz
    la: Latin
    lb: Luxembourgish
    lg: Ganda (Luganda)
    li: Limburgish
    lij: Ligurian
    lmo: Lombard
    ln: Lingala
    lo: Lao
    lt: Lithuanian
    ltg: Latgalian
    luo: Luo
    lus: Mizo
    lv: Latvian
    mai: Maithili
    mak: Makassar
    mg: Malagasy
    mi: Maori
    min: Minangkabau
    mk: Macedonian
    ml: Malayalam
    mn: Mongolian
    mr: Marathi
    ms: Malay
    mt: Maltese
    my: Burmese
    ne: Nepali
    new: Newari
    nl: Dutch
    no: Norwegian
    nr: Southern Ndebele
    nso: Northern Sotho (Sepedi)
    nus: Nuer
    ny: Chichewa (Nyanja)
    oc: Occitan
    om: Oromo
    or: Odia
    pa: Punjabi
    pag: Pangasinan
    pam: Kapampangan
    pap: Papiamento
    pl: Polish
    ps: Pashto
    pt: Portuguese
    pt-BR: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    qu: Quechua
    ro: Romanian
    rom: Romani
    rn: Rundi
    ru: Russian
    rw: Kinyarwanda
    sa: Sanskrit
    scn: Sicilian
    sd: Sindhi
    sg: Sango
    shn: Shan
    si: Sinhalese
    sk: Slovak
    sl: Slovenian
    sm: Samoan
    sn: Shona
    so: Somali
    sq: Albanian
    sr: Serbian
    ss: Swati
    st: Sesotho
    su: Sundanese
    sv: Swedish
    sw: Swahili
    szl: Silesian
    ta: Tamil
    te: Telugu
    tet: Tetum
    tg: Tajik
    th: Thai
    ti: Tigrinya
    tk: Turkmen
    tn: Tswana
    tr: Turkish
    ts: Tsonga
    tt: Tatar
    ug: Uyghur
    uk: Ukrainian
    ur: Urdu
    uz: Uzbek
    vi: Vietnamese
    xh: Xhosa
    yi: Yiddish
    yo: Yoruba
    yua: Yucatec Maya
    yue: Cantonese
    zh: Simplified Chinese
    zh-TW: Traditional Chinese
    zu: Zulu

    Note: Use the multilingual method. / to separate, such as en/ja, which indicates English and Japanese.
    ProcessType Integer No

    Subtitle processing type:

    • 0: ASR recognition subtitle
    • 1: Pure caption translation
    • 2: OCR recognition subtitle

    Note: ASR is selected by default if the field is unspecified.
    SelectingSubtitleAreasConfig MPSSelectingSubtitleAreasConfig No

    Area configurations for the subtitle OCR extraction box
    SpeakerMode Integer No

    Speaker identification switch. Valid values:
    0: Speaker identification is disabled.
    1: Speaker identification is enabled.
    SpeakerLabel Integer No

    Indicates whether to output the identified speaker to the subtitle file. Valid values:
    0: The speaker is not output to the subtitle file.
    1: The speaker is output to the VTT subtitle file.
    Note: To use this parameter, the value of SpeakerMode cannot be 0.

    MPSSmartSubtitlesTaskInput

    Smart subtitle input struct.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer No

    Smart subtitle template ID.
    RawParameter MPSRawSmartSubtitleParameter No

    Custom smart subtitle parameter. It takes effect when Definition is set to 0. This parameter is used in high customization scenarios. It is recommended that you preferentially use Definition to specify smart subtitle parameters.

    MPSSubTaskResult

    MPS specific task query result type.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskType String Task type. Specific subtask type in the MPS WorkflowTask structure. Value:
  • MediaProcess.Transcode: audio and video transcoding task.
  • AiAnalysis.DeLogo: intelligent erasure task.
  • AiAnalysis.ClassificationTask: intelligent classification task.
  • AiAnalysis.CoverTask: intelligent thumbnail generating.
  • AiAnalysis.TagTask: intelligent tag task.
  • AiAnalysis.FrameTagTask: intelligent frame-by-frame tagging task.
  • AiAnalysis.HighlightTask: Intelligent highlight task.
  • AiAnalysis.SegmentTask: Intelligent video splitting task.
  • AiAnalysis.HeadTailTask: Intelligent opening and closing credits task.
  • AiAnalysis.DescriptionTask: Intelligent summary task.
  • AiAnalysis.HorizontalToVerticalTask: Intelligent Landscape to Portrait Task.
  • AiAnalysis.DubbingTask: Intelligent dubbing task.
  • AiAnalysis.VideoRemakeTask: Intelligent deduplication task.
  • AiAnalysis.VideoComprehensionTask: Video understanding task.
  • SmartSubtitle.AsrFullTextTask: intelligent speech full-text recognition task.
  • SmartSubtitle.TransTextTask: Translation result.
  • SmartSubtitle.PureSubtitleTransTask: Returns the translation result of the pure subtitle file.
  • SmartSubtitle.OcrFullTextTask: Intelligent text extraction subtitle task.
  • SmartErase: intelligent erasure task.

    		•
    Status String Task status, including PROCESSING, SUCCESS, and FAIL.
    ErrCode String Error code. 0 indicates success, others indicate failure.
    Message String Error message.
    Input String MPS video processing task input. This field corresponds to the Input result returned by the MPS task in JSON format.
    Output MPSTaskOutput MPS video processing task output.

    MPSTaskOutput

    MPS subtask output return result.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    OutputFiles Array of MPSOutputFile File type result in the returned result. For example, in intelligent erasure, the video file after removal will be stored in the media asset and the FileId will be provided in this field. The file Url of the subtitle extracted from video will be provided in this field.
    OutputText String Result returned by the task. This field corresponds to the Output result returned by the MPS task in JSON format.
    Different MPS task output results have different structures. For specific return content, see the MPS task output struct.
    Intelligent Classification Result
    Intelligent Cover Result
    Intelligent tag result
    Intelligent frame tagging classification result
    Intelligent Highlight Result
    Video Splitting Result
    Intelligent video opening/closing credits result
    Intelligent summary result
    Horizontal-to-Vertical Video Transformation Result
    Intelligent dubbing result
    Intelligent video understanding result
    Smart subtitling full text recognition result
    Intelligent caption translation result
    Intelligent caption pure subtitle file translation result
    Smart subtitling text extraction result

    MPSTemplate

    MPS task template description.

    Used by actions: DescribeMPSTemplates.

    Name Type Description
    TaskType String MPS template type. Valid values:
  • Transcode: transcoding template.
    		•
    MPSTemplateInfo String MPS task template detail.

    MPSUpdateSmartEraseSubtitleConfig

    Subtitle removal configuration for the smart erasing template.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    SubtitleEraseMethod String No

    Subtitle erasure method.
    Automatic erasing: Video subtitles are automatically recognized using an AI model and are erased without traces to generate a new video. However, missed or incorrect erasing may occur due to image interference and special subtitle styles. In this case, you can specify the erasing area.
    When using automatic erasing, if you do not specify AutoAreas, the default region (lower middle part of the frame) will be erased automatically. If AutoAreas is specified, the designated region will be erased instead.
    Specified area erasure: If your subtitle position is fixed, it is recommended to directly specify the erasure area to minimize missed erasures.
    When choosing specified area erasure, please input at least one designated region in CustomAreas.

    • auto: Automatic erasing
    • custom: Specified area erasure
    SubtitleModel String No

    Subtitle erasure model. Standard version (recommended): If your subtitles have a standard style, it is usually recommended to select this version for better effectiveness in seamless detail removal. Area edition: If the subtitles have special styles, such as calligraphy, shadow, or motion effects, you are recommended to select this edition to ensure a larger erasing area. However, the erasing effect in the details is not as good as the standard edition. - standard Standard model - area Regional model
    OcrSwitch String No

    Whether OCR subtitle extraction is enabled. The default value is OFF.
    OCR subtitle extraction is supported if and only if SubtitleEraseMethod is set to auto. When enabled, it identifies the text region that appears most persistently and stably within the automatic erasing area as the subtitle area. The text within the subtitle area is extracted and erased.

    • ON Enable
    • OFF Disable
    SubtitleLang String No

    Subtitle language, used to guide OCR recognition, default value is zh_en.
    This parameter is valid only when OcrSwitch is "ON".

    • zh_en Chinese and English
    • multi Other. Specifically support the following languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, Hindi, Arabic, India-Bengali, India-Gujarati, India-Kannada, India-Malayalam, India-Tamil, India-Telugu, Slovenian, Polish, Catalonia, Bosnia, Czech, Estonian, Croatian, Punjabi, Marathi, Azerbaijan, Indonesian, Luxembourg, Lithuanian, Latvian, Malta, Slovak, Turkish, Kazakh, Greek, Irish, Belarus, Khmer, Tagalog, Pashto, Persian, Tajikistan
    SubtitleFormat String No

    Subtitle file format. Default value: vtt. This parameter is valid only when OcrSwitch is "ON".

    • srt srt format
    • vtt WebVTT format
    TransSwitch String No

    Whether to enable subtitle translation. Default value: OFF. This parameter is valid only when OcrSwitch is set to "ON".

    • ON: Enable
    • OFF: Disable
    TransDstLang String No

    The target language for subtitle translation defaults to en. This parameter is valid only when TransSwitch is set to "ON". Currently support the following languages:
    zh: Simplified Chinese
    en: English
    ja: Japanese
    ko: Korean
    fr: French
    es: Spanish
    it: Italian
    de: German
    tr: Turkish
    ru: Russian
    pt: Portuguese
    vi: Vietnamese
    id: Indonesian
    ms: Malay
    th: Thai
    ar: Arabic
    hi: Hindi
    AutoAreas Array of MPSEraseArea No

    Automatically erase custom regions. For selected regions, use the AI model to automatically detect and erase existing targets.
    Note: When the erase method is set to custom, this parameter will not take effect. To modify the template, input [] for region cleanup. The template region information remains unchanged if not provided.
    CustomAreas Array of MPSEraseTimeArea No

    Specify the removal of custom regions. For specified regions, directly perform erasure without detection and recognition within a selected time range. Note: When modifying the template, import [] to clear regions. The template region information remains unchanged if not imported.

    MPSUpdateSmartEraseWatermarkConfig

    Watermark removal configuration for the smart erasing template.

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    WatermarkEraseMethod String No

    Watermark removal method.
    Auto removal: Automatically recognize watermarks in videos through Model A and generate new videos after removal. Suitable for dynamic watermarks. When using auto removal, if you do not specify AutoAreas, it will perform auto removal on the full-screen video; if you specify AutoAreas, it will change to auto removal on your designated regions.
    Specified area removal: For static watermarks with fixed positions, it is recommended to directly specify the removal area. When you choose specified area removal, import at least one designated region. - auto Auto removal - custom Specified area removal
    WatermarkModel String No

    Watermark removal model. basic Edition: provides average effects and high cost performance. It applies to animations or videos with clean backgrounds. advanced Edition: offers better effectiveness and is suitable for mini-dramas or reality-style videos.

    • basic Edition
    • advanced Edition
    AutoAreas Array of MPSEraseArea No

    Automatically erase custom regions. For selected regions, use the AI model to automatically detect and erase existing targets. Note: When the erase method is set to custom, this parameter will not take effect. To clear regions, input []. If not provided, the template region information remains unchanged.
    CustomAreas Array of MPSEraseTimeArea No

    Specify the removal of custom regions. For specified regions, directly perform erasure without detection and recognition within a selected time range. Note: Import [] to clear regions. The template region information remains unchanged if not imported.

    MaxAge

    Browser cache rule configuration, which is used to set the default value of MaxAge and is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    MaxAgeRules Array of MaxAgeRule No MaxAge rule

    MaxAgeRule

    MaxAge rules configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    MaxAgeType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • MaxAgeContents Array of String Yes Matching content under the corresponding type of MaxAgeType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.
    • Note: all rules cannot be deleted. They follow the origin site by default and can be modified.
    MaxAgeTime Integer Yes MaxAge time setting, unit second; Note: The time is 0, which means no caching.
    FollowOrigin String No Whether to follow the origin server. Valid values: on and off. If it's on, MaxAgeTime is ignored.

    MediaAdaptiveDynamicStreamingInfo

    Adaptive bitrate streaming information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AdaptiveDynamicStreamingSet Array of AdaptiveDynamicStreamingInfoItem Information array of adaptive bitrate streaming.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaAiAnalysisClassificationItem

    Intelligent categorization result

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Classification String Name of intelligently generated category.
    Confidence Float Confidence of intelligently generated category between 0 and 100.

    MediaAiAnalysisCoverItem

    Information of intelligently generated cover

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    CoverUrl String Address of intelligently generated cover.
    Confidence Float Confidence of intelligently generated cover between 0 and 100.

    MediaAiAnalysisFrameTagItem

    Result information of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tag String Frame-specific tag name.
    CategorySet Array of String Category list of frame-specific tag names. CategorySet.N indicates the N+1-level category.
    For example, if the Tag is "tower", and CategorySet contains two elements (CategorySet.0 is "scene", and CategorySet.1 is "architecture"), then the frame-specific tag is "tower", the first-level category is "scene", and the second-level category is "architecture".
    Confidence Float Confidence of intelligently generated frame-specific tag between 0 and 100.

    MediaAiAnalysisFrameTagSegmentItem

    List of frame-specific tag segments

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float

    Offset time for frame tagging start.

    Unit: second
    EndTimeOffset Float

    End time offset of frame tagging.

    Unit: seconds
    TagSet Array of MediaAiAnalysisFrameTagItem

    Tag list in the time segment.

    MediaAiAnalysisHighlightItem

    Information of an intelligently generated highlight

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    HighlightUrl String

    Intelligent highlight address.
    CovImgUrl String

    Intelligent highlight cover address.
    Confidence Float

    Reliability of the intelligent highlight collection, with a value range from 0 to 100.
    Duration Float

    Intelligent highlight duration.

    Unit: second
    SegmentSet Array of HighlightSegmentItem

    Intelligent highlight sub-clip list. The highlight collection is generated by concatenation of these sub-segments.

    MediaAiAnalysisTagItem

    Result information of intelligent tagging

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tag String Tag name.
    Confidence Float Confidence of tag between 0 and 100.

    MediaAnimatedGraphicsInfo

    Result information of animated image generating in VOD file

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AnimatedGraphicsSet Array of MediaAnimatedGraphicsItem Result information of animated image generating task
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaAnimatedGraphicsItem

    Result information of animated image generating task

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Url String Address of generated animated image.
    Note: this field may return null, indicating that no valid values can be obtained.
    Definition Integer Animated image generating template ID. For more information, please see Animated Image Generating Parameter Template.
    Note: this field may return null, indicating that no valid values can be obtained.
    Container String Animated image format, such as gif.
    Note: this field may return null, indicating that no valid values can be obtained.
    Height Integer Height of animated image in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Width of animated image in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Bitrate Integer Bitrate of animated image in bps.
    Note: this field may return null, indicating that no valid values can be obtained.
    Size Integer Size of animated image in bytes.
    Note: this field may return null, indicating that no valid values can be obtained.
    Md5 String MD5 value of an animated image.
    Note: this field may return null, indicating that no valid values can be obtained.
    StartTimeOffset Float Start time offset of animated image in video in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTimeOffset Float End time offset of animated image in video in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaAudioStreamItem

    Information of audio stream in VOD file

    Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

    Name Type Description
    Bitrate Integer

    Bitrate of the audio stream. Measurement unit: bps.
    SamplingRate Integer

    Sampling rate of the audio stream, unit: hz.
    Codec String

    Audio stream encoding format, such as aac.

    MediaBasicInfo

    Basic information of VOD media file

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Name String Media filename.
    Note: this field may return null, indicating that no valid values can be obtained.
    Description String Media file description.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of media file in ISO date format.
    Note: this field may return null, indicating that no valid values can be obtained.
    UpdateTime String Last update time of media file (by an operation that triggers updating of media file information such as modifying video attributes or initiating video processing) in ISO date format.
    Note: this field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time of media file in ISO date format. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. 9999-12-31T23:59:59Z means "never expire".
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassId Integer Category ID of media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassName String Category name of media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassPath String Category path to media file separated by "-", such as "new first-level category - new second-level category".
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverUrl String Cover image address of media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Type String Media file container, such as mp4 and flv.
    Note: this field may return null, indicating that no valid values can be obtained.
    MediaUrl String URL of source media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    SourceInfo MediaSourceData Source information of media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    StorageRegion String Regions where media files are stored, such as ap-chongqing. For more regions, see Storage Region.
    StoragePath String Media storage path.
    TagSet Array of String Tag information of media file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Vid String Unique ID of an LVB recording file.
    Category String File type:
  • Video: video file
  • Audio: audio file
  • Image: image file
    		•
    Status String File status: Normal: normal, Forbidden: banned.
    StorageClass String Storage class of a media file:
  • STANDARD
  • STANDARD_IA
  • ARCHIVE
  • DEEP_ARCHIVE
    		•

    MediaCastEvent

    Used by actions: PullEvents.

    Name Type Required Description
    CastId String No
    Status String No Retweet status. Valid values:
  • Working: running.
  • Scheduled: start up after reaching the scheduled time;
  • Stopped: relay has been stopped;
  • Idle: idle.
    		•

    MediaClassInfo

    Category information description

    Used by actions: DescribeAllClass.

    Name Type Description
    ClassId Integer The category ID.
    ParentId Integer Parent category ID, which is -1 for a first-level category.
    Name String The category name.
    Level Integer Category level. 0 for first-level category, up to 3, i.e., up to 4 levels of categories are allowed.
    SubClassIdSet Array of Integer The IDs of the immediate subcategories of the current category.
    ClassName String The category name. This parameter is not recommended. Please use Name instead.

    MediaContentReviewAsrTextSegmentItem

    Video segment containing ASR-detected suspicious content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of suspected segment in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTimeOffset Float End time offset of suspected segment in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Confidence Float Confidence of suspected segment.
    Note: this field may return null, indicating that no valid values can be obtained.
    Suggestion String Processing suggestion for the detected suspicious content. Valid values:
  • pass
  • review
  • block
    		•
    KeywordSet Array of String List of suspected keywords.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaContentReviewOcrTextSegmentItem

    Video segment containing OCR-detected suspicious content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of suspected segment in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTimeOffset Float End time offset of suspected segment in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Confidence Float Confidence of suspected segment.
    Note: this field may return null, indicating that no valid values can be obtained.
    Suggestion String Processing suggestion for the detected suspicious content. Valid values:
  • pass
  • review
  • block
    		•
    KeywordSet Array of String List of suspected keywords.
    Note: this field may return null, indicating that no valid values can be obtained.
    AreaCoordSet Array of Integer Zone coordinates (at the pixel level) of suspected text: [x1, y1, x2, y2], i.e., the coordinates of the top-left and bottom-right corners.
    Note: this field may return null, indicating that no valid values can be obtained.
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTime String Expiration time of suspected image URL in ISO date format.

    MediaContentReviewPoliticalSegmentItem

    Video segment containing detected politically sensitive content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment in seconds.
    EndTimeOffset Float End time offset of a suspected segment in seconds.
    Confidence Float Confidence score for the detected politically sensitive content
    Suggestion String Processing suggestion for the detected politically sensitive content. Valid values:
  • pass
  • review
  • block
    		•
    Name String Name of the politically sensitive content or banned images
    Label String Labels for the detected politically sensitive content. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows:
    violation_photo:
  • violation_photo: banned images

    • politician:
  • nation_politician: state leader of China
  • province_politician: provincial officials
  • bureau_politician: bureau-level officials
  • county_politician: county-level officials
  • rural_politician: township-level officials
  • sensitive_politician: politically sensitive people
  • foreign_politician: state leaders of other countries

    • entertainment:
  • sensitive_entertainment: banned people in the entertainment industry

    • sport:
  • sensitive_sport: banned sports celebrities

    • entrepreneur:
  • sensitive_entrepreneur: banned businesspeople

    • scholar:
  • sensitive_scholar: banned scholars

    • celebrity:
  • sensitive_celebrity: banned celebrities
  • historical_celebrity: banned historical figures

    • military:
  • sensitive_military: banned people in military
    		•
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    AreaCoordSet Array of Integer Coordinates (pixel) of the detected politically sensitive content or banned icons. The format is [x1, y1, x2, y2], which indicates the coordinates of the top-left and bottom-right corners.
    PicUrlExpireTime String Expiration time of suspected image URL in ISO date format.

    MediaContentReviewSegmentItem

    Video segment containing detected pornographic or terrorism content

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment in seconds.
    EndTimeOffset Float End time offset of a suspected segment in seconds.
    Confidence Float Confidence score for the detected pornographic content
    Label String Label for the detected pornographic content
    Suggestion String Processing suggestion for the detected pornographic content. Valid values:
  • pass
  • review
  • block
    		•
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTime String Expiration time of suspected image URL in ISO date format.

    MediaDeleteItem

    Specify video content for deletion

    Used by actions: DeleteMedia, PullEvents.

    Name Type Required Description
    Type String Yes The specified portion to be deleted. The parameter is invalid if this field is not filled in. Optional values u200bare:
  • OriginalFiles (Delete the original file. After deletion, video processing operations such as transcoding cannot be initiated);
  • TranscodeFiles (delete transcoded files);
  • AdaptiveDynamicStreamingFiles (Delete the adaptive bitrate streaming files);

    • Notice:
  • When the value is OriginalFiles, the cover file carried when uploading the file will be deleted;
  • When the value is TranscodeFiles, cover files generated by media processing will be deleted.
    		•
    Definition Integer No ID of the template for which to delete the videos of the type specified by the Type parameter. For the template definition, please see Transcoding Template.
    Default value: 0, which indicates to delete all videos of the type specified by the Type parameter.

    MediaImageSpriteInfo

    Image sprite information of VOD file

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    ImageSpriteSet Array of MediaImageSpriteItem Information set of image sprites with specified specifications. Each element represents a set of image sprites with the same specification.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaImageSpriteItem

    Image sprite information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer

    Sprite sheet specification. Please refer to sprite sheet parameter template.
    Height Integer

    Height of the sprite sheet.
    Width Integer

    Width of the sprite sheet.
    TotalCount Integer

    The number of small images in each sprite sheet.
    ImageUrlSet Array of String

    The domain names or IP addresses of each sprite sheet.
    WebVttUrl String Address of WebVtt file for the position-time relationship among subimages in an image sprite. The WebVtt file indicates the corresponding time points of each subimage and their coordinates in the image sprite, which is typically used by the player for implementing preview.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaInfo

    VOD file information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    BasicInfo MediaBasicInfo

    Basic information. Include video name, category, playback address, cover image.


    Note: This field may return null, indicating that no valid values can be obtained.
    MetaData MediaMetaData

    Meta information, including size, duration, video stream information, and audio stream information.


    Note: This field may return null, indicating that no valid values can be obtained.
    TranscodeInfo MediaTranscodeInfo

    Transcoding result information, including domain names or IP addresses, specifications, bitrates, and resolutions of various types of videos generated by video transcoding.


    Note: This field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicsInfo MediaAnimatedGraphicsInfo

    AnimatedGraphicsInfo. Information related to the animated graphics (such as gif) after video-to-gif conversion.


    Note: This field may return null, indicating that no valid values can be obtained.
    SampleSnapshotInfo MediaSampleSnapshotInfo

    Sampling screenshot information. Screenshot information related to the video after sampling screenshot taking.


    Note: This field may return null, indicating that no valid values can be obtained.
    ImageSpriteInfo MediaImageSpriteInfo

    Sprite image information. Relevant information of the sprite after capturing CSS sprites from the video.


    Note: This field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetInfo MediaSnapshotByTimeOffsetInfo

    Screenshot information at the specified time point. Information of each screenshot after capturing the video at the specified time point.


    Note: This field may return null, indicating that no valid values can be obtained.
    KeyFrameDescInfo MediaKeyFrameDescInfo

    Video timestamp information. Each dotting information set for the video.


    Note: This field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingInfo MediaAdaptiveDynamicStreamingInfo

    Adaptive Bitrate Streaming information. Includes specification, encryption type, packaging format and information related to.


    Note: This field may return null, indicating that no valid values can be obtained.
    MiniProgramReviewInfo MediaMiniProgramReviewInfo

    miniProgramReviewInfo


    Note: This field may return null, indicating that no valid values can be obtained.
    SubtitleInfo MediaSubtitleInfo

    Subtitle information.


    Note: This field may return null, indicating that no valid values can be obtained.
    FileId String

    Media file unique identifier ID.
    ReviewInfo FileReviewInfo

    Verification information.


    Note: This field may return null, indicating that no valid values can be obtained.
    MPSAiMediaInfo MPSAiMediaInfo

    MPS intelligent media asset information
    ImageUnderstandingInfo ImageUnderstandingInfo

    Image understanding information.


    Note: This field may return null, indicating that no valid values can be obtained.
    KnowledgeBasesInfo KnowledgeBasesInfo

    Intelligent library information.
    FaceRecognitionInfo FaceRecognitionInfo

    Facial recognition information.

    MediaInputInfo

    Information, name, and customer ID of the source video to be processed

    Used by actions: ProcessMediaByUrl.

    Name Type Required Description
    Url String Yes Video URL.
    Name String No Video name.
    Id String No Custom video ID.

    MediaKeyFrameDescInfo

    Video timestamp information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    KeyFrameDescSet Array of MediaKeyFrameDescItem Information array of video timestamps.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaKeyFrameDescItem

    Video timestamp information

    Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

    Name Type Required Description
    TimeOffset Float Yes Offset time of video timestamp in seconds.
    Content String Yes Content string of timestamp containing 1-128 characters.

    MediaMetaData

    VOD media file metadata

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, LiveRealTimeClip, PullEvents, SearchMedia, SimpleHlsClip.

    Name Type Description
    Size Integer Size of uploaded media file in bytes (which is the sum of size of m3u8 and ts files if the video is in HLS format).
    Note: this field may return null, indicating that no valid values can be obtained.
    Container String Container, such as m4a and mp4.
    Note: this field may return null, indicating that no valid values can be obtained.
    Bitrate Integer Sum of the average bitrate of a video stream and that of an audio stream in bps.
    Note: this field may return null, indicating that no valid values can be obtained.
    Height Integer Maximum value of the height of a video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Maximum value of the width of a video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Duration Float Video duration in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Rotate Integer Selected angle during video recording in degrees.
    Note: this field may return null, indicating that no valid values can be obtained.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioStreamSet Array of MediaAudioStreamItem Audio stream information.
    Note: this field may return null, indicating that no valid values can be obtained.
    VideoDuration Float Video duration in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioDuration Float Audio duration in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Md5 String The MD5 hash of the file.
  • Note: To get the MD5 hash of a file, call the DescribeFileAttributes API. The information will be returned after the task is completed.
    		•

    MediaMiniProgramReviewElem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Type String Audit type.
  • Porn: porn image,
  • Porn.Ocr: porn text,
  • Porn.Asr: porn speech,
  • Terrorism: terrorism image,
  • Political: politically sensitive image,
  • Political.Ocr: politically sensitive text
  • Political.Asr: politically sensitive speech
    		•
    Suggestion String Audit suggestion.
  • pass: normal,
  • block: violating,
  • review: suspected of violation.
    		•
    Confidence Float Confidence of audit result between 0 and 100.

    MediaMiniProgramReviewInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    MiniProgramReviewList Array of MediaMiniProgramReviewInfoItem Audit information list.

    MediaMiniProgramReviewInfoItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer Template ID, which is the ID of the transcoding template corresponding to the video published on WeChat Mini Program. 0 represents the source video.
    MetaData MediaMetaData Video metadata.
    Url String Video playback address for WeChat Mini Program audit
    Note: this field may return null, indicating that no valid values can be obtained.
    ReviewResult String Status of video release on WeChat Mini Program
  • Pass: succeeded.
  • Rejected: rejected.
    		•
    ReviewSummary Array of MediaMiniProgramReviewElem WeChat Mini Program audit element.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaOutputInfo

    Information parameter of file output by video processing

    Used by actions: ProcessMediaByUrl.

    Name Type Required Description
    Region String No Region of the bucket where an output file is stored, such as ap-guangzhou.
    Bucket String No Bucket of output file.
    Dir String No Path to output file, which must end in "/".

    MediaProcessTaskAdaptiveDynamicStreamingResult

    Result type of adaptive bitrate streaming task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Progress Integer The progress of the adaptive bitrate task. Value range: 0-100.
    Input AdaptiveDynamicStreamingTaskInput Input of adaptive bitrate streaming task.
    Output AdaptiveDynamicStreamingInfoItem Output of adaptive bitrate streaming task.
    BeginProcessTime String The time when the conversion to adaptive code stream task starts, using ISO date format.
    FinishTime String The time when the adaptive code stream conversion task is completed, using ISO date format.

    MediaProcessTaskAnimatedGraphicResult

    Result type of animated image generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AnimatedGraphicTaskInput Input of animated image generating task.
    Output MediaAnimatedGraphicsItem Output of animated image generating task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer The progress of an animated image generation task. Value range: 0-100.
    BeginProcessTime String The time when the rotation graph task started to execute, using ISO date format.
    FinishTime String The time when the rotation graph task is completed, using ISO date format.

    MediaProcessTaskCoverBySnapshotResult

    Result type of cover generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input CoverBySnapshotTaskInput Input of cover generating task.
    Output CoverBySnapshotTaskOutput Output of cover generating task.
    Progress Integer The progress of a video screenshot (thumbnail) task. Value range: 0-100.
    BeginProcessTime String The time when the screenshot making cover task started, using ISO date format.
    FinishTime String Screenshot the time when the cover task was completed, using ISO date format.

    MediaProcessTaskImageSpriteResult

    Result type of image sprite generating task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input ImageSpriteTaskInput Input of image sprite generating task.
    Output MediaImageSpriteItem Output of image sprite generating task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer The progress of an image sprite generation task. Value range: 0-100.
    BeginProcessTime String The time when the sprite cut task started to be executed, using ISO date format.
    FinishTime String The time when the sprite cut task is completed, using ISO date format.

    MediaProcessTaskInput

    Video processing task type

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    TranscodeTaskSet Array of TranscodeTaskInput No List of transcoding tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput No List of animated image generating tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput No List of time point screencapturing tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput No List of sampled screencapturing tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageSpriteTaskSet Array of ImageSpriteTaskInput No List of image sprite generating tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverBySnapshotTaskSet Array of CoverBySnapshotTaskInput No List of cover generating tasks.
    Note: this field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingTaskSet Array of AdaptiveDynamicStreamingTaskInput No List of adaptive bitrate streaming tasks.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskResult

    Query result type of task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Task type. Valid values:
  • Transcode: transcoding
  • AnimatedGraphics: animated image generating
  • SnapshotByTimeOffset: time point screencapturing
  • SampleSnapshot: sampled screencapturing
  • ImageSprites: image sprite generating
  • CoverBySnapshot: Screencapturing for cover image
  • AdaptiveDynamicStreaming: adaptive bitrate streaming
    		•
    TranscodeTask MediaProcessTaskTranscodeResult Query result of transcoding task, which is valid when task type is Transcode.
    Note: this field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult Query result of animated image generating task, which is valid when task type is AnimatedGraphics.
    Note: this field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult Query result of time point screencapturing task, which is valid when task type is SnapshotByTimeOffset.
    Note: this field may return null, indicating that no valid values can be obtained.
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult Query result of sampled screencapturing task, which is valid when task type is SampleSnapshot.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageSpriteTask MediaProcessTaskImageSpriteResult Query result of image sprite generating task, which is valid when task type is ImageSprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverBySnapshotTask MediaProcessTaskCoverBySnapshotResult Query result of cover generating task, which is valid if task type is CoverBySnapshot.
    Note: this field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult Query result of adaptive bitrate streaming, which is valid if task type is AdaptiveDynamicStreaming.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskSampleSnapshotResult

    Result type of sampled screencapturing task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input SampleSnapshotTaskInput Input of sampled screencapturing task.
    Output MediaSampleSnapshotItem Output of sampled screencapturing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer The progress of a sampled screenshot task. Value range: 0-100.
    BeginProcessTime String The time when the sampling screenshot task starts execution is in ISO date format.
    FinishTime String The time when the sampling screenshot task is completed uses ISO date format.

    MediaProcessTaskSnapshotByTimeOffsetResult

    Result type of time point screencapturing task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input SnapshotByTimeOffsetTaskInput Input of time point screencapturing task.
    Output MediaSnapshotByTimeOffsetItem Output of time point screencapturing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer The progress of a time point screenshot task. Value range: 0-100.
    BeginProcessTime String The time when the point-in-time screenshot task started to be executed, using ISO date format.
    FinishTime String The time when the point-in-time screenshot task is completed, using ISO date format.

    MediaProcessTaskTranscodeResult

    Result type of transcoding task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input TranscodeTaskInput Input of transcoding task.
    Output MediaTranscodeItem Output of transcoding task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Progress Integer Transcoding progress. Value range: 0-100.
    BeginProcessTime String Transcoding task start time in ISO date format
    FinishTime String Transcoding task end time in ISO date format

    MediaSampleSnapshotInfo

    Information of sampled screenshot of VOD file

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SampleSnapshotSet Array of MediaSampleSnapshotItem Information set of sampled screenshots with the specified specifications. Each element represents a set of sampled screenshots with the same specification.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaSampleSnapshotItem

    Sampled screenshot information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer Sampled screenshot specification ID. For more information, please see Sampled Screencapturing Parameter Template.
    Note: this field may return null, indicating that no valid values can be obtained.
    SampleType String Sample type. Valid values:
  • Percent: samples at a specified percentage interval.
  • Time: samples at a specified time interval.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Interval Integer Sampling interval
  • If SampleType is Percent, this value means taking a screenshot at an interval of the specified percentage.
  • If SampleType is Time, this value means taking a screenshot at an interval of the specified time (in seconds). The first screenshot is always the first video frame.

    • Note: this field may return null, indicating that no valid values can be obtained.
    ImageUrlSet Array of String List of URLs of generated screenshots.
    Note: this field may return null, indicating that no valid values can be obtained.
    WaterMarkDefinition Array of Integer List of watermarking template IDs if the screenshots are watermarked.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaSnapshotByTimeOffsetInfo

    Information of time point screenshot in VOD file

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SnapshotByTimeOffsetSet Array of MediaSnapshotByTimeOffsetItem Information set of time point screenshots with a specified specification. Currently, there can be only one set of screenshots for each specification.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaSnapshotByTimeOffsetItem

    Information of time point screenshot in VOD file

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer Specification of a time point screenshot. For more information, please see Parameter Template for Time Point Screencapturing.
    Note: this field may return null, indicating that no valid values can be obtained.
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem Information set of screenshots of the same specification. Each element represents a screenshot.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaSnapshotByTimePicInfoItem

    Time point screenshot information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TimeOffset Float Time offset corresponding to the screenshot in the video in milliseconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Url String Screenshot URL.
    Note: this field may return null, indicating that no valid values can be obtained.
    WaterMarkDefinition Array of Integer List of watermarking template IDs if the screenshots are watermarked.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaSourceData

    Source file information.

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    SourceType String Media file source category:
  • Record: comes from recording, such as live recording, live streaming time shift recording.
  • Upload: Comes from upload, such as pull upload, server-side upload, and client UGC upload.
  • VideoProcessing: comes from video processing, such as video splicing, video editing.
  • TrtcRecord: Comes from TRTC simultaneous recording.
  • WebPageRecord: comes from panoramic recording.
  • Unknown: Unknown source.
    		•
    SourceContext String Field passed through when the user creates a file.
    LiveRecordInfo LiveRecordInfo Live recording information is valid when file source is Record.
    Note: This field may return null, indicating that no valid values can be obtained.
    TrtcRecordInfo TrtcRecordInfo TRTC Companion Recording Information. Valid at that time when the file source is TrtcRecord.
    Note: This field may return null, indicating that no valid values can be obtained.
    WebPageRecordInfo WebPageRecordInfo Panoramic recording information. Valid when the file source is WebPageRecord.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaSubStreamInfoItem

    The stream information of adaptive bitrate streaming.

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Type String The stream type. Valid values:
  • audio: Audio only
  • video: Video (may include audio)
    		•
    Width Integer The video width (px) if Type is video.
    Height Integer The video height (px) if Type is video.
    Size Integer The file size (bytes).
    Note:For adaptive bitrate streaming files generated before 2023-02-09T16:00:00Z, the value of this parameter is 0.

    MediaSubtitleInfo

    Subtitle information

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SubtitleSet Array of MediaSubtitleItem Subtitle information list

    MediaSubtitleInput

    Input parameters of subtile information

    Used by actions: ModifyMediaInfo.

    Name Type Required Description
    Name String Yes Subtitle name. Length limit: 64 characters
    Language String Yes Subtitle language. Common values are as follows:
  • zh: Chinese.
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • vi: Vietnamese;
  • ms: Malay;
  • th: Thai;
  • pt: Portuguese;
  • tr: Turkish;
  • ar: Arabic;
  • es: Spanish;
  • hi: Hindi;
  • fr: French.

    • For other values, see RFC5646
    Format String Yes Subtitle format. Valid value:
  • vtt
    		•
    Content String Yes Subtitle content, which is Base64-encoded strings
    Id String No The subtitle ID. It can be up to 16 characters long, can contain letters, numbers, underscores (_), and hyphens (-), and cannot be identical to an existing subtitle ID.

    MediaSubtitleItem

    Subtitle information

    Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

    Name Type Description
    Id String Unique subtitle ID
    Name String Subtitle name
    Language String Subtitle language. Common values are as follows:
  • zh: Chinese;
  • en: English;
  • ja: Japanese;
  • ko: Korean;
  • vi: Vietnamese.
  • ms: Malay;
  • th: Thai;
  • pt: Portuguese;
  • tr: Turkish;
  • ar: Arabic;
  • es: Spanish;
  • hi: Hindi;
  • fr: French.

    • For other values, see RFC5646
    Format String Subtitle format. Valid value:
  • vtt
    		•
    Url String Subtitle URL
    Source String Subtitle source. Value ranges from...to...
  • UserUploaded: User upload.
  • AIRecognition: AI recognition, generated through speech recognition or speech translation generation.
    		•

    MediaTrack

    Track information

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String Yes Track type. Valid values:

    • Video: video track, which is composed of the following items:
      • VideoTrackItem
      • MediaTransitionItem
      • EmptyTrackItem
    • Audio: audio track, which is composed of the following items:
      • AudioTrackItem
      • MediaTransitionItem
      • EmptyTrackItem
    • Sticker: sticker track, which is composed of the following items:
      • StickerTrackItem
      • EmptyTrackItem
    TrackItems Array of MediaTrackItem Yes List of media segments on track.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaTrackItem

    Segment information of media track

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes Segment type. Valid values:
  • Video: video segment.
  • Audio: audio segment.
  • Sticker: sticker segment.
  • Transition: transition.
  • Empty: empty segment.
    		•
    VideoItem VideoTrackItem No Video segment, which is valid if Type is Video.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioItem AudioTrackItem No Audio segment, which is valid if Type is Audio.
    Note: this field may return null, indicating that no valid values can be obtained.
    StickerItem StickerTrackItem No Sticker segment, which is valid if Type is Sticker.
    Note: this field may return null, indicating that no valid values can be obtained.
    TransitionItem MediaTransitionItem No Transition, which is valid if Type is Transition.
    Note: this field may return null, indicating that no valid values can be obtained.
    EmptyItem EmptyTrackItem No Empty segment, which is valid if Type is Empty. It is used as placeholder on time axis.
  • If you want a period of silence between two audio segments, you can use EmptyTrackItem to hold the place.
  • Use EmptyTrackItem as a placeholder to locate an item.

    • Note: this field may return null, indicating that no valid values can be obtained.

    MediaTranscodeInfo

    Transcoding information of VOD file

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TranscodeSet Array of MediaTranscodeItem Information set of transcoding with each specification. Each element represents a result of transcoding with a specification.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaTranscodeItem

    Transcoding information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Url String Address of output video file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Definition Integer For transcoding specification ID, see Transcoding Parameter Template.
    Note: A value of 0 represents the original file.
    Bitrate Integer Sum of the average bitrate of a video stream and that of an audio stream in bps.
    Note: this field may return null, indicating that no valid values can be obtained.
    Height Integer Maximum value of the height of a video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Maximum value of the width of a video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Size Integer The file size (bytes).
  • If the file is an HLS file, the value of this parameter is the sum of the size of the M3U8 and TS files.
    		•
    Duration Float Video duration in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Md5 String MD5 value of video.
    Note: this field may return null, indicating that no valid values can be obtained.
    Container String Container, such as m4a and mp4.
    Note: this field may return null, indicating that no valid values can be obtained.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioStreamSet Array of MediaAudioStreamItem Audio stream information.
    Note: this field may return null, indicating that no valid values can be obtained.
    DigitalWatermarkType String The watermark type. Valid values:
  • Trace: Digital watermark
  • None: Regular watermark
    		•
    CopyRightWatermarkText String
    BlindWatermarkDefinition Integer Digital watermark template id.

    MediaTransitionItem

    Transition information

    Used by actions: ComposeMedia.

    Name Type Required Description
    Duration Float Yes Transition duration in seconds. For two media segments that use a transition, the start time of the second segment on the track will be automatically set to the end time of the first segment minus the transition duration.
    MediaTransitions Array of TransitionOperation No Transition operation list. Image transition operations and audio transition operations support at most one each.

    MediaVideoStreamItem

    Information of video stream in VOD file

    Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

    Name Type Description
    Bitrate Integer Bitrate of video stream in bps.
    Note: this field may return null, indicating that no valid values can be obtained.
    Height Integer Height of video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Width of video stream in px.
    Note: this field may return null, indicating that no valid values can be obtained.
    Codec String Video stream encoder, such as h264.
    Note: this field may return null, indicating that no valid values can be obtained.
    Fps Integer Frame rate in Hz.
    Note: this field may return null, indicating that no valid values can be obtained.
    CodecTag String The codec tag. This parameter is valid only if Codec is hevc.
    DynamicRangeInfo DynamicRangeInfo Dynamic range information.
  • Note: This parameter is valid for transcoding files generated after 2023-01-10T00:00:00Z.
    		•

    MosaicConfigureInfo

    Control parameters for detecting video mosaic.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video mosaic inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    MosaicConfigureInfoForUpdate

    Control parameters for detecting video mosaic.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video mosaic inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    MosaicInput

    Blur parameter type of video processing task

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    CoordinateOrigin String No Origin position, which currently can only be:
  • TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text.

    • Default value: TopLeft.
    XPos String No The horizontal position of the origin of the blur relative to the origin of coordinates of the video. % and px formats are supported:
  • If the string ends in %, the XPos of the blur will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width;
  • If the string ends in px, the XPos of the blur will be the specified px; for example, 100px means that XPos is 100 px.

    • Default value: 0 px.
    YPos String No Vertical position of the origin of blur relative to the origin of coordinates of video. % and px formats are supported:
  • If the string ends in %, the YPos of the blur will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height;
  • If the string ends in px, the YPos of the blur will be the specified px; for example, 100px means that YPos is 100 px.

    • Default value: 0 px.
    Width String No Blur width. % and px formats are supported:
  • If the string ends in %, the Width of the blur will be the specified percentage of the video width; for example, 10% means that Width is 10% of the video width;
  • If the string ends in px, the Width of the blur will be in px; for example, 100px means that Width is 100 px.

    • Default value: 10%.
    Height String No Blur height. % and px formats are supported:
  • If the string ends in %, the Height of the blur will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height;
  • If the string ends in px, the Height of the blur will be in px; for example, 100px means that Height is 100 px.

    • Default value: 10%.
    StartTimeOffset Float No Start time offset of blur in seconds. If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame.
  • If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame;
  • If this value is greater than 0 (e.g., n), the blur will appear at second n after the first video frame;
  • If this value is smaller than 0 (e.g., -n), the blur will appear at second n before the last video frame.
    		•
    EndTimeOffset Float No End time offset of blur in seconds.
  • If this parameter is left empty or 0 is entered, the blur will exist till the last video frame;
  • If this value is greater than 0 (e.g., n), the blur will exist till second n;
  • If this value is smaller than 0 (e.g., -n), the blur will exist till second n before the last video frame.
    		•

    NoiseConfigureInfo

    Control parameters for detecting video noise.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video noise inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    NoiseConfigureInfoForUpdate

    Control parameters for detecting video noise.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video noise inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    ObjectConfigureInfo

    Control parameter of object recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of object recognition task. Valid values:
  • ON: enables intelligent object recognition task;
  • OFF: disables intelligent object recognition task.
    		•
    ObjectLibrary String No Object library. Valid values:
  • Default: default object library;
  • UserDefine: custom object library.
  • All: both default and custom object libraries will be used.

    • Default value: All, i.e., both default and custom object libraries will be used.

    ObjectConfigureInfoForUpdate

    Control parameter of object recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of object recognition task. Valid values:
  • ON: enables intelligent object recognition task;
  • OFF: disables intelligent object recognition task.
    		•
    ObjectLibrary String No Object library. Valid values:
  • Default: default object library;
  • UserDefine: custom object library.
  • All: both default and custom object libraries will be used.
    		•

    OcrFullTextConfigureInfo

    Control parameter of full text recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of full text recognition task. Valid values:
  • ON: enables intelligent full text recognition task;
  • OFF: disables intelligent full text recognition task.
    		•

    OcrFullTextConfigureInfoForUpdate

    Control parameter of full text recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of full text recognition task. Valid values:
  • ON: enables intelligent full text recognition task;
  • OFF: disables intelligent full text recognition task.
    		•

    OcrWordsConfigureInfo

    Text keyword recognition control parameter.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of text keyword recognition task. Valid values:
  • ON: enables text keyword recognition task;
  • OFF: disables text keyword recognition task.
    		•
    LabelSet Array of String No Keyword filter tag, which specifies the keyword tag that needs to be returned. If this parameter is left empty, all results will be returned.
    There can be up to 10 tags, each with a length limit of 16 characters.

    OcrWordsConfigureInfoForUpdate

    Control parameter of text keyword recognition.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of text keyword recognition task. Valid values:
  • ON: enables text keyword recognition task;
  • OFF: disables text keyword recognition task.
    		•
    LabelSet Array of String No Keyword filter tag, which specifies the keyword tag that needs to be returned. If this parameter is left empty or a blank value is entered, all results will be returned.
    There can be up to 10 tags, each with a length limit of 16 characters.

    Origin

    Origin Server Configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Origins Array of String No List of main origin sites. When modifying the main origin site, the corresponding OriginType needs to be filled in at the same time.
    OriginType String No Main origin site type, input parameters support the following types:
  • domain: domain name type;
  • ip: IP list as the origin site;
  • third_party: third-party storage origin site .
    • ServerName String No When returning to the main origin server, the Host header will default to the accelerated domain name if it is not filled in. When the origin server type is object storage, the ServerName field is required.
    OriginPullProtocol String No Back-to-origin protocol configuration:
  • http: Forces HTTP back-to-origin;
  • follow: The protocol follows back-to-origin;
  • https: Forces https back-to-origin, and https back-to-origin only supports origin. Station port 443.
    • BackupOrigins Array of String No Backup source site list. When modifying the backup origin site, the corresponding OriginType needs to be filled in at the same time.
    BackupOriginType String No Backup origin site type, input parameters support the following types:
  • domain: domain name type;
  • ip: IP list as the origin site;
  • third_party: third-party storage origin site .
    • BackupServerName String No Host header used when accessing the backup origin server. If it is left empty, the ServerName of primary origin server will be used by default. Note: This field may return null, indicating that no valid value can be obtained.
    OriginCompany String No Object storage back to the origin vendor. Required when the origin site type is a third-party storage origin site (third_party). Optional values u200bu200binclude the following:
  • aws_s3: AWS S3;
  • ali_oss: Alibaba Cloud OSS;
  • hw_obs: Huawei OBS;
  • others: object storage from other manufacturers, only supports object storage compatible with AWS signature algorithm, such as Tencent Cloud COS.

    • OssPrivateAccess

    Access authentication configuration for OSS origin

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Alibaba Cloud OSS return-to-origin authentication configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No BucketName.

    OthersPrivateAccess

    Origin-pull authentication for other origins

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Other manufacturers' object storage back-to-origin authentication configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No Bucket name

    OutputAudioStream

    Information of output audio stream

    Used by actions: ComposeMedia.

    Name Type Required Description
    Codec String No Audio stream encoder. Valid values:
  • libfdk_aac: suitable for mp4 files.

    • Default value: libfdk_aac.
    SampleRate Integer No Audio stream sample rate. Valid values:
  • 16,000
  • 32,000
  • 44,100
  • 48,000

    • In Hz.
    Default value: 16,000.
    AudioChannel Integer No Number of sound channels. Valid values:
  • 1: mono.
  • 2: dual

    • Default value: 2.
    Bitrate Integer No The bit rate of the audio stream, value range: 0 and [26, 256], unit: kbps.
    When the value is 0, the audio bitrate will be automatically set.

    OutputVideoStream

    Information of output video stream

    Used by actions: ComposeMedia.

    Name Type Required Description
    Codec String No Video stream encoder. Valid values:
  • libx264: H.264

    • Default value: libx264.
    Fps Integer No Video frame rate in Hz. Value range: [0, 60].
    Default value: 0, which means that the value is the same as the video frame rate of the first video segment in the first video track.

    PersistenceCompleteTask

    Clipping solidification task information.

    Used by actions: PullEvents.

    Name Type Description
    FileId String Consolidate the generated Media ID.
    PersistenceSource String The source of clipping solidification has the following three types.
  • SimpleHlsClip: Comes from simple HLS edit;
  • FastEditMedia: Comes from quick media editing;
  • LiveRealTimeClip: comes from live stream clipping.
    		•

    PlayStatFileInfo

    Information of a playback statistics file

    Used by actions: DescribeDailyPlayStatFileList.

    Name Type Description
    Date String Date of playback statistics in ISO date format.
    Url String URL of a playback statistics file, including the following contents:
  • date: playback date
  • file_id: video file ID
  • ip_count: number of client IPs after deduplication
  • flux: playback traffic in bytes
  • play_times: total playback times
  • pc_play_times: playback times on PC clients
  • mobile_play_times: playback times on mobile clients
  • iphone_play_times: playback times on iPhone
  • android_play_times: playback times on Android
  • host_name: domain name
    		•

    PlayStatInfo

    The playback statistics.

    Used by actions: DescribeMediaPlayStatDetails.

    Name Type Description
    Time String The start time (in ISO date format) of the data returned. For example, if the granularity is a day, 2018-12-01T00:00:00+08:00 indicates that the data is for the period between December 1, 2018 (inclusive) and December 2, 2018 (exclusive).
  • If the granularity is an hour, 2019-08-22T00:00:00+08:00 indicates the data is for the period between 00:00 and 01:00 AM on August 22, 2019.
  • If the granularity is a day, 2019-08-22T00:00:00+08:00 indicates the data is for August 22, 2019.
    		•
    FileId String The ID of the media file.
    PlayTimes Integer The playback times.
    Traffic Integer The traffic (in bytes) consumed for playback.

    PlayerConfig

    Player configuration details

    Used by actions: DescribeSuperPlayerConfigs.

    Name Type Description
    Name String

    Player configuration name.
    Type String

    Player configuration type. Valid values:

  • Preset: system predefined configuration.
  • Custom: user-customized configuration.
    		•
    AudioVideoType String

    Played Audio and Video Type. Optional values:

  • AdaptiveDynamicStream: adaptive bitrate stream output;
  • Transcode: transcoding output;
  • Original: original audio/video.
    		•
    DrmSwitch String

    Switch for playing DRM-protected adaptive bitstream:

  • ON: Enable, indicates only playback of protected adaptive bitrate output;
  • OFF: Disable, indicates playback of unencrypted adaptive bitstream output.
    		•
    AdaptiveDynamicStreamingDefinition Integer

    Allowed output of unencrypted adaptive bitstream template ID.
    DrmStreamingsInfo DrmStreamingsInfo

    Allowed output of DRM adaptive bitstream template content.


    Note: This field may return null, indicating that no valid values can be obtained.
    TranscodeDefinition Integer

    Allowed output transcoding template ID.
    ImageSpriteDefinition Integer

    Allowed output sprite template ID.
    ResolutionNameSet Array of ResolutionNameInfo

    The player displays names for substreams of different resolution.
    CreateTime String

    Player configuration creation time, in ISO date format.
    UpdateTime String

    Last player configuration modification time, in ISO date format.
    Domain String

    Domain name used during playback. A value of Default indicates usage of the domain name in the default distribution configuration.
    Scheme String

    Scheme used during playback. Value ranges from:

  • Default: Use the scheme in the default distribution configuration;
  • HTTP;
  • HTTPS.
    		•
    Comment String

    Template description information.

    PoliticalAsrReviewTemplateInfo

    Parameters for ASR-based recognition of politically sensitive content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable ASR-based recognition of politically sensitive content. Valid values:
  • ON
  • OFF
    		•
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100

    PoliticalAsrReviewTemplateInfoForUpdate

    Parameters for ASR-based recognition of politically sensitive content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable ASR-based recognition of politically sensitive content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    PoliticalConfigureInfo

    Parameters for recognition of politically sensitive content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfo No Image recognition involves control parameters for inappropriate information.
    AsrReviewInfo PoliticalAsrReviewTemplateInfo No ASR-based recognition involves control parameters for inappropriate information.
    OcrReviewInfo PoliticalOcrReviewTemplateInfo No Text recognition involves control parameters for inappropriate information.

    PoliticalConfigureInfoForUpdate

    Parameters for recognition of politically sensitive content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfoForUpdate No Parameters for recognition of politically sensitive content in images
    AsrReviewInfo PoliticalAsrReviewTemplateInfoForUpdate No Parameters for ASR-based recognition of politically sensitive content
    OcrReviewInfo PoliticalOcrReviewTemplateInfoForUpdate No Parameters for OCR-based recognition of politically sensitive content

    PoliticalImgReviewTemplateInfo

    Parameters for recognition of politically sensitive content in images

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable recognition of politically sensitive content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of politically sensitive content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • violation_photo: banned images
  • politician: politically sensitive people
  • entertainment: people in the entertainment industry
  • sport: sportspeople
  • entrepreneur: businesspeople
  • scholar: scholars
  • celebrity: celebrities
  • military: people in military
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 97 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 95 will be used by default. Value range: 0-100

    PoliticalImgReviewTemplateInfoForUpdate

    Parameters for recognition of politically sensitive content in images

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable recognition of politically sensitive content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of politically sensitive content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • violation_photo: banned images
  • politician: politically sensitive people
  • entertainment: people in the entertainment industry
  • sport: sportspeople
  • entrepreneur: businesspeople
  • scholar: scholars
  • celebrity: celebrities
  • military: people in military
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    PoliticalOcrReviewTemplateInfo

    Parameters for OCR-based recognition of politically sensitive content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable OCR-based recognition of politically sensitive content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    PoliticalOcrReviewTemplateInfoForUpdate

    Parameters for OCR-based recognition of politically sensitive content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable OCR-based recognition of politically sensitive content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    PornAsrReviewTemplateInfo

    Parameters for ASR-based recognition of pornographic content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable ASR-based recognition of pornographic content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    PornAsrReviewTemplateInfoForUpdate

    Parameters for ASR-based recognition of pornographic content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable ASR-based recognition of pornographic content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    PornConfigureInfo

    Parameters for recognition of pornographic content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfo No Image recognition involves control parameters for offensive information.
    AsrReviewInfo PornAsrReviewTemplateInfo No ASR-based recognition involves control parameters for offensive information.
    OcrReviewInfo PornOcrReviewTemplateInfo No Text recognition involves control parameters for offensive information.

    PornConfigureInfoForUpdate

    Parameters for recognition of pornographic content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfoForUpdate No Parameters for recognition of pornographic content in images
    AsrReviewInfo PornAsrReviewTemplateInfoForUpdate No Parameters for ASR-based recognition of pornographic content
    OcrReviewInfo PornOcrReviewTemplateInfoForUpdate No Parameters for OCR-based recognition of pornographic content

    PornImgReviewTemplateInfo

    Parameters for recognition of pornographic content in images

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable recognition of pornographic content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of pornographic content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • porn
  • vulgar
  • intimacy
  • sexy
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 90 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 0 will be used by default. Value range: 0-100

    PornImgReviewTemplateInfoForUpdate

    Parameters for recognition of pornographic content in images

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable recognition of pornographic content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of pornographic content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • porn
  • vulgar
  • intimacy
  • sexy
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    PornOcrReviewTemplateInfo

    Parameters for OCR-based recognition of pornographic content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable OCR-based recognition of pornographic content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    PornOcrReviewTemplateInfoForUpdate

    Parameters for OCR-based recognition of pornographic content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable OCR-based recognition of pornographic content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

    ProcedureReviewAudioVideoTaskInput

    The moderation task details of a task flow template.

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes The moderation template ID.
    ReviewContents Array of String No The type of moderated content. Valid values:
  • Media: The original audio/video.
  • Cover: Thumbnails.

    • If this parameter is not specified or an empty array is passed in, Media will be used.

    ProcedureTask

    Video processing task information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Video processing task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.
    		•
    FileId String Media file ID.
  • If the task flow is initiated by ProcessMedia, this field means the FileId in MediaInfo;
  • If the task flow is initiated by ProcessMediaByUrl, this field means the Id in MediaInputInfo.

    • Note: this field may return null, indicating that no valid values can be obtained.
    FileName String Media filename
  • If the task flow is initiated by ProcessMedia, this field means the BasicInfo.Name in MediaInfo;
  • If the task flow is initiated by ProcessMediaByUrl, this field means the Name in MediaInputInfo.

    • Note: this field may return null, indicating that no valid values can be obtained.
    FileUrl String Media file address
  • If the task flow is initiated by ProcessMedia, this field means the BasicInfo.MediaUrl in MediaInfo;
  • If the task flow is initiated by ProcessMediaByUrl, this field means the Url in MediaInputInfo.
    		•
    MetaData MediaMetaData Source video metadata.
    MediaProcessResultSet Array of MediaProcessTaskResult Execution status and result of video processing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    AiContentReviewResultSet Array of AiContentReviewResult Status and result of an intelligent recognition task
    AiAnalysisResultSet Array of AiAnalysisResult Execution status and result of video content analysis task.
    Note: this field may return null, indicating that no valid values can be obtained.
    AiRecognitionResultSet Array of AiRecognitionResult Execution status and result of video content recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    TasksPriority Integer Task flow priority. Value range: [-10, 10].
    Note: this field may return null, indicating that no valid values can be obtained.
    TasksNotifyMode String Notification mode for change in task flow status.
  • Finish: an event notification will be initiated only after the task flow is completely executed;
  • Change: an event notification will be initiated as soon as the status of a subtask in the task flow changes;
  • None: no callback for the task flow will be accepted.

    • Note: this field may return null, indicating that no valid values can be obtained.
    SessionContext String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
    Note: this field may return null, indicating that no valid values can be obtained.
    SessionId String The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
    Note: this field may return null, indicating that no valid values can be obtained.
    Operator String The operator. Valid values:
  • SYSTEM: The task is triggered by the system.
    		•
    OperationType String The operation type. Valid values:
  • TSC: TSC-based smart bitrate reduction
    		•

    ProcedureTemplate

    Task flow template details

    Used by actions: DescribeProcedureTemplates.

    Name Type Description
    Name String Task flow name.
    Type String Type of a task flow template. Valid values:
  • Preset: preset task flow template;
  • Custom: custom task flow template.
    		•
    Comment String Template description. Length limit: 256 characters.
    MediaProcessTask MediaProcessTaskInput Parameter of video processing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    AiContentReviewTask AiContentReviewTaskInput The information of the intelligent moderation task*.
    *: This parameter is used by our old moderation templates and is not recommended. Please use ReviewAudioVideoTask instead.
    Note: This field may return null, indicating that no valid values can be obtained.
    AiAnalysisTask AiAnalysisTaskInput Parameter of AI-based content analysis task.
    Note: this field may return null, indicating that no valid values can be obtained.
    AiRecognitionTaskSet Array of AiRecognitionTaskInput Parameters for the AI content recognition task.
    MiniProgramPublishTask WechatMiniProgramPublishTaskInput Parameter of a release on WeChat Mini Program task.
    Note: this field may return null, indicating that no valid values can be obtained.
    ReviewAudioVideoTask ProcedureReviewAudioVideoTaskInput The information of the moderation task.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.

    ProcessImageAsync

    Asynchronous task processing info for images

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Value:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. Returns a non-zero error code for source error. For 0, please use the ErrCode of each specific task.
    Message String Error message.
    Progress Integer Task progress, with a value range of [0-100].
    Input ProcessImageAsyncInput Input information for asynchronous task processing of images.
    Output ProcessImageAsyncOutput Output information of asynchronous image processing tasks.
    SessionId String Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters.

    ProcessImageAsyncInput

    Asynchronous task processing info for images.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileId String FileId for image processing.
    ImageTaskInput ProcessImageAsyncTaskInput Image processing parameter.
    OutputConfig ProcessImageAsyncOutputConfig Output media file configuration for image processing tasks.

    ProcessImageAsyncInputExtendedParameter

    Image asynchronous processing extension parameter.

    Used by actions: ProcessImageAsync.

    Name Type Required Description
    Prompts Array of String No Prompt for model input.

    ProcessImageAsyncOutput

    Output of asynchronous task processing for images.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfo ProcessImageAsyncOutputFileInfo Output file information of asynchronous image processing tasks.
    OutputText String Image understanding result.

    ProcessImageAsyncOutputConfig

    Output media file configuration for asynchronous task processing of images.

    Used by actions: DescribeTaskDetail, ProcessImageAsync.

    Name Type Required Description
    MediaName String No Output filename, up to 64 characters. Default filename is specified generation by system.
    ClassId Integer No Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.
  • Default value: 0, indicating other categories.
    		•
    ExpireTime String No Expiry date of the output file. Files will be deleted longer than this time. Default is no expiration. Format according to ISO 8601 standard. For details, see ISO date format description.

    ProcessImageAsyncOutputFileInfo

    Output file info for asynchronous task processing of images.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    MediaName String Output filename, up to 64 characters. Default filename is specified generation by system.
    ClassId Integer Category ID, used to categorize and manage media. You can create a category and obtain the category ID through the create category API. Valid when StorageMode is Permanent.
    ExpireTime String Expiry date of the output file. Files will be deleted longer than this time. Default is no expiration. Format according to ISO 8601 standard. For details, see ISO date format description.
    FileType String File type, such as mp4, flv.
    FileUrl String Media file playback address.
    FileId String Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData Output video meta information. Valid when StorageMode is Permanent.

    ProcessImageAsyncTask

    Image async processing configuration

    Used by actions: CreateProcessImageAsyncTemplate, DescribeProcessImageAsyncTemplates, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    EncodeConfig ImageEncodeConfig No Image transcoding output configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    EnhanceConfig ImageEnhanceConfig No Image enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    ProcessImageAsyncTaskInput

    Image processing configuration.

    Used by actions: DescribeTaskDetail, ProcessImageAsync.

    Name Type Required Description
    Definition Integer Yes Image asynchronous processing template ID.
    ExtendedParameter ProcessImageAsyncInputExtendedParameter No Extended parameters for asynchronous image processing.

    ProcessImageAsyncTemplateItem

    Image asynchronous processing template details.

    Used by actions: DescribeProcessImageAsyncTemplates.

    Name Type Description
    Definition Integer Unique identifier of the image asynchronous processing template.
    Type String Template type.
    Name String Image asynchronous processing template name.
    Comment String Description information of the image asynchronous processing template.
    CreateTime String

    Template creation time, in ISO date format.
    UpdateTime String

    Last template modification time, in ISO date format.
    ProcessImageConfigure ProcessImageAsyncTask Image asynchronous processing template configuration.

    ProcessMediaByMPS

    MPS media processing task info.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Value:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. Returns a non-zero error code for source error. For 0, please use the ErrCode of each specific task.
    Message String Error information. Return the corresponding exception Message in case of source error, otherwise please use each specific task Message.
    SubTaskSet Array of MPSSubTaskResult MPS video processing task.

    ProductImageConfig

    AI product image parameter configuration.

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    Prompt String No Prompt content for image generation background. if this field is default, inspiration is automatically generated internally.
    NegativePrompt String No Prevent the model from generating image prompts.
    ProductDesc String No Product description describes in detail, helping generate images that meet requirements.
    MoreRequirement String No Special requirements. if any, import them through this field.
    OutputImageCount Integer No Specifies the number of images to generate. defaults to 1 if left empty. valid value: 10.

    ProductShowcaseConfig

    AI-generated product 360-degree show video parameter configuration

    Used by actions: CreateSceneAigcVideoTask.

    Name Type Required Description
    CameraMovement String No Camera movement method. Supported values: AutoMatch, ZoomIn, ZoomOut, GlideRight, GlideLeft, CraneDown.

    ProhibitedAsrReviewTemplateInfo

    Control parameter of prohibited information detection in speech task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of prohibited information detection in speech task. Valid values:
  • ON: enables prohibited information detection in speech task;
  • OFF: disables prohibited information detection in speech task.
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    ProhibitedAsrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in speech task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of prohibited information detection in speech task. Valid values:
  • ON: enables prohibited information detection in speech task;
  • OFF: disables prohibited information detection in speech task.
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    ProhibitedConfigureInfo

    Control parameter of prohibited information detection task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfo No Voice prohibition control parameter.
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo No Text prohibited control parameters.

    ProhibitedConfigureInfoForUpdate

    Control parameter of prohibited information detection task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfoForUpdate No Control parameter of prohibited information detection in speech.
    OcrReviewInfo ProhibitedOcrReviewTemplateInfoForUpdate No Control parameter of prohibited information detection in text.

    ProhibitedOcrReviewTemplateInfo

    Control parameter of prohibited information detection in text task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of prohibited information detection in text task. Valid values:
  • ON: enables prohibited information detection in text task;
  • OFF: disables prohibited information detection in text task.
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    ProhibitedOcrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in text task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of prohibited information detection in text task. Valid values:
  • ON: enables prohibited information detection in text task;
  • OFF: disables prohibited information detection in text task.
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    PullUploadTask

    The information of a pull and upload task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.
    		•
    ErrCode Integer Error code. 0: success; other values: failure.
  • 40000: invalid input parameter. Please check it;
  • 60000: invalid source file (e.g., video data is corrupted). Please check whether the source file is normal;
  • 70000: internal service error. Please try again.
    		•
    Message String Error message.
    FileId String The ID of the uploaded file.
    MediaBasicInfo MediaBasicInfo The basic information of the uploaded file.
    Note: This field may return null, indicating that no valid values can be obtained.
    MetaData MediaMetaData The metadata of the output video.
    FileUrl String The playback address of the uploaded file.
    ProcedureTaskId String The task ID for the task type Procedure. If a task flow is specified by PullUpload, and the task flow includes one or more of MediaProcessTask, AiAnalysisTask, and AiRecognitionTask, the task specified by this parameter will be executed.
    ReviewAudioVideoTaskId String The task ID for the task type ReviewAudioVideo. If a task flow is specified by PullUpload, and the task flow includes ReviewAudioVideoTask, the task specified by this parameter will be executed.
    SessionContext String The source context, which is used to pass through user request information. The PullComplete callback will return the value of this parameter. It can contain up to 1,000 characters.
    SessionId String The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
    Progress Integer The progress of the pull and upload task. Value range: 1-100.

    QRCodeConfigureInfo

    Control parameters for QR code detection in video.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes QR code inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    QRCodeConfigureInfoForUpdate

    Control parameters for QR code detection in video.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No QR code inspection switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•

    QualityEnhanceTask

    Quality Enhance Task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task Id.
    Status String Task flow status, values:
  • PROCESSING: Processing;
  • FINISH: Completed.
    • ErrCode Integer Error code, 0 means success, other values u200bu200bmean failure:
  • 40000: The input parameters are illegal, please check the input parameters;
  • 60000: Source file error (such as video data damage), Please confirm whether the source file is normal;
  • 70000: Internal service error, it is recommended to try again.
    • Message String Error message.
    ErrCodeExt String Error code. An empty string indicates success. Other values u200bu200bindicate failure. For values, please refer to Video Processing Error Code list.
    Progress Integer Media quality enhance task progress, value range [0-100].
    Input QualityEnhanceTaskInput Input of the audio and video quality regeneration task.
    Output QualityEnhanceTaskOutput Output of the audio and video quality regeneration task.
    MetaData MediaMetaData Metadata of the output video after audio and video quality revival.
    SessionId String Identification code used for deduplication. If there is a request for the same identification code within seven days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.
    SessionContext String Source context, used to transparently transmit user request information. The task flow status change callback will return the value of this field, which can be up to 1000 characters.

    QualityEnhanceTaskInput

    Input for media quality enhance task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String Media file ID.
    Definition Integer Media quality enhance template ID.

    QualityEnhanceTaskOutput

    Output for media quality enhance task

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String File types such as mp4, flv, etc.
    FileUrl String Media file playback address.
    FileId String Media file ID.
    MediaName String Output file name, up to 64 characters. By default, the generated file name is specified by the system.
    ClassId Integer Classification ID is used to classify media. You can create a classification through the Create Classification interface to obtain the classification ID.
  • Default value: 0, indicating other categories.
    • ExpireTime String The expiration time of the output file. The file will be deleted after this time. The default is permanent and not expired. The format is expressed in accordance with the ISO 8601 standard. For details, see ISO Date Format Description.

    QualityEvaluationConfigureInfo

    Control parameters for video quality evaluation.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Video quality evaluation switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•
    Score Integer No Video quality evaluation filter threshold, the result only returns the time periods lower than this value, the default value is 60.

    QualityEvaluationConfigureInfoForUpdate

    Control parameters for video quality evaluation.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Video quality evaluation switch, optional values:
  • ON: enabled;
  • OFF: disabled.
    		•
    Score Integer No Video quality evaluation filter threshold, the result only returns the time periods lower than this value, the default value is 60.

    QualityInspectItem

    Abnormal segment information of media quality inspection.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float Offset time of abnormal segment start, in seconds.
    EndTimeOffset Float End time offset of an abnormal fragment, in seconds.
    AreaCoordSet Array of Integer Detected abnormal area coordinates. The array contains 4 elements [x1,y1,x2,y2], sequentially representing the horizontal and vertical coordinates of the top-left corner and bottom-right point.
    Note: This field is valid only when the Type value is one of the following:
  • BlackWhiteEdge: black and white edges.
  • Mosaic: mosaic.
  • QRCode: QR code.
  • AppletCode: mini program code.
  • BarCode: barcode.
    		•
    Confidence Integer Confidence degree, value ranges from 0 to 100.
    Note: This field is valid only when the Type value is one of the following:
  • Mosaic: mosaic.
  • QRCode: QR code.
  • AppletCode: mini program code.
  • BarCode: barcode.
    		•

    QualityInspectResultItem

    Abnormal result Information of media quality inspection.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Exception type. Valid values:
  • Jitter: jitter.
  • Blur: blurry;
  • LowLighting: low light;
  • HighLighting: overexposure.
  • CrashScreen: screen glitch;
  • BlackWhiteEdge: black and white edges.
  • SolidColorScreen: solid color screen.
  • Noise: noise.
  • Mosaic: mosaic.
  • QRCode: QR code.
  • AppletCode: mini program code.
  • BarCode: barcode;
  • LowVoice: bass;
  • HighVoice: high voice;
  • NoVoice: mute;
  • LowEvaluation: no-reference scoring below threshold.
    		•
    SegmentSet Array of QualityInspectItem Abnormal fragment list.
    Note: The list only displays the first 100 elements. To obtain the complete result, refer to the corresponding file in SegmentSetFileUrl.
    SegmentSetFileUrl String URL of Abnormal Fragment List File. The content of the file is JSON, consistent with the fields of SegmentSet. (The file will not be retained permanently and will be deleted when reaching SegmentSetFileUrlExpireTime.)
    SegmentSetFileUrlExpireTime String Expiration time of the Segment List File URL for anomalies, in ISO date format.

    QualityInspectTask

    Media quality inspection task information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCodeExt String Error code. An empty string indicates success, and additional values indicate failure. For values, see the video processing error code list (https://www.tencentcloud.com/document/product/266/50368?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String Error message.
    MetaData MediaMetaData Metadata of audio and video for quality inspection input.
    Note: This field may return null, indicating that no valid values can be obtained.
    Input QualityInspectTaskInput Audio and video quality inspection task input.
    Output QualityInspectTaskOutput Audio and video quality inspection task output.
    SessionId String Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String Source context. This is used to pass through user request information. The audio and video quality detection completion callback returns the value of this field. The maximum length is 1000 characters.

    QualityInspectTaskInput

    Input of media quality inspection task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String Media file ID.
    Definition Integer Audio and video quality inspection template ID.

    QualityInspectTaskOutput

    Media quality inspection task generates.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    NoAudio Integer Whether there is no audio track in the media file. Value ranges from...to...
  • 0: No, have audio tracks;
  • 1: Yes, no audio track.
    		•
    NoVideo Integer Whether there is no video track in the media file. Value ranges from...to...
  • 0: No, meaning there is a video track;
  • 1: Yes, no video track.
    		•
    QualityEvaluationScore Integer Video picture quality score, value ranges from 0 to 100.
    QualityInspectResultSet Array of QualityInspectResultItem List of abnormalities detected in audio and video quality.

    QualityInspectTemplateItem

    Media quality inspection template details.

    Used by actions: DescribeQualityInspectTemplates.

    Name Type Description
    Definition Integer Template ID.
    Type String Template type. Available values:
  • Preset: system preset template;
  • Custom: User-defined template.
    		•
    Name String Template Name
    Comment String Template description.
    ScreenshotInterval Float Frame interception interval in seconds.
    JitterConfigure JitterConfigureInfo Control parameters for video frame jitter and ghosting detection.
    BlurConfigure BlurConfigureInfo Control parameters for video frame blur detection.
    AbnormalLightingConfigure AbnormalLightingConfigureInfo Control parameters for low-light and overexposure detection in video frames.
    CrashScreenConfigure CrashScreenConfigureInfo Control parameters for screen glitch detection in video footage.
    BlackWhiteEdgeConfigure BlackWhiteEdgeConfigureInfo Control parameters for video picture black edge, white edge, black screen, and white screen detection.
    NoiseConfigure NoiseConfigureInfo Control parameters for video frame noise detection.
    MosaicConfigure MosaicConfigureInfo Control parameters for video frame mosaic detection.
    QRCodeConfigure QRCodeConfigureInfo Control parameters for video frame QR code detection.
    QualityEvaluationConfigure QualityEvaluationConfigureInfo Control parameters for video frame quality evaluation.
    VoiceConfigure VoiceConfigureInfo Control parameters for audio (mute, bass, clipping) detection.
    CreateTime String Template creation time. Use the ISO date format.
    UpdateTime String Template last modified time, use ISO date format.

    Quic

    QUIC configuration item

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Quic function configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.

    • RebuildAudioInfo

    The audio remaster parameters.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate.

    Name Type Required Description
    AudioDenoiseInfo AudioDenoiseInfo No Audio noise reduction control parameters.

    RebuildMediaOutputConfig

    The parameters for the output file of a remaster task.

    Used by actions: EnhanceMediaByTemplate, RebuildMediaByTemplate.

    Name Type Required Description
    MediaName String No The filename. This parameter can contain up to 64 characters, and will be generated by the system if it is left empty.
    ClassId Integer No The ID of the file's category. You can use the CreateClass API to create a category and get the category ID.
  • The default value is 0, which means the "Other" category.
    		•
    ExpireTime String No The expiration time of the output file, in ISO date format. The file will be deleted after the specified expiration time. By default, the file will never expire.

    RebuildMediaTargetAudioStream

    The output audio parameters of an audio/video remastering task.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia.

    Name Type Required Description
    Codec String No The audio codec.
    If Container is mp3, the valid value is:
  • libmp3lame

    • If Container is ogg or flac, the valid value is:
  • flac

    • If Container is m4a, the valid values are:
  • libfdk_aac
  • libmp3lame
  • ac3

    • If Container is mp4 or flv, the valid values are:
  • libfdk_aac (Recommended for MP4)
  • libmp3lame (Recommended for FLV)
  • mp2

    • If Container is hls, the valid value is:
  • libfdk_aac
    		•
    Bitrate Integer No Bitrate of the audio stream, value ranges from 0 to [26, 256], measurement unit: kbps.
    When the value is 0, it means VOD automatically sets the bitrate.
    SampleRate Integer No The audio sample rate. Valid values:
  • 32000
  • 44100
  • 48000


    • Unit: Hz.
    AudioChannel Integer No The audio channels. Valid values:
  • 1: Mono-channel
  • 2: Dual-channel
  • 6: Stereo


    • You cannot set this parameter to 6 if the container format is an audio format (FLAC, OGG, MP3, M4A).
    Default value: 2.

    RebuildMediaTargetInfo

    The parameters of an audio/video remastering output file.

    Used by actions: DescribeTaskDetail, PullEvents, RebuildMedia.

    Name Type Required Description
    MediaName String No The filename. This parameter can contain up to 64 characters, and will be generated by the system if it is left empty.
    Description String No The description (up to 128 characters). If you do not specify this, the description will be empty.
    ClassId Integer No The ID of the file’s category. You can use the CreateClass API to create a category and get the category ID.
  • The default value is 0, which means the “Other” category.
    		•
    ExpireTime String No The expiration time of the output file, in ISO date format. The file will be deleted after the specified expiration time. By default, the file will never expire.
    Container String No The output container format. Valid values: mp4 (default), flv, hls.
    VideoStream RebuildMediaTargetVideoStream No The output video parameters.
    AudioStream RebuildMediaTargetAudioStream No The output audio parameters.
    RemoveVideo Integer No Whether to remove video data. Valid values:
  • 0: No
  • 1: Yes


    • Default value: 0.
    RemoveAudio Integer No Whether to remove audio data. Valid values:
  • 0: No
  • 1: Yes


    • Default value: 0.

    RebuildMediaTargetVideoStream

    The output video parameters of an audio/video remastering task.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia.

    Name Type Required Description
    Codec String No The video codec. Valid values:
  • libx264: H.264
  • libx265: H.265
  • av1: AOMedia Video 1

    • The default codec is H.264.
    Bitrate Integer No Bitrate of video stream, value ranges from 0 to [128, 35000], measurement unit: kbps.
    When the value is 0, VOD automatically sets the bitrate.
    Fps Integer No The video frame rate (Hz). Value range: 0-100. If the value is 0, the original video frame rate will be used.
    ResolutionAdaptive String No Resolution adaption. Valid values:
  • open: Enable. When resolution adaption is enabled, Width indicates the long side of a video, while Height indicates the short side.
  • close: Disable. When resolution adaption is disabled, Width indicates the width of a video, while Height indicates the height.


    • Default value: open.
    Width Integer No The maximum video width (or long side) in pixels. Value range: 0 and 128-4096.
  • If both Width and Height are 0, the original resolution will be used.
  • If Width is 0 and Height is not, the video width will be proportionally scaled.
  • If Width is not 0 and Height is, the video height will be proportionally scaled.
  • If neither Width nor Height is 0, the specified width and height will be used.


    • Default value: 0.
    Height Integer No The maximum video width (or short side) in pixels. Value range: 0 and [128, 4096].
  • If both Width and Height are 0, the original resolution will be used.
  • If Width is 0 and Height is not, the video width will be proportionally scaled.
  • If Width is not 0 and Height is, the video height will be proportionally scaled.
  • If neither Width nor Height is 0, the specified width and height will be used.


    • Default value: 0.
    FillType String No The fill mode, which indicates how a video is resized when the video’s original aspect ratio is different from the target aspect ratio. Valid values:
  • stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: Keep the image's original aspect ratio and fill the blank space with black bars.


    • Default value: stretch.
    Gop Integer No The number of frames between two I-frames. Valid values: 0 and 1-100000.
    If this parameter is 0 or left empty, the interval will be determined by the system.

    RebuildMediaTask

    The information of an audio/video remastering task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task flow status. Valid values:
  • PROCESSING
  • FINISH
    		•
    ErrCode Integer The error code. 0 indicates the task is successful. Other values indicate that the task failed.
  • 40000: Invalid input parameter.
  • 60000: Source file error (e.g., video data is corrupted).
  • 70000: Internal server error. Please try again.
    		•
    Message String The error message.
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Progress Integer The task progress. Value range: 0-100.
    Input RebuildMediaTaskInput Input of the audio and video quality regeneration task.
    Output RebuildMediaTaskOutput Output of the audio and video quality regeneration task.
    MetaData MediaMetaData Metadata of the output video after audio and video quality revival.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.

    RebuildMediaTaskInput

    The input parameters of an audio/video remastering task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String The file ID.
    StartTimeOffset Float The start offset (seconds). If you do not specify this, the segment will start from the beginning of the video.
    EndTimeOffset Float The end offset (seconds). If you do not specify this, the segment will end at the end of the video.
    Definition Integer Audio and video quality rebirth template number.
    RepairInfo RepairInfo The video quality remastering parameters.
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo The smart frame interpolation parameters.
    SuperResolutionInfo SuperResolutionInfo The super resolution parameters.
    HDRInfo HDRInfo The high dynamic range (HDR) parameters.
    VideoDenoiseInfo VideoDenoiseInfo The image noise removal parameters.
    AudioDenoiseInfo AudioDenoiseInfo The noise removal parameters.
    ColorInfo ColorEnhanceInfo The color enhancement parameters.
    SharpInfo SharpEnhanceInfo The detail enhancement parameters.
    FaceInfo FaceEnhanceInfo The face enhancement parameters.
    LowLightInfo LowLightEnhanceInfo The low-light enhancement parameters.
    ScratchRepairInfo ScratchRepairInfo The banding removal parameters.
    ArtifactRepairInfo ArtifactRepairInfo The artifact removal (smoothing) parameters.
    TargetInfo RebuildMediaTargetInfo The output parameters of the file.

    RebuildMediaTaskOutput

    The output parameters of an audio/video remastering task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String The file type, such as MP4 and FLV.
    FileUrl String The playback URL of the output file.
    FileId String The file ID.
    MediaName String The filename. This parameter can contain up to 64 characters, and will be generated by the system if it is left empty.
    ClassId Integer The ID of the file’s category. You can use the CreateClass API to create a category and get the category ID.
  • The default value is 0, which means the “Other” category.
    		•
    ExpireTime String The expiration time of the output file, in ISO date format. The file will be deleted after the specified expiration time. By default, the file will never expire.

    RebuildMediaTemplate

    The details of a remaster template.

    Used by actions: DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates.

    Name Type Description
    Definition Integer The remaster template ID.
    Type String The template type. Valid values:
  • Preset
  • Custom
    		•
    Name String The remaster template name.
    Comment String The template description.
    RebuildVideoInfo RebuildVideoInfo Audio-visual quality revival video control info.
    RebuildAudioInfo RebuildAudioInfo Audio-visual quality revival audio control info.
    TargetVideoInfo RebuildMediaTargetVideoStream Output video control information.
    TargetAudioInfo RebuildMediaTargetAudioStream Output audio control information.
    Container String The output file format. Valid values: mp4 (default), hls.
    RemoveVideo Integer Whether to remove video data. Valid values:
  • 0: No
  • 1: Yes

    • Default value: 0.
    RemoveAudio Integer Whether to remove audio data. Valid values:
  • 0: No
  • 1: Yes

    • Default value: 0.
    CreateTime String The template creation time in ISO date format.
    UpdateTime String The last updated time of the template in ISO date format.

    RebuildVideoInfo

    The video remaster parameters.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate.

    Name Type Required Description
    RepairInfo RepairInfo No The image restoration parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo No The smart frame interpolation parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    SuperResolutionInfo SuperResolutionInfo No The super resolution parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    HDRInfo HDRInfo No The high dynamic range (HDR) configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    VideoDenoiseInfo VideoDenoiseInfo No The image noise removal parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    ColorInfo ColorEnhanceInfo No The color enhancement parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    SharpInfo SharpEnhanceInfo No The detail enhancement parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    FaceInfo FaceEnhanceInfo No The face enhancement parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    LowLightInfo LowLightEnhanceInfo No The low-light enhancement parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    ScratchRepairInfo ScratchRepairInfo No The banding removal parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    ArtifactRepairInfo ArtifactRepairInfo No The artifact removal parameters.
    Note: This field may return null, indicating that no valid values can be obtained.

    ReduceMediaBitrateAdaptiveDynamicStreamingResult

    The information of an adaptive bitrate (bitrate reduction) task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String The task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Message String The error message.
    Input AdaptiveDynamicStreamingTaskInput The input of an adaptive bitrate task.
    Output AdaptiveDynamicStreamingInfoItem The output of an adaptive bitrate task.

    ReduceMediaBitrateMediaProcessTaskResult

    The result of a bitrate reduction task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String The task type. Valid values:
  • Transcode
  • AdaptiveDynamicStreaming
    		•
    TranscodeTask ReduceMediaBitrateTranscodeResult Query result of video transcoding task in bitrate reduction, valid when task type is Transcode.
    AdaptiveDynamicStreamingTask ReduceMediaBitrateAdaptiveDynamicStreamingResult Query result of the video to adaptive streaming task in bitrate reduction tasks. Valid when the task type is AdaptiveDynamicStreaming.

    ReduceMediaBitrateTask

    The information of a bitrate reduction task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task flow status. Valid values:
  • PROCESSING
  • FINISH
    		•
    FileId String The ID of the media file.
    FileName String The name of the media file.
    FileUrl String The address of the media file.
    MetaData MediaMetaData Metadata of the original video.
    MediaProcessResultSet Array of ReduceMediaBitrateMediaProcessTaskResult The execution status and result of the bitrate reduction task.
    TasksPriority Integer The task priority, which can be a value from -10 to 10.
    TasksNotifyMode String The notification mode for the change of task status. Valid values:
  • Finish: Send a notification after the task is completed.
  • None: Do not send status change notifications for this task.
    		•
    SessionContext String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.

    ReduceMediaBitrateTranscodeResult

    The information of a transcoding (bitrate reduction) task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String The task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Message String The error message.
    Input TranscodeTaskInput The input of a transcoding task.
    Output MediaTranscodeItem Transcoding task output.
    Progress Integer The transcoding progress. Value range: 0-100.
    BeginProcessTime String The start time of the transcoding task, in ISO date format.
    FinishTime String The end time of the transcoding task, in ISO date format.

    Referer

    Referer blacklist/whitelist configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes referer Blacklist and whitelist configuration switch, value:
  • on: on;
  • off: off.
    • RefererRules Array of RefererRule No Referer blacklist/whitelist configuration rule

    RefererAuthPolicy

    Referer hotlink protection configuration

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes Referer hotlink protection status. Valid values:
  • Enabled
  • Disabled
    		•
    AuthType String No Referer authentication method. Valid values:
  • Black: blocklist. Any HTTP request carrying a referer in the Referers list will be rejected.
  • White: allowlist. Only HTTP requests carrying referers in the Referers list will be accepted.

    • When Status is set to Enabled, AuthType must be specified.
    Referers Array of String No Referer list used for verification, supports a maximum of 400 Referers. When Status value is Enabled, Referers cannot be empty array. Referer format follows reference domain format.
    BlankRefererAllowed String No Whether to allow requests with empty referer to access this domain name. Valid values:
  • Yes
  • No

    • When Status is set to Enabled, BlankRefererAllowed must be specified.

    RefererRule

    Referer blacklist/whitelist configuration rules, which is effective for specific resources.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.
    • RefererType String Yes rferer configuration type, value:
  • whitelist: whitelist;
  • blacklist: blacklist.
    • Referers Array of String Yes Referer content list
    AllowEmpty Boolean Yes Whether to allow empty referers: When the anti-hotlinking type is whitelist, true means that empty referers are allowed, false means that empty referers are not allowed; when the anti-hotlinking type is blacklist, true means that empty referers are rejected, and false means that empty referers are not rejected.

    RemoveWaterMarkTaskInput

    The input of a watermark removal task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String The ID of the media file.

    RemoveWaterMarkTaskOutput

    The output of a watermark removal task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String The file ID.
    FileType String The file type, such as MP4 or MP3.
    FileUrl String The playback URL of the output file.
    MediaName String The filename, which can be up to 64 characters long.
    MetaData MediaMetaData The metadata of the video, including size, duration, video stream information, and audio stream information.

    RemoveWatermarkTask

    The information of a watermark removal task. This parameter is valid only if TaskType is RemoveWatermark.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task flow status. Valid values:
  • PROCESSING
  • FINISH
    		•
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video processing error codes.
    ErrCode Integer Error code. 0: Successful; other values: Failed.
  • 40000: Invalid input parameter.
  • 60000: Source file error (e.g., video data is corrupted).
  • 70000: Internal server error. Please try again.
    		•
    Message String The error message.
    Input RemoveWaterMarkTaskInput Input of the intelligent watermark removal task.
    Output RemoveWaterMarkTaskOutput The output of a watermark removal task.
    Note: This field may return null, indicating that no valid values can be obtained.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.

    RepairInfo

    The video quality remastering parameters.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable video quality remastering. Valid values:
  • ON
  • OFF
    		•
    Type String No The video quality remastering type. This parameter is valid only if Switch is ON.
  • weak
  • normal
  • strong

    • Default value: weak.

    RequestHeader

    Custom request header configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Custom request header configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • HeaderRules Array of HttpHeaderPathRule No Custom request header configuration rules

    ResolutionNameInfo

    Player substream name information

    Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs, ModifySuperPlayerConfig.

    Name Type Required Description
    MinEdgeLength Integer Yes Length of video short side in px.
    Name String Yes Display name.

    ResourceTag

    Tag key value. For details, see Tags.

    Used by actions: CreateSubAppId, DescribeSubAppIds.

    Name Type Required Description
    TagKey String Yes Tag key.
    TagValue String Yes Tag value.

    ResponseHeader

    Custom response header configuration. This is disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Custom response header configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • HeaderRules Array of HttpHeaderPathRule No Custom response header rules

    RestoreMediaTask

    Video retrieval task information

    Used by actions: PullEvents.

    Name Type Description
    FileId String File ID
    OriginalStorageClass String Original storage class
    TargetStorageClass String Target storage class. For temporary retrieval, the target storage class is the same as the original.
    RestoreTier String Retrieval mode. Valid values:
  • Expedited
  • Standard
  • Bulk
    		•
    RestoreDay Integer Validity period (days) for a temporary copy. 0 indicates permanent retrieval.

    ReviewAudioVideoSegmentItem

    The suspicious segment detected.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float The start time offset (seconds) of the segment.
    EndTimeOffset Float The end time offset (seconds) of the segment.
    Confidence Float The confidence score of the segment.
    Suggestion String The processing suggestion for the segment. Valid values:
  • review: The content may be non-compliant. Please review it.
  • block: The content is non-compliant. We recommend you block it.
    		•
    Label String The most likely label for the segment. Valid values:
  • Porn
  • Terrorism
    		•
    SubLabel String The sublabel for the segment. This parameter is valid only if Form is Image or Voice.
    Valid values when Form is Image and Label is Porn:
  • porn
  • vulgar


    • Valid values when Form is Image and Label is Terrorism:
  • guns
  • bloody
  • banners
  • scenario (terrorist scenes)
  • explosion


    • Valid values when Form is Voice and Label is Porn:
  • moan
    		•
    Form String The format of the suspicious segment detected. Valid values:
  • Image
  • OCR
  • ASR
  • Voice
    		•
    AreaCoordSet Array of Integer The pixel coordinates ([x1, y1, x2, y2]) of the top-left corner and bottom-right corner of the suspicious text. This parameter is valid only if Form is OCR.
    Note: This parameter is not supported currently.
    Text String The content of the suspicious text detected. This parameter is valid only if Form is OCR or ASR.
    KeywordSet Array of String The keywords that match the suspicious text. This parameter is valid only if Form is OCR or ASR.
    Url String The URL of a suspected image (which will be deleted
    after PicUrlExpireTime).
    PicUrlExpireTime String The expiration time of the suspected image URL in ISO date format.

    ReviewAudioVideoTask

    The information of a moderation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String The task ID.
    Status String The task status. Valid values:
  • PROCESSING
  • FINISH
    		•
    ErrCodeExt String The error code. An empty string indicates the task is successful; other values indicate that the task failed. For details, see Video processing error codes.
    Message String The error message.
    Input ReviewAudioVideoTaskInput Audio/video moderation task input.
    Output ReviewAudioVideoTaskOutput Audio/video moderation task output.
    SessionId String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last seven days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext String The source context, which is used to pass through user request information. The ReviewAudioVideoComplete callback will return the value of this parameter. It can contain up to 1,000 characters.

    ReviewAudioVideoTaskInput

    The input of a moderation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String The ID of the media file.
    Definition Integer The moderation template ID.
    ReviewContents Array of String The type of moderated content. Valid values:
  • Media: The original audio/video.
  • Cover: Thumbnails.
    		•

    ReviewAudioVideoTaskOutput

    The output of a moderation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Suggestion String The handling suggestion. Valid values:
  • pass
  • review
  • block
    		•
    Label String The most likely label for the suspicious content. This parameter is valid only if Suggestion is review or block.
  • Porn
  • Terrorism
    		•
    Form String The most likely format of the suspicious content. This parameter is valid only if Suggestion is review or block.
  • Image
  • OCR
  • ASR
  • Voice
    		•
    SegmentSet Array of ReviewAudioVideoSegmentItem A list of the suspicious segments detected.
    Note: Only the first 10 results will be returned at most. You can get all the results from the file specified by SegmentSetFileUrl.
    SegmentSetFileUrl String The URL of the file that contains suspicious segments. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time (SegmentSetFileUrlExpireTime).
    SegmentSetFileUrlExpireTime String The expiration time of the file that contains suspicious segments, in ISO date format.
    CoverReviewResult ReviewImageResult The thumbnail moderation result.
    Note: This field may return null, indicating that no valid values can be obtained.

    ReviewImageResult

    Image moderation results.

    Used by actions: DescribeTaskDetail, PullEvents, ReviewImage.

    Name Type Description
    Suggestion String Image review result suggestion. Value ranges from...to...
  • pass: it is recommended to pass;
  • review: suggest re-examination;
  • block: Suggest banning.
    		•
    Label String The most likely label for the suspicious content. This parameter is valid if Suggestion is review or block. Valid values:
  • Porn
  • Terror
    		•
    Form String Valid when Suggestion is review or block, indicating the most likely prohibited forms. Value ranges from...to...
  • Image: The figure or icon on the screen;
  • OCR: Text on the screen.
    		•
    SegmentSet Array of ReviewImageSegmentItem Video clips suspected of containing violation information.
    Note: The list only displays the first 10 elements. To obtain the complete result, refer to the corresponding file in SegmentSetFileUrl.
    SegmentSetFileUrl String URL of video clip list file involved in suspicion of violation information. The content of the file is JSON, consistent with the fields of SegmentSet. (The file will not be retained permanently and will be deleted when reaching SegmentSetFileUrlExpireTime.)
    SegmentSetFileUrlExpireTime String URL expiry time of the list of video clips suspected of involving violation information, in ISO date format.

    ReviewImageSegmentItem

    The information of an image moderation segment.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float Score of offensive information involved in suspected clips.
    Suggestion String Result suggestions for identifying violations in suspected clips. Value ranges from...to...
  • review: suspected violation, suggest re-examination;
  • block: Confirmed violation. Suggest banning.
    		•
    Label String The most likely label for the suspicious content. Valid values:
  • Porn
  • Terror
    		•
    SubLabel String Rule violation subtag.
    Form String Suspected segment is prohibited in the form of, value ranges from...to...
  • Image: The figure or icon on the screen;
  • OCR: Text on screen.
    		•
    AreaCoordSet Array of Integer Coordinates of the area where suspicious figures, icons, or text appear (pixel level), [x1, y1, x2, y2], i.e., coordinates of the top-left corner and coordinate of the bottom-right corner.
    Text String Valid when Form is OCR, means the OCR Text Content that comes out.
    KeywordSet Array of String Valid when Form is OCR, means the list of violation keywords hit by suspicious fragments.

    ReviewInfo

    Moderation details.

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer The moderation template ID.
    Suggestion String The suggestion. Valid values:
  • pass
  • review
  • block
    		•
    TypeSet Array of String The moderation type in the format of Form.Label. This parameter is valid if Suggestion is review or block.
    Form indicates the type of inappropriate content detected. Valid values:
  • Image (people or icons in images)
  • OCR (text in images)
  • ASR (speech)
  • Voice

    • Label indicates the violation label. Valid values:
  • Porn (pornographic content)
  • Terror (terrorist content)
  • Polity (politically sensitive content)
  • Ad (advertisement)
  • Illegal (illegal content)
  • Abuse
  • Moan
    		•
    ReviewTime String The moderation time in ISO date format.

    ReviewTemplate

    Review template detail

    Used by actions: DescribeReviewTemplates.

    Name Type Description
    Definition Integer Unique tag of the moderation template.
    Name String The template name.
    Comment String The template description.
    Type String The template type. Valid values:
  • Preset
  • Custom
    		•
    Labels Array of String The violation labels used.
    CreateTime String The template creation time in ISO date format.
    UpdateTime String The last updated time of the template in ISO date format.

    RoundPlayFilePlayInfo

    Playlist Program Playback Information

    Used by actions: DescribeCurrentPlaylist.

    Name Type Description
    ItemId String Playlist program id, assigned by the system.
    FileId String The media file id.
    StartPlayTime String The playback start time, in iso 8601 date format.
    Duration Float Playback duration, in seconds.
    Progress Float Playback progress, in seconds.

    RoundPlayInfo

    The information of a playlist.

    Used by actions: DescribeRoundPlays.

    Name Type Description
    RoundPlayId String The playlist ID.
    StartTime String The playback start time, in ISO 8601 date format.
    RoundPlaylist Array of RoundPlayListItemInfo The files on the list.
    Name String The playlist name (not longer than 64 characters).
    Desc String The playlist description (not longer than 256 characters).
    Status String Playback status, optional values:
  • Enabled: startup status;
  • Disabled: stop status.

    • Default value: Enabled.
    PlayBackMode String Play mode, optional values:
  • Loop: Play the playlist in a loop;
  • Linear: Play once, stop playing after the playlist is played.

    • Default value: Loop.
    Url String Carousel playback address.
    CreateTime String Creation time in ISO 8601 format.
    UpdateTime String Update time, format according to ISO 8601. See ISO date format description.
    ExpiredTime String Expiration time, in iso 8601 format. for details, see iso date format. the playback of the playlist will stop after expiration. "9999-12-31t23:59:59+08:00" means never expire.

    RoundPlayListItemInfo

    Carousel program information

    Used by actions: CreateRoundPlay, DescribeRoundPlays, HandleCurrentPlaylist, ModifyRoundPlay.

    Name Type Required Description
    FileId String Yes The file ID.
    AudioVideoType String Yes The type of the media played. Valid values:
  • Transcode: A transcoding output. Because a file may be bound to multiple transcoding templates, you need to specify Definition if the type is Transcode.
  • Original: The original file.

    • The file must be in HLS format.
    ItemId String No ID of the program to be played, assigned by the system.
    Definition Integer No The transcoding template to be played is specified. this parameter is required if audiovideotype is transcode.

    RuleCache

    Branch path cache configuration. The default cache expiration for all files is 30 days.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.
    • CacheConfig RuleCacheConfig Yes Cache configuration.

    RuleCacheConfig

    Path cache cache configuration (select one of the three cache modes)

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Cache CacheConfigCache No Cache configuration.
    NoCache CacheConfigNoCache No No cache configuration.
    FollowOrigin CacheConfigFollowOrigin No Follow the origin site.

    SDMCDrmKeyProviderInfo

    The DRM key information provided by SDMC.

    Used by actions: DescribeDrmKeyProviderInfo, SetDrmKeyProviderInfo.

    Name Type Required Description
    Uid String Yes The user ID assigned by SDMC, which can contain up to 128 characters.
    SecretId String Yes The secret ID assigned by SDMC, which can contain up to 128 characters.
    SecretKey String Yes The secret key assigned by SDMC, which can contain up to 128 characters.
    FairPlayCertificateUrl String Yes The URL of the FairPlay certificate issued by SDMC. It must be an HTTPS address and can contain up to 1,024 characters.

    SampleSnapshotTaskInput

    Input parameter type of sampling screencapturing task

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Sampled screencapturing template ID.
    WatermarkSet Array of WatermarkInput No List of up to 10 image or text watermarks.
    Note: this field may return null, indicating that no valid values can be obtained.

    SampleSnapshotTemplate

    Details of a sampled screencapturing template

    Used by actions: DescribeSampleSnapshotTemplates.

    Name Type Description
    Definition Integer Unique ID of a sampled screencapturing template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of a sampled screencapturing template.
    Comment String Template description.
    Width Integer Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    Height Integer Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    ResolutionAdaptive String Resolution adaption. Valid values:
  • open: enabled. In this case, Width represents the long side of a video, while Height the short side;
  • close: disabled. In this case, Width represents the width of a video, while Height the height.

    • Default value: open.
    Format String Image format.
    SampleType String Sampled screencapturing type.
    SampleInterval Integer Sampling interval.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    FillType String The fill mode, or the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
  • stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: Keep the image's original aspect ratio and fill the blank space with black bars.
  • white: Keep the image’s original aspect ratio and fill the blank space with white bars.
  • gauss: Keep the image’s original aspect ratio and apply Gaussian blur to the blank space.

    • Default value: black.

    SceneAigcImageOutputConfig

    Output media file configuration for the scenario-based AIGC image generation task.

    Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StorageMode String No

    Storage mode

    Enumeration value:

    • Temporary: Temporary storage. The generated video file will not be stored in VOD. You can obtain the temporary access URL from the event notification, with a valid period of 7 days.
    • Permanent: Permanent storage. The generated video file will be stored in VOD. You can obtain the FileId from the event notification.

    Default value: Temporary
    MediaName String No

    Output filename, up to 64 characters. Default filename is specified by the system.
    ClassId Integer No

    Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.

  • Default value: 0, indicating other categories.
    		•
    ExpireTime String No

    Expiry date of the output file. Files will be deleted longer than this time. Default is no expiration. Format according to ISO 8601 standard. For details, see ISO date format description.
    AspectRatio String No

    Specify the aspect ratio of the generated image. The input format is W:H.
    This field is valid in the following scenarios:

    • Product image generation scenario. Available values are: 1:1, 3:2, 2:3, 3:4, 4:3, 4:5, 5:4, 16:9, 9:16, 21:9.
    • AI image expansion scenario. Available values are: 1:1, 3:2, 2:3, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9. It can be used in conjunction with ImageWidth and ImageHeight. The rules are as follows:
      1. When only AspectRatio is specified, adaptively adjust based on the original image input.
      2. When AspectRatio and ImageWidth are specified, ImageHeight is calculated based on both, and vice versa.
      3. When AspectRatio, ImageWidth, and ImageHeight are specified simultaneously, prioritize using ImageWidth and ImageHeight.
    EncodeConfig ImageSceneAigcEncodeConfig No

    Output image encoding format parameters. Valid only for AI clothing change scenarios.
    ImageWidth Integer No

    Output image width. Valid only for AI image expansion scenarios.
    ImageHeight Integer No

    Output image height, valid only for AI image expansion scenarios.
    Resolution String No

    Output resolution. Only valid for change_clothes and change_clothes_under scenarios. Available values: 1K, 2K, 4K.

    SceneAigcImageTask

    Scenario-based AIGC image generation task info

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Value:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. Returns a non-zero error code for source error. For 0, please use the ErrCode of each specific task.
    Message String Error message.
    Progress Integer Task progress, with a value range of [0-100].
    Input SceneAigcImageTaskInput Input of the AIGC image generation task.
    Output SceneAigcImageTaskOutput Output information of the AIGC image generation task.
    SessionId String Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters.

    SceneAigcImageTaskInput

    Scenario-based AIGC image generation task info

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SceneInfo AigcImageSceneInfo Scenario-based image generation parameter configuration.
    FileInfos Array of SceneAigcImageTaskInputFileInfo Input image list.
    OutputConfig SceneAigcImageOutputConfig Output media file configuration for scenario-based image generation tasks.

    SceneAigcImageTaskInputFileInfo

    Input file information for the scenario-based AIGC image generation task.

    Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String No Input video File type. valid values:
  • File: on-demand media File;
  • Url: accessible Url;
    		•
    FileId String No The media File ID of the image File, which is the globally unique identifier of the File in vod, is assigned by the vod backend after successful upload. you can obtain this field in the video upload completion event notification or vod console. this parameter is valid when the Type value is File.
    Note:
    1. recommended for use with images less than 7 mb.
    2. image format value is jpeg, jpg, png, webp.
    Url String No Accessible file URL. this parameter is valid when Type value is Url.
    Note:
    1. recommended for use with images less than 7 MB.
    2. image format value is jpeg, jpg, png, webp.

    SceneAigcImageTaskOutput

    Scenario-based output of the AIGC image generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileInfos Array of SceneAigcImageTaskOutputFileInfo Output file information of the AIGC image generation task.

    SceneAigcImageTaskOutputFileInfo

    Scenario-based output file info of the AIGC image generation task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StorageMode String Storage mode. Valid values:
  • Permanent: retained permanently;
  • Temporary: temporary storage;

    		•
    MediaName String Output filename, up to 64 characters. Default filename is specified generation by system. Valid when StorageMode is Permanent.
    ClassId Integer Category ID, used to categorize and manage media. You can create a category and obtain the category ID through the create category API. Valid when StorageMode is Permanent.
    ExpireTime String Expiry date of the output file. Files will be deleted longer than this time. Default is no expiration. Format according to ISO 8601 standard. For details, see ISO date format description.
    FileType String File type, such as mp4, flv.
    FileUrl String Media file playback address.
    FileId String Media file ID. Valid when StorageMode is Permanent.
    MetaData MediaMetaData Output video meta information. Valid when StorageMode is Permanent.

    SceneAigcVideoOutputConfig

    Scenario-based output media file configuration for the AIGC video generation task.

    Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

    Name Type Required Description
    StorageMode String No Storage mode. Valid values:
  • Permanent: Permanent storage. The generated image file will be stored in VOD, and the FileId can be obtained in the event notification.
  • Temporary: Temporary storage. The generated image file will not be stored in VOD, and the URL for temporary access can be obtained in the event notification.

    • Default value: Temporary
    MediaName String No Output filename, up to 64 characters. Default filename is specified generation by system.
    ClassId Integer No Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the create category API.
  • Default value: 0, indicating other categories.
    		•
    ExpireTime String No Expiry date of the output file. Files will be deleted longer than this time. Default is no expiration. Format according to ISO 8601 standard. For details, see ISO date format description.
    AspectRatio String No Specify the aspect ratio of the generated video. Input format is W:H. Valid only for product image scenarios. Options: 16:9, 9:16.
    Duration Float No Generate video duration. Available values: 4, 6, 8 seconds.

    SceneAigcVideoTask

    Scenario-based AIGC video generation task info

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Value:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. Returns a non-zero error code for source error. For 0, please use the ErrCode of each specific task.
    Message String Error message.
    Progress Integer Task progress, with a value range of [0-100].
    Input SceneAigcVideoTaskInput Input of the AIGC video generation task.
    Output SceneAigcVideoTaskOutput Output information of the AIGC video task.
    SessionId String Identifier for deduplication. If a request with the same identifier has been sent within the past seven days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.
    SessionContext String Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters.

    SceneAigcVideoTaskInput

    Scenario-based AIGC video generation task info

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SceneInfo AigcVideoSceneInfo Scenario-based image generation parameter configuration.
    FileInfos Array of SceneAigcVideoTaskInputFileInfo Input image list.
    OutputConfig SceneAigcVideoOutputConfig Output media file configuration for scenario-based image generation tasks.

    SceneAigcVideoTaskInputFileInfo

    Scenario-based AIGC image generation task input file info

    Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

    Name Type Required Description
    Type String No Input video file type. Valid values:
  • File: on-demand media file;
  • Url: accessible URL;
    		•
    FileId String No Media file ID of the image file, which is the globally unique ID of the file in VOD, is assigned by the VOD backend after successful upload. You can get this field in the video upload completion event notification or VOD console. This parameter is valid when the Type value is File.
    Description:
    1. Use images less than 7M.
    Image format. Valid values: jpeg, jpg, png, and webp.
    Url String No Accessible file URL. This parameter is valid when the Type value is Url.
    Description:
    1. Use images less than 7M.
    Image format. Valid values: jpeg, jpg, png, and webp.

    SceneAigcVideoTaskOutput

    Scenario-based output of the AIGC video generation task.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfos Array of SceneAigcImageTaskOutputFileInfo Output file information of the AIGC video task.

    ScratchRepairInfo

    Banding removal configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable banding removal. Valid values:
  • ON
  • OFF

    • Default value: OFF.
    Intensity Float No The banding removal strength. Value range: 0.0 - 1.0. This parameter is valid only if Switch is ON.
    Default value: 0.0.
    Type String No The banding removal type. This parameter is valid only if Switch is ON. Valid values:
  • normal

    • Default value: normal.

    SegmentConfigureInfo

    Control parameter of video splitting recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of video splitting recognition task. Valid values:
  • ON: enables intelligent video splitting recognition task;
  • OFF: disables intelligent video splitting recognition task.
    		•

    SegmentConfigureInfoForUpdate

    Control parameter of video splitting recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of video splitting recognition task. Valid values:
  • ON: enables intelligent video splitting recognition task;
  • OFF: disables intelligent video splitting recognition task.
    		•

    SemanticsSearchResult

    Semantic search result.

    Used by actions: SearchMediaBySemantics.

    Name Type Description
    FileId String Specifies the unique identifier of the media file.
    Score Float Score of the video in this retrieval. higher score indicates greater similarity to the retrieval value. value ranges from 0 to 1.
    StartTimeOffset Float Specifies the start time of the video clip, in seconds.
    EndTimeOffset Float Segment end time of the video, in seconds.

    SharpEnhanceInfo

    Detail enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable detail enhancement. Valid values:
  • ON
  • OFF
    		•
    Intensity Float No The detail enhancement strength. Value range: 0.0 – 1.0. This parameter is valid only if Switch is ON.
    Default value: 0.0.

    SnapshotByTimeOffset2017

    Screencapturing output information (v2017)

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    TimeOffset Integer Specific time point of screenshot in milliseconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    Url String Address of output screenshot file.
    Note: this field may return null, indicating that no valid values can be obtained.

    SnapshotByTimeOffsetTask2017

    The details of a time point screenshot task. This parameter is only valid for the v2017 time point screenshot API.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Screencapturing task ID.
    FileId String Screenshot file ID.
    Definition Integer screenshot specification. For more information, please see Parameter Template for Time Point Screencapturing.
    SnapshotInfoSet Array of SnapshotByTimeOffset2017 Result information of screencapturing.

    SnapshotByTimeOffsetTaskInput

    Input parameter type of time point screencapturing task

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Time point screencapturing template ID.
    ExtTimeOffsetSet Array of String No The list of screenshot time points. “s” and “%” formats are supported:
  • When a time point string ends with “s”, its unit is second. For example, “3.5s” means the 3.5th second of the video.
  • When a time point string ends with “%”, it represents the percentage of the video’s duration. For example, “10%” means that the time point is at the 10% of the video’s entire duration.
    		•
    TimeOffsetSet Array of Float No List of time points for screencapturing in milliseconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    WatermarkSet Array of WatermarkInput No List of up to 10 image or text watermarks.
    Note: this field may return null, indicating that no valid values can be obtained.

    SnapshotByTimeOffsetTemplate

    Details of a specified time point screencapturing template

    Used by actions: DescribeSnapshotByTimeOffsetTemplates.

    Name Type Description
    Definition Integer Unique ID of a specified time point screencapturing template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of a specified time point screencapturing template.
    Comment String Template description.
    Width Integer Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    Height Integer Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

    • Default value: 0.
    ResolutionAdaptive String Resolution adaption. Valid values:
  • open: enabled. In this case, Width represents the long side of a video, while Height the short side;
  • close: disabled. In this case, Width represents the width of a video, while Height the height.

    • Default value: open.
    Format String Image format.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    FillType String The fill mode, or the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
  • stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: Keep the image's original aspect ratio and fill the blank space with black bars.
  • white: Keep the image’s original aspect ratio and fill the blank space with white bars.
  • gauss: Keep the image’s original aspect ratio and apply Gaussian blur to the blank space.

    • Default value: black.

    SortBy

    Sort by criterion

    Used by actions: DescribeProcedureTemplates, DescribeTasks, SearchMedia.

    Name Type Required Description
    Field String Yes Sort by field
    Order String Yes Sorting order. Valid values: Asc (ascending), Desc (descending)

    SpecificationDataItem

    Statistics of task with specified specification.

    Used by actions: DescribeMediaProcessUsageData.

    Name Type Description
    Specification String Task specification.
    Data Array of TaskStatDataItem Statistics.

    SplitMediaOutputConfig

    Information of video splitting output files.

    Used by actions: DescribeTaskDetail, PullEvents, SplitMedia.

    Name Type Required Description
    MediaName String No Name of an output file. This parameter can contain up to 64 characters, and will be generated by the system if it is left empty.
    Type String No Output file format. Valid values: mp4 (default), hls.
    ClassId Integer No Category ID, which is used to categorize the media file for management. You can use CreateClass API to create a category and get the category ID.
  • Default value: 0, which means other categories.
    		•
    ExpireTime String No Expiration time of an output file. After passing the expiration time, the file will be deleted. There is no expiration time set for a file by default. The time is in ISO date format.

    SplitMediaTask

    Video splitting task information. This field has a value only when TaskType is SplitMedia.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: processing
  • FINISH: finished
    		•
    ErrCodeExt String Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
    ErrCode Integer Error code. 0 indicates the task is successful; other values indicate failure. You're not recommended to use this parameter, but to use the new parameter ErrCodeExt.
    Message String Error information.
    FileInfoSet Array of SplitMediaTaskSegmentInfo List of video splitting task details.
    SessionContext String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1000 characters.
    SessionId String ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or set to an empty string, no deduplication will be performed.
    Progress Integer The progress of a video splitting task. Value range: 0-100.

    SplitMediaTaskConfig

    Video stripping task configuration information.

    Used by actions: SplitMedia.

    Name Type Required Description
    StartTimeOffset Float No The offset time of the start of video stripping, unit: seconds.
  • Leave it blank or fill in 0, which means that the transcoded video starts from the starting position of the original video;
  • When the value is greater than 0 (assumed to be n), it means that after transcoding The video starts from the n-th second position of the original video;
  • When the value is less than 0 (assumed to be -n), it means that the transcoded video starts from the position n seconds before the end of the original video.
    • EndTimeOffset Float No Offset time at the end of video stripping, unit: seconds.
  • Leave it blank or fill it in with 0, which means that the transcoded video will continue until the end of the original video;
  • When the value is greater than 0 (assumed to be n), it means that the transcoded video will continue until the end of the original video. The video continues until the nth second of the original video and terminates;
  • When the value is less than 0 (assumed to be -n), it means that the transcoded video continues until n seconds before the end of the original video.
    • ProcedureName String No Task flow name. Fill in to automatically execute task flow on the generated new video.
    OutputConfig SplitMediaOutputConfig No The video is split into strips to output information.

    SplitMediaTaskInput

    Input information of a video splitting task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String Video ID.
    StartTimeOffset Float Offset of the video splitting start time in seconds.
  • If this parameter is left empty or set to 0, the transcoded video will start at the same time as the original video.
  • If this parameter is set to a positive number (n for example), the transcoded video will start at the nth second of the original video.
  • If this parameter is set to a negative number (-n for example), the transcoded video will start at the nth second before the end of the original video.
    		•
    EndTimeOffset Float Offset of the video splitting end time in seconds.
  • If this parameter is left empty or set to 0, the transcoded video will end at the same time as the original video.
  • If this parameter is set to a positive number (n for example), the transcoded video will end at the nth second of the original video.
  • If this parameter is set to a negative number (-n for example), the transcoded video will end at the nth second before the end of the original video.
    		•
    ProcedureName String Task flow name. Fill in if you need to execute task flow on the generated new video.
    OutputConfig SplitMediaOutputConfig Output information of a video splitting task.

    SplitMediaTaskSegmentInfo

    Information of a video splitting task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Input SplitMediaTaskInput Input information of a video splitting task.
    Output TaskOutputMediaInfo Video splitting task output information.
    ProcedureTaskId String The task ID for the task type Procedure. If a task flow (ProcedureName) is specified by SplitMedia, and the task flow includes one or more of MediaProcessTask, AiAnalysisTask, and AiRecognitionTask, the task specified by this parameter will be executed.
    ReviewAudioVideoTaskId String The task ID for the task type ReviewAudioVideo. If a task flow (ProcedureName) is specified by SplitMedia, and the task flow includes ReviewAudioVideoTask, the task specified by this parameter will be executed.

    StatDataItem

    Statistics

    Used by actions: DescribeCDNStatDetails, DescribeCDNUsageData, DescribeClientUploadAccelerationUsageData, DescribeReviewDetails, DescribeStorageDetails.

    Name Type Description
    Time String Start time of data time range in ISO date format. For example, if the time granularity is 1-day, 2018-12-01T00:00:00+08:00 represents the time range between December 1, 2018 (inclusive) and December 2, 2018 (not inclusive).
  • For data at hourly level, 2019-08-22T00:00:00+08:00 indicates the statistics between 00:00 and 01:00 AM on August 22, 2019.
  • For data at daily level, 2019-08-22T00:00:00+08:00 indicates statistics on August 22, 2019.
    		•
    Value Integer Data size.
  • The data of the storage space, the unit is bytes.
  • Transcoding duration data, unit is seconds.
  • Traffic data, unit is bytes.
  • Bandwidth data, unit is bits per second.
  • Live broadcast clip data, the unit is seconds.
  • Carousel data, unit is seconds.
  • The number of sub-applications, the unit is one.

    • StickerTrackItem

    Information of sticker on sticker track.

    Used by actions: ComposeMedia.

    Name Type Required Description
    SourceMedia String Yes Source of media material for sticker segment, which can be:
  • ID of VOD media files
  • Download URL of other media files

    • Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
    Duration Float Yes Sticker duration in seconds.
    StartTime Float No Start time of sticker on track in seconds.
    CoordinateOrigin String No Origin position. Valid values:
  • Center: the origin of coordinates is the center position, such as the center of canvas.

    • Default value: Center.
    XPos String No The horizontal position of the origin of the sticker relative to the origin of the canvas. % and px formats are supported:
  • If the string ends in %, the XPos of the sticker will be at the position of the specified percentage of the canvas width; for example, 10% means that XPos is 10% of the canvas width.
  • If the string ends in px, the XPos of the sticker will be in px; for example, 100px means that XPos is 100 px.

    • Default value: 0 px.
    YPos String No The vertical position of the origin of the sticker relative to the origin of the canvas. % and px formats are supported:
  • If the string ends in %, the YPos of the sticker will be at the position of the specified percentage of the canvas height; for example, 10% means that YPos is 10% of the canvas height.
  • If the string ends in px, the YPos of the sticker will be in px; for example, 100px means that YPos is 100 px.

    • Default value: 0 px.
    Width String No Sticker width. % and px formats are supported:
  • If the string ends in %, the Width of the sticker will be the specified percentage of the canvas width; for example, 10% means that Width is 10% of the canvas width.
  • If the string ends in px, the Width of the sticker will be in px; for example, 100px means that Width is 100 px.
  • If both Width and Height are empty, then they will be the Width and Height of the sticker material, respectively.
  • If Width is empty (0), but Height is not empty, Width will be proportionally scaled.
  • If Width is not empty, but Height is empty, Height will be proportionally scaled.
    		•
    Height String No Sticker height. % and px formats are supported:
  • If the string ends in %, the Height of the sticker will be the specified percentage of the canvas height; for example, 10% means that Height is 10% of the canvas height.
  • If the string ends in px, the Height of the sticker will be in px; for example, 100px means that Height is 100 px.
  • If both Width and Height are empty, then they will be the Width and Height of the sticker material, respectively.
  • If Width is empty, but Height is not empty, Width will be proportionally scaled.
  • If Width is not empty, but Height is empty, Height will be proportionally scaled.
    		•
    ImageOperations Array of ImageTransform No Operation on sticker such as image rotation.
    Note: this field may return null, indicating that no valid values can be obtained.

    StorageRegionInfo

    The information of a storage region.

    Used by actions: DescribeStorageRegions.

    Name Type Description
    Region String The storage region.
    Description String The description of the storage region.
    Status String Whether storage is enabled in the region. Valid values:
  • opened: Enabled
  • unopened: Not enabled
    		•
    IsDefault Boolean Whether the region is the default storage region. Valid values: true, false.
    Area String Whether the storage region is inside or outside the Chinese mainland. Valid values:
  • Chinese Mainland
  • Outside Chinese Mainland
    		•

    StorageStatData

    VOD storage usage by region.

    Used by actions: DescribeStorageData.

    Name Type Description
    Area String VOD storage billing region. Valid values:
  • Chinese Mainland
  • Outside Chinese Mainland
    		•
    TotalStorage Integer Current total storage capacity in bytes.
    InfrequentStorage Integer Current STANDARD_IA storage capacity in bytes.
    StandardStorage Integer Current STANDARD storage capacity in bytes.
    ArchiveStorage Integer Current ARCHIVE storage usage in bytes
    DeepArchiveStorage Integer Current DEEP ARCHIVE storage usage in bytes

    SubAppIdInfo

    Subapplication information.

    Used by actions: DescribeSubAppIds.

    Name Type Description
    SubAppId Integer Subapplication ID.
    SubAppIdName String The subapplication name.
    Description String Subapplication overview.
    CreateTime String Subapplication creation time of task in ISO date format.
    Status String Subapplication status. Valid values:
  • On: enabled
  • Off: disabled
  • Destroying: terminating
  • Destroyed: terminated
    		•
    Name String The subapplication name. This parameter is not recommended. Please use SubAppIdName instead.
    Mode String Mode of this application. Valid values:
    -fileid: Only in fileid mode
    -fileid+path: FileID & Path mode
    Leave empty to select FileID mode by default
    StorageRegions Array of String Storage regions enabled for the sub-app.
    Tags Array of ResourceTag tag bound to the sub-application.

    SubtitleFormatsOperation

    The modification of the subtitle format list.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Type String Yes The modification type. Valid values:
  • add: Add the formats specified by Formats.
  • delete: Delete the formats specified by Formats.
  • reset: Reset the format list to formats specified by Formats.
    		•
    Formats Array of String Yes The subtitle format list. Valid values:
  • vtt
  • srt
    		•

    SubtitleInfoInput

    Subtitle suppression input

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Id String Yes

    Subtitle ID.
    FontType String No

    Font type.

    Enumeration value:

    • hei.ttf: Heiti
    • song.ttf: Song Typeface
    • kai.ttf (recommended) or simkai.ttf: KaiTi
    • msyh.ttf: Microsoft YaHei
    • msyhbd.ttf: Microsoft YaHei in bold
    • hkjgt.ttf: Hwakangangtai
    • dhttx.ttf: Dianheiti Ultra Light
    • xqgdzt.ttf: Xique Ancient Dictionary
    • qpcyt.ttf: Smart Splice Super Round Body
    • arial.ttf: only supports English
    • dinalternate.ttf: DIN Alternate Bold
    • helveticalt.ttf: Helvetica
    • helveticains.ttf: Helvetica Inserat
    • trajanpro.ttf: TrajanPro-Bold
    • korean.ttf: Korean
    • japanese.ttf: Japanese
    • thai.ttf: Thai
    • roboto.ttf: Roboto
    • notosans.ttf: NotoSans
    • notosansthai.ttf: Thai NotoSansThai
    • sarabun.ttf: Thai Sarabun
    • kanit.ttf: Thai Kanit
    • charmonman.ttf: Thai Charmonman
    • notonaskharabic.ttf: Arabic NotoNaskhArabic
    • notosansdevanagari.ttf: India NotoSansDevanagari
    • notosanstc.ttf: Cantonese NotoSansTC
    • notosanskr.ttf: Korean NotoSansKR
    • gothica1.ttf: Korean GothicA1
    • nanummyeongjo.ttf: Korean NanumMyeongjo
    • notosansjp.ttf: Japanese NotoSansJP
    • notoserifjp.ttf: Japanese NotoSerifJP
    • shipporimincho.ttf: Japanese ShipporiMincho

    Default value: hei.ttf Heiti
    FontSize String No

    Font size. If not specified, the font size in the subtitle file applies. Pixel and percentage formats are supported:

    • Pixel: Npx, where N ranges from (0,4096].
    • Percentage: N%, where N ranges from (0,100]. For example, 10% means the subtitle font size equals 10% of the source video height. If left blank and the subtitle file has no settings, the default is 5% of the source video height.
    FontColor String No

    Font color, format: 0xRRGGBB.

    Default value: 0xFFFFFF (white).
    FontAlpha Float No

    Text opacity. Value ranges from 0 to 1.

    • 0: completely transparent;
    • 1: completely opaque

    Default value: 1
    YPos String No

    Subtitle Y-coordinate position. Specify this parameter to ignore the built-in coordinates in the subtitle file. Supports pixel and percentage formats:

    • Pixel: Npx, where N ranges from [0,4096].
    • Percentage: N%, where N ranges from [0,100]. For example, 10% means the subtitle Y-coordinate = 10% * source video height. Default value: source video height * 4%.
      Note: The coordinate axis origin is at the bottom of the central axis of the source video, and the subtitle reference point is at the bottom of the central axis of the subtitle. Refer to the figure below:image
    BoardY String No

    Subtitle background base plate Y-coordinate position. Supports pixel and percentage formats:

    • Pixel: Npx, where N ranges from [0,4096].
    • Percentage: N%, where N ranges from [0,100]. For example, 10% means the subtitle background base plate Y-coordinate = 10% * source video height. If not specified, the subtitle background base plate is disabled.
      Note: The coordinate axis origin is located at the bottom of the central axis of the source video, and the reference point of the subtitle background base plate is at the bottom of its central axis. Refer to the figure below:image
    BoardWidth String No

    Width of the base plate, a positive integer.

    • Pixel: Npx, where N is in the range of [0,4096].
    • Percentage: N%, where N ranges from 0 to 100. If background is enabled and this parameter is not specified, the default width is 90% of the source video width.
    BoardHeight String No

    Height of the base plate, a positive integer.

    • Pixel: Npx, where N ranges from 0 to 4096.
    • Percentage: N%, where N ranges from 0 to 100. If background is enabled and this parameter is not specified, the default height is 15% of the source video height.
    BoardColor String No

    Base plate color. Format: 0xRRGGBB.

    Default value: 0x000000 (black).
    BoardAlpha Float No

    Subtitle background transparency. Value range: [0, 1].

    • 0: completely transparent;
    • 1: completely opaque.

    Default value: 0.8.
    Alignment String No

    Alignment mode.

    Enumeration values:

    • top: top alignment. The top position of subtitles is fixed, while the bottom position changes according to the line count.
    • bottom: bottom alignment. The bottom position of subtitles is fixed, while the top position changes according to the line count.

    Default value: bottom
    OutlineWidth String No

    Stroke width. Floating-point number.

    • Pixel: Npx, where N is in the range of [0,1000].
    • Percentage: N%, where N ranges from 0 to 100.

    By default if left blank, it is 0.3% of the source video height.
    OutlineColor String No

    Border color. Format: 0xRRGGBB.

    Default value: 0x000000 (black).
    OutlineAlpha Float No

    Stroke transparency. The value should be a positive floating-point number in the range of (0, 1].

    • 0: completely transparent;
    • 1: completely opaque.

    Default value: 1
    ShadowWidth String No

    Shadow width. Floating-point number.

    • Pixel: Npx, N value ranges from 0 to 1000.
    • Percentage: N%, N value ranges from 0 to 100. No shading by default if left blank.
    ShadowColor String No

    Shadow color. Format: 0xRRGGBB.

    Default value: 0x000000 (black) when shadow has set.
    ShadowAlpha Float No

    Shadow transparency. The value should be a positive floating-point number in the range of (0, 1].

    • 0: completely transparent;
    • 1: completely opaque.

    Default value: 1, completely opaque, with shadow configured.
    LineSpacing String No

    Line spacing. Positive integer.

    • Pixel: Npx, N value ranges from 0 to 1000.
    • Percentage: N%, N value ranges from 0 to 100.

    Default value: 0

    SuperResolutionInfo

    Super resolution configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Super resolution control switch. Optional values:
  • ON: Enable super resolution;
  • OFF: Disable screen super resolution.
    		•
    Type String No The super resolution type. This parameter is valid only if Switch is ON. Valid values:
  • lq: For low-resolution videos with obvious noise
  • hq: For high-resolution videos

    • Default value: lq.
    Size Integer No The ratio of the target resolution to the original resolution. Valid values: 2.
    Default value: 2.

    SvgWatermarkInput

    Input parameter of SVG watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    Width String No Watermark width, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px; if 0px is entered
    and Height is not 0px, the watermark width will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark width will be the width of the source SVG image;
  • If the string ends in W%, the Width of the watermark will be the specified percentage of the video width; for example, 10W% means that Width is 10% of the video width;
  • If the string ends in H%, the Width of the watermark will be the specified percentage of the video height; for example, 10H% means that Width is 10% of the video height;
  • If the string ends in S%, the Width of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Width is 10% of the short side of the video;
  • If the string ends in L%, the Width of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Width is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as W%.

    • Default value: 10W%.
    Height String No Watermark height, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px; if 0px is entered
    and Width is not 0px, the watermark height will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark height will be the height of the source SVG image;
  • If the string ends in W%, the Height of the watermark will be the specified percentage of the video width; for example, 10W% means that Height is 10% of the video width;
  • If the string ends in H%, the Height of the watermark will be the specified percentage of the video height; for example, 10H% means that Height is 10% of the video height;
  • If the string ends in S%, the Height of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Height is 10% of the short side of the video;
  • If the string ends in L%, the Height of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Height is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as H%.

    • Default value: 0 px.

    SvgWatermarkInputForUpdate

    Input parameter of SVG watermarking template

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    Width String No Watermark width, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px; if 0px is entered
    and Height is not 0px, the watermark width will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark width will be the width of the source SVG image;
  • If the string ends in W%, the Width of the watermark will be the specified percentage of the video width; for example, 10W% means that Width is 10% of the video width;
  • If the string ends in H%, the Width of the watermark will be the specified percentage of the video height; for example, 10H% means that Width is 10% of the video height;
  • If the string ends in S%, the Width of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Width is 10% of the short side of the video;
  • If the string ends in L%, the Width of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Width is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as W%.

    • Default value: 10W%.
    Height String No Height of a watermark, supporting six formats: px, %, W%, H%, S%, and L%.
  • If a string ends with px, it means the watermark Height is in pixels, for example, 100px means the Height is 100 pixels; when 0px is filled and

    • When Width is not 0px, it means the height of the watermark is proportionally scaled based on the original SVG image; when both Width and Height are set to 0px, it means the height of the watermark takes the height of the original SVG image;
  • If a string ends with W%, it indicates that the Height of a watermark is a percentage of a video's width. For example, 10W% means that Height is 10% of a video's width.
  • If a string ends with H%, it indicates that the Height of a watermark is a percentage of a video's height. For example, 10H% means that Height is 10% of a video's height.
  • If a string ends with S%, it indicates that the Height of a watermark is a percentage of a video's short side. For example, 10S% means that Height is 10% of a video's short side.
  • If a string ends with L%, it indicates that the Height of a watermark is a percentage of the long side of the video. For example, 10L% means that Height is 10% of the long side of the video.
  • When the string ends with %, it has the same meaning as H%.

    • Default value: 0px.

    TEHDConfig

    TESHD parameter configuration.

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Type String Yes TESHD transcoding type. Valid values:
  • TEHD-100
  • OFF (default)
    		•
    MaxVideoBitrate Integer No Maximum video bitrate. Valid at that time when Type is specified as top speed Codec.
    Leave it blank or set it to 0 to let VOD automatically set the bitrate cap.

    TEHDConfigForUpdate

    TESHD parameter configuration.

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    Type String No TESHD transcoding type. Valid values:
  • TEHD-100
  • OFF (default)
    		•
    MaxVideoBitrate Integer No Maximum bitrate. If this parameter is left blank, no modification will be made.

    TagConfigureInfo

    Control parameter of intelligent tagging task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Switch of intelligent tagging task. Valid values:
  • ON: enables intelligent tagging task;
  • OFF: disables intelligent tagging task.
    		•

    TagConfigureInfoForUpdate

    Control parameter of intelligent tagging task

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No Switch of intelligent tagging task. Valid values:
  • ON: enables intelligent tagging task;
  • OFF: disables intelligent tagging task.
    		•

    TaskOutputMediaInfo

    Output media file information of a video processing task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String Media file ID.
    MediaBasicInfo MediaBasicInfo

    TaskSimpleInfo

    Task overview information

    Used by actions: DescribeTasks.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values: WAITING (Waiting), PROCESSING (Processing), FINISH (Completed), ABORTED (Terminated).
    FileId String Video ID
    TaskType String The task type. Valid values:
  • Procedure: Video processing
  • EditMedia: Video editing
  • ReduceMediaBitrate: Bitrate reduction
  • WechatDistribute: Publishing to Weixin
  • ReviewAudioVideo: Moderation

    • Task types for v2017:
  • Transcode: Transcoding
  • SnapshotByTimeOffset: Screencapturing
  • Concat: Video splicing
  • Clip: Video clipping
  • ImageSprites: Image sprite generating
    		•
    CreateTime String Creation time of task in ISO date format.
    BeginProcessTime String Start time of task execution in ISO date format. If the task has not been started yet, this field will be empty.
    FinishTime String End time of task in ISO date format. If the task has not been completed yet, this field will be empty.
    SessionId String ID used for deduplication if there was a request with the same ID in the last seven days.
    SessionContext String Source context, which is used to pass through the user request information.

    TaskStatData

    Video processing task statistics.

    Used by actions: DescribeMediaProcessUsageData.

    Name Type Description
    TaskType String Task type.
  • Transcoding: standard transcoding
  • Transcoding-TESHD: TSC transcoding
  • Editing: video editing
  • Editing-TESHD: Extremely fast high-definition video editing
  • AdaptiveBitrateStreaming: adaptive bitrate streaming
  • ContentAudit: content moderation
  • ContentRecognition: content recognition
  • RemoveWatermark: Watermark removal
  • ExtractTraceWatermark: extract watermark
  • AddTraceWatermark: Add watermark
  • RebuildMedia: Audio and video quality revival
  • QualityInspect: audio and video quality inspection
  • Transcode: Transcode, including standard transcoding, top speed Codec, and video editing (This is not recommended)
  • VoiceTranslation: speech translation
  • JITTranscoding: JIT transcoding.
  • VideoSnapshot: video screenshot.
  • JITEncryption: Instant encryption
    		•
    Summary Array of TaskStatDataItem Task statistics overview (usage unit: second).
    Details Array of SpecificationDataItem Task statistics data of different specifications.
    Transcoding specification:
  • Remuxing: conversion to muxing.
  • Audio: audio transcoding
  • Standard.H264.SD: H.264 encoding standard-definition transcoding
  • Standard.H264.HD: H.264 encoding high-definition transcoding
  • Standard.H264.FHD: H.264 encoding full high-definition transcoding
  • Standard.H264.2K: H.264 encoding 2K transcode
  • Standard.H264.4K: H.264 encoding 4K transcode
  • Standard.H265.SD: H.265 encoding standard definition transcode
  • Standard.H265.HD: H.265 encoding high-definition transcoding
  • Standard.H265.FHD: H.265 encoding full HD transcoding
  • Standard.H265.2K: 2K transcoding with H.265 encoding
  • Standard.H265.4K: H.265 encoding 4K transcode
  • TESHD-10.H264.SD: H.264 encoding type standard definition TSC transcoding
  • TESHD-10.H264.HD: H.264 encoding high-definition TSC transcoding
  • TESHD-10.H264.FHD: H.264 full HD TSC transcoding
  • TESHD-10.H264.2K: H.264 encoding type 2K TSC transcoding
  • TESHD-10.H264.4K: H.264 encoding type 4K TSC transcoding
  • TESHD-10.H265.SD: H.265 encoding type SD TSC transcoding
  • TESHD-10.H265.HD: H.265 encoding type high-definition TSC transcoding
  • TESHD-10.H265.FHD: H.265 encoding full HD TSC transcoding
  • TESHD-10.H265.2K: H.265 encoding type 2K TSC transcoding
  • TESHD-10.H265.4K: H.265 encoding type 4K TSC transcoding
  • Edit.Audio: audio editing
  • Edit.H264.SD: H.264 encoding standard-definition video editing
  • Edit.H264.HD: H.264 encoding high-definition video edit
  • Edit.H264.FHD: H.264 Full HD video editing
  • Edit.H264.2K: H.264 encoding 2K video editing
  • Edit.H264.4K: H.264 encoding 4K video editing
  • Edit.H265.SD: H.265-encoded standard-definition video editing
  • Edit.H265.HD: H.265 encoding high-definition video editing
  • Edit.H265.FHD: Full HD video editing with H.265 encoding
  • Edit.H265.2K: H.265 encoding 2K video editing
  • Edit.H265.4K: H.265 encoding 4K video editing
  • Edit.TESHD-10.H264.SD: H.264 encoding type standard-definition extremely fast high-definition video editing
  • Edit.TESHD-10.H264.HD: H.264 encoding high-definition extremely fast high-definition video editing
  • Edit.TESHD-10.H264.FHD: Full HD extremely fast high-definition video editing with H.264 encoding
  • Edit.TESHD-10.H264.2K: H.264 encoding 2K extremely fast high-definition video editing
  • Edit.TESHD-10.H264.4K: H.264 encoding mode 4K extremely fast high-definition video editing
  • Edit.TESHD-10.H265.SD: H.265-encoded standard-definition extremely fast high-definition video editing
  • Edit.TESHD-10.H265.HD: H.265 encoding high-definition extremely fast high-definition video editing
  • Edit.TESHD-10.H265.FHD: Full HD extremely fast high-definition video editing with H.265 encoding
  • Edit.TESHD-10.H265.2K: H.265 encoding 2K extremely fast high-definition video editing
  • Edit.TESHD-10.H265.4K: H.265 encoding 4K extremely fast high-definition video editing

    • Watermark removal, audio and video quality revival specification:
  • 480P: Short edge ≤ 480px
  • 720P: Short edge ≤ 720px
  • 1080P: Short edge ≤ 1080px
  • 2K: Short edge ≤ 1440px
  • 4K: Short edge ≤ 2160px
  • 8K: Short edge ≤ 4320px
  • Audio: audio

    • Instant transcoding specification:
  • JITTranscoding.H264.SD: H.264 encoding standard definition JIT transcoding
  • JITTranscoding.H264.HD: H.264 encoding high-definition JIT transcoding
  • JITTranscoding.H264.FHD: H.264 encoding full HD JIT transcoding
  • JITTranscoding.H264.2K: H.264 encoding type 2K JIT transcoding
  • JITTranscoding.Audio: JIT transcoding for audio
  • JITTranscoding.Copy: JIT transcoding remuxing

    • Video screenshot specification:
  • SnapshotByTimeOffset: time point screenshot
  • SampleSnapshot: sampled screenshot
  • ImageSprite: sprite sheet
    		•

    TaskStatDataItem

    Task statistics, including number of tasks and usage.

    Used by actions: DescribeAigcUsageData, DescribeMediaProcessUsageData.

    Name Type Description
    Time String Start time of data time range in ISO date format. For example, if the time granularity is 1-day, 2018-12-01T00:00:00+08:00 represents the time range between December 1, 2018 (inclusive) and December 2, 2018 (not inclusive).
    Count Integer Number of tasks.
    Usage Integer Task usage.

    TempCertificate

    Temporary credential

    Used by actions: ApplyUpload.

    Name Type Description
    SecretId String Temporary security certificate ID.
    SecretKey String Temporary security certificate Key.
    Token String Token value.
    ExpiredTime Integer Certificate expiration time. A Unix timestamp will be returned which is accurate down to the second.

    TerrorismConfigureInfo

    Parameters for recognition of terrorism content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfo No Image recognition involves task control parameters for unsafe information.
    OcrReviewInfo TerrorismOcrReviewTemplateInfo No Text identification involves task control parameters for unsafe information.

    TerrorismConfigureInfoForUpdate

    Parameters for recognition of terrorism content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfoForUpdate No Parameters for recognition of terrorism content in images
    OcrReviewInfo TerrorismOcrReviewTemplateInfoForUpdate No Parameters for OCR-based recognition of terrorism content

    TerrorismImgReviewTemplateInfo

    Parameters for recognition of terrorism content in images

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable recognition of terrorism content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of terrorism content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • guns: weapons and guns
  • crowd: crowd
  • bloody: bloody scenes
  • police: police force
  • banners: terrorism flags
  • militant: militants
  • explosion: explosions and fires
  • terrorists: terrorists
  • scenario: terrorism images
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 90 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 80 will be used by default. Value range: 0-100

    TerrorismImgReviewTemplateInfoForUpdate

    Parameters for recognition of terrorism content in images

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable recognition of terrorism content in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for recognition of terrorism content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values:
  • guns: weapons and guns
  • crowd: crowd
  • bloody: bloody scenes
  • police: police force
  • banners: terrorism flags
  • militant: militants
  • explosion: explosions and fires
  • terrorists: terrorists
  • scenario: terrorism images
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    TerrorismOcrReviewTemplateInfo

    Parameters for OCR-based recognition of terrorism content

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable OCR-based recognition of terrorism content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    TerrorismOcrReviewTemplateInfoForUpdate

    Parameters for OCR-based recognition of terrorism content

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable OCR-based recognition of terrorism content. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    TextWatermarkTemplateInput

    Text watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    FontType String Yes Font type. Currently, two types are supported:
  • simkai.ttf: both Chinese and English are supported;
  • arial.ttf: only English is supported.
    		•
    FontSize String Yes Font size in Npx format where N is a numeric value.
    FontColor String Yes Font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlpha Float Yes Text transparency. Value range: (0, 1]
  • 0: completely transparent
  • 1: completely opaque

    • Default value: 1.

    TextWatermarkTemplateInputForUpdate

    Text watermarking template

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    FontType String No Font type. Currently, two types are supported:
  • simkai.ttf: both Chinese and English are supported;
  • arial.ttf: only English is supported.
    		•
    FontSize String No Font size in Npx format where N is a numeric value.
    FontColor String No Font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlpha Float No Text transparency. Value range: (0, 1]
  • 0: completely transparent
  • 1: completely opaque
    		•

    TimeRange

    General data type used to describe a time period.

    Used by actions: DescribeRoundPlays, DescribeTasks, SearchMedia.

    Name Type Required Description
    After String No
  • After or at this time (start time).
  • In ISO 8601 format. For more information, please see ISO Date Format.
    		•
    Before String No
  • Earlier than this time (end time).
  • In ISO 8601 format. For more information, please see ISO date format.
    		•

    TraceWatermarkInput

    The information of a digital watermark.

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Switch String No Whether to use digital watermarks. This parameter is required. Valid values:
  • ON
  • OFF
    		•

    TranscodePlayInfo2017

    Video transcoding playback information (v2017)

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String Playback address.
    Definition Integer Transcoding specification ID. For more information, please see Transcoding Parameter Template.
    Bitrate Integer Sum of the average bitrate of a video stream and that of an audio stream in bps.
    Height Integer Maximum value of the height of a video stream in px.
    Width Integer Maximum value of the width of a video stream in px.

    TranscodeTask2017

    The details of a video transcoding task. This parameter is only valid for tasks initiated by the v2017 video transcoding API.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Transcoding task ID.
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String ID of transcoded file.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileName String Name of transcoded file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Duration Integer Video duration in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverUrl String Cover address.
    Note: this field may return null, indicating that no valid values can be obtained.
    PlayInfoSet Array of TranscodePlayInfo2017 Playback information generated after video transcoding.
    Note: this field may return null, indicating that no valid values can be obtained.

    TranscodeTaskInput

    Input parameter type of transcoding task

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes

    Video transcoding template ID.
    WatermarkSet Array of WatermarkInput No

    Watermark list. Up to 10 image or text watermarks are supported.
    TraceWatermark TraceWatermarkInput No

    Traceable watermark.
    CopyRightWatermark CopyRightWatermarkInput No

    Copyright watermark.
    BlindWatermark BlindWatermarkInput No

    Digital watermark.
    MosaicSet Array of MosaicInput No

    Mosaic list. Up to 10 are supported.
    HeadTailSet Array of HeadTailTaskInput No

    Opening and ending list. Up to 10 opening and ending sequences are supported.
    StartTimeOffset Float No

    Start time offset of the transcoded video, unit: second.

  • Leave it blank or enter 0 means the transcoded video starts from the start position of the original video.
  • When the value is greater than 0 (assume it is n), it means the transcoded video starts from the nth second position of the original video.
  • When the value is less than 0 (assume it is -n), it means the transcoded video starts from the position n seconds before the end of the original video.
    		•
    EndTimeOffset Float No

    Offset of the termination time of the transcoded video, unit: second.

  • Leave it blank or enter 0 means the transcoded video lasts until the end of the original video.
  • When the value is greater than 0 (assume it is n), it means the transcoded video lasts until the nth second of the original video.
  • When the value is less than 0 (assume it is -n), it means the transcoded video lasts until n seconds before the end of the original video.
    		•
    SubtitleInfoSet Array of SubtitleInfoInput No

    List of subtitle suppression information. Up to 2 are supported.

    TranscodeTemplate

    Transcoding template details

    Used by actions: DescribeTranscodeTemplates.

    Name Type Description
    Definition String

    Unique identifier of the transcoding template.
    Container String

    Container format. Valid values: mp4, flv, hls, mp3, flac, and ogg.
    Name String

    Transcoding template name.
    Comment String

    Template description information.
    Type String

    Template type. Value:

  • Preset: preset template.
  • Custom: custom template.
    		•
    RemoveVideo Integer

    Whether to remove video data. Value:

  • 0: Reserved;
  • 1: Remove.
    		•
    RemoveAudio Integer

    Remove audio data. Parameter value:

  • 0: reserved;
  • 1: remove.
    		•
    VideoTemplate VideoTemplateInfo

    Video stream configuration parameters. This field is valid only when RemoveVideo is 0.
    AudioTemplate AudioTemplateInfo

    Audio stream configuration parameters. This field is valid only when RemoveAudio is 0.
    TEHDConfig TEHDConfig

    TSC transcoding parameter.


    Note: This field may return null, indicating that no valid values can be obtained.
    EnhanceConfig EnhanceConfig

    Audio/Video enhancement configuration.


    Note: This field may return null, indicating that no valid values can be obtained.
    ContainerType String

    Container format filter criteria. Valid values:

  • Video: Video format, can contain both video stream and audio stream.
  • PureAudio: Pure audio format, can only contain audio stream.
    		•
    CreateTime String

    Template creation time, in ISO date format.
    UpdateTime String

    Last template modification time, in ISO date format.
    SegmentType String

    Segment type. Valid only when Container is hls.
    StdExtInfo String

    Extended parameter.

    TransitionOperation

    Transition operation

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes Transition type, the values u200bu200bare:

    • Image transition operation, used for transition processing between two video clip images:

      • ImageFadeInFadeOut: image fade in and fade out.
      • BowTieHorizontal: horizontal bow tie.
      • BowTieVertical: vertical bow tie.
      • ButterflyWaveScrawler: Shake.
      • Cannabisleaf: maple leaf.
      • Circle: Arc retraction.
      • CircleCrop: Circles gather together.
      • Circleopen: ellipse gathering.
      • Crosswarp: Horizontal warping.
      • Cube: Cube.
      • DoomScreenTransition: Curtain.
      • Doorway: Porch.
      • Dreamy: Wave.
      • DreamyZoom: Horizontal zoom.
      • FilmBurn: Fire Burning Cloud.
      • GlitchMemories: Glitch.
      • Heart: heart shape.
      • InvertedPageCurl: Page turning.
      • Luma: Corrosion.
      • Mosaic: Nine-square grid.
      • Pinwheel: Windmill.
      • PolarFunction: elliptical diffusion.
      • PolkaDotsCurtain: Arc diffusion.
      • Radial: radar scanning
      • RotateScaleFade: up and down.
      • Squeeze: gather up and down.
      • Swap: zoom in and switch.
      • Swirl: spiral.
      • UndulatingBurnOutSwirl: Water spreading.
      • Windowblinds: blinds.
      • WipeDown: Wrap downward.
      • WipeLeft: Wrap to the left.
      • WipeRight: Wrap to the right.
      • WipeUp: Wrap up.
      • ZoomInCircles: Water ripples.


    • Audio transition operation, used for transition processing between two audio clips:

      • AudioFadeInFadeOut : The sound fades in and out.



    TrtcRecordInfo

    The TRTC recording information.

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    SdkAppId Integer The TRTC application ID.
    RoomId String The TRTC room ID.
    TaskId String The recording task ID.
    UserIds Array of String The IDs of users whose streams are mixed.

    UrlSignatureAuthPolicy

    Key hotlink protection information for generating the signature

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes Whether to enable or disable key hotlink protection. Valid values:
  • Enabled: enable
  • Disabled: disable
    		•
    EncryptedKey String No The key for generating the signature of key hotlink protection.
    EncryptedKey can contain 8-40 bytes, and cannot contain non-printable characters.

    UserAgentFilter

    UserAgent:blacklist/whitelist configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes UserAgent blacklist and whitelist configuration switch, the values u200bu200bare:
  • on: on;
  • off: off.
    • FilterRules Array of UserAgentFilterRule No UA blacklist/whitelist effect rule list

    UserAgentFilterRule

    UserAgent blacklist/whitelist rule configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    FilterType String Yes UA blacklist type:
  • whitelist: whitelist;
  • blacklist: blacklist.
    • UserAgents Array of String Yes UserAgent list.
    RuleType String Yes Rule type:
  • all: valid for all files;
  • file: valid for specified file suffix;
  • directory: valid for specified path;
  • path: specified absolute The path takes effect.
    • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill in * when all is used;
  • Fill in suffix name when file is used, such as jpg, txt;
  • Fill in path when directory is used, such as /xxx/ test/;
  • Fill in the absolute path when path is specified, such as /xxx/test.html.

    • UserDefineAsrTextReviewTemplateInfo

    Parameters for custom ASR-based recognition

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable custom ASR-based recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom ASR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom ASR-based recognition.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    UserDefineAsrTextReviewTemplateInfoForUpdate

    Parameters for custom ASR-based recognition

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable custom ASR-based recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom ASR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom ASR-based recognition.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    UserDefineConfigureInfo

    Parameters for custom recognition

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfo No User-defined character video moderation control parameter.
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo No User custom voice video moderation control parameter.
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo No User custom text video moderation control parameter.

    UserDefineConfigureInfoForUpdate

    Parameters for custom recognition

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate No Parameters for custom facial recognition
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate No Parameters for custom ASR-based recognition
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate No Parameters for custom OCR-based recognition

    UserDefineFaceReviewTemplateInfo

    Parameters for custom facial recognition

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable custom facial recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom facial recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding custom facial libraries.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 97 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 95 will be used by default. Value range: 0-100

    UserDefineFaceReviewTemplateInfoForUpdate

    Parameters for custom facial recognition

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable custom facial recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom facial recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding custom facial libraries.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    UserDefineOcrTextReviewTemplateInfo

    Parameters for custom OCR-based recognition

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to enable custom OCR-based recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom OCR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom OCR-based recognition.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

    UserDefineOcrTextReviewTemplateInfoForUpdate

    Parameters for custom OCR-based recognition

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to enable custom OCR-based recognition. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Filter labels for custom OCR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom OCR-based recognition.
    Up to 10 labels are allowed, each containing no more than 16 characters.
    BlockConfidence Integer No Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
    ReviewConfidence Integer No Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

    VideoConfigureInfo

    Just In Time transcoding video template configuration.

    Used by actions: CreateJustInTimeTranscodeTemplate, DescribeJustInTimeTranscodeTemplates.

    Name Type Required Description
    Width Integer No The maximum value of the video stream width (or long side), value range: 0 and [128, 1920], unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;

    • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.


    • Default value: 0.
    Height Integer No The maximum value of the video stream height (or short side), value range: 0 and [128, 1920], unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;

    • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.


    • Default value: 0.
    ResolutionAdaptive String No Resolution adaptive, optional values:
  • open: open, at this time, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed, at this time , Width represents the width of the video, and Height represents the height of the video.


    • Default value: open.
    Bitrate Integer No Bitrate of video stream, value ranges from 0 to [128, 10000]. Measurement unit: kbps.
    When the value is 0, VOD automatically sets the bitrate.

    VideoConfigureInfoForUpdate

    Just In Time transcoding video template update configuration.

    Used by actions: ModifyJustInTimeTranscodeTemplate.

    Name Type Required Description
    Width Integer No The maximum value of the video stream width (or long side), value range: 0 and [128, 1920], unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;

    • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.


    • Default value: 0.
    Height Integer No The maximum value of the video stream height (or short side), value range: 0 and [128, 1920], unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;

    • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.


    • Default value: 0.
    ResolutionAdaptive String No Resolution adaptive, optional values:
  • open: open, at this time, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed, at this time , Width represents the width of the video, and Height represents the height of the video.


    • Default value: open.
    Bitrate Integer No Bitrate of video stream, value ranges from 0 to [128, 10000], measurement unit: kbps.
    When the value is 0, it means VOD automatically sets the bitrate.

    VideoDenoiseInfo

    Image noise removal configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable image noise removal. Valid values:
  • ON
  • OFF
    		•
    Type String No The image noise removal type. This parameter is valid only if Switch is ON. Valid values:
  • weak
  • strong

    • Default value: weak.

    VideoEnhanceConfig

    Video enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    EnhanceScenarioType String No Enhancement scenario configuration. Valid values:
  • common: general enhancement parameters, which are basic optimization parameters suitable for various video types, enhancing overall video quality.
  • AIGC: overall resolution enhancement. It leverages AI technology to improve the overall video resolution and enhance image clarity.
  • short_play: enhance facial and subtitle details, emphasizing characters' facial expressions and subtitle clarity to improve the viewing experience.
  • short_video: optimize complex and diverse image quality issues, tailoring quality enhancements for the complex scenarios such as short videos to address various visual issues.
  • game (video): fix motion blur and enhance details, with a focus on enhancing the clarity of game details and restoring blurry areas during motions to make the image content during gaming clearer and richer.
  • HD_movie_series (UHD TV shows and movies), obtain smooth UHD effect, target the demand for UHD video from broadcasting/TV Stations and OTT, generate 4K 60fps HDR Ultra-High-Definition Standard Video. Support broadcasting scenario format standards.
  • LQ_material: low-definition material/old video restoration. It enhances overall resolution, and solves issues of old videos, such as low resolution, blur, distortion, scratches, and color temperature due to their age.
  • lecture: live shows, e-commerce, conferences, and lectures. It improves the face display effect and performs specific optimizations, including face region enhancement, noise reduction, and artifacts removal, for scenarios involving human explanation, such as live shows, e-commerce, conferences, and lectures.
  • Input of a null string indicates that the enhancement scenario is not used.
    		•
    SuperResolution SuperResolutionInfo No Super-resolution configuration. The video will not be processed when the source resolution exceeds the target resolution. Note that large model enhancement cannot be enabled simultaneously.
    Note: This field may return null, indicating that no valid values can be obtained.
    Hdr HDRInfo No HDR configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    Denoise VideoDenoiseInfo No Video noise reduction configuration. Note that it cannot be enabled simultaneously with large model enhancement.
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageQualityEnhance ImageQualityEnhanceInfo No Comprehensive enhancement configuration. Note that only one of the three items, large model, comprehensive enhancement, and jitter removal, can be configured.
    Note: This field may return null, indicating that no valid values can be obtained.
    ColorEnhance ColorEnhanceInfo No Color enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    LowLightEnhance LowLightEnhanceInfo No Low-light enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ScratchRepair ScratchRepairInfo No Remove scratch configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ArtifactRepair ArtifactRepairInfo No Artifacts removal configuration. Note that only one of the three items, large model, comprehensive enhancement, and artifacts removal, can be configured.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiffusionEnhance DiffusionEnhanceInfo No Large model enhancement configuration. Note that you can configure only one of the large model, comprehensive enhancement, and deburr options. It cannot intersect with super-resolution or noise reduction.
    Note: This field may return null, indicating that no valid values can be obtained.
    FrameRateWithDen FrameRateWithDenInfo No Frame interpolation frame rate configuration supports fractions. Note that it is mutually exclusive with FrameRate. The capacity will not take effect when the source frame rate is equal to or greater than the target frame rate.
    Note: This field may return null, indicating that no valid values can be obtained.

    VideoFrameInterpolationInfo

    Smart frame interpolation configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable smart frame interpolation. Valid values:
  • ON
  • OFF
    		•
    Fps Integer No The frame rate. Value range: (0, 100]. This parameter is valid only if Switch is ON. By default, the original frame rate will be used.

    VideoTemplateInfo

    Video stream configuration parameter

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Codec String Yes

    Video stream encoding format. Available values:

  • libx264: H.264 code;
  • libx265: H.265 code;
  • av1: AOMedia Video 1 code;
  • H.266: H.266 code.
    • Note:
  • av1 and H.266 encoding containers currently only support mp4;
  • H.266 currently only supports fixed CRF bitrate control method.
    		•
    Fps Integer Yes

    Video frame rate. Value ranges from 0 to 100. Measurement unit: Hz.
    When the value is 0, it means the frame rate is consistent with the original video.
    Bitrate Integer Yes

    Bitrate of video stream, value ranges from 0 to [128, 100000], unit: kbps.
    When the value is 0, it means the bitrate is automatically set by VOD.
    ResolutionAdaptive String No

    Resolution adaptation. Available values:

  • open: Enable. At this point, Width represents the long side of the video, and Height represents the short side of the video;
  • close: Disable. At this point, Width represents the width of the video, and Height represents the height of the video.
    • Default value: open.
    Width Integer No

    The maximum value of the video stream width (or long side). Valid values: 0 and [128, 8192]. Unit: px.

  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;
  • When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    • Default value: 0.
    Height Integer No

    The maximum value of the video stream height (or short side). Valid values: 0 and [128, 8192]. Unit: px.

  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;
  • When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    • Default value: 0.
    FillType String No

    Filling method. When video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "filling". Optional filling mode:

  • stretch: Stretch each frame to fill the entire screen, possibly causing the transcoded video to be "squashed" or "stretched".
  • black: Maintain video aspect ratio with edges filled with black.
  • white: Maintain video aspect ratio with edge remainder filled with white.
  • gauss: Maintain video aspect ratio with Gaussian blur filling for the rest of the edges.
    • Default value: black.
    Vcrf Integer No

    Control factor for constant video bitrate, value range [1, 51].

    Note:

  • If you specify this parameter, the bitrate control mode for CRF will be used to transcode (video bitrate will no longer take effect).
  • When the specified video stream encoding format is H.266, this field is required with a recommended value of 28.
  • If there are no special requirements, it is not recommended to specify this parameter.
    		•
    Gop Integer No

    Interval between I-frames, in frames. Value range: 0 and [1, 100000].
    When it is set to 0 or not set, the system will automatically set the gop length.
    GopUnit String No

    Gop value unit.

    Enumeration value:

    • frame: Represents the number of frames.
    • second: Represents seconds.

    Default value: frame
    PreserveHDRSwitch String No

    Whether the transcoding output still keeps HDR when the original video is HDR (High Dynamic Range). Value ranges from:

  • ON: If the raw file is HDR, the transcoding output keeps HDR; otherwise, the transcoding output is SDR (Standard Dynamic Range).
  • OFF: Regardless of whether the raw file is HDR or SDR, the transcoding output is SDR.
    • Default value: OFF.
    CodecTag String No

    Encoding tag, valid only when the video stream encoding format is H.265. Available values:

  • hvc1 refers to the hvc1 tag;
  • hev1 refers to the hev1 tag.
    • Default value: hvc1.
    Mode String No

    Bitrate control mode.

    Enumeration value:

    • VBR: Variable Bit Rate, dynamic bitrate (VBR), adjusts the output bitrate based on the complexity of the video image to ensure higher image quality, suitable for storage scenarios and applications with high image quality requirements.
    • ABR: Average Bit Rate, average bitrate, maintains the average bitrate of the output video as much as possible while allowing short-term bitrate fluctuation, suitable for scenarios where maintaining a certain image quality and minimizing overall bitrate are desired.
    • CBR: Constant Bit Rate, constant bitrate, maintains a constant output bitrate regardless of image complexity changes, suitable for scenarios with strict network bandwidth requirements, such as live streaming.
    • VCRF: Constant Quality Factor, controls video quality by setting a quality factor to achieve constant quality encoding of videos, with bitrate adjustment based on content complexity, suitable for scenarios where maintaining a certain quality is desired.

    Default value: VBR
    Bframes Integer No

    Number of B-frames between reference frames, set to auto by default.

    Value ranges from 0 to 16.
    HlsTime Integer No

    Average duration of slices. 0 or empty means auto, which automatically chooses appropriate segment duration based on video features such as GOP.

    Value ranges from 0 to 10.

    Unit: second.

    Supports only transcoding template. Adaptive bitrate stream template is not currently supported.
    VideoProfile String No

    A predefined group of encoding tools or features allowed by video encoding standards, suitable for different scenarios.

    Enumeration value:

    • baseline: Supports only I/P frames and non-interlaced scenarios, suitable for video calls and mobile video.
    • main: Mainstream profile, provides I, P, and B frames, and supports both interlaced and non-interlaced modes. Mainly used in mainstream audio and video consumption products such as video players and streaming media transmission devices.
    • high: Highest encoding level, adds 8X8 prediction to the Main Profile and supports custom quantification. Widely used in Blu-ray storage and HDTV scenarios.
    • default: Automatic filling along with the original video.

    Default value: default

    This configuration item is valid only when Codec is libx264.

    VideoTemplateInfoForUpdate

    Video stream configuration parameter

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    Codec String No

    Video stream encoding format. Available values:

  • libx264: H.264 encoding;
  • libx265: H.265 encoding;
  • av1: AOMedia Video 1 encoding;
  • H.266: H.266 encoding.
    • Note:
  • av1 and H.266 encoding containers currently only support mp4;
  • H.266 currently only supports fixed CRF bitrate control method.
    		•
    Fps Integer No

    Video frame rate. Value ranges from 0 to 100. Unit: Hz.
    When the value is 0, it means the frame rate is consistent with the original video.
    Bitrate Integer No

    Bitrate of video stream. Value ranges from 0 to [128, 100000]. Unit: kbps.
    When the value is 0, it means VOD automatically sets the bitrate.
    ResolutionAdaptive String No

    Resolution adaptation, available values:

  • open: Enable. At this point, Width represents the long side of the video, and Height indicates the short side.
  • close: Disable. At this point, Width represents the width of the video, and Height indicates the height.
    		•
    Width Integer No

    The maximum value of the video stream width (or long side). Valid values: 0 and [128, 8192]. Unit: px.

  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;
  • When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    		•
    Height Integer No

    Maximum value of the video stream height (or short side). Value ranges from 0 to [128, 8192]. Measurement unit: px.
    FillType String No

    Filling method. When video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "filling". Optional filling mode:

  • stretch: Stretch each frame to fill the entire screen, possibly causing the transcoded video to be "squashed" or "stretched".
  • black: Maintain video aspect ratio with edges filled with black.
  • white: Maintain video aspect ratio with edge remainder filled with white.
  • gauss: Maintain video aspect ratio with Gaussian blur filling for the rest of the edges.
    		•
    Vcrf Integer No

    Control factor for constant video bitrate. Value range: [1, 51]. Enter 0 to indicate that it is disabled.

    Note:

  • If you specify this parameter, the bitrate control mode for CRF will be used to transcode (video bitrate will no longer take effect).
  • When the encoding format of the specified video stream is H.266, this field is required. The recommended value is 28.
  • If there are no special requirements, it is not recommended to specify this parameter.
    		•
    Gop Integer No

    Interval between I-frames, in frames. Value range: 0 and [1, 100000].
    When it is set to 0 or not set, the system will automatically set the gop length.
    PreserveHDRSwitch String No

    Whether the transcoding output remains HDR when the original video is HDR (High Dynamic Range). Value ranges from:

  • ON: If the raw file is HDR, the transcoding output remains HDR; otherwise, the output is SDR (Standard Dynamic Range).
  • OFF: Regardless of whether the raw file is HDR or SDR, the transcoding output is SDR.
    		•
    CodecTag String No

    Encoding tag, valid only when the video stream encoding format is H.265. Value range:

  • hvc1 means hvc1 tag;
  • hev1 means hev1 tag.
    • Default value: hvc1.
    GopUnit String No

    Gop value unit.

    Enumeration value:

    • frame: Represents the number of frames.
    • second: Represents seconds.

    Default value: frame
    Mode String No

    Bitrate control mode.

    Enumeration value:

    • VBR: Variable Bit Rate, dynamic bitrate (VBR), adjusts the output bitrate based on the complexity of the video image to ensure higher image quality, suitable for storage scenarios and applications with high image quality requirements.
    • ABR: Average Bit Rate, average bitrate, maintains a stable average bitrate of the output video as much as possible but allows short-term bitrate fluctuation, suitable for scenarios where minimizing overall bitrate is needed while maintaining a certain image quality.
    • CBR: Constant Bit Rate, constant bitrate, maintains a constant output bitrate regardless of image complexity changes, suitable for scenarios with strict network bandwidth requirements, such as live streaming.
    • VCRF: Constant Rate Factor, constant quality factor, controls video quality by setting a quality factor to achieve constant quality encoding of videos, with bitrate adjustment based on content complexity, suitable for scenarios where maintaining a certain quality is desired.

    Default value: VBR
    Bframes Integer No

    Maximum number of consecutive B-frames, set to auto by default. -1 means change to automatic value.

    Value ranges from -1 to 16.
    HlsTime Integer No

    Average segment duration. 0 or blank means auto, which automatically chooses appropriate segment duration based on video features such as GOP.

    Value ranges from 0 to 10.

    Measurement unit: seconds.

    Supports only transcoding templates, not currently supported for adaptive bitrate templates.
    VideoProfile String No

    A predefined group of encoding tools or features allowed by the video encoding standard, suitable for different scenarios.

    Enumeration values:

    • baseline: Supports only I/p frames and non-interlaced scenarios, suitable for video calls and mobile video.
    • main: Mainstream Profile, provides I, p, and B frames, and supports both interlaced and non-interlaced modes. Primarily used in mainstream audio and video consumption products such as video players and streaming media transmission devices.
    • high: Highest encoding level, adds 8X8 prediction to the main Profile and supports custom quantification. Widely used in Blu-ray storage and HDTV scenarios.
    • default: Automatic filling along with the original video.

    default value: default

    This configuration item is valid only when Codec is libx264.

    VideoTrackItem

    Video segment information of video track.

    Used by actions: ComposeMedia.

    Name Type Required Description
    SourceMedia String Yes Source of media material for video segment, which can be:
  • ID of VOD media files
  • Download URL of other media files.

    • Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
    SourceMediaStartTime Float No Start time of video segment in material file in seconds. Default value: 0.
    Duration Float No Video segment duration in seconds. By default, the length of the video material will be used, which means that the entire material will be captured. If the source file is an image, Duration needs to be greater than 0.
    TargetDuration Float No The target video duration, in seconds.
  • If TargetDuration is empty or 0, the target duration is the same as Duration.
  • If TargetDuration is a value greater than 0, the playback speed will be changed to make the final video duration the same as the value of TargetDuration.
    		•
    CoordinateOrigin String No Video origin position. Valid values:
  • Center: the origin of coordinates is the center position, such as the center of canvas.

    • Default value: Center.
    XPos String No The horizontal position of the origin of the video segment relative to the origin of the canvas. % and px formats are supported:
  • If the string ends in %, the XPos of the video segment will be at the position of the specified percentage of the canvas width; for example, 10% means that XPos is 10% of the canvas width.
  • If the string ends in px, the XPos of the video segment will be in px; for example, 100px means that XPos is 100 px.

    • Default value: 0 px.
    YPos String No The vertical position of the origin of the video segment relative to the origin of the canvas. % and px formats are supported:
  • If the string ends in %, the YPos of the video segment will be at the position of the specified percentage of the canvas height; for example, 10% means that YPos is 10% of the canvas height.
  • If the string ends in px, the YPos of the video segment will be in px; for example, 100px means that YPos is 100 px.

    • Default value: 0 px.
    Width String No Video segment width. % and px formats are supported:
  • If the string ends in %, the Width of the video segment will be the specified percentage of the canvas width; for example, 10% means that Width is 10% of the canvas width.
  • If the string ends in px, the Width of the video segment will be in px; for example, 100px means that Width is 100 px.
  • If both Width and Height are empty, then they will be the Width and Height of the video material, respectively.
  • If Width is empty, but Height is not empty, Width will be proportionally scaled.
  • If Width is not empty, but Height is empty, Height will be proportionally scaled.
    		•
    Height String No Video segment height. % and px formats are supported:
  • If the string ends in %, the Height of the video segment will be the specified percentage of the canvas height; for example, 10% means that Height is 10% of the canvas height;
  • If the string ends in px, the Height of the video segment will be in px; for example, 100px means that Height is 100 px.
  • If both Width and Height are empty, then they will be the Width and Height of the video material, respectively.
  • If Width is empty, but Height is not empty, Width will be proportionally scaled.
  • If Width is not empty, but Height is empty, Height will be proportionally scaled.
    		•
    AudioOperations Array of AudioTransform No Operation on audio such as muting.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageOperations Array of ImageTransform No Operation on video image such as image rotation.
    Note: this field may return null, indicating that no valid values can be obtained.

    VoiceConfigureInfo

    Control parameters for audio (silence, bass, pop) detection.

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes Audio (mute, bass, pop) detection switch, optional values:
  • ON: on;
  • OFF: off.

    • VoiceConfigureInfoForUpdate

    Control parameters for audio (silence, bass, pop) detection.

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No Audio (mute, bass, pop) detection switch, optional values:
  • ON: on;
  • OFF: off.

    • WatermarkConfigureData

    Just In Time transcoding watermark template configuration.

    Used by actions: DescribeJustInTimeTranscodeTemplates.

    Name Type Description
    Switch String Whether to enable watermark. Possible values:
  • ON: means enabling watermark;
  • OFF: means turning off watermark.
    • Url String Watermark URL.
    Width String The width of the watermark.
  • The string ends with %, indicating that the watermark Width is a percentage of the video width, such as 10% indicating that the Width is 10% of the video width;
    		•
    Height String The height of the watermark.
  • The string ends with %, indicating that the watermark Height is a percentage of the video height, for example, 10% means that the Height is 10% of the video height;
    		•
    XPos String The horizontal position of the watermark origin from the video image coordinate origin. The string ends with %, indicating that the watermark XPos specifies a percentage of the video width, such as 10% indicating that XPos is 10% of the video width.
    YPos String The vertical position of the watermark origin from the video image coordinate origin. When the string ends with %, it means that the watermark YPos specifies a percentage of the video height. For example, 10% means that YPos is 10% of the video height.

    WatermarkConfigureInfo

    Just In Time transcoding watermark template configuration.

    Used by actions: CreateJustInTimeTranscodeTemplate.

    Name Type Required Description
    Switch String Yes Whether to enable watermark. Possible values:
  • ON: means enabling watermark;
  • OFF: means turning off watermark.
    • ImageContent String No Watermark image Base64 encoded string. Supports jpeg, png image formats.
    Width String No The width of the watermark.
  • The string ends with %, indicating that the watermark Width is a percentage of the video width, such as 10% indicating that the Width is 10% of the video width;
    		•
    Height String No The height of the watermark.
  • The string ends with %, indicating that the watermark Height is a percentage of the video height, for example, 10% means that the Height is 10% of the video height;
    		•
    XPos String No The horizontal position of the watermark origin from the video image coordinate origin. The string ends with %, indicating that the watermark XPos specifies a percentage of the video width, such as 10% indicating that the XPos is 10% of the video width.
    YPos String No The vertical position of the watermark origin from the video image coordinate origin. When the string ends with %, it means that the watermark YPos specifies a percentage of the video height. For example, 10% means that YPos is 10% of the video height.

    WatermarkConfigureInfoForUpdate

    Just In Time transcoding watermark template update configuration.

    Used by actions: ModifyJustInTimeTranscodeTemplate.

    Name Type Required Description
    Switch String No Whether to enable watermark. Possible values:
  • ON: means enabling watermark;
  • OFF: means turning off watermark.
    • ImageContent String No Watermark image Base64 encoded string. Supports jpeg, png image formats.
    Width String No The width of the watermark.
  • The string ends with %, indicating that the watermark Width is a percentage of the video width, such as 10% indicating that the Width is 10% of the video width;
    		•
    Height String No The height of the watermark.
  • The string ends with %, indicating that the watermark Height is a percentage of the video height, for example, 10% means that the Height is 10% of the video height;
    		•
    XPos String No The horizontal position of the watermark origin from the video image coordinate origin. The string ends with %, indicating that the watermark XPos specifies a percentage of the video width, such as 10% indicating that XPos is 10% of the video width.
    YPos String No The vertical position of the watermark origin from the video image coordinate origin. When the string ends with %, it means that the watermark YPos specifies a percentage of the video height. For example, 10% means that YPos is 10% of the video height.

    WatermarkInput

    Watermark parameter type of video processing task

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Watermarking template ID.
    TextContent String No Text content, which contains up to 100 characters. Set this parameter only when the watermark type is text.
    VOD does not support adding text watermarks on screenshots.
    SvgContent String No SVG content, which contains up to 2,000,000 characters. Set this parameter only when the watermark type is SVG.
    VOD does not support adding SVG watermarks on screenshots.
    StartTimeOffset Float No Start time offset of a watermark in seconds. If this parameter is left blank or 0 is entered, the watermark will appear upon the first video frame.
  • If this parameter is left blank or 0 is entered, the watermark will appear upon the first video frame;
  • If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;
  • If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame.
    		•
    EndTimeOffset Float No End time offset of a watermark in seconds.
  • If this parameter is left blank or 0 is entered, the watermark will exist till the last video frame;
  • If this value is greater than 0 (e.g., n), the watermark will exist till second n;
  • If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame.
    		•

    WatermarkTemplate

    Watermarking template details

    Used by actions: DescribeWatermarkTemplates.

    Name Type Description
    Definition Integer Unique ID of watermarking template.
    Type String Watermark type. Valid values:
  • image: image watermark;
  • text: text watermark.
    		•
    Name String Watermarking template name.
    Note: this field may return null, indicating that no valid values can be obtained.
    Comment String Template description.
    XPos String Horizontal position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Left edge of the watermark will be at the position of the specified percentage of the video width; for example, 10% means that the Left edge is at 10% of the video width;
  • If the string ends in px, the Left edge of the watermark will be at the position of the specified px of the video width; for example, 100px means that the Left edge is at the position of 100 px.
    		•
    YPos String Vertical position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Top edge of the watermark will beat the position of the specified percentage of the video height; for example, 10% means that the Top edge is at 10% of the video height;
  • If the string ends in px, the Top edge of the watermark will be at the position of the specified px of the video height; for example, 100px means that the Top edge is at the position of 100 px.
    		•
    ImageTemplate ImageWatermarkTemplate Image watermarking template. This field is valid only when Type is image.
    Note: this field may return null, indicating that no valid values can be obtained.
    TextTemplate TextWatermarkTemplateInput Text watermarking template. This field is valid only when Type is text.
    Note: this field may return null, indicating that no valid values can be obtained.
    SvgTemplate SvgWatermarkInput SVG watermarking template. This field is valid when Type is svg.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    CoordinateOrigin String Origin position. Valid values:
  • topLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text;
  • topRight: the origin of coordinates is in the top-right corner of the video, and the origin of the watermark is in the top-right corner of the image or text;
  • bottomLeft: the origin of coordinates is in the bottom-left corner of the video, and the origin of the watermark is in the bottom-left corner of the image or text;
  • bottomRight: the origin of coordinates is in the bottom-right corner of the video, and the origin of the watermark is in the bottom-right corner of the image or text.
    		•

    WebPageRecordInfo

    Panoramic recording information

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Required Description
    RecordUrl String No Panoramic recording Url.
    RecordTaskId String No Panoramic recording task ID.

    WechatMiniProgramPublishTask

    Release on WeChat Mini Program task information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
    WAITING: waiting;
    PROCESSING: processing;
    FINISH: completed.
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.
    		•
    Message String Error message.
    FileId String ID of published video file.
    SourceDefinition Integer ID of the transcoding template corresponding to the published video. 0 represents the source video.
    PublishResult String Status of video release on WeChat Mini Program. Valid values:
  • Pass: successfully published;
  • Failed: failed to publish;
  • Rejected: rejected.
    		•

    WechatMiniProgramPublishTaskInput

    Type of a release on WeChat Mini Program task

    Used by actions: DescribeProcedureTemplates.

    Name Type Required Description
    SourceDefinition Integer Yes ID of the transcoding template corresponding to the published video. 0 represents the source video.

    WechatPublishTask

    Release on WeChat task information

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
    WAITING: waiting;
    PROCESSING: processing;
    FINISH: completed.
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.

    • Note: this field may return null, indicating that no valid values can be obtained.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String ID of published video file.
    Note: this field may return null, indicating that no valid values can be obtained.
    Definition Integer Release on WeChat template ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    SourceDefinition Integer ID of the transcoding template corresponding to the published video. 0 represents the source video.
    Note: this field may return null, indicating that no valid values can be obtained.
    WechatStatus String Release on WeChat status. Valid values:
  • FAIL: failure;
  • SUCCESS: success;
  • AUDITNOTPASS: rejected
  • NOTTRIGGERED: release on WeChat not initiated yet.

    • Note: this field may return null, indicating that no valid values can be obtained.
    WechatVid String WeChat Vid.
    Note: this field may return null, indicating that no valid values can be obtained.
    WechatUrl String WeChat address.
    Note: this field may return null, indicating that no valid values can be obtained.
    Topik sebelumnya: DeleteProcedureTemplateTopik selanjutnya: Error Codes

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan