International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2020-10-16 18:37:01

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.
TagConfigure TagConfigureInfo Control parameter of intelligent tagging task.
CoverConfigure CoverConfigureInfo Control parameter of intelligent cover generating task.
FrameTagConfigure FrameTagConfigureInfo Control parameter of intelligent frame-specific tagging task.
CreateTime String Creation time of template in ISO date format.
UpdateTime String Last modified time of template in ISO date format.

AIRecognitionTemplateItem

Details of a video content recognition template

Used by actions: DescribeAIRecognitionTemplates.

Name Type Description
Definition Integer Unique ID of a video content recognition template.
Name String Name of a video content recognition template.
Comment String Description of a video content recognition template.
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.
CreateTime String Creation time of a template in ISO date format.
UpdateTime String Last modified time of a template in ISO date format.

AdaptiveDynamicStreamingInfoItem

Adaptive bitrate streaming information

Used by actions: DescribeTaskDetail, ParseNotification.

Name Type Description
Definition Integer Adaptive bitrate streaming specification.
Package String Container format. Valid values: HLS, MPEG-DASH.
Path String Playback address.
Storage TaskOutputStorage Storage location of adaptive bitrate streaming files.

AdaptiveDynamicStreamingTaskInput

Input parameter type of adaptive bitrate streaming

Used by actions: CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ParseNotification, ProcessMedia, ResetWorkflow.

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.
OutputStorage TaskOutputStorage No Target bucket of an output file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited.
Note: this field may return null, indicating that no valid values can be obtained.
OutputObjectPath String No The relative or absolute output path of the manifest file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, a relative path in the following format will be used by default: {inputName}_adaptiveDynamicStreaming_{definition}.{format}.
SubStreamObjectName String No The relative output path of the substream file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, a relative path in the following format will be used by default: {inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}.
SegmentObjectName String No The relative output path of the segment file after being transcoded to adaptive bitrate streaming (in HLS format only). If this parameter is left empty, a relative path in the following format will be used by default: {inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}.

AdaptiveDynamicStreamingTemplate

Details of an adaptive bitrate streaming template

Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

Name Type Description
Definition Integer Unique ID of an adaptive bitrate streaming template.
Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of an adaptive bitrate streaming template.
    Comment String Description of an adaptive bitrate streaming template.
    Format String Adaptive bitrate streaming format. Valid values:
  • HLS;
  • MPEG-DASH.
    		•
    StreamInfos Array of AdaptiveStreamTemplate Parameter information of input streams for transcoding to 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: CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Video VideoTemplateInfo Yes Video parameter information.
    Audio AudioTemplateInfo Yes Audio parameter information.
    RemoveAudio Integer No Whether to remove audio stream. Valid values:
  • 0: no,
  • 1: yes.
    		•
    RemoveVideo Integer No Whether to remove video stream. Valid values:
  • 0: no,
  • 1: yes.
    		•

    AiAnalysisResult

    Intelligent analysis results

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
  • Classification: intelligent categorization
  • Cover: intelligent cover generating
  • Tag: intelligent tagging
  • FrameTag: intelligent frame-specific 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.
    CoverTask AiAnalysisTaskCoverResult Query result of intelligent cover generating task in video content analysis, which is valid if task type is Cover.
    TagTask AiAnalysisTaskTagResult Query result of intelligent tagging task in video content analysis, which is valid if task type is Tag.
    FrameTagTask AiAnalysisTaskFrameTagResult Query result of intelligent frame-specific tagging task in video content analysis, which is valid if task type is FrameTag.

    AiAnalysisTaskClassificationInput

    Input type of intelligent categorization task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Intelligent video categorization template ID.

    AiAnalysisTaskClassificationOutput

    Result information of intelligent categorization

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ClassificationSet Array of MediaAiAnalysisClassificationItem List of intelligently generated video categories.

    AiAnalysisTaskClassificationResult

    Result type of intelligent categorization task

    Used by actions: DescribeTaskDetail, ParseNotification.

    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.

    AiAnalysisTaskCoverInput

    Input type of intelligent categorization task

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiAnalysisTaskCoverOutput

    Result information of intelligent cover generating

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    CoverSet Array of MediaAiAnalysisCoverItem List of intelligently generated covers.
    OutputStorage TaskOutputStorage Storage location of intelligently generated cover.

    AiAnalysisTaskCoverResult

    Result type of intelligent cover generating task

    Used by actions: DescribeTaskDetail, ParseNotification.

    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.

    AiAnalysisTaskFrameTagInput

    Input type of intelligent frame-specific tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiAnalysisTaskFrameTagOutput

    Result information of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    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.

    AiAnalysisTaskInput

    AI video intelligent analysis input parameter types

    Used by actions: CreateWorkflow, DescribeWorkflows, ProcessMedia, ResetWorkflow.

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

    AiAnalysisTaskTagInput

    Input type of intelligent tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Intelligent video tagging template ID.

    AiAnalysisTaskTagOutput

    Result information of intelligent tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TagSet Array of MediaAiAnalysisTagItem List of intelligently generated video tags.

    AiAnalysisTaskTagResult

    Result type of intelligent tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

    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.

    AiContentReviewResult

    Content audit result

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 text
  • Porn.Ocr: OCR-based porn information detection in text
  • Porn.Voice: Porn information detection in speech
  • Political.Asr: ASR-based politically sensitive information detection in text
  • Political.Ocr: OCR-based politically sensitive information detection in text
    		•
    SampleRate Float Sample rate, which indicates the number of video frames captured per second for audit
    Duration Float Audited video duration in seconds.
    PornTask AiReviewTaskPornResult Query result of an intelligent porn information detection in 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 an intelligent terrorism information detection in 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 an intelligent politically sensitive information detection in 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 an ASR-based porn information detection in text 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 an 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 an ASR-based politically sensitive information detection in text 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 an 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 if task type is Terrorism.Ocr.
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult Query result of ASR-based prohibited information detection in speech task in video content audit, which is valid if task type is Prohibited.Asr.
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult Query result of OCR-based prohibited information detection in text task in video content audit, which is valid if task type is Prohibited.Ocr.

    AiContentReviewTaskInput

    Task type of intelligent content audit

    Used by actions: CreateWorkflow, DescribeWorkflows, ProcessLiveStream, ProcessMedia, ResetWorkflow.

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

    AiRecognitionResult

    Intelligent recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskAsrFullTextResult

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskAsrFullTextResultInput

    Input for full speech recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Full speech recognition template ID.

    AiRecognitionTaskAsrFullTextResultOutput

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem List of full speech recognition segments.
    SubtitlePath String Subtitles file address.
    OutputStorage TaskOutputStorage Subtitles file storage location.

    AiRecognitionTaskAsrFullTextSegmentItem

    Full speech recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskAsrWordsResult

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 a speech keyword recognition task.
    Output AiRecognitionTaskAsrWordsResultOutput Output information of a speech keyword recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionTaskAsrWordsResultInput

    Input for speech keyword recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Speech keyword recognition template ID.

    AiRecognitionTaskAsrWordsResultItem

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    Name Type Description
    ResultSet Array of AiRecognitionTaskAsrWordsResultItem Speech keyword recognition result set.

    AiRecognitionTaskAsrWordsSegmentItem

    Speech recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskFaceResult

    Face recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 a face recognition task.
    Output AiRecognitionTaskFaceResultOutput Output information of a 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, ParseNotification.

    Name Type Description
    Definition Integer Face recognition template ID.

    AiRecognitionTaskFaceResultItem

    Face recognition result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Id String Unique ID of a 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 Name of a figure.
    SegmentSet Array of AiRecognitionTaskFaceSegmentItem Result set of segments that contain a figure.

    AiRecognitionTaskFaceResultOutput

    Output of intelligent face recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ResultSet Array of AiRecognitionTaskFaceResultItem Intelligent face recognition result set.

    AiRecognitionTaskFaceSegmentItem

    Face recognition result segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a recognition segment in seconds.
    EndTimeOffset Float End time offset of a recognition segment in seconds.
    Confidence Float Confidence of a recognition segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of a 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.

    AiRecognitionTaskInput

    Input parameter type of video content recognition

    Used by actions: CreateWorkflow, DescribeWorkflows, ProcessLiveStream, ProcessMedia, ResetWorkflow.

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

    AiRecognitionTaskOcrFullTextResult

    Full text recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 a full text recognition task.
    Output AiRecognitionTaskOcrFullTextResultOutput Output information of a full text recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionTaskOcrFullTextResultInput

    Input for full text recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Full text recognition template ID.

    AiRecognitionTaskOcrFullTextResultOutput

    Output of full text recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskOcrFullTextSegmentItem Full text recognition result set.

    AiRecognitionTaskOcrFullTextSegmentItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskOcrFullTextSegmentTextItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Confidence of a recognition segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of a 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, ParseNotification.

    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 a text keyword recognition task.
    Output AiRecognitionTaskOcrWordsResultOutput Output information of a text keyword recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionTaskOcrWordsResultInput

    Input for text keyword recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Text keyword recognition template ID.

    AiRecognitionTaskOcrWordsResultItem

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    Name Type Description
    ResultSet Array of AiRecognitionTaskOcrWordsResultItem Text keyword recognition result set.

    AiRecognitionTaskOcrWordsSegmentItem

    Text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a recognition segment in seconds.
    EndTimeOffset Float End time offset of a recognition segment in seconds.
    Confidence Float Confidence of a recognition segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of a 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.

    AiReviewPoliticalAsrTaskInput

    Input parameter type of an ASR-based politically sensitive information detection in text task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a politically sensitive information detection template.

    AiReviewPoliticalAsrTaskOutput

    ASR-detected politically sensitive information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiReviewPoliticalOcrTaskInput

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a politically sensitive information detection template.

    AiReviewPoliticalOcrTaskOutput

    OCR-detected politically sensitive information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Score of the OCR-detected politically sensitive information in text from 0 to 100.
    Suggestion String Suggestion for the 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 a politically sensitive information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a politically sensitive information detection template.

    AiReviewPoliticalTaskOutput

    Politically sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Score of the detected politically sensitive information in video from 0 to 100.
    Suggestion String Suggestion for the detected politically sensitive information. Valid values:
  • pass.
  • review.
  • block.
    		•
    Label String Tags for the results of video politically sensitive information detection. The relationship between the LabelSet parameter in the content audit template controlling tasks of video politically sensitive information detection and this parameter is as follows:
    violation_photo:
  • violation_photo: violating photo.

    • Other values (politician/entertainment/sport/entrepreneur/scholar/celebrity/military):
  • politician: political figure.
    		•
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem List of video segments that contain the detected politically sensitive information.

    AiReviewPornAsrTaskInput

    Input parameter type of an ASR-based porn information detection in text task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a porn information detection template.

    AiReviewPornAsrTaskOutput

    ASR-detected porn information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiReviewPornOcrTaskInput

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a porn information detection template.

    AiReviewPornOcrTaskOutput

    OCR-detected porn information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Score of the OCR-detected porn information in text from 0 to 100.
    Suggestion String Suggestion for the 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 a porn information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Required Description
    Definition Integer Yes ID of a porn information detection template.

    AiReviewPornTaskOutput

    Porn information detection result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Score of the detected porn information in video from 0 to 100.
    Suggestion String Suggestion for the detected porn information. Valid values:
  • pass.
  • review.
  • block.
    		•
    Label String Tag of the detected porn information in video. Valid values:
  • porn: Porn.
  • sexy: Sexiness.
  • vulgar: Vulgarity.
  • intimacy: Intimacy.
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain the detected porn information.

    AiReviewProhibitedAsrTaskInput

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Prohibited information detection template ID.

    AiReviewProhibitedAsrTaskOutput

    ASR-detected prohibited information in speech

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    Name Type Description
    Definition Integer Prohibited information detection template ID.

    AiReviewProhibitedOcrTaskOutput

    OCR-detected prohibited information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 an ASR-based politically sensitive information detection in text task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 AiReviewPoliticalAsrTaskInput Input for an ASR-based politically sensitive information detection in text task during content audit.
    Output AiReviewPoliticalAsrTaskOutput Output of an ASR-based politically sensitive information detection in text task during content audit.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPoliticalOcrResult

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

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiReviewTaskPoliticalResult

    Result type of a politically sensitive information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 AiReviewPoliticalTaskInput Input for a politically sensitive information detection task during content audit.
    Output AiReviewPoliticalTaskOutput Output of a politically sensitive information detection task during content audit.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornAsrResult

    Result type of an ASR-based porn information detection in text task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 AiReviewPornAsrTaskInput Input for an ASR-based porn information detection in text task during content audit.
    Output AiReviewPornAsrTaskOutput Output of an ASR-based porn information detection in text task during content audit.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornOcrResult

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 AiReviewPornOcrTaskInput Input for an OCR-based porn information detection in text task during content audit.
    Output AiReviewPornOcrTaskOutput Output of an OCR-based porn information detection in text task during content audit.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPornResult

    Result type of a porn information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, FAIL.
    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 AiReviewPornTaskInput Input for a porn information detection task during content audit.
    Output AiReviewPornTaskOutput Output of a porn information detection task during 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, ParseNotification.

    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

    AiReviewTaskProhibitedOcrResult

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    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

    AiReviewTaskTerrorismOcrResult

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    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.

    AiReviewTaskTerrorismResult

    Result type of a terrorism information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 AiReviewTerrorismTaskInput Input for a terrorism information detection task during content audit.
    Output AiReviewTerrorismTaskOutput Output of a terrorism information detection task during 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, ParseNotification.

    Name Type Description
    Definition Integer Terrorism information detection template ID.

    AiReviewTerrorismOcrTaskOutput

    OCR-detected terrorism information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    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 a terrorism information detection task during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer ID of a terrorism information detection template.

    AiReviewTerrorismTaskOutput

    Terrorism information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Score of the detected terrorism information in a video from 0 to 100.
    Suggestion String Suggestion for the detected terrorism information. Valid values:
  • pass.
  • review.
  • block.
    		•
    Label String Tag of the 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.
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments that contain the detected terrorism information.

    AiSampleFaceInfo

    AI-based sample management - face information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

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

    AiSampleFaceOperation

    AI-based sample management - face data operation.

    Used by actions: ModifyPersonSample.

    Name Type Required Description
    Type String Yes Operation type. Valid values: add, delete, reset. The reset operation will clear the existing face data of a figure and add FaceContents as the specified face data.
    FaceIds Array of String No Face ID set. This field is required when Type is delete.
    FaceContents Array of String No String set generated by Base64-encoding the face image.
  • This field is required when Type is add or reset;
  • Array length limit: 5 images.

    • Note: The image must be a relatively clear full-face photo of a figure in at least 200 * 200 px.

    AiSampleFailFaceInfo

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

    Used by actions: CreatePersonSample, ModifyPersonSample.

    Name Type Description
    Index Integer Corresponds to incorrect image subscripts in the FaceContents input parameter, starting from 0.
    ErrCode Integer Error code. Valid values:
  • 0: Succeeded;
  • Other values: Failed.
    		•
    Message String Error description.

    AiSamplePerson

    AI-based sample management - figure information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

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

    AiSampleTagOperation

    AI-based sample management - tag operation.

    Used by actions: ModifyPersonSample, ModifyWordSample.

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

    AiSampleWord

    AI-based sample management - keyword output information.

    Used by actions: DescribeWordSamples.

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

    AiSampleWordInfo

    AI-based sample management - keyword input information.

    Used by actions: CreateWordSamples.

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

    AnimatedGraphicTaskInput

    Type of an animated image generating task.

    Used by actions: CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ParseNotification, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Definition Integer Yes Animated image generating template ID.
    StartTimeOffset Float Yes Start time of an animated image in a video in seconds.
    EndTimeOffset Float Yes End time of an animated image in a video in seconds.
    OutputStorage TaskOutputStorage No Target bucket of a generated animated image file. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputObjectPath String No Output path to a generated animated image file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: {inputName}_animatedGraphic_{definition}.{format}.

    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 a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.

    AsrFullTextConfigureInfo

    Control parameter of a full speech recognition task.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of a full speech recognition task. Valid values:
  • ON: Enables an intelligent full speech recognition task;
  • OFF: Disables an intelligent full speech recognition task.
    		•
    SubtitleFormat String No Format of the generated subtitles file. If this parameter is left empty or an empty string is entered, no subtitles files will be generated. Valid value:
  • vtt: Generates a WebVTT subtitles file.
    		•

    AsrFullTextConfigureInfoForUpdate

    Control parameter of a full speech recognition task.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of a full speech recognition task. Valid values:
  • ON: Enables an intelligent full speech recognition task;
  • OFF: Disables an intelligent full speech recognition task.
    		•
    SubtitleFormat String No Format of the generated subtitles file. If an empty 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: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

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

    AsrWordsConfigureInfoForUpdate

    Speech keyword recognition control parameter.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of a speech keyword recognition task. Valid values:
  • ON: Enables a speech keyword recognition task;
  • OFF: Disables a 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: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeAdaptiveDynamicStreamingTemplates, DescribeTaskDetail, DescribeTranscodeTemplates, DescribeWorkflows, ModifyAdaptiveDynamicStreamingTemplate, ParseNotification, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Codec String Yes Audio stream codec.
    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.

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

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

    ContentReviewTemplateItem

    Details of a content audit template

    Used by actions: DescribeContentReviewTemplates.

    Name Type Description
    Definition Integer Unique ID of a content audit template.
    Name String Name of a content audit template. Length limit: 64 characters.
    Comment String Description of a content audit template. 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 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.
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.

    CosFileUploadTrigger

    Input rule bound to COS.

    Used by actions: CreateWorkflow, DescribeWorkflows, ResetWorkflow.

    Name Type Required Description
    Bucket String Yes Name of the COS bucket bound to a workflow, such as TopRankVideo-125xxx88.
    Region String Yes Region of the COS bucket bound to a workflow, such as ap-chongiqng.
    Dir String No Input path directory bound to a workflow, such as /movie/201907/. If this parameter is left empty, the / root directory will be used.
    Formats Array of String No Format list of files that can trigger a workflow, such as ["mp4", "flv", "mov"]. If this parameter is left empty, files in all formats can trigger the workflow.

    CosInputInfo

    Information of the COS object for video processing.

    Used by actions: CreateWorkflow, DescribeMediaMetaData, DescribeTaskDetail, DescribeWorkflows, EditMedia, ParseNotification, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Bucket String Yes Name of the COS bucket where a video processing object file is located, such as TopRankVideo-125xxx88.
    Region String Yes Region of the COS bucket where a video processing object file is located, such as ap-chongqing.
    Object String Yes Path to an input object file for video processing, such as /movie/201907/WildAnimal.mov.

    CosOutputStorage

    Information of a COS output object generated from video processing.

    Used by actions: CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, EditMedia, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Bucket String No Name of the target bucket of a video processing output file, such as TopRankVideo-125xxx88. If this parameter is left empty, the parameter of the upper folder will be inherited.
    Region String No Region of the target bucket of a video processing output file, such as ap-chongqing. If this parameter is left empty, the parameter of the upper folder will be inherited.

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

    EditMediaFileInfo

    VOD video file editing information

    Used by actions: DescribeTaskDetail, EditMedia, ParseNotification.

    Name Type Required Description
    InputInfo MediaInputInfo Yes Video input information.
    StartTimeOffset Float No Start time offset of video clipping in seconds.
    EndTimeOffset Float No End time offset of video clipping in seconds.

    EditMediaTask

    Video editing task information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.
    		•
    ErrCode Integer Error code
  • 0: success;
  • Other values: failure.
    		•
    Message String Error message.
    Input EditMediaTaskInput Input of video editing task.
    Output EditMediaTaskOutput Output of video editing task.

    EditMediaTaskInput

    Input of video editing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    FileInfoSet Array of EditMediaFileInfo Information of input video file.

    EditMediaTaskOutput

    Output of video editing task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    OutputStorage TaskOutputStorage Target storage of edited file.
    Path String Path of edited video file.

    FaceConfigureInfo

    Control parameter of a face recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Switch of a face recognition task. Valid values:
  • ON: Enables an intelligent face recognition task;
  • OFF: Disables an 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 an empty 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 an empty 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.)

    FaceConfigureInfoForUpdate

    Control parameter of a face recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Switch of a face recognition task. Valid values:
  • ON: Enables an intelligent face recognition task;
  • OFF: Disables an intelligent face recognition task.
    		•
    Score Float No Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0-100.
    DefaultLibraryLabelSet Array of String No Default figure filter tag, which specifies the default figure tag that needs to be returned. If this parameter is left empty or an empty 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 an empty 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.
    		•

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

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

    ImageSpriteTaskInput

    Input parameter type of an image sprite generating task

    Used by actions: CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ParseNotification, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Definition Integer Yes ID of an image sprite generating template.
    OutputStorage TaskOutputStorage No Target bucket of a generated image sprite. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputObjectPath String No Output path to a generated image sprite file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: {inputName}_imageSprite_{definition}_{number}.{format}.
    WebVttObjectName String No Output path to the WebVTT file after an image sprite is generated, which can only be a relative path. If this parameter is left empty, the following relative path will be used by default: {inputName}_imageSprite_{definition}.{format}.
    ObjectNumberFormat NumberFormat No Rule of the {number} variable in the image sprite output path.
    Note: This field may return null, indicating that no valid values can be obtained.

    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 Subimage width of an image sprite.
    Height Integer Subimage height of an image sprite.
    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 a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    FillType String Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
  • stretch: Stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
  • black: Fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.

    • Default value: black.
    Comment String Template description.

    ImageWatermarkInput

    Input parameter of an 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 pixels. For example, 100px means that Width is 100 pixels. Value range: [8, 4096].

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

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

    ImageWatermarkInputForUpdate

    Input parameter of an image watermarking template

    Used by actions: ModifyWatermarkTemplate.

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

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

    ImageWatermarkTemplate

    Image watermarking template

    Used by actions: DescribeWatermarkTemplates.

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

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

    LiveStreamAiRecognitionResultInfo

    Live stream AI recognition results

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    ResultSet Array of LiveStreamAiRecognitionResultItem Content recognition result list.

    LiveStreamAiRecognitionResultItem

    AI-based live stream recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Type String Result type. Valid values:
  • FaceRecognition: face recognition,
  • AsrWordsRecognition: speech keyword recognition,
  • OcrWordsRecognition: text keyword recognition,
  • AsrFullTextRecognition: full speech recognition,
  • OcrFullTextRecognition: full text recognition.
    		•
    FaceRecognitionResultSet Array of LiveStreamFaceRecognitionResult Face recognition result, which is valid when Type is
    FaceRecognition.
    AsrWordsRecognitionResultSet Array of LiveStreamAsrWordsRecognitionResult Speech keyword recognition result, which is valid when Type is
    AsrWordsRecognition.
    OcrWordsRecognitionResultSet Array of LiveStreamOcrWordsRecognitionResult Text keyword recognition result, which is valid when Type is
    OcrWordsRecognition.
    AsrFullTextRecognitionResultSet Array of LiveStreamAsrFullTextRecognitionResult Full speech recognition result, which is valid when Type is
    AsrFullTextRecognition.
    OcrFullTextRecognitionResultSet Array of LiveStreamOcrFullTextRecognitionResult Full text recognition result, which is valid when Type is
    OcrFullTextRecognition.

    LiveStreamAiReviewImagePoliticalResult

    Result of politically sensitive information detection in image in AI-based live stream content audit

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment in seconds.
    EndPtsTime Float End PTS time of a suspected segment in seconds.
    Confidence Float Score of a suspected politically sensitive segment.
    Suggestion String Suggestion for porn information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
    		•
    Label String Tag of the detected politically sensitive information in video. Valid values:
  • politician: Politically sensitive figure.
  • violation_photo: Violating photo.
    		•
    Name String Name of a politically sensitive figure or violating photo.
    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.
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTime String Expiration time of a suspected image URL in ISO date format.

    LiveStreamAiReviewImagePornResult

    Result of porn information detection in image in AI-based live stream content audit

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment in seconds.
    EndPtsTime Float End PTS time of a suspected segment in seconds.
    Confidence Float Score of a suspected porn segment.
    Suggestion String Suggestion for porn information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
    		•
    Label String Tag of the detected porn information in video. Valid values:
  • porn: Porn.
  • sexy: Sexiness.
  • vulgar: Vulgarity.
  • intimacy: Intimacy.
    		•
    Url String URL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTime String Expiration time of a suspected image URL in ISO date format.

    LiveStreamAiReviewImageTerrorismResult

    Result of terrorism information detection in image in AI-based live stream content audit

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment in seconds.
    EndPtsTime Float End PTS time of a suspected segment in seconds.
    Confidence Float Score of a suspected terrorism segment.
    Suggestion String Suggestion for terrorism information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
    		•
    Label String Tag of the detected terrorism information in a video. Valid values:
  • guns: Weapons and guns.
  • crowd: Crowd.
  • police: Police force.
  • bloody: Bloody scenes.