tencent cloud

Feedback

Data Types

Last updated: 2023-12-07 10:51:59

    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 Control parameter of intelligent categorization task.
    Note: this field may return null, indicating that no valid values can be obtained.
    TagConfigure TagConfigureInfo Control parameter of intelligent tagging task.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverConfigure CoverConfigureInfo Control parameter of intelligent cover generating task.
    Note: this field may return null, indicating that no valid values can be obtained.
    FrameTagConfigure FrameTagConfigureInfo Control parameter of intelligent frame-specific tagging task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.
    HeadTailConfigure HeadTailConfigureInfo Control parameter of opening and closing credits recognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    SegmentConfigure SegmentConfigureInfo Control parameter of splitting recognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    FaceConfigure FaceConfigureInfo Face recognition control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrFullTextConfigure OcrFullTextConfigureInfo Full text recognition control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrWordsConfigure OcrWordsConfigureInfo Text keyword recognition control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrFullTextConfigure AsrFullTextConfigureInfo Full speech recognition control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrWordsConfigure AsrWordsConfigureInfo Speech keyword recognition control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    ObjectConfigure ObjectConfigureInfo Control parameter of object recognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Required Description
    Definition Integer Yes Adaptive bitrate streaming specification.
    Package String Yes The packaging format. Valid values:
  • HLS
  • DASH
  • DrmType String Yes Encryption type.
    Url String Yes Playback address.
    Size Integer No 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.
  • If the file is a DASH file, the value of this parameter is the sum of the size of the MPD and segment files.
  • Note: For adaptive bitrate streaming files generated before 2022-01-10T16:00:00Z, the value of this parameter is 0.
  • DigitalWatermarkType String No Digital watermark type. Optional values:
  • Trace means traceability watermark processing;
  • CopyRight means copyright watermark processing;
  • None means no digital watermark processing.
  • SubStreamSet Array of MediaSubStreamInfoItem No The information of the streams.
    CopyRightWatermarkText String No Copyright Information.

    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 List of up to 10 image or text watermarks.
    Note: this field may return null, indicating that no valid values can be obtained.
    TraceWatermark TraceWatermarkInput No Digital watermark.
    CopyRightWatermark CopyRightWatermarkInput No CopyRight Watermark.
    SubtitleSet Array of String No List of subtitle IDs (maximum: 16)

    AdaptiveDynamicStreamingTemplate

    Details of a transcoding to adaptive bitrate streaming template

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

    Name Type Description
    Definition Integer Unique ID of a transcoding to adaptive bitrate streaming template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
  • Name String Name of a transcoding to adaptive bitrate streaming template.
    Comment String Description of a transcoding to adaptive bitrate streaming template.
    Format String Adaptive bitstream format. Valid value:
  • HLS.
  • DrmType String The DRM type. Valid values:
  • SimpleAES
  • Widevine
  • FairPlay

  • If this parameter is an empty string, it indicates that the video is not protected by DRM.
    DrmKeyProvider String The provider of the DRM key. Valid values:
  • SDMC
  • VOD

  • The default is VOD.
    StreamInfos Array of AdaptiveStreamTemplate Parameter information of input stream for adaptive bitrate streaming. Up to 10 streams can be input.
    DisableHigherVideoBitrate Integer Whether to prohibit transcoding from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.
  • DisableHigherVideoResolution Integer Whether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.
  • CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    SegmentType String The segment type. This parameter is valid only if 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 information.
    RemoveAudio Integer No Whether to remove audio stream. Valid values:
  • 0: no,
  • 1: yes.
  • RemoveVideo Integer No Whether to remove a video stream. Valid values:
  • 0: no
  • 1: yes
  • TEHDConfig TEHDConfig No TESHD transcoding parameters
    Note: This field may return null, indicating that no valid value was found.

    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 intelligent categorization task in video content analysis, which is valid if task type is Classification.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverTask AiAnalysisTaskCoverResult Query result of intelligent cover generating task in video content analysis, which is valid if task type is Cover.
    Note: this field may return null, indicating that no valid values can be obtained.
    TagTask AiAnalysisTaskTagResult Query result of intelligent tagging task in video content analysis, which is valid if task type is Tag.
    Note: this field may return null, indicating that no valid values can be obtained.
    FrameTagTask AiAnalysisTaskFrameTagResult Query result of intelligent frame-specific tagging task in video content analysis, which is valid if task type is FrameTag.
    Note: this field may return null, indicating that no valid values can be obtained.
    HighlightTask AiAnalysisTaskHighlightResult Query result of an intelligent highlight generating task in video content analysis, which is valid when task type is Highlight.
    Note: this field may return null, indicating that no valid values can be obtained.

    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 Output of intelligent categorization task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output of intelligent cover generating task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output of intelligent frame-specific tagging task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output of an intelligent highlight generating task.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Output of intelligent tagging task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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,
  • OcrFullTextRecognition: full text recognition,
  • HeadTailRecognition: video opening and ending credits recognition,
  • ObjectRecognition: object recognition.
  • HeadTailTask AiRecognitionTaskHeadTailResult Video opening and ending credits recognition result, which is valid when Type is
    HeadTailRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    SegmentTask AiRecognitionTaskSegmentResult Video splitting recognition result, which is valid when Type is
    SegmentRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    FaceTask AiRecognitionTaskFaceResult Face recognition result, which is valid when Type is
    FaceRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrWordsTask AiRecognitionTaskAsrWordsResult Speech keyword recognition result, which is valid when Type is
    AsrWordsRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrFullTextTask AiRecognitionTaskAsrFullTextResult Full speech recognition result, which is valid when Type is
    AsrFullTextRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrWordsTask AiRecognitionTaskOcrWordsResult Text keyword recognition result, which is valid when Type is
    OcrWordsRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrFullTextTask AiRecognitionTaskOcrFullTextResult Full text recognition result, which is valid when Type is
    OcrFullTextRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.
    ObjectTask AiRecognitionTaskObjectResult Object recognition result, which is valid when Type is
    ObjectRecognition.
    Note: this field may return null, indicating that no valid values can be obtained.

    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 of full speech recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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

    The subtitle information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    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.

    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 Output information of speech keyword recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output information of face recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output information of video opening and ending credits recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output information of object recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output information of full text recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output information of text keyword recognition task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Input information of video splitting task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Output AiRecognitionTaskSegmentResultOutput Output information of video splitting task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Output for OCR-based recognition of politically sensitive content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for intelligent recognition of politically sensitive content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for ASR-based recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for OCR-based recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for intelligent recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for ASR-based recognition of banned content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for OCR-based recognition of banned content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for OCR-based recognition of terrorism content
    Note: This field may return null, indicating that no valid value can be found.
    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 Output for intelligent recognition of terrorism content
    Note: This field may return null, indicating that no valid value can be found.
    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.
  • 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, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, 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 full speech recognition task.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of full speech recognition task. Valid values:
  • ON: enables intelligent full speech recognition task;
  • OFF: disables intelligent full speech recognition task.
  • SubtitleFormats Array of String No The formats of the subtitle files generated. If this parameter is not passed or an empty string is passed in, no subtitles files will be generated. Valid values:
  • vtt
  • srt
  • SubtitleFormat String No The format of the subtitle file generated. If this parameter is not passed or an empty string is passed in, no subtitles files will be generated. Valid values:
  • vtt
  • srt

  • Note: This parameter has been deprecated. Please use SubtitleFormats instead.
    SrcLanguage String No Media source language value range:
  • zh: Mandarin
  • en: English
  • ja: Japanese
  • zh-ca: Cantonese
  • Note: If it fills in an empty string or leave this parameter blank, it will be automatically recognized (it is recommended to fill in the language corresponding to the media to improve the recognition accuracy).

    AsrFullTextConfigureInfoForUpdate

    Control parameter of full speech recognition task.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of full speech recognition task. Valid values:
  • ON: enables intelligent full speech recognition task;
  • OFF: disables intelligent full speech recognition task.
  • SubtitleFormatsOperation SubtitleFormatsOperation No The modification information of the subtitle format list.
    SubtitleFormat String No The format of the subtitle file generated. If you pass in an empty string, no subtitle files will be generated. Valid values:
  • vtt
  • srt

  • Note: This parameter has been deprecated. Please use SubtitleFormatsOperation instead.
    SrcLanguage String No Media source language value range:
  • zh: Mandarin
  • en: English
  • ja: Japanese
  • zh-ca: Cantonese
  • 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.

    AudioDenoiseInfo

    Noise removal configuration.

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

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

  • Default value: weak.

    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 Audio stream bitrate in Kbps. Value range: 0 and [26, 256].
    If the value is 0, the bitrate of the audio stream will be the same as that of the original audio.
    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 Audio stream bitrate in Kbps. Value range: 0 and [26, 256]. If the value is 0, the bitrate of the audio stream will be the same as that of the original audio.
    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 Volume adjustment parameter, which is valid if Type is Volume.
    Note: this field may return null, indicating that no valid values can be obtained.

    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 Timestamp hotlink protection mode A configuration
    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.
  • 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 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.

    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 name configuration information.
    Note: This field may return null, indicating that no valid value can be obtained.

    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 Log date in the format of yyyy-MM-dd, such as 2018-03-01.
    Name String Log name in the format of date and time-domain name,
    such as 2018120101-test.vod2.mqcloud.com.
    Url String Log download link, which is valid for 24 hours.
    StartTime String Log start time in ISO date format
    EndTime String Log end time in ISO date format

    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, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, 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.

    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 media file composing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Output ComposeMediaTaskOutput Output of media file composing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.

    ContentReviewOcrResult

    The result for OCR-based image moderation.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float The confidence score for the OCR-based moderation result. Value range: 0-100.
    Suggestion String The suggestion for handling the suspicious content detected based on OCR. Valid values:
  • pass/li>
  • review
  • block
  • KeywordSet Array of String The list of suspicious keywords detected based on OCR.
    AreaCoordSet Array of Integer The coordinates (pixel) of the top-left and bottom-right corners of the frame where a suspicious keyword appears. Format: [x1, y1, x2, y2].

    ContentReviewResult

    The result for intelligent image moderation.

    Used by actions: ReviewImage.

    Name Type Description
    Type String The result type. Valid values:
  • Porn.Image: Pornographic content in the image
  • Terrorism.Image: Terrorist content in the image
  • Political.Image: Politically sensitive content in the image
  • Porn.Ocr: Pornographic content in the image based on OCR
  • Terrorism.Ocr: Terrorist content in the image based on OCR
  • Political.Ocr: Politically sensitive content in the image based on OCR
  • PornImageResult PornImageResult The pornographic content detected in the image. This parameter is valid if Type is Porn.Image.
    Note: This field may return null, indicating that no valid value was found.
    TerrorismImageResult TerrorismImageResult The terrorist content detected in the image. This parameter is valid if Type is Terrorism.Image.
    Note: This field may return null, indicating that no valid value was found.
    PoliticalImageResult PoliticalImageResult The politically sensitive content detected in the image. This parameter is valid if Type is Political.Image.
    Note: This field may return null, indicating that no valid value was found.
    PornOcrResult ContentReviewOcrResult The pornographic content detected in the image based on OCR. This parameter is valid if Type is Porn.Ocr.
    Note: This field may return null, indicating that no valid value was found.
    TerrorismOcrResult ContentReviewOcrResult The terrorist content detected in the image based on OCR. This parameter is valid if Type is Terrorism.Ocr.
    Note: This field may return null, indicating that no valid value was found.
    PoliticalOcrResult ContentReviewOcrResult The politically sensitive content detected in the image based on OCR. This parameter is valid if Type is Political.Ocr.
    Note: This field may return null, indicating that no valid value was found.

    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 Parameters for recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.
    TerrorismConfigure TerrorismConfigureInfo Parameters for recognition of terrorism content
    Note: This field may return null, indicating that no valid value can be found.
    PoliticalConfigure PoliticalConfigureInfo Parameters for recognition of politically sensitive content
    Note: This field may return null, indicating that no valid value can be found.
    ProhibitedConfigure ProhibitedConfigureInfo Control parameter of prohibited information detection. Prohibited information includes:
  • Abusive;
  • Drug-related.

  • Note: this field may return null, indicating that no valid values can be obtained.
    UserDefineConfigure UserDefineConfigureInfo Custom recognition parameters
    Note: This field may return null, indicating that no valid value can be found.
    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.
  • 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.

    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.

    DomainDetailInfo

    Domain name information

    Used by actions: DescribeVodDomains.

    Name Type Description
    Domain String Domain name
    AccelerateAreaInfos Array of AccelerateAreaInfo Acceleration region information
    Note: this field may return null, indicating that no valid value is obtained.
    DeployStatus String Deployment status. Valid values:
  • Online
  • Deploying
  • Locked: you cannot change the deployment status of locked domain names
  • HTTPSConfig DomainHTTPSConfig HTTPS configuration information
    Note: this field may return null, indicating that no valid value is obtained.
    UrlSignatureAuthPolicy UrlSignatureAuthPolicy Key hotlink protection configuration
    Note: this field may return null, indicating that no valid value is obtained.
    RefererAuthPolicy RefererAuthPolicy Referer hotlink protection configuration
    Note: this field may return null, indicating that no valid value is obtained.
    CreateTime String The time when the domain name was added in the VOD system
  • The time is in ISO 8601 date format.
  • QUICConfig DomainQUICConfig The QUIC configuration for the domain.
    Note: This field may return null, indicating that no valid values can be obtained.

    DomainHTTPSConfig

    HTTPS configuration information of the domain name

    Used by actions: DescribeVodDomains.

    Name Type Required Description
    CertExpireTime String Yes Time when the certificate expires
  • The time is in ISO 8601 date format.
  • 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.

    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 Input of video editing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Output EditMediaTaskOutput Output of video editing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 The bit rate of the video stream, value range: 0 and [128, 35000], unit: kbps.
    When the value is 0 or left blank, it means automatically selecting the best video bit rate.
    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.

    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.

    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 confirm that the message has been received, and the confirmation is valid for 30 seconds. After the confirmation expires, the event can be obtained again.
    EventType String Supported event types:
  • NewFileUpload: Video uploaded.
  • ProcedureStateChanged: Task flow status changed.
  • FileDeleted: Video deleted.
  • RestoreMediaComplete: Video retrieved.
  • PullComplete: Finished video pulling.
  • EditMediaComplete: Finished video editing.
  • SplitMediaComplete: Finished video splitting.
  • ComposeMediaComplete: Finished producing the media file.
  • RemoveWatermark: Watermark removed.
  • RebuildMediaComplete: Finished audio/video remastering.
  • ReviewAudioVideoComplete: Finished moderation.
  • ExtractTraceWatermarkComplete: Finished digital watermark extraction.
  • DescribeFileAttributesComplete: Finished getting file attributes.
  • QualityEnhanceComplete: FinishedQualityEnhance.
  • v2017 task types:
  • TranscodeComplete: Finished video transcoding.
  • ConcatComplete: Finished video splicing.
  • ClipComplete: Finished video clipping.
  • CreateImageSpriteComplete: Finished image sprite generation.
  • CreateSnapshotByTimeOffsetComplete: Finished time point screencapturing.
  • FileUploadEvent FileUploadTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ProcedureStateChangeEvent ProcedureTask
    Note: This field may return null, indicating that no valid value can be obtained.
    FileDeleteEvent FileDeleteTask
    Note: This field may return null, indicating that no valid value can be obtained.
    PullCompleteEvent PullUploadTask
    Note: This field may return null, indicating that no valid value can be obtained.
    EditMediaCompleteEvent EditMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    SplitMediaCompleteEvent SplitMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ComposeMediaCompleteEvent ComposeMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ClipCompleteEvent ClipTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    TranscodeCompleteEvent TranscodeTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    ConcatCompleteEvent ConcatTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    WechatPublishCompleteEvent WechatPublishTask
    Note: This field may return null, indicating that no valid value can be obtained.
    RemoveWatermarkCompleteEvent RemoveWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    RestoreMediaCompleteEvent RestoreMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    RebuildMediaCompleteEvent RebuildMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ExtractTraceWatermarkCompleteEvent ExtractTraceWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ExtractCopyRightWatermarkCompleteEvent ExtractCopyRightWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ReviewAudioVideoCompleteEvent ReviewAudioVideoTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ReduceMediaBitrateCompleteEvent ReduceMediaBitrateTask
    Note: This field may return null, indicating that no valid value can be obtained.
    DescribeFileAttributesCompleteEvent DescribeFileAttributesTask
    Note: This field may return null, indicating that no valid value can be obtained.
    QualityInspectCompleteEvent QualityInspectTask
    Note: This field may return null, indicating that no valid value can be obtained.
    QualityEnhanceCompleteEvent QualityEnhanceTask Remaster completion event, valid when the event type is QualityEnhanceComplete.
    Pay attention to: this field may return null, indicating that no valid value can be obtained

    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 Extract copyright watermark task input information.
    Note: This field may return null, indicating that no valid value can be obtained.
    Output ExtractCopyRightWatermarkTaskOutput Extract copyright watermark task output information.
    Note: This field may return null, indicating that no valid value can be obtained.
    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 The distributor’s user ID, which is a six-digit hex number. This parameter is relevant when digital watermarks are used.
    Uid String This parameter has been deprecated.

    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, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, 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.

    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 The type of the file deleted.
    Note: This field may return null, indicating that no valid value can be obtained.

    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.
    Note: This field may return null, indicating that no valid value can be obtained.

    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.

    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, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes Whether to enable HDR. Valid values:
  • ON
  • OFF
  • Type String No The HDR type. Valid values:
  • hdr10
  • hlg


  • Note:
  • This parameter is valid only if Switch is ON.
  • For audio/video remastering, this parameter is valid only if the output video codec is 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: 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.
    Note: This field may return null, indicating that no valid value can be obtained.

    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.
    StartTimeOffset Float Start time offset of a segment.
    EndTimeOffset Float End time offset of a segment.

    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 Server certificate configuration information

    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

    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.

    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.

    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.

    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.

    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

    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.
    Note: This field may return null, indicating that no valid value can be obtained.
    WatermarkConfigure WatermarkConfigureData Watermark parameter configuration.
    Note: This field may return null, indicating that no valid value can be obtained.

    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 Start time of the cliped segment, in ISO date format
    EndTime String End time of the cliped segment, in ISO date format

    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
    StreamId String Live recording stream ID.
    RecordStartTime String Recording start time, use ISO date format.
    RecordEndTime String Recording end time, using ISO date format.

    LowLightEnhanceInfo

    Low-light enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, 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.

    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 Start time offset of frame-specific tag.
    EndTimeOffset Float End time offset of frame-specific tag.
    TagSet Array of MediaAiAnalysisFrameTagItem List of tags in time period.

    MediaAiAnalysisHighlightItem

    Information of an intelligently generated highlight

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    HighlightUrl String Address of an intelligently generated highlight.
    CovImgUrl String Address of an intelligently generated highlight cover.
    Confidence Float Confidence of an intelligently generated highlight between 0 and 100.
    Duration Float Duration of an intelligently generated highlight.
    SegmentSet Array of HighlightSegmentItem List of intelligently generated highlight subsegments, which together form a highlight.

    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 audio stream in bps.
    Note: this field may return null, indicating that no valid values can be obtained.
    SamplingRate Integer Sample rate of audio stream in Hz.
    Note: this field may return null, indicating that no valid values can be obtained.
    Codec String Audio stream encoder, such as aac.
    Note: this field may return null, indicating that no valid values can be obtained.

    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.
    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
  • 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.
    PicUrlExpireTimeStamp Integer This field has been disused. Please use PicUrlExpireTime.
    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).
    PicUrlExpireTimeStamp Integer This field has been disused. Please use 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 Image sprite specification. For more information, please see Image Sprite Parameter Template.
    Note: this field may return null, indicating that no valid values can be obtained.
    Height Integer Subimage height of image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer Subimage width of image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of subimages in each image sprite.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageUrlSet Array of String Address of each 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. 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, such as video name, category, playback address, and cover image.
    Note: this field may return null, indicating that no valid values can be obtained.
    MetaData MediaMetaData Metadata, such as 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 Result information of transcoding, such as address, specification, bitrate, and resolution of the videos in various bitrates generated by transcoding a video.
    Note: this field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicsInfo MediaAnimatedGraphicsInfo Result information of animated image generating, i.e., relevant information of an animated image (such as .gif) generated from a video.
    Note: this field may return null, indicating that no valid values can be obtained.
    SampleSnapshotInfo MediaSampleSnapshotInfo Sampled screenshot information, i.e., relevant information of a sampled screenshot generated from a video.
    Note: this field may return null, indicating that no valid values can be obtained.
    ImageSpriteInfo MediaImageSpriteInfo Image sprite information, i.e., relevant information of image sprite generated from video.
    Note: this field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetInfo MediaSnapshotByTimeOffsetInfo Time point screenshot information, i.e., information of each time point screenshot generated from a video.
    Note: this field may return null, indicating that no valid values can be obtained.
    KeyFrameDescInfo MediaKeyFrameDescInfo Timestamp information, i.e., information of each timestamp set for a video.
    Note: this field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingInfo MediaAdaptiveDynamicStreamingInfo Adaptive bitrate streaming information, such as specification, encryption type, and container format.
    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 value is obtained.
    FileId String Unique ID of media file.
    ReviewInfo FileReviewInfo Moderation details.
    Note: This field may return null, indicating that no valid values can be obtained.

    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.
  • 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 files source category:
  • Record: From recording. Such as live streaming recording, live time shift recording, etc.
  • Upload: From upload. Such as pull upload, upload from server, client UGC upload, etc.
  • VideoProcessing: From video processing. Such as video splicing, video editing, etc.
  • TrtcRecord: From TRTC accompanying recording.
  • WebPageRecord: From panoramic recording.
  • Unknown: Unknown source.
  • SourceContext String User-transparent transmission field when creating a file.
    LiveRecordInfo LiveRecordInfo Live streaming recording information, valid when the file source is Record.
    TrtcRecordInfo TrtcRecordInfo TRTC recording information, valid when the file source is TrtcRecord.
    WebPageRecordInfo WebPageRecordInfo Panoramic recording information, valid when the file source is WebPageRecord.

    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:
  • cn: Chinese
  • ja: Japanese
  • en-US: English

  • For other valid values, see RFC 5646.
    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:
  • cn: Chinese
  • ja: Japanese
  • en-US: English

  • For other values, see RFC 5646.
    Format String Subtitle format. Valid value:
  • vtt
  • Url String Subtitle URL

    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

    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.

    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: preset configuration;
  • Custom: custom configuration.
  • AudioVideoType String The type of audio/video played. Valid values:
  • AdaptiveDynamicStreaming: Adaptive bitrate stream
  • Transcode: Transcoded stream
  • Original: The original stream
  • DrmSwitch String Switch of DRM-protected adaptive bitstream playback:
  • ON: enabled, indicating to play back only output adaptive bitstreams protected by DRM;
  • OFF: disabled, indicating to play back unencrypted output adaptive bitstreams.
  • AdaptiveDynamicStreamingDefinition Integer ID of the unencrypted adaptive bitrate streaming template that allows output.
    DrmStreamingsInfo DrmStreamingsInfo Content of the DRM-protected adaptive bitrate streaming template that allows output.
    TranscodeDefinition Integer The ID of the transcoding template allowed.
    ImageSpriteDefinition Integer ID of the image sprite generating template that allows output.
    ResolutionNameSet Array of ResolutionNameInfo Display name of player for substreams with different resolutions.
    CreateTime String Creation time of player configuration in ISO date format.
    UpdateTime String Last modified time of player configuration in ISO date format.
    Domain String Domain name used for playback. If its value is Default, the domain name configured in Default Distribution Configuration will be used.
    Scheme String Scheme used for playback. Valid values:
  • Default: the scheme configured in Default Distribution Configuration will be used;
  • HTTP;
  • HTTPS.
  • Comment String Template description.

    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 Parameters for recognition of politically sensitive content in images
    Note: This field may return null, indicating that no valid value can be found.
    AsrReviewInfo PoliticalAsrReviewTemplateInfo No Parameters for ASR-based recognition of politically sensitive content
    Note: This field may return null, indicating that no valid value can be found.
    OcrReviewInfo PoliticalOcrReviewTemplateInfo No Parameters for OCR-based recognition of politically sensitive content
    Note: This field may return null, indicating that no valid value can be found.

    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

    PoliticalImageResult

    The moderation result for politically sensitive content in an image.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float The confidence score for the moderation result. Value range: 0-100.
    Suggestion String The suggestion for handling the detected politically sensitive content. Valid values:
  • pass/li>
  • review
  • block
  • Name String The name of the politically sensitive content or banned icon detected.
    AreaCoordSet Array of Integer The coordinates (pixel) of the top-left and bottom-right corners of the frame where the politically sensitive content or banned icon appears. Format: [x1, y1, x2, y2].

    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 Parameters for recognition of pornographic content in images
    Note: This field may return null, indicating that no valid value can be found.
    AsrReviewInfo PornAsrReviewTemplateInfo No Parameters for ASR-based recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.
    OcrReviewInfo PornOcrReviewTemplateInfo No Parameters for OCR-based recognition of pornographic content
    Note: This field may return null, indicating that no valid value can be found.

    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

    PornImageResult

    The moderation result for pornographic content in an image.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float The confidence score for the moderation result. Value range: 0-100.
    Suggestion String The suggestion for handling the detected pornographic content. Valid values:
  • pass/li>
  • review
  • block
  • Label String The label for the detected pornographic content. Valid values:
  • porn
  • sexy
  • vulgar
  • intimacy
  • 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.
  • ErrCode Integer Disused. Please use ErrCode of each specific task.
    Note: this field may return null, indicating that no valid values can be obtained.
    Message String Disused. Please use Message of each specific task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.
    AiRecognitionTask AiRecognitionTaskInput Type parameter of AI-based content recognition 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.

    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 Control parameter of prohibited information detection in speech.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo No Control parameter of prohibited information detection in text.
    Note: this field may return null, indicating that no valid values can be obtained.

    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 for media quality enhance task.
    Note: This field may return null, indicating that no valid value can be obtained.
    Output QualityEnhanceTaskOutput Output of the media quality enhance task.
    Note: This field may return null, indicating that no valid value can be obtained.
    MetaData MediaMetaData Media quality enhance outputs meta-information of the video.
    Note: This field may return null, indicating that no valid value can be obtained.
    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 Abnormal segment start offset time, unit: seconds.
    EndTimeOffset Float Abnormal segment termination's offset time, unit: seconds.
    AreaCoordSet Array of Integer Detect abnormality in the area coordinates. The array contains 4 elements [x1, y1, x2, y2], which indicate the horizontal and vertical coordinates of the upper left and lower right points of the area in sequence. Pay attention to: The value of this field is valid only when Type is one of the following:
  • BlackWhiteEdge: black and white edge;
  • Mosaic: mosaic;
  • QRCode: QR code;
  • AppletCode: Mini Program code;
  • BarCode: bar code.
  • Confidence Integer Confidence threshold, range: [0, 100]. Pay attention to: This field is valid only when Type has one of the following values:
  • Mosaic: Mosaic;
  • QRCode: QR code;
  • AppletCode: Mini Program code;
  • BarCode: Bar code.
  • QualityInspectResultItem

    Abnormal result Information of media quality inspection.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String Abnormal type, range:
  • Jitter: Jitter;
  • Blur: Blur;
  • LowLighting: Low lighting;
  • HighLighting: Overexposure;
  • CrashScreen: Crash screen;
  • BlackWhiteEdge: Black and white edges;
  • SolidColorScreen: Solid color screen;
  • Noise: Noise;
  • Mosaic: Mosaic;
  • QRCode: QR code;
  • AppletCode: Applet code;
  • BarCode: Bar code;
  • LowVoice: Low voice;
  • HighVoice: High voice;
  • NoVoice: mutes;
  • LowEvaluation: No reference scoring below the threshold.
  • SegmentSet Array of QualityInspectItem Abnormal segment List. Pay attention to: This list will only show the first 100 elements at most. If you wish to get the complete result, please get it from the file corresponding to SegmentSetFileUrl.
    SegmentSetFileUrl String Abnormal segment List file URL. The file content is JSON, and the data structure is consistent with the SegmentSet Field. (The file will not be permanently stored, and will be deleted after reaching the SegmentSetFileUrlExpireTime Time point).
    SegmentSetFileUrlExpireTime String Abnormal segment List file URL expiration time, using ISO date supported.

    QualityInspectTask

    Media quality inspection task information.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String Media quality inspection task ID.
    Status String Task status, value:
  • PROCESSING: processing;
  • FINISH: Completed.
  • ErrCodeExt String Error code, an empty string indicates success, other values indicate failure. Please refer to the Video Processing Error Code list for values.
    Message String Error information.
    MetaData MediaMetaData Media quality inspection input metadata of audio and video.
    Input QualityInspectTaskInput Media quality inspection task input.
    Output QualityInspectTaskOutput Media quality inspection task generates.
    SessionId String Used for deduplication, if there has been a request with the same recognition code within seven days, this request will return an error. Maximum length of 50 characters, without or with an empty string indicates no deduplication.
    SessionContext String Source context, used for transparent transmission of user request information. Upon completion of media quality inspection, the callback will return the value of this field, with a maximum length of 1000 characters.

    QualityInspectTaskInput

    Input of media quality inspection task.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String Media file ID.
    Definition Integer Media quality inspect template ID.

    QualityInspectTaskOutput

    Media quality inspection task generates.

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    NoAudio Integer Whether the media files have no audio track, range:
  • 0: No, that is, there is an audio track;
  • 1: Yes, that is, there is no audio track.
  • NoVideo Integer Whether the media files have no video track, range:
  • 0: No, that is, there is a video track;
  • 1: Yes, that is, there is no video track.
  • QualityEvaluationScore Integer Quality score, value range: [0, 100].
    QualityInspectResultSet Array of QualityInspectResultItem Abnormal items list detected of media quality inspection task

    QualityInspectTemplateItem

    Media quality inspection template details.

    Used by actions: DescribeQualityInspectTemplates.

    Name Type Description
    Definition Integer Media quality inspection template ID.
    Type String Template Type, available options:
  • Preset: Preset Template;
  • Custom: User Custom Template.
  • Name String Media quality inspection template name.
    Comment String Template description.
    ScreenshotInterval Float Frame interval, unit in seconds.
    JitterConfigure JitterConfigureInfo Control parameters for detecting video jitter and ghosting.
    BlurConfigure BlurConfigureInfo Control parameters for detecting video blur.
    AbnormalLightingConfigure AbnormalLightingConfigureInfo Control parameters for detecting low brightness and overexposure of video.
    CrashScreenConfigure CrashScreenConfigureInfo Control parameters for detecting video crash.
    BlackWhiteEdgeConfigure BlackWhiteEdgeConfigureInfo Control parameters for detecting video black edges, white edges, black screen, and white screen.
    NoiseConfigure NoiseConfigureInfo Control parameters for detecting video noise.
    MosaicConfigure MosaicConfigureInfo Control parameters for detecting video mosaic.
    QRCodeConfigure QRCodeConfigureInfo Control parameters for QR code detection in video.
    QualityEvaluationConfigure QualityEvaluationConfigureInfo Control parameters for video quality evaluation.
    VoiceConfigure VoiceConfigureInfo Control parameters for audio (mutes, bass, blast sound).
    CreateTime String Template Creation Time, using ISO date format.
    UpdateTime String Template Modification time, using 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 The noise removal parameters.
    Note: This field may return null, indicating that no valid values can be obtained.

    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 The audio bitrate, in Kbps. Value range: 0 and 26-256.
    If the value is 0, the original audio bitrate will be used.
    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 The video bitrate (Kbps). Value range: 0 and 128-35000.
    If the value is 0, the original video bitrate will be used.
    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 The input parameters of the audio/video remastering task.
    Note: This field may return null, indicating that no valid values can be obtained.
    Output RebuildMediaTaskOutput The output parameters of the audio/video remastering task.
    Note: This field may return null, indicating that no valid values can be obtained.
    MetaData MediaMetaData The metadata of the output file.
    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.

    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 The ID of the remaster template.
    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 The video remaster parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    RebuildAudioInfo RebuildAudioInfo The audio remaster parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    TargetVideoInfo RebuildMediaTargetVideoStream The output video parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    TargetAudioInfo RebuildMediaTargetAudioStream The output audio parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 The result of a transcoding task. This parameter is valid if Type is Transcode.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingTask ReduceMediaBitrateAdaptiveDynamicStreamingResult The result of an adaptive bitrate task. This parameter is valid if Type is AdaptiveDynamicStreaming.
    Note: This field may return null, indicating that no valid values can be obtained.

    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 The metadata of the source video.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 The output of a transcoding task.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 The list of referers (up to 20). When Status is set to Enabled, Referers cannot be empty. Enter domain names as referers.
    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 The input of a watermark removal task.
    Note: This field may return null, indicating that no valid values can be obtained.
    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: 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.
    Status Integer This field has been disused.
    Message String This field has been disused.

    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 The input of a moderation task.
    Note: This field may return null, indicating that no valid values can be obtained.
    Output ReviewAudioVideoTaskOutput The output of a moderation 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 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 The suggestion. Valid values:
  • pass
  • review
  • block
  • 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 The most likely type of the suspicious content. This parameter is valid only if Suggestion is review or block.
  • Image (people or icons in images)
  • OCR (text in images)
  • SegmentSet Array of ReviewImageSegmentItem 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.

    ReviewImageSegmentItem

    The information of an image moderation segment.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float The confidence score for the suspicious segment.
    Suggestion String The suggestion. Valid values:
  • review: The content may be non-compliant and needs to be reviewed.
  • block: The content is non-compliant and should be blocked.
  • Label String The most likely label for the suspicious content. Valid values:
  • Porn
  • Terror
  • SubLabel String The sub-label.
    Form String The type of the suspicious segment. Valid values:
  • Image (people or icons in images)
  • OCR (text in images)
  • AreaCoordSet Array of Integer The pixel coordinates of the suspicious people, icons, or text. The format is [x1, y1, x2, y2], which indicates the coordinates of the top-left and bottom-right corners.
    Text String The content of the suspicious text detected. This parameter is valid only if Form is OCR.
    KeywordSet Array of String The keywords that match the suspicious text. This parameter is valid only if Form is OCR.

    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

    The details of a moderation template.

    Used by actions: DescribeReviewTemplates.

    Name Type Description
    Definition Integer The unique ID 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.

    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.

    RoundPlayListItemInfo

    Carousel media file information

    Used by actions: CreateRoundPlay, DescribeRoundPlays, 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.
    Definition Integer No The transcoding template used to generate the transcoding output played. 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.
    Note: This field may return null, indicating that no valid value can be obtained.
    NoCache CacheConfigNoCache No Configuration is not cached.
    Note: This field may return null, indicating that no valid value can be obtained.
    FollowOrigin CacheConfigFollowOrigin No Follow the origin configuration.
    Note: This field may return null, indicating that no valid value can be obtained.

    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.

    ScratchRepairInfo

    Banding removal configuration.

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

    Name Type Required Description
    Switch String Yes Whether to enable banding removal. Valid values:
  • ON
  • 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.
  • SharpEnhanceInfo

    Detail enhancement configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, 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: 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 template name, if you want Fill in when executing the 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 template name, which should be entered if you want to perform a 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 Output information of a video splitting task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.

    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
  • SuperResolutionInfo

    Super resolution configuration.

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

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

  • If super resolution is enabled, the output resolution will double.
    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 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.
  • CycleConfig WatermarkCycleConfigForUpdate No Watermark period configuration is used to configure the watermark to be displayed and hidden periodically.
    The main usage scenario is: in order to prevent video from being blocked, watermarks are set in multiple places on the video. These watermarks are periodically displayed and hidden in a fixed order.
    For example, set four watermarks A, B, C, and D to be located in the upper left corner, upper right corner, lower right corner, and lower left corner of the video respectively. When the video starts, { A displays for 5 seconds -> B displays for 5 seconds -> C Display for 5 seconds -> D Display for 5 seconds} -> A Display for 5 seconds -> B Display for 5 seconds -> ..., only one watermark is displayed at any time.
    The curly brackets {} represent a large cycle consisting of 4 watermarks A, B, C, and D. It can be seen that each large cycle lasts 20 seconds.
    It can be seen that A, B, C, and D are periodically displayed for 5 seconds and hidden for 15 seconds, and the four have a fixed display order.
    This configuration item is used to describe the periodic configuration of a single watermark.
    Note: This field may return null, indicating that no valid value can be obtained.

    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 bitrate, which is valid when Type is TESHD.
    If this parameter is left blank or 0 is entered, there will be no upper limit for bitrate.

    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)
    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: Normal transcoding
  • Transcoding-TESHD: Extremely fast high-definition transcoding
  • Editing: Video editing

  • < li> Editing-TESHD: Extremely fast high-definition video editing
  • AdaptiveBitrateStreaming: Adaptive bitrate streaming
  • ContentAudit: Content audit
  • ContentRecognition: Content Recognize
  • RemoveWatermark: Remove watermark
  • ExtractTraceWatermark: Extract watermark
  • AddTraceWatermark: Add watermark
  • RebuildMedia : Audio and video quality reborn
  • QualityInspect: Media quality inspection
  • Transcode: transcoding, including normal transcoding, ultra-fast high-definition and video editing (not recommended)
  • Transcode: li>
  • Summary Array of TaskStatDataItem Task statistics overview (usage unit: second).
    Details Array of SpecificationDataItem The usage statistics for different task types.
    Transcoding:
  • Remuxing
  • Audio (audio transcoding)
  • Standard.H264.SD
  • Standard.H264.HD
  • Standard.H264.FHD
  • Standard.H264.2K
  • Standard.H264.4K
  • Standard.H265.SD
  • Standard.H265.HD
  • Standard.H265.FHD
  • Standard.H265.2K
  • Standard.H265.4K
  • TESHD-10.H264.SD (H.264 SD Top Speed Codec transcoding)
  • TESHD-10.H264.HD (H.264 HD Top Speed Codec transcoding)
  • TESHD-10.H264.FHD (H.264 FHD Top Speed Codec transcoding)
  • TESHD-10.H264.2K (H.264 2K Top Speed Codec transcoding)
  • TESHD-10.H264.4K (H.264 4K Top Speed Codec transcoding)
  • TESHD-10.H265.SD (H.265 SD Top Speed Codec transcoding)
  • TESHD-10.H265.HD (H.265 HD Top Speed Codec transcoding)
  • TESHD-10.H265.FHD (H.265 FHD Top Speed Codec transcoding)
  • TESHD-10.H265.2K (H.265 2K Top Speed Codec transcoding)
  • TESHD-10.H265.4K (H.265 4K Top Speed Codec transcoding)
  • Edit.Audio
  • Edit.H264.SD (H.264 SD video editing)
  • Edit.H264.HD (H.264 HD video editing)
  • Edit.H264.FHD (H.264 FHD video editing)
  • Edit.H264.2K (H.264 2K video editing)
  • Edit.H264.4K (H.264 4K video editing)
  • Edit.H265.SD (H.265 SD video editing)
  • Edit.H265.HD (H.265 HD video editing)
  • Edit.H265.FHD (H.265 FHD video editing)
  • Edit.H265.2K (H.265 2K video editing)
  • Edit.H265.4K (H.265 4K video editing)
  • Edit.TESHD-10.H264.SD (H.264 SD Top Speed Codec video editing)
  • Edit.TESHD-10.H264.HD (H.264 HD Top Speed Codec video editing)
  • Edit.TESHD-10.H264.FHD (H.264 FHD Top Speed Codec video editing)
  • Edit.TESHD-10.H264.2K (H.264 2K Top Speed Codec video editing)
  • Edit.TESHD-10.H264.4K (H.264 4K Top Speed Codec video editing)
  • Edit.TESHD-10.H265.SD (H.265 SD Top Speed Codec video editing)
  • Edit.TESHD-10.H265.HD (H.265 HD Top Speed Codec video editing)
  • Edit.TESHD-10.H265.FHD (H.265 FHD Top Speed Codec video editing)
  • Edit.TESHD-10.H265.2K (H.265 2K Top Speed Codec video editing)
  • Edit.TESHD-10.H265.4K (H.265 4K Top Speed Codec video editing)

  • The watermark removal/remaster specifications. Valid values:
  • 480P (short side ≤ 480 px)
  • 720P (short side ≤ 720 px)
  • 1080P (short side ≤ 1080 px)
  • 2K (short side ≤ 1440 px)
  • 4K (short side ≤ 2160 px)
  • 8K (short side ≤ 4320 px)
  • audio
  • TaskStatDataItem

    Task statistics, including number of tasks and usage.

    Used by actions: 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 Parameters for recognition of terrorism content in images
    Note: This field may return null, indicating that no valid value can be found.
    OcrReviewInfo TerrorismOcrReviewTemplateInfo No Parameters for OCR-based recognition of terrorism content
    Note: This field may return null, indicating that no valid value can be found.

    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

    TerrorismImageResult

    The moderation result for terrorist content in an image.

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float The confidence score for the moderation result. Value range: 0-100.
    Suggestion String The suggestion for handling the detected terrorist content. Valid values:
  • pass/li>
  • review
  • block
  • Label String The label for the detected terrorist content. Valid values:
  • guns
  • crowd
  • police
  • bloody
  • banners
  • explosion
  • scenario (terrorist scenes)
  • 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: 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
  • Definition Integer No This parameter has been deprecated.

    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 List of up to 10 image or text watermarks.
    Note: this field may return null, indicating that no valid values can be obtained.
    TraceWatermark TraceWatermarkInput No Digital watermark.
    CopyRightWatermark CopyRightWatermarkInput No Copyright watermark.
    MosaicSet Array of MosaicInput No List of blurs. Up to 10 ones can be supported.
    HeadTailSet Array of HeadTailTaskInput No List of video opening/closing credits configuration template IDs. You can enter up to 10 IDs.
    StartTimeOffset Float No Start time offset of a transcoded video, 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 No End time offset of a transcoded video, 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.
  • TranscodeTemplate

    Transcoding template details

    Used by actions: DescribeTranscodeTemplates.

    Name Type Description
    Definition String Unique ID of transcoding template.
    Container String Container. Valid values: mp4, flv, hls, mp3, flac, ogg.
    Name String Transcoding template name.
    Note: this field may return null, indicating that no valid values can be obtained.
    Comment String Template description.
    Note: this field may return null, indicating that no valid values can be obtained.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
  • RemoveVideo Integer Whether to remove video data. Valid values:
  • 0: retain;
  • 1: remove.
  • RemoveAudio Integer Whether to remove audio data. Valid values:
  • 0: retain;
  • 1: remove.
  • VideoTemplate VideoTemplateInfo Video stream configuration parameter. This field is valid only when RemoveVideo is 0.
    Note: this field may return null, indicating that no valid values can be obtained.
    AudioTemplate AudioTemplateInfo Audio stream configuration parameter. This field is valid only when RemoveAudio is 0.
    Note: this field may return null, indicating that no valid values can be obtained.
    TEHDConfig TEHDConfig TESHD transcoding parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    ContainerType String Container filter. Valid values:
  • Video: video container that can contain both video stream and audio stream;
  • PureAudio: audio container that can contain only audio stream.
  • CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    SegmentType String The segment type. This parameter is valid only if Container is hls

    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 Parameters for custom facial recognition
    Note: This field may return null, indicating that no valid value can be found.
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo No Parameters for custom ASR-based recognition
    Note: This field may return null, indicating that no valid value can be found.
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo No Parameters for custom OCR-based recognition
    Note: This field may return null, indicating that no valid value can be found.

    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 The bit rate of the video stream, value range: 0 and [128, 10000], unit: kbps.
    When the value is 0, it means that the video bitrate remains the same as the original video.

    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 The bit rate of the video stream, value range: 0 and [128, 10000], unit: kbps.
    When the value is 0, it means that the video bitrate remains the same as the original video.

    VideoDenoiseInfo

    Image noise removal configuration.

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, 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.

    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 The video codec. Valid values:
  • libx264: H.264
  • libx265: H.265
  • av1: AOMedia Video 1
  • H.266: H.266

  • Notes:
  • The AOMedia Video 1 and H.266 codecs can only be used for MP4 files.
  • Only CRF is supported for H.266 currently.
  • Fps Integer Yes Video frame rate in Hz. Value range: [0,100].
    If the value is 0, the frame rate will be the same as that of the source video.
    Bitrate Integer Yes Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
    If the value is 0, the bitrate of the video will be the same as that of the source video.
    ResolutionAdaptive String No 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.
    Note: this field may return null, indicating that no valid values can be obtained.
    Width Integer No The maximum video width (or long side) in pixels. Value range: 0 and [128, 8192].
  • If both Width and Height are 0, the output resolution will be the same as that of the source video.
  • 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 height (or short side) in pixels. Value range: 0 and [128, 8192].
  • If both Width and Height are 0, the output resolution will be the same as that of the source video.
  • 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 Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
  • stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: fills the uncovered area with black color, without changing the image's aspect ratio.
  • white: fills the uncovered area with white color, without changing the image's aspect ratio.
  • gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.

  • Default value: black
    Vcrf Integer No The video constant rate factor (CRF). Value range: 1-51.

    Notes:
  • If this parameter is specified, CRF encoding will be used and the bitrate parameter will be ignored.
  • If Codec is H.266, this parameter is required (28 is recommended).
  • We don’t recommend using this parameter unless you have special requirements.
  • Gop Integer No I-frame interval in frames. Valid values: 0 and 1-100000.
    When this parameter is set to 0 or left empty, Gop will be automatically set.
    PreserveHDRSwitch String No Whether to output an HDR (high dynamic range) video if the source video is HDR. Valid values:
  • ON: If the source video is HDR, output an HDR video; if not, output an SDR (standard dynamic range) video.
  • OFF: Output an SDR video regardless of whether the source video is HDR.

  • Default value: OFF.
    CodecTag String No The codec tag. This parameter is valid only if the H.265 codec is used. Valid values:
  • hvc1
  • hev1

  • Default value: hvc1.

    VideoTemplateInfoForUpdate

    Video stream configuration parameter

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    Codec String No The video codec. Valid values:
  • libx264: H.264
  • libx265: H.265
  • av1: AOMedia Video 1
  • H.266: H.266

  • Notes:
  • The AOMedia Video 1 and H.266 codecs can only be used for MP4 files.
  • Only CRF is supported for H.266 currently.
  • Fps Integer No Video frame rate in Hz. Value range: [0,100].
    If the value is 0, the frame rate will be the same as that of the source video.
    Bitrate Integer No Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
    If the value is 0, the bitrate of the video will be the same as that of the source video.
    ResolutionAdaptive String No 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.
  • Width Integer No The maximum video width (or long side) in pixels. Value range: 0 and [128, 8192].
  • If both Width and Height are 0, the output resolution will be the same as that of the source video.
  • 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.
  • Height Integer No The maximum video height (or short side) in pixels. Value range: 0 and [128, 8192].
    FillType String No Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. Valid values:
  • stretch: stretches video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: fills the uncovered area with black color, without changing the image's aspect ratio.
  • white: fills the uncovered area with white color, without changing the image's aspect ratio.
  • gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
  • Vcrf Integer No The video constant rate factor (CRF). Value range: 1-51. 0 means to disable this parameter.

    Notes:
  • If this parameter is specified, CRF encoding will be used and the bitrate parameter will be ignored.
  • If Codec is H.266, this parameter is required (28 is recommended).
  • We don’t recommend using this parameter unless you have special requirements.
  • Gop Integer No I-frame interval in frames. Valid values: 0 and 1-100000.
    When this parameter is set to 0 or left empty, Gop will be automatically set.
    PreserveHDRSwitch String No Whether to output an HDR (high dynamic range) video if the source video is HDR. Valid values:
  • ON: If the source video is HDR, output an HDR video; if not, output an SDR (standard dynamic range) video.
  • OFF: Output an SDR video regardless of whether the source video is HDR.
  • CodecTag String No The codec tag. This parameter is valid only if the H.265 codec is used. Valid values:
  • hvc1
  • hev1

  • Default value: hvc1.

    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.

    WatermarkCycleConfigForUpdate

    Watermark cycle configuration.

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    StartTime Float No Playback time point in seconds when a watermark appears in a video for the first time.
    DisplayDuration Float No Display duration of a watermark in a watermark cycle in seconds.
    CycleDuration Float No Duration of a watermark cycle in seconds.
    If 0 is entered, a watermark will last for only one cycle (i.e., visible for DisplayDuration seconds throughout the video).

    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.

    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support