Data Types

Last updated: 2020-03-27 18:45:46

    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.

    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 Container format. Valid values: hls, dash.
    DrmType String Yes Encryption type.
    Url String Yes Playback address.

    AdaptiveDynamicStreamingTaskInput

    Input parameter type of adaptive bitrate streaming

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、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.

    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.
    PackageType String Container type. Valid values:
  • hls;
  • dash.
  • DrmType String DRM type. Valid values:
  • FairPlay;
  • SimpleAES;
  • Widevine.

  • If this field is a blank string, DRM will not be performed on the video.
    VideoTrackTemplateSet Array of VideoTrackTemplateInfo List of video track templates.
    AudioTrackTemplateSet Array of AudioTrackTemplateInfo List of audio track templates.
    Format String Adaptive bitstream format. Valid value:
  • HLS.
  • 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.

    AdaptiveStreamTemplate

    Adaptive bitrate streaming parameter template

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

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

    AiAnalysisTaskClassificationResult

    Result type of intelligent categorization task

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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 covers.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    AiAnalysisTaskTagResult

    Result type of intelligent tagging task

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    AiContentReviewResult

    Content audit result

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Type String Task type. Valid values:
  • Porn: porn information detection in image
  • Terrorism: terrorism information detection in image
  • Political: politically sensitive information detection in image
  • Porn.Asr: ASR-based porn information detection in speech
  • Porn.Ocr: OCR-based porn information detection in text
  • Political.Asr: ASR-based politically sensitive information detection in speech
  • Political.Ocr: OCR-based politically sensitive information detection in text
  • Terrorism.Ocr: OCR-based terrorism information in text
  • Prohibited.Asr: ASR-based prohibited information detection in speech
  • Prohibited.Ocr: OCR-based prohibited information detection in text
  • PornTask AiReviewTaskPornResult Query result of intelligent porn information detection in video image task in video content audit, which is valid when task type is Porn.
    Note: this field may return null, indicating that no valid values can be obtained.
    TerrorismTask AiReviewTaskTerrorismResult Query result of intelligent terrorism information detection in video image task in video content audit, which is valid when task type is Terrorism.
    Note: this field may return null, indicating that no valid values can be obtained.
    PoliticalTask AiReviewTaskPoliticalResult Query result of intelligent politically sensitive information detection in video image task in video content audit, which is valid when task type is Political.
    Note: this field may return null, indicating that no valid values can be obtained.
    PornAsrTask AiReviewTaskPornAsrResult Query result of ASR-based porn information detection in speech task in video content audit, which is valid when task type is Porn.Asr.
    Note: this field may return null, indicating that no valid values can be obtained.
    PornOcrTask AiReviewTaskPornOcrResult Query result of OCR-based porn information detection in text task in video content audit, which is valid when task type is Porn.Ocr.
    Note: this field may return null, indicating that no valid values can be obtained.
    PoliticalAsrTask AiReviewTaskPoliticalAsrResult Query result of ASR-based politically sensitive information detection in speech task in video content audit, which is valid when task type is Political.Asr.
    Note: this field may return null, indicating that no valid values can be obtained.
    PoliticalOcrTask AiReviewTaskPoliticalOcrResult Query result of OCR-based politically sensitive information detection in text task in video content audit, which is valid when task type is Political.Ocr.
    Note: this field may return null, indicating that no valid values can be obtained.
    TerrorismOcrTask AiReviewTaskTerrorismOcrResult Query result of OCR-based terrorism information detection in text task in video content audit, which is valid when task type is Terrorism.Ocr.
    Note: this field may return null, indicating that no valid values can be obtained.
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult Query result of ASR-based prohibited information detection in speech task in video content audit, which is valid when task type is Prohibited.Asr.
    Note: this field may return null, indicating that no valid values can be obtained.
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult Query result of OCR-based prohibited information detection in text task in video content audit, which is valid when task type is Prohibited.Ocr.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiContentReviewTaskInput

    Task type of intelligent content audit

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

    Name Type Required Description
    Definition Integer Yes Video content audit 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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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 speech recognition segments.
    SubtitleUrl String Subtitles file URL.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.
    SegmentSet Array of AiRecognitionTaskObjectSeqmentItem List of segments that contain an object.

    AiRecognitionTaskObjectResultOutput

    Output of intelligent object recognition.

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    ResultSet Array of AiRecognitionTaskObjectResultItem Result set of intelligent object recognition.

    AiRecognitionTaskObjectSeqmentItem

    Object 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.

    AiRecognitionTaskOcrFullTextResult

    Full text recognition result.

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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.
    ErrCode Integer Error code. 0: success; other values: failure.
    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.

    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.

    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 parameter type of ASR-based politically sensitive information detection in speech task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Politically sensitive information detection template ID.

    AiReviewPoliticalAsrTaskOutput

    ASR-detected politically sensitive information in speech

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Confidence Float Score of ASR-detected politically sensitive information in speech between 0 and 100.
    Suggestion String Suggestion for ASR-detected politically sensitive information in speech. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSet Array of MediaContentReviewAsrTextSegmentItem List of video segments that contain ASR-detected politically sensitive information in speech.

    AiReviewPoliticalOcrTaskInput

    Input parameter type of OCR-based politically sensitive information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Politically sensitive information detection template ID.

    AiReviewPoliticalOcrTaskOutput

    OCR-detected politically sensitive information in text

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Confidence Float Score of OCR-detected politically sensitive information in text between 0 and 100.
    Suggestion String Suggestion for OCR-detected politically sensitive information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected politically sensitive information in text.

    AiReviewPoliticalTaskInput

    Input parameter type of politically sensitive information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Politically sensitive information detection template ID.

    AiReviewPoliticalTaskOutput

    Politically sensitive information

    Used by actions: DescribeTaskDetail、PullEvents.

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

  • Note: this field may return null, indicating that no valid values can be obtained.
    Label String Tag of detected politically sensitive information in video. Valid values:
  • politician: politically sensitive figure.
  • violation_photo: violating photo.

  • Note: this field may return null, indicating that no valid values can be obtained.
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem List of video segments that contain the detected politically sensitive information.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewPornAsrTaskInput

    Input parameter type of ASR-based porn information detection in speech task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Porn information detection template ID.

    AiReviewPornAsrTaskOutput

    ASR-detected porn information in speech

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Confidence Float Score of ASR-detected porn information in speech between 0 and 100.
    Suggestion String Suggestion for ASR-detected porn information in speech. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSet Array of MediaContentReviewAsrTextSegmentItem List of video segments that contain the ASR-detected porn information in speech.

    AiReviewPornOcrTaskInput

    Input parameter type of OCR-based porn information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Porn information detection template ID.

    AiReviewPornOcrTaskOutput

    OCR-detected porn information in text

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Confidence Float Score of OCR-detected porn information in text between 0 and 100.
    Suggestion String Suggestion for OCR-detected porn information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain the OCR-detected porn information in text.

    AiReviewPornTaskInput

    Input parameter type of porn information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Required Description
    Definition Integer Yes Porn information detection template ID.

    AiReviewPornTaskOutput

    Result information of porn information detection

    Used by actions: DescribeTaskDetail、PullEvents.

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

  • Note: this field may return null, indicating that no valid values can be obtained.
    Label String Tag of detected porn information in video. Valid values:
  • porn: porn.
  • sexy: sexiness.
  • vulgar: vulgarity.
  • intimacy: intimacy.

  • Note: this field may return null, indicating that no valid values can be obtained.
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain the detected porn information.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewProhibitedAsrTaskInput

    Input parameter type of ASR-based prohibited information detection in speech task in content audit

    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 the ASR-detected prohibited information in speech.

    AiReviewProhibitedOcrTaskInput

    Input parameter type of OCR-based prohibited information detection in text task in content audit

    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 the OCR-detected prohibited information in text.

    AiReviewTaskPoliticalAsrResult

    Result type of ASR-based politically sensitive information detection in speech task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalAsrTaskInput Input of ASR-based politically sensitive information detection in speech task in content audit.
    Output AiReviewPoliticalAsrTaskOutput Output of ASR-based politically sensitive information detection in speech task in content audit.

    AiReviewTaskPoliticalOcrResult

    Result type of OCR-based politically sensitive information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalOcrTaskInput Input of OCR-based politically sensitive information detection in text task in content audit.
    Output AiReviewPoliticalOcrTaskOutput Output of OCR-based politically sensitive information detection in text task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPoliticalResult

    Result type of politically sensitive information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPoliticalTaskInput Input of politically sensitive information detection task in content audit.
    Output AiReviewPoliticalTaskOutput Output of politically sensitive information detection task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornAsrResult

    Result type of ASR-based porn information detection in speech task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornAsrTaskInput Input of ASR-based porn information detection in speech task in content audit.
    Output AiReviewPornAsrTaskOutput Output of ASR-based porn information detection in speech task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornOcrResult

    Result type of OCR-based porn information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornOcrTaskInput Input of OCR-based porn information detection in text task in content audit.
    Output AiReviewPornOcrTaskOutput Output of OCR-based porn information detection in text task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornResult

    Result type of porn information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewPornTaskInput Input of porn information detection task in content audit.
    Output AiReviewPornTaskOutput Output of porn information detection task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskProhibitedAsrResult

    Result type of ASR-based prohibited information detection in speech task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Input AiReviewProhibitedAsrTaskInput Input of ASR-based prohibited information detection in speech task in content audit
    Output AiReviewProhibitedAsrTaskOutput Output of ASR-based prohibited information detection in speech task in content audit
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskProhibitedOcrResult

    Result type of OCR-based prohibited information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Input AiReviewProhibitedOcrTaskInput Input of OCR-based prohibited information detection in text task in content audit
    Output AiReviewProhibitedOcrTaskOutput Output of OCR-based prohibited information detection in text task in content audit
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskTerrorismOcrResult

    Result type of OCR-based terrorism information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Input AiReviewTerrorismOcrTaskInput Input of OCR-based terrorism information detection in text task in content audit.
    Output AiReviewTerrorismOcrTaskOutput Output of OCR-based terrorism information detection in text task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTaskTerrorismResult

    Result type of terrorism information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    Input AiReviewTerrorismTaskInput Input of terrorism information detection task in content audit.
    Output AiReviewTerrorismTaskOutput Output of terrorism information detection task in content audit.
    Note: this field may return null, indicating that no valid values can be obtained.

    AiReviewTerrorismOcrTaskInput

    Input parameter type of OCR-based terrorism information detection in text task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Terrorism information detection template ID.

    AiReviewTerrorismOcrTaskOutput

    OCR-detected terrorism information in text

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Confidence Float Score of OCR-detected terrorism information in text between 0 and 100.
    Suggestion String Suggestion for OCR-detected terrorism information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments that contain OCR-detected terrorism information in text.

    AiReviewTerrorismTaskInput

    Input parameter type of terrorism information detection task in content audit

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Definition Integer Terrorism information detection template ID.

    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 detected terrorism information in a video. Valid values:
  • guns: weapons and guns.
  • crowd: crowd.
  • police: police force.
  • bloody: bloody scenes.
  • banners: terrorism flags.
  • militant: militants.
  • explosion: explosions and fires.
  • terrorists: terrorists.

  • Note: this field may return null, indicating that no valid values can be obtained.
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain the detected terrorism information.
    Note: this field may return null, indicating that no valid values can be obtained.

    AnimatedGraphicTaskInput

    Animated image generating task type

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、DescribeTaskDetail、ProcessMedia、PullEvents、ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Animated image generating template ID
    StartTimeOffset Float Yes Start time of animated image in video in seconds.
    EndTimeOffset Float Yes End time of animated image in video in seconds.

    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.

    AsrFullTextConfigureInfo

    Control parameter of full speech recognition task.

    Used by actions: 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.
  • SubtitleFormat String No Format of generated subtitles file. If this parameter is left empty or a blank string is entered, no subtitles files will be generated. Valid value:
  • vtt: generates a WebVTT subtitles file.
  • AsrWordsConfigureInfo

    Speech keyword recognition control parameter.

    Used by actions: 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.

    AudioTemplateInfo

    Audio stream configuration parameter

    Used by actions: CreateTranscodeTemplate、DescribeAdaptiveDynamicStreamingTemplates、DescribeTranscodeTemplates.

    Name Type Required Description
    Codec String Yes Audio stream encoder.
    When the outer Container parameter is mp3, the valid value is:
  • libmp3lame.

  • When the outer Container parameter is ogg or flac, the valid value is:
  • flac.

  • When the outer Container parameter is m4a, the valid values include:
  • libfdk_aac;
  • libmp3lame;
  • ac3.

  • When the outer Container parameter is mp4 or flv, the valid values include:
  • libfdk_aac: more suitable for mp4;
  • libmp3lame: More suitable for flv;
  • mp2.

  • When the outer Container parameter is hls, the valid values include:
  • libfdk_aac;
  • libmp3lame.
  • 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 Audio stream sample rate. Valid values:
  • 32,000
  • 44,100
  • 48,000

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

  • Default value: 2.

    AudioTemplateInfoForUpdate

    Audio stream configuration parameter

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    Codec String No Audio stream encoder.
    When the outer Container parameter is mp3, the valid value is:
  • libmp3lame.

  • When the outer Container parameter is ogg or flac, the valid value is:
  • flac.

  • When the outer Container parameter is m4a, the valid values include:
  • libfdk_aac;
  • libmp3lame;
  • ac3.

  • When the outer Container parameter is mp4 or flv, the valid values include:
  • libfdk_aac: more suitable for mp4;
  • libmp3lame: More suitable for flv;
  • mp2.

  • When the outer Container parameter is hls, the valid values include:
  • libfdk_aac;
  • libmp3lame.
  • 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 Audio stream sample rate. Valid values:
  • 32,000
  • 44,100
  • 48,000

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

    Audio segment information of audio track.

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    Name Type Required Description
    SourceMedia String Yes Source of media file for audio material, which can be an ID of a VOD file or URL of another file.
    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.
    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.

    AudioTrackTemplateInfo

    Information of a transcoding to adaptive bitrate streaming audio track template.

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates、DescribeAudioTrackTemplates.

    Name Type Required Description
    Definition Integer Yes Unique ID of a template.
    Codec String Yes Audio track encoder.
    When Container is mp3, the valid value is:
  • libmp3lame.

  • When Container is ogg or flac, the valid value is:
  • flac.

  • When Container is m4a, the valid values include:
  • libfdk_aac;
  • libmp3lame;
  • ac3.

  • When the video track's Container is mp4 or flv, the valid values include:
  • libfdk_aac: more suitable for mp4;
  • libmp3lame: more suitable for flv;
  • mp2.

  • When the video track's Container is hls, the valid values include:
  • libfdk_aac;
  • libmp3lame.
  • 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 Audio stream sample rate. Valid values:
  • 32,000
  • 44,100
  • 48,000

  • In Hz.
    Type String No Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
  • Name String No Template name. Length limit: 64 characters.
    Comment String No Template description. Length limit: 256 characters.
    AudioChannel Integer No Audio channel system. Valid values:
  • 1: Mono
  • 2: Dual
  • 6: Stereo

  • Default value: 2.
    CreateTime String No Creation time of template in ISO date format.
    UpdateTime String No Last modified time of template in ISO date format.

    AudioTransform

    Audio operation

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    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、DescribeTaskDetail、PullEvents.

    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.

    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, which is the width of the output video. Value range: 0–4096 px.
    Default value: 0, which means that the value is the same as the video width of the first video segment in the first video track.
    Height Integer No Canvas height, which is the height (or long side) of the output video. Value range: 0–4096 px.
    Default value: 0, which means that the value is the same as the video height of the first video segment in the first video track.

    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

    Video clipping task information. This structure is only used for tasks initiated by the ClipVideo API in v2017.

    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.

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

    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

    Video splicing task information. This structure is only used for tasks initiated by the ConcatVideo API in v2017.

    Used by actions: DescribeTaskDetail、PullEvents.

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

    ContentReviewTemplateItem

    Content audit template details

    Used by actions: DescribeContentReviewTemplates.

    Name Type Description
    Definition Integer Unique ID of content audit template.
    Name String Content audit template name. Length limit: 64 characters.
    Comment String Content audit template description. Length limit: 256 characters.
    PornConfigure PornConfigureInfo Porn information detection control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    TerrorismConfigure TerrorismConfigureInfo Terrorism information detection control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    PoliticalConfigure PoliticalConfigureInfo Politically sensitive information detection control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    ProhibitedConfigure ProhibitedConfigureInfo Control parameter of prohibited information detection. Prohibited information includes:
  • Abusive;
  • Drug-related.

  • Note: this parameter is not supported yet.
    Note: this field may return null, indicating that no valid values can be obtained.
    UserDefineConfigure UserDefineConfigureInfo Custom content audit control parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    ReviewWallSwitch String Switch controlling whether to add audit result to review list (for human review).
  • ON: yes;
  • OFF: no.
  • 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.

    CoverBySnapshotTaskInput

    Input parameter type of cover generating task

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、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.
  • CreateImageSpriteTask2017

    Image sprite generating task. This structure is only used for tasks initiated by the CreateImageSprite API in v2017.

    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.

    EditMediaFileInfo

    VOD video file editing information

    Used by actions: DescribeTaskDetail、EditMedia、PullEvents.

    Name Type Required Description
    FileId String Yes Video ID.
    StartTimeOffset Float No Start time offset of video clipping in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTimeOffset Float No End time offset of video clipping in seconds.
    Note: this field may return null, indicating that no valid values can be obtained.

    EditMediaOutputConfig

    Result file output of video editing.

    Used by actions: EditMedia.

    Name Type Required Description
    MediaName String No Output filename of up to 64 characters, which is generated by the system by default.
    Type String No Output file format. Valid values: mp4, hls. Default value: mp4.
    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.

    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.

    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.
    Message String Error message.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.
    ProcedureTaskId String If a video processing flow is specified when a video editing task is initiated, this field will be the ID of the task flow.
    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.

    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.

    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、DescribeTaskDetail、PullEvents.

    Name Type Required Description
    Duration Float Yes Duration in seconds.

    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 type:
  • NewFileUpload: video upload completion;
  • ProcedureStateChanged: task flow status change;
  • FileDeleted: video deletion completion;
  • PullComplete: video pull for upload completion;
  • EditMediaComplete: video editing completion;
  • WechatPublishComplete: release on WeChat completion;
  • ComposeMediaComplete: media file composing completion;
  • WechatMiniProgramPublishComplete: release on WeChat Mini Program completion.

  • Event types compatible with v2017:
  • TranscodeComplete: video transcoding completion;
  • ConcatComplete: video splicing completion;
  • ClipComplete: video clipping completion;
  • CreateImageSpriteComplete: image sprite generating completion;
  • CreateSnapshotByTimeOffsetComplete: time point screencapturing completion.
  • FileUploadEvent FileUploadTask Video upload completion event, which is valid if the event type is NewFileUpload.
    Note: this field may return null, indicating that no valid values can be obtained.
    ProcedureStateChangeEvent ProcedureTask Task flow status change event, which is valid if the event type is ProcedureStateChanged.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileDeleteEvent FileDeleteTask File deletion event, which is valid if the event type is FileDeleted.
    Note: this field may return null, indicating that no valid values can be obtained.
    PullCompleteEvent PullUploadTask Video pull for upload completion event, which is valid if the event type is PullComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    EditMediaCompleteEvent EditMediaTask Video editing completion event, which is valid if the event type is EditMediaComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    WechatPublishCompleteEvent WechatPublishTask Release on WeChat completion event, which is valid if the event type is WechatPublishComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    TranscodeCompleteEvent TranscodeTask2017 Video transcoding completion event, which is valid if the event type is TranscodeComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    ConcatCompleteEvent ConcatTask2017 Video splicing completion event, which is valid if the event type is ConcatComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    ClipCompleteEvent ClipTask2017 Video clipping completion event, which is valid if the event type is ClipComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017 Image sprite generating completion event, which is valid if the event type is CreateImageSpriteComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017 Time point screencapturing completion event, which is valid when the event type is CreateSnapshotByTimeOffsetComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    ComposeMediaCompleteEvent ComposeMediaTask Media file composing task completion event, which is valid when the event type is ComposeMediaComplete.
    Note: this field may return null, indicating that no valid values can be obtained.
    WechatMiniProgramPublishCompleteEvent WechatMiniProgramPublishTask Release on WeChat Mini Program task completion event, which is valid if the event type is WechatMiniProgramPublishComplete.
    Note: this field may return null, indicating that no valid values can be obtained.

    FaceConfigureInfo

    Control parameter of face recognition task

    Used by actions: 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 figure filter tag, which specifies the default figure tag that needs to be returned. If this parameter is left empty or a blank value is entered, all results of the default figures will be returned. Valid values:
  • entertainment: entertainment celebrity;
  • sport: sports celebrity;
  • politician: politically sensitive figure.
  • UserDefineLibraryLabelSet Array of String No Custom figure filter tag, which specifies the custom figure tag that needs to be returned. If this parameter is left empty or a blank value is entered, all results of the custom figures will be returned. Valid values:
    There can be up to 10 tags, each with a length limit of 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.)

    FileDeleteTask

    File deleting task

    Used by actions: PullEvents.

    Name Type Description
    FileIdSet Array of String List of IDs of deleted files.

    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 If a video processing flow is specified when a video is uploaded, this field will be the ID of the task flow.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.

    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.

    HeadTailConfigureInfo

    Control parameter of video opening and ending credits recognition task.

    Used by actions: 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.
  • 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.
  • ImageSpriteTaskInput

    Input parameter type of image sprite generating task

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、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.

    ImageTransform

    Operation such as image rotation and flipping

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    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 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 px; for example, 100px means that Width is 100 px.

  • 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 Width of the watermark will be in px; for example, 100px means that Width is 100 px.

  • Default value: 0 px, which means that Height will be proportionally scaled according to the aspect ratio of the original watermark image.

    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 px; for example, 100px means that Width is 100 px.
  • 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 Width of the watermark will be in px; for example, 100px means that Width is 100 px.

  • 0px means that Height will be proportionally scaled according to the video width.

    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 Width of the watermark will be in px; for example, 100px means that Width is 100 px;

  • 0px means that Height will be proportionally scaled according to the video width.

    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.
    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、DescribeTaskDetail、LiveRealTimeClip、PullEvents、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 Storage region of media file, such as ap-guangzhou. For more information, please see Region List.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 LVB recording file
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaContentReviewAsrTextSegmentItem

    Suspected segment identified during ASR-based speech audit in content audit

    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 Suggestion for suspected segment audit. Valid values:
  • pass.
  • review.
  • block.

  • Note: this field may return null, indicating that no valid values can be obtained.
    KeywordSet Array of String List of suspected keywords.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaContentReviewOcrTextSegmentItem

    Suspected segment identified during OCR-based text audit in content audit

    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 Suggestion for suspected segment audit. Valid values:
  • pass.
  • review.
  • block.

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

    Suspected politically sensitive segment identified in content audit

    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 Score of a suspected politically sensitive segment.
    Suggestion String Suggestion for politically sensitive information detection of a suspected segment. Valid values:
  • pass.
  • review.
  • block.
  • Name String Name of a politically sensitive figure or violating photo.
    Label String Tag of politically sensitive information detection result of a suspected segment.
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    AreaCoordSet Array of Integer Zone coordinates (at the pixel level) of a politically sensitive figure or violating photo: [x1, y1, x2, y2], i.e., 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

    Suspected porn/terrorism segment identified in content audit

    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 Score of a suspected porn segment.
    Label String Tag of porn information detection result of a suspected segment.
    Suggestion String Suggestion for porn information detection of a suspected segment. 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.

    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.
    MiniProgramReviewInfo MediaMiniProgramReviewInfo WeChat Mini Program audit information.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileId String Unique ID of media file.

    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、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.

    MediaMiniProgramReviewElem

    Summary metadata of WeChat Mini Program audit.

    Used by actions: DescribeMediaInfos、SearchMedia.

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

    MediaMiniProgramReviewInfo

    WeChat Mini Program audit information

    Used by actions: DescribeMediaInfos、SearchMedia.

    Name Type Description
    MiniProgramReviewList Array of MediaMiniProgramReviewInfoItem Audit information list.

    MediaMiniProgramReviewInfoItem

    WeChat Mini Program audit information unit

    Used by actions: DescribeMediaInfos、SearchMedia.

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

    MediaOutputInfo

    Information parameter of file output by video processing

    Used by actions: ProcessMediaByUrl.

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

    MediaProcessTaskAdaptiveDynamicStreamingResult

    Result type of adaptive bitrate streaming task

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    Input AdaptiveDynamicStreamingTaskInput Input of adaptive bitrate streaming task.
    Output AdaptiveDynamicStreamingInfoItem Output of adaptive bitrate streaming task.

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

    MediaProcessTaskCoverBySnapshotResult

    Result type of cover generating task

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    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.

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

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

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

    MediaProcessTaskTranscodeResult

    Result type of transcoding task

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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.
    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.

    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、DescribeTaskDetail、PullEvents、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 Source category of media file:
  • Record: recording, such as LVB recording and LVB time shifting recording.
  • Upload: upload, such as pull for upload, upload from server, and UCG upload from client.
  • VideoProcessing: video processing, such as video splicing and video clipping.
  • Unknown: unknown source.

  • Note: this field may return null, indicating that no valid values can be obtained.
    SourceContext String Field passed through when a file is created.
    Note: this field may return null, indicating that no valid values can be obtained.

    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、DescribeTaskDetail、PullEvents.

    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 Transcoding specification ID. For more information, please see Transcoding Parameter Template.
    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.
    Size Integer Total size of a 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.
    Duration Float Video duration in seconds.
    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.
    Md5 String MD5 value of video.
    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.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaTransitionItem

    Transition information

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    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.
    Transitions Array of TransitionOpertion No List of transition operations. Up to one video image or audio transition operation is supported.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaVideoStreamItem

    Information of video stream in VOD file

    Used by actions: DescribeMediaInfos、DescribeTaskDetail、LiveRealTimeClip、PullEvents、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.

    MosaicInput

    Blur parameter type of video processing task

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、DescribeTaskDetail、ProcessMedia、PullEvents、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.
  • ObjectConfigureInfo

    Control parameter of object recognition task

    Used by actions: 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.

    OcrFullTextConfigureInfo

    Control parameter of full text recognition task

    Used by actions: 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.
  • OcrWordsConfigureInfo

    Text keyword recognition control parameter.

    Used by actions: 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.

    OutputAudioStream

    Information of output audio stream

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    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.

    OutputVideoStream

    Information of output video stream

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    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.

    PoliticalAsrReviewTemplateInfo

    Control parameter of politically sensitive information detection in speech task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of politically sensitive information detection in speech task. Valid values:
  • ON: enables politically sensitive information detection in speech task;
  • OFF: disables politically sensitive information detection in speech task.
  • 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. If this parameter is left empty, 100 will be used by default. 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. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    PoliticalConfigureInfo

    Control parameter of politically sensitive information detection task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfo No Control parameter of politically sensitive information detection in video image.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrReviewInfo PoliticalAsrReviewTemplateInfo No Control parameter of politically sensitive information detection in speech.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrReviewInfo PoliticalOcrReviewTemplateInfo No Control parameter of politically sensitive information detection in text.
    Note: this field may return null, indicating that no valid values can be obtained.

    PoliticalImgReviewTemplateInfo

    Control parameter of politically sensitive information detection in video image task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of politically sensitive information detection in video image task. Valid values:
  • ON: enables politically sensitive information detection in video image task;
  • OFF: disables politically sensitive information detection in video image task.
  • LabelSet Array of String No Filter tag for politically sensitive information detection in video image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values:
  • violation_photo: violating photo;
  • politician: politically sensitive figure;
  • entertainment: entertainment celebrity;
  • sport: sports celebrity.
  • 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. If this parameter is left empty, 97 will be used by default. 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. If this parameter is left empty, 95 will be used by default. Value range: 0–100.

    PoliticalOcrReviewTemplateInfo

    Control parameter of politically sensitive information detection in text task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of politically sensitive information detection in text task. Valid values:
  • ON: enables politically sensitive information detection in text task;
  • OFF: disables politically sensitive information detection in text task.
  • 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. If this parameter is left empty, 100 will be used by default. 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. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    PornAsrReviewTemplateInfo

    Control parameter of porn information detection in speech task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of porn information detection in speech task. Valid values:
  • ON: enables porn information detection in speech task;
  • OFF: disables porn information detection in speech task.
  • 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. If this parameter is left empty, 100 will be used by default. 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. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    PornConfigureInfo

    Control parameter of porn information detection task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfo No Control parameter of porn information detection in video image.
    Note: this field may return null, indicating that no valid values can be obtained.
    AsrReviewInfo PornAsrReviewTemplateInfo No Control parameter of porn information detection in speech.
    Note: this field may return null, indicating that no valid values can be obtained.
    OcrReviewInfo PornOcrReviewTemplateInfo No Control parameter of porn information detection in text.
    Note: this field may return null, indicating that no valid values can be obtained.

    PornImgReviewTemplateInfo

    Control parameter of porn information detection in video image task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of porn information detection in video image task. Valid values:
  • ON: enables porn information detection in video image task;
  • OFF: disables porn information detection in video image task.
  • LabelSet Array of String No Filter tag for porn information detection in video image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values:
  • porn: porn;
  • vulgar: vulgarity;
  • intimacy: intimacy;
  • sexy: sexiness.
  • 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. If this parameter is left empty, 90 will be used by default. 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. If this parameter is left empty, 0 will be used by default. Value range: 0–100.

    PornOcrReviewTemplateInfo

    Control parameter of porn information detection in text task

    Used by actions: DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of porn information detection in text task. Valid values:
  • ON: enables porn information detection in text task;
  • OFF: disables porn information detection in text task.
  • 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. If this parameter is left empty, 100 will be used by default. 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. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    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 Execution status and result of video content audit task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.

    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.
  • MediaProcessTask MediaProcessTaskInput Parameter of video processing task.
    Note: this field may return null, indicating that no valid values can be obtained.
    AiContentReviewTask AiContentReviewTaskInput Parameter of AI-based content audit task.
    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.
    MiniProgramPublishTask WechatMiniProgramPublishTaskInput Parameter of a release on WeChat Mini Program task.
    Note: this field may return null, indicating that no valid values can be obtained.
    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: 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 Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. 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. 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: 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.

    ProhibitedOcrReviewTemplateInfo

    Control parameter of prohibited information detection in text task

    Used by actions: 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 Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. 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. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    PullUploadTask

    Video pull for upload task information

    Used by actions: DescribeTaskDetail、PullEvents.

    Name Type Description
    TaskId String Pull for upload 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 ID of video generated after pull for upload is completed.
    MediaBasicInfo MediaBasicInfo Basic information of media file generated after pull for upload is completed.
    Note: this field may return null, indicating that no valid values can be obtained.
    FileUrl String Playback address generated after pull for upload is completed.
    ProcedureTaskId String If a video processing flow is specified when a video is pulled for upload, this parameter will be the ID of the task flow.
    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.
    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.

    SampleSnapshotTaskInput

    Input parameter type of sampling screencapturing task

    Used by actions: CreateProcedureTemplate、DescribeProcedureTemplates、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 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.
  • white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
  • gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.

  • Default value: black.

    SegmentConfigureInfo

    Control parameter of video splitting recognition task

    Used by actions: 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.
  • 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

    Time point screencapturing task information. This structure is only used for tasks initiated by the CreateSnapshotByTimeOffset API in v2017.

    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、DescribeProcedureTemplates、DescribeTaskDetail、ProcessMedia、PullEvents、ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes Time point screencapturing template ID.
    TimeOffsetSet Array of Float Yes 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 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.
  • white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
  • gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.

  • Default value: black.

    SortBy

    Sort by criterion

    Used by actions: SearchMedia.

    Name Type Description
    Field String Sort by field
    Order String 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.

    StatDataItem

    Statistics

    Used by actions: DescribeCDNUsageData、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.
  • Storage capacity in bytes.
  • Transcoding duration in seconds.
  • Traffic in bytes.
  • Bandwidth in bps.
  • StickerTrackItem

    Information of sticker on sticker track.

    Used by actions: ComposeMedia、DescribeTaskDetail、PullEvents.

    Name Type Required Description
    SourceMedia String Yes Source of media file for sticker material, which can be an ID of a VOD file or URL of another file.
    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.

    SubAppIdInfo

    Subapplication information.

    Used by actions: DescribeSubAppIds.

    Name Type Description
    SubAppId Integer Subapplication ID.
    Name String 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.
  • 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 cycle configuration, which is used to configure watermarks so that they will be displayed and hidden periodically.
    Primary use case: watermarks can be added at various positions in a video, which are displayed and hidden periodically to prevent them from being covered.
    For example, watermarks A, B, C, and D are set in the top-left corner, top-right corner, bottom-right corner, and bottom-left corner of a video, respectively. After the first video frame, { A will be displayed for 5s -> B for 5s -> C for 5s -> D for 5s } -> A for 5s -> B for 5s -> ... Only one watermark will be visible at any time.
    Within the braces ({}) is a major cycle composed of four watermarks, namely, A, B, C, and D, which lasts for 20 seconds in a cycle.
    Watermarks A, B, C, and D are displayed periodically for 5 seconds and hidden for 15 seconds each in a fixed order.
    This configuration item is used to describe the cycle configuration of a single watermark.

    TEHDConfig

    TESHD parameter configuration.

    Used by actions: CreateTranscodeTemplate、DescribeTranscodeTemplates.

    Name Type Required Description
    Type String Yes TESHD type. Valid values:
  • TEHD-100: TESHD-100.

  • If this parameter is left blank, TESHD will not be enabled.
    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 type. Valid values:
  • TEHD-100: TESHD-100.

  • If this parameter is left blank, no modification will be made.
    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.
  • TaskStatData

    Video processing task statistics.

    Used by actions: DescribeMediaProcessUsageData.

    Name Type