Overview
Menu

Data Types

Last updated: 2023-10-12 16:44:49Download PDF

AIAnalysisTemplateItem

AI-based intelligent analysis template details

Used by actions: DescribeAIAnalysisTemplates.

NameTypeDescription
DefinitionIntegerUnique ID of intelligent analysis template.
NameStringIntelligent analysis template name.
CommentStringIntelligent analysis template description.
ClassificationConfigureClassificationConfigureInfoControl parameter of intelligent categorization task.
TagConfigureTagConfigureInfoControl parameter of intelligent tagging task.
CoverConfigureCoverConfigureInfoControl parameter of intelligent cover generating task.
FrameTagConfigureFrameTagConfigureInfoControl parameter of intelligent frame-specific tagging task.
CreateTimeStringCreation time of template in ISO date format.
UpdateTimeStringLast modified time of template in ISO date format.
TypeStringThe template type. Valid values:
* Preset
* Custom
Note: This field may return null, indicating that no valid value can be obtained.

AIRecognitionTemplateItem

Details of a video content recognition template

Used by actions: DescribeAIRecognitionTemplates.

NameTypeDescription
DefinitionIntegerUnique ID of a video content recognition template.
NameStringName of a video content recognition template.
CommentStringDescription of a video content recognition template.
FaceConfigureFaceConfigureInfoFace recognition control parameter.
Note: This field may return null, indicating that no valid values can be obtained.
OcrFullTextConfigureOcrFullTextConfigureInfoFull text recognition control parameter.
Note: This field may return null, indicating that no valid values can be obtained.
OcrWordsConfigureOcrWordsConfigureInfoText keyword recognition control parameter.
Note: This field may return null, indicating that no valid values can be obtained.
AsrFullTextConfigureAsrFullTextConfigureInfoFull speech recognition control parameter.
Note: This field may return null, indicating that no valid values can be obtained.
AsrWordsConfigureAsrWordsConfigureInfoSpeech keyword recognition control parameter.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTimeStringCreation time of a template in ISO date format.
UpdateTimeStringLast modified time of a template in ISO date format.
TypeStringThe template type. Valid values:
* Preset
* Custom
Note: This field may return null, indicating that no valid value can be obtained.

Activity

A subtask of a scheme.

Used by actions: CreateSchedule, DescribeSchedules, ModifySchedule.

NameTypeRequiredDescription
ActivityTypeStringYesThe subtask type.
  • input: The start.
  • output: The end.
  • action-trans: Transcoding.
  • action-samplesnapshot: Sampled screencapturing.
  • action-AIAnalysis: Content analysis.
  • action-AIRecognition: Content recognition.
  • action-aiReview: Content moderation.
  • action-animated-graphics: Animated screenshot generation.
  • action-image-sprite: Image sprite generation.
  • action-snapshotByTimeOffset: Time point screencapturing.
  • action-adaptive-substream: Adaptive bitrate streaming.

  • Note: This field may return null, indicating that no valid values can be obtained.
    ReardriveIndexArray of IntegerNoThe indexes of the subsequent actions.
    Note: This field may return null, indicating that no valid values can be obtained.
    ActivityParaActivityParaNoThe parameters of a subtask.
    Note: This field may return null, indicating that no valid values can be obtained.

    ActivityPara

    A subtask of a scheme.

    Used by actions: CreateSchedule, ModifySchedule.

    NameTypeRequiredDescription
    TranscodeTaskTranscodeTaskInputNoA transcoding task.
    AnimatedGraphicTaskAnimatedGraphicTaskInputNoAn animated screenshot generation task.
    SnapshotByTimeOffsetTaskSnapshotByTimeOffsetTaskInputNoA time point screencapturing task.
    SampleSnapshotTaskSampleSnapshotTaskInputNoA sampled screencapturing task.
    ImageSpriteTaskImageSpriteTaskInputNoAn image sprite generation task.
    AdaptiveDynamicStreamingTaskAdaptiveDynamicStreamingTaskInputNoAn adaptive bitrate streaming task.
    AiContentReviewTaskAiContentReviewTaskInputNoA content moderation task.
    AiAnalysisTaskAiAnalysisTaskInputNoA content analysis task.
    AiRecognitionTaskAiRecognitionTaskInputNoA content recognition task.

    ActivityResItem

    The execution results of the subtasks of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TranscodeTaskMediaProcessTaskTranscodeResultThe result of a transcoding task.
    Note: This field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicTaskMediaProcessTaskAnimatedGraphicResultThe result of an animated image generating task.
    Note: This field may return null, indicating that no valid values can be obtained.
    SnapshotByTimeOffsetTaskMediaProcessTaskSampleSnapshotResultThe result of a time point screenshot task.
    Note: This field may return null, indicating that no valid values can be obtained.
    SampleSnapshotTaskMediaProcessTaskSampleSnapshotResultThe result of a sampled screenshot task.
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageSpriteTaskMediaProcessTaskImageSpriteResultThe result of an image sprite task.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdaptiveDynamicStreamingTaskMediaProcessTaskAdaptiveDynamicStreamingResultThe result of an adaptive bitrate streaming task.
    Note: This field may return null, indicating that no valid values can be obtained.
    RecognitionTaskScheduleRecognitionTaskResultThe result of a content recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.
    ReviewTaskScheduleReviewTaskResultThe result of a content moderation task.
    Note: This field may return null, indicating that no valid values can be obtained.
    AnalysisTaskScheduleAnalysisTaskResultThe result of a content analysis task.
    Note: This field may return null, indicating that no valid values can be obtained.

    ActivityResult

    The execution result of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ActivityTypeStringThe type of the scheme’s subtask.
  • Transcode: Transcoding
  • SampleSnapshot: Sampled screenshot
  • AnimatedGraphics: Animated image generating
  • SnapshotByTimeOffset: Time point screenshot
  • ImageSprites: Image sprite generating
  • AdaptiveDynamicStreaming: Adaptive bitrate streaming
  • AiContentReview: Content moderation
  • AIRecognition: Content recognition
  • AIAnalysis: Content analysis
  • ActivityResItemActivityResItemThe execution results of the subtasks of the scheme.

    AdaptiveDynamicStreamingInfoItem

    Adaptive bitrate streaming information

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerAdaptive bitrate streaming specification.
    PackageStringContainer format. Valid values: HLS, MPEG-DASH.
    PathStringPlayback address.
    StorageTaskOutputStorageStorage location of adaptive bitrate streaming files.

    AdaptiveDynamicStreamingTaskInput

    Input parameter type of adaptive bitrate streaming

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesAdaptive bitrate streaming template ID.
    WatermarkSetArray of WatermarkInputNoList of up to 10 image or text watermarks.
    OutputStorageTaskOutputStorageNo
    Note: This field may return·null, indicating that no valid values can be obtained.
    OutputObjectPathStringNoThe 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}.
    SubStreamObjectNameStringNoThe 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}.
    SegmentObjectNameStringNoThe 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}.
    AddOnSubtitlesArray of AddOnSubtitleNo
    Note: This field may return·null, indicating that no valid values can be obtained.
    DrmInfoDrmInfoNo
    Note: This field may return·null, indicating that no valid values can be obtained.

    AdaptiveDynamicStreamingTemplate

    Details of an adaptive bitrate streaming template

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

    NameTypeDescription
    DefinitionIntegerUnique ID of an adaptive bitrate streaming template.
    TypeStringTemplate type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
  • NameStringName of an adaptive bitrate streaming template.
    CommentStringDescription of an adaptive bitrate streaming template.
    FormatStringAdaptive bitrate streaming format. Valid values:
  • HLS;
  • MPEG-DASH.
  • StreamInfosArray of AdaptiveStreamTemplateParameter information of input streams for transcoding to adaptive bitrate streaming. Up to 10 streams can be input.
    DisableHigherVideoBitrateIntegerWhether to prohibit transcoding from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.
  • DisableHigherVideoResolutionIntegerWhether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.
  • CreateTimeStringCreation time of template in ISO date format.
    UpdateTimeStringLast modified time of template in ISO date format.

    AdaptiveStreamTemplate

    Adaptive bitrate streaming parameter template

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    NameTypeRequiredDescription
    VideoVideoTemplateInfoYesVideo parameter information.
    AudioAudioTemplateInfoYesAudio parameter information.
    RemoveAudioIntegerNoWhether to remove audio stream. Valid values:
  • 0: no,
  • 1: yes.
  • RemoveVideoIntegerNoWhether to remove video stream. Valid values:
  • 0: no,
  • 1: yes.
  • AddOnSubtitle

    The information of the subtitles to add.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    TypeStringNoThe mode. Valid values:
  • subtitle-stream: Add a subtitle track.
  • close-caption-708: Embed CEA-708 subtitles in SEI frames.
  • close-caption-608: Embed CEA-608 subtitles in SEI frames.

  • Note: This field may return·null, indicating that no valid values can be obtained.
    SubtitleMediaInputInfoNoThe subtitle file.
    Note: This field may return·null, indicating that no valid values can be obtained.

    AiAnalysisResult

    Intelligent analysis results

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TypeStringTask type. Valid values:
  • Classification: intelligent categorization
  • Cover: intelligent cover generating
  • Tag: intelligent tagging
  • FrameTag: intelligent frame-specific tagging
  • Highlight: intelligent highlight generating
  • ClassificationTaskAiAnalysisTaskClassificationResultQuery result of intelligent categorization task in video content analysis, which is valid if task type is Classification.
    CoverTaskAiAnalysisTaskCoverResultQuery result of intelligent cover generating task in video content analysis, which is valid if task type is Cover.
    TagTaskAiAnalysisTaskTagResultQuery result of intelligent tagging task in video content analysis, which is valid if task type is Tag.
    FrameTagTaskAiAnalysisTaskFrameTagResultQuery result of intelligent frame-specific tagging task in video content analysis, which is valid if task type is FrameTag.
    HighlightTaskAiAnalysisTaskHighlightResultThe result of a highlight generation task. This parameter is valid if 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, ParseNotification.

    NameTypeDescription
    DefinitionIntegerIntelligent video categorization template ID.

    AiAnalysisTaskClassificationOutput

    Result information of intelligent categorization

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ClassificationSetArray of MediaAiAnalysisClassificationItemList of intelligently generated video categories.

    AiAnalysisTaskClassificationResult

    Result type of intelligent categorization task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiAnalysisTaskClassificationInputInput of intelligent categorization task.
    OutputAiAnalysisTaskClassificationOutputOutput of intelligent categorization task.

    AiAnalysisTaskCoverInput

    Input type of intelligent categorization task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerIntelligent video cover generating template ID.

    AiAnalysisTaskCoverOutput

    Result information of intelligent cover generating

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    CoverSetArray of MediaAiAnalysisCoverItemList of intelligently generated covers.
    OutputStorageTaskOutputStorageStorage location of intelligently generated cover.

    AiAnalysisTaskCoverResult

    Result type of intelligent cover generating task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiAnalysisTaskCoverInputInput of intelligent cover generating task.
    OutputAiAnalysisTaskCoverOutputOutput of intelligent cover generating task.

    AiAnalysisTaskFrameTagInput

    Input type of intelligent frame-specific tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerIntelligent frame-specific video tagging template ID.

    AiAnalysisTaskFrameTagOutput

    Result information of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    SegmentSetArray of MediaAiAnalysisFrameTagSegmentItemList of frame-specific video tags.

    AiAnalysisTaskFrameTagResult

    Result type of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiAnalysisTaskFrameTagInputInput of intelligent frame-specific tagging task.
    OutputAiAnalysisTaskFrameTagOutputOutput of intelligent frame-specific tagging task.

    AiAnalysisTaskHighlightInput

    The input of an intelligent highlight generation task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe ID of the intelligent highlight generation template.

    AiAnalysisTaskHighlightOutput

    The output of an intelligent highlight generation task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    HighlightSetArray of MediaAiAnalysisHighlightItemA list of the highlight segments generated.
    OutputStorageTaskOutputStorageThe storage location of the highlight segments.
    Note: This field may return·null, indicating that no valid values can be obtained.

    AiAnalysisTaskHighlightResult

    The result of an intelligent highlight generation task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeIntegerError code. 0: The task succeeded; other values: The task failed.
    MessageStringThe error message.
    InputAiAnalysisTaskHighlightInputThe input of the intelligent highlight generation task.
    OutputAiAnalysisTaskHighlightOutputThe output of the intelligent highlight generation task.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiAnalysisTaskInput

    AI video intelligent analysis input parameter types

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

    NameTypeRequiredDescription
    DefinitionIntegerYesVideo content analysis template ID.
    ExtendedParameterStringNoAn extended parameter, whose value is a stringfied JSON.
    Note: This parameter is for customers with special requirements. It needs to be customized offline.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiAnalysisTaskTagInput

    Input type of intelligent tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerIntelligent video tagging template ID.

    AiAnalysisTaskTagOutput

    Result information of intelligent tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TagSetArray of MediaAiAnalysisTagItemList of intelligently generated video tags.

    AiAnalysisTaskTagResult

    Result type of intelligent tagging task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiAnalysisTaskTagInputInput of intelligent tagging task.
    OutputAiAnalysisTaskTagOutputOutput of intelligent tagging task.

    AiContentReviewResult

    Content audit result

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TypeStringTask type. Valid values:
  • Porn (in images)
  • Terrorism (in images)
  • Political (in images)
  • Porn.Asr
  • Porn.Ocr
  • Political.Asr
  • Political.Ocr
  • Terrorism.Ocr
  • Prohibited.Asr
  • Prohibited.Ocr
  • SampleRateFloatSample rate, which indicates the number of video frames captured per second for audit
    DurationFloatAudited video duration in seconds.
    PornTaskAiReviewTaskPornResultQuery 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.
    TerrorismTaskAiReviewTaskTerrorismResultThe result of detecting terrorism content in images, which is valid when the task type is Terrorism.
    Note: This field may return null, indicating that no valid values can be obtained.
    PoliticalTaskAiReviewTaskPoliticalResultThe result of detecting politically sensitive information in images, which is valid when the task type is Political.
    Note: This field may return null, indicating that no valid values can be obtained.
    PornAsrTaskAiReviewTaskPornAsrResultQuery 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.
    PornOcrTaskAiReviewTaskPornOcrResultQuery 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.
    PoliticalAsrTaskAiReviewTaskPoliticalAsrResultThe result of detecting politically sensitive information based on ASR, which is valid when the task type is Political.Asr.
    Note: This field may return null, indicating that no valid values can be obtained.
    PoliticalOcrTaskAiReviewTaskPoliticalOcrResultThe result of detecting politically sensitive information based on OCR, which is valid when the task type is Political.Ocr.
    Note: This field may return null, indicating that no valid values can be obtained.
    TerrorismOcrTaskAiReviewTaskTerrorismOcrResultThe result of detecting terrorism content based on OCR, which is valid when task type is Terrorism.Ocr.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProhibitedAsrTaskAiReviewTaskProhibitedAsrResultQuery result of ASR-based prohibited information detection in speech task in video content audit, which is valid if task type is Prohibited.Asr.
    ProhibitedOcrTaskAiReviewTaskProhibitedOcrResultQuery 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: CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesVideo content audit template ID.

    AiQualityControlTaskInput

    The parameters for a video quality control task.

    Used by actions: DescribeTaskDetail, ParseNotification, ProcessLiveStream, ProcessMedia.

    NameTypeRequiredDescription
    DefinitionIntegerNoThe ID of the quality control template.
    Note: This field may return null, indicating that no valid values can be obtained.
    ChannelExtParaStringNoThe channel extension parameter, which is a serialized JSON string.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionResult

    Intelligent recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TypeStringThe task type. Valid values:
  • FaceRecognition: Face recognition
  • AsrWordsRecognition: Speech keyword recognition
  • OcrWordsRecognition: Text keyword recognition
  • AsrFullTextRecognition: Full speech recognition
  • OcrFullTextRecognition: Full text recognition
  • TransTextRecognition: Speech translation
  • FaceTaskAiRecognitionTaskFaceResultFace recognition result, which is valid when Type is
    FaceRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrWordsTaskAiRecognitionTaskAsrWordsResultSpeech keyword recognition result, which is valid when Type is
    AsrWordsRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrFullTextTaskAiRecognitionTaskAsrFullTextResultFull speech recognition result, which is valid when Type is
    AsrFullTextRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrWordsTaskAiRecognitionTaskOcrWordsResultText keyword recognition result, which is valid when Type is
    OcrWordsRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrFullTextTaskAiRecognitionTaskOcrFullTextResultFull text recognition result, which is valid when Type is
    OcrFullTextRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.
    TransTextTaskAiRecognitionTaskTransTextResultThe translation result. This parameter is valid only if Type is
    TransTextRecognition.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionTaskAsrFullTextResult

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiRecognitionTaskAsrFullTextResultInputInput information of a full speech recognition task.
    OutputAiRecognitionTaskAsrFullTextResultOutputOutput 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.

    NameTypeDescription
    DefinitionIntegerFull speech recognition template ID.

    AiRecognitionTaskAsrFullTextResultOutput

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    SegmentSetArray of AiRecognitionTaskAsrFullTextSegmentItemList of full speech recognition segments.
    SubtitlePathStringSubtitles file address.
    OutputStorageTaskOutputStorageSubtitles file storage location.

    AiRecognitionTaskAsrFullTextSegmentItem

    Full speech recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatConfidence of a recognition segment. Value range: 0-100.
    StartTimeOffsetFloatStart time offset of a recognition segment in seconds.
    EndTimeOffsetFloatEnd time offset of a recognition segment in seconds.
    TextStringRecognized text.

    AiRecognitionTaskAsrWordsResult

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiRecognitionTaskAsrWordsResultInputInput information of a speech keyword recognition task.
    OutputAiRecognitionTaskAsrWordsResultOutputOutput 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.

    NameTypeDescription
    DefinitionIntegerSpeech keyword recognition template ID.

    AiRecognitionTaskAsrWordsResultItem

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    WordStringSpeech keyword.
    SegmentSetArray of AiRecognitionTaskAsrWordsSegmentItemList of time segments that contain the speech keyword.

    AiRecognitionTaskAsrWordsResultOutput

    Output of speech keyword recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ResultSetArray of AiRecognitionTaskAsrWordsResultItemSpeech keyword recognition result set.

    AiRecognitionTaskAsrWordsSegmentItem

    Speech recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a recognition segment in seconds.
    EndTimeOffsetFloatEnd time offset of a recognition segment in seconds.
    ConfidenceFloatConfidence of a recognition segment. Value range: 0-100.

    AiRecognitionTaskFaceResult

    Face recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiRecognitionTaskFaceResultInputInput information of a face recognition task.
    OutputAiRecognitionTaskFaceResultOutputOutput 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.

    NameTypeDescription
    DefinitionIntegerFace recognition template ID.

    AiRecognitionTaskFaceResultItem

    Face recognition result

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    IdStringUnique ID of a figure.
    TypeStringFigure library type, indicating to which figure library the recognized figure belongs:
  • Default: Default figure library;
  • UserDefine: Custom figure library.
  • NameStringName of a figure.
    SegmentSetArray of AiRecognitionTaskFaceSegmentItemResult set of segments that contain a figure.
    GenderStringThe person’s gender.
  • Male
  • Female

  • Note: This field may return null, indicating that no valid value can be obtained.
    BirthdayStringThe person’s birth date.
    Note: This field may return null, indicating that no valid value can be obtained.
    ProfessionStringThe person’s job or job title.
    Note: This field may return null, indicating that no valid value can be obtained.
    SchoolOfGraduationStringThe college the person graduated from.
    Note: This field may return null, indicating that no valid value can be obtained.
    AbstractStringThe person’s profile.
    Note: This field may return null, indicating that no valid value can be obtained.
    PlaceOfBirthStringThe person’s place of birth.
    Note: This field may return null, indicating that no valid value can be obtained.
    PersonTypeStringWhether the person is a politician or artist.
  • Politician
  • Artist

  • Note: This field may return null, indicating that no valid value can be obtained.
    RemarkStringSensitivity
  • Normal
  • Sensitive

  • Note: This field may return null, indicating that no valid value can be obtained.
    UrlStringThe screenshot URL.
    Note: This field may return null, indicating that no valid value can be obtained.

    AiRecognitionTaskFaceResultOutput

    Output of intelligent face recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ResultSetArray of AiRecognitionTaskFaceResultItemIntelligent face recognition result set.

    AiRecognitionTaskFaceSegmentItem

    Face recognition result segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a recognition segment in seconds.
    EndTimeOffsetFloatEnd time offset of a recognition segment in seconds.
    ConfidenceFloatConfidence of a recognition segment. Value range: 0-100.
    AreaCoordSetArray of IntegerZone 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: CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesIntelligent video recognition template ID.

    AiRecognitionTaskOcrFullTextResult

    Full text recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiRecognitionTaskOcrFullTextResultInputInput information of a full text recognition task.
    OutputAiRecognitionTaskOcrFullTextResultOutputOutput 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.

    NameTypeDescription
    DefinitionIntegerFull text recognition template ID.

    AiRecognitionTaskOcrFullTextResultOutput

    Output of full text recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    SegmentSetArray of AiRecognitionTaskOcrFullTextSegmentItemFull text recognition result set.

    AiRecognitionTaskOcrFullTextSegmentItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a recognition segment in seconds.
    EndTimeOffsetFloatEnd time offset of a recognition segment in seconds.
    TextSetArray of AiRecognitionTaskOcrFullTextSegmentTextItemRecognition segment result set.

    AiRecognitionTaskOcrFullTextSegmentTextItem

    Full text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatConfidence of a recognition segment. Value range: 0-100.
    AreaCoordSetArray of IntegerZone 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.
    TextStringRecognized text.

    AiRecognitionTaskOcrWordsResult

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiRecognitionTaskOcrWordsResultInputInput information of a text keyword recognition task.
    OutputAiRecognitionTaskOcrWordsResultOutputOutput 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.

    NameTypeDescription
    DefinitionIntegerText keyword recognition template ID.

    AiRecognitionTaskOcrWordsResultItem

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    WordStringText keyword.
    SegmentSetArray of AiRecognitionTaskOcrWordsSegmentItemList of segments that contain a text keyword.

    AiRecognitionTaskOcrWordsResultOutput

    Output of text keyword recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ResultSetArray of AiRecognitionTaskOcrWordsResultItemText keyword recognition result set.

    AiRecognitionTaskOcrWordsSegmentItem

    Text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a recognition segment in seconds.
    EndTimeOffsetFloatEnd time offset of a recognition segment in seconds.
    ConfidenceFloatConfidence of a recognition segment. Value range: 0-100.
    AreaCoordSetArray of IntegerZone 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.

    AiRecognitionTaskTransTextResult

    The translation result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value indicates the task has failed. For details, see Error Codes.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    MessageStringThe error message.
    InputAiRecognitionTaskTransTextResultInputThe input of the translation task.
    OutputAiRecognitionTaskTransTextResultOutputThe output of the translation task.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiRecognitionTaskTransTextResultInput

    The translation input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe translation template ID.

    AiRecognitionTaskTransTextResultOutput

    The translation result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    SegmentSetArray of AiRecognitionTaskTransTextSegmentItemThe translated segments.
    SubtitlePathStringThe subtitle URL.
    OutputStorageTaskOutputStorageThe subtitle storage location.

    AiRecognitionTaskTransTextSegmentItem

    The translated segments.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for a segment. Value range: 0-100.
    StartTimeOffsetFloatThe start time offset (seconds) of a segment.
    EndTimeOffsetFloatThe end time offset (seconds) of a segment.
    TextStringThe text transcript.
    TransStringThe translation.

    AiReviewPoliticalAsrTaskInput

    The input parameters for ASR-based detection of politically sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe template ID.

    AiReviewPoliticalAsrTaskOutput

    The information about the sensitive content detected based on ASR.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for the ASR-based detection of sensitive information. Value range: 0-100.
    SuggestionStringThe suggestion for handling the sensitive information detected based on ASR. Valid values:
  • pass
  • review
  • block
  • SegmentSetArray of MediaContentReviewAsrTextSegmentItemThe video segments that contain sensitive information detected based on ASR.

    AiReviewPoliticalOcrTaskInput

    The input parameters for OCR-based detection of politically sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe template ID.

    AiReviewPoliticalOcrTaskOutput

    The information about the sensitive content detected based on OCR.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for the OCR-based detection of sensitive information. Value range: 0-100.
    SuggestionStringThe suggestion for handling the sensitive information detected based on OCR. Valid values:
  • pass
  • review
  • block
  • SegmentSetArray of MediaContentReviewOcrTextSegmentItemThe video segments that contain sensitive information detected based on OCR.

    AiReviewPoliticalTaskInput

    The input parameters for the detection of politically sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe template ID.

    AiReviewPoliticalTaskOutput

    The sensitive information detected.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for the detection of sensitive information. Value range: 0-100.
    SuggestionStringThe suggestion for handling the sensitive information detected. Valid values:
  • pass
  • review
  • block
  • LabelStringThe labels for the detected sensitive content. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows:
    violation_photo:
  • violation_photo (banned icons)

  • Other values (politician/entertainment/sport/entrepreneur/scholar/celebrity/military):
  • politician
  • SegmentSetArray of MediaContentReviewPoliticalSegmentItemThe video segments that contain sensitive information.

    AiReviewPornAsrTaskInput

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerID of a porn information detection template.

    AiReviewPornAsrTaskOutput

    ASR-detected porn information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatScore of the ASR-detected porn information in text from 0 to 100.
    SuggestionStringSuggestion for the ASR-detected porn information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSetArray of MediaContentReviewAsrTextSegmentItemList 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.

    NameTypeDescription
    DefinitionIntegerID of a porn information detection template.

    AiReviewPornOcrTaskOutput

    OCR-detected porn information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatScore of the OCR-detected porn information in text from 0 to 100.
    SuggestionStringSuggestion for the OCR-detected porn information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSetArray of MediaContentReviewOcrTextSegmentItemList 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.

    NameTypeRequiredDescription
    DefinitionIntegerYesThe ID of a porn detection template.
    Note: This field may return·null, indicating that no valid values can be obtained.

    AiReviewPornTaskOutput

    Porn information detection result

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatScore of the detected porn information in video from 0 to 100.
    SuggestionStringSuggestion for the detected porn information. Valid values:
  • pass.
  • review.
  • block.
  • LabelStringTag of the detected porn information in video. Valid values:
  • porn: Porn.
  • sexy: Sexiness.
  • vulgar: Vulgarity.
  • intimacy: Intimacy.
  • SegmentSetArray of MediaContentReviewSegmentItemList 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.

    NameTypeDescription
    DefinitionIntegerProhibited information detection template ID.

    AiReviewProhibitedAsrTaskOutput

    ASR-detected prohibited information in speech

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatScore of ASR-detected prohibited information in speech between 0 and 100.
    SuggestionStringSuggestion for ASR-detected prohibited information in speech. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSetArray of MediaContentReviewAsrTextSegmentItemList 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.

    NameTypeDescription
    DefinitionIntegerProhibited information detection template ID.

    AiReviewProhibitedOcrTaskOutput

    OCR-detected prohibited information in text

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatScore of OCR-detected prohibited information in text between 0 and 100.
    SuggestionStringSuggestion for OCR-detected prohibited information in text. Valid values:
  • pass.
  • review.
  • block.
  • SegmentSetArray of MediaContentReviewOcrTextSegmentItemList of video segments that contain the OCR-detected prohibited information in text.

    AiReviewTaskPoliticalAsrResult

    The result of ASR-based detection of politically sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiReviewPoliticalAsrTaskInputThe input parameter for ASR-based detection of politically sensitive information.
    OutputAiReviewPoliticalAsrTaskOutputThe output of ASR-based detection of politically sensitive information.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPoliticalOcrResult

    The result of OCR-based detection of politically sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    Note: This field may return null, indicating that no valid values can be obtained.
    InputAiReviewPoliticalOcrTaskInputThe input parameter for OCR-based detection of politically sensitive information.
    OutputAiReviewPoliticalOcrTaskOutputThe output of OCR-based detection of politically sensitive information.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskPoliticalResult

    The result of sensitive information detection.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiReviewPoliticalTaskInputThe input parameter for sensitive information detection.
    OutputAiReviewPoliticalTaskOutputThe output of sensitive information detection.
    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.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiReviewPornAsrTaskInputInput for an ASR-based porn information detection in text task during content audit.
    OutputAiReviewPornAsrTaskOutputOutput 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.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiReviewPornOcrTaskInputInput for an OCR-based porn information detection in text task during content audit.
    OutputAiReviewPornOcrTaskOutputOutput 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.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    Note: This field may return null, indicating that no valid values can be obtained.
    InputAiReviewPornTaskInputInput for a porn information detection task during content audit.
    OutputAiReviewPornTaskOutputOutput 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.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError 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.
  • MessageStringError message.
    InputAiReviewProhibitedAsrTaskInputInput of ASR-based prohibited information detection in speech task in content audit
    OutputAiReviewProhibitedAsrTaskOutputOutput 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.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError 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.
  • MessageStringError message.
    InputAiReviewProhibitedOcrTaskInputInput of OCR-based prohibited information detection in text task in content audit
    OutputAiReviewProhibitedOcrTaskOutputOutput of OCR-based prohibited information detection in text task in content audit

    AiReviewTaskTerrorismOcrResult

    The result of OCR-based detection of terrorism content.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError 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.
  • MessageStringError message.
    InputAiReviewTerrorismOcrTaskInputThe input parameter for OCR-based detection of terrorism content.
    OutputAiReviewTerrorismOcrTaskOutputThe output of OCR-based detection of terrorism content.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTaskTerrorismResult

    The result of sensitive information detection.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAiReviewTerrorismTaskInputThe input parameter for sensitive information detection.
    OutputAiReviewTerrorismTaskOutputThe output of sensitive information detection.
    Note: This field may return null, indicating that no valid values can be obtained.

    AiReviewTerrorismOcrTaskInput

    The input parameter for OCR-based detection of sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe template ID.

    AiReviewTerrorismOcrTaskOutput

    The information about the sensitive content detected based on OCR.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for the OCR-based detection of sensitive information. Value range: 1-100.
    SuggestionStringThe suggestion for handling the sensitive information detected based on OCR. Valid values:
  • pass
  • review
  • block
  • SegmentSetArray of MediaContentReviewOcrTextSegmentItemThe video segments that contain sensitive information detected based on OCR.

    AiReviewTerrorismTaskInput

    The input parameter for the detection of sensitive information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerThe template ID.

    AiReviewTerrorismTaskOutput

    The information about the sensitive content detected.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score for the detection of sensitive information. Value range: 0-100.
    SuggestionStringThe suggestion for handling the sensitive information detected. Valid values:
  • pass
  • review
  • block
  • LabelStringThe labels for the detected sensitive content. Valid values:
  • guns
  • crowd
  • police
  • bloody
  • banners (sensitive flags)
  • militant
  • explosion
  • terrorists
  • scenario (sensitive scenes)
  • SegmentSetArray of MediaContentReviewSegmentItemThe video segments that contain sensitive information.

    AiSampleFaceInfo

    AI-based sample management - face information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

    NameTypeDescription
    FaceIdStringFace image ID.
    UrlStringFace image address.

    AiSampleFaceOperation

    AI-based sample management - face data operation.

    Used by actions: ModifyPersonSample.

    NameTypeRequiredDescription
    TypeStringYesOperation 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.
    FaceIdsArray of StringNoFace ID set. This field is required when Type is delete.
    FaceContentsArray of StringNoString 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.

    NameTypeDescription
    IndexIntegerCorresponds to incorrect image subscripts in the FaceContents input parameter, starting from 0.
    ErrCodeIntegerError code. Valid values:
  • 0: Succeeded;
  • Other values: Failed.
  • MessageStringError description.

    AiSamplePerson

    AI-based sample management - figure information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

    NameTypeDescription
    PersonIdStringFigure ID.
    NameStringName of a figure.
    DescriptionStringFigure description.
    FaceInfoSetArray of AiSampleFaceInfoFace information.
    TagSetArray of StringFigure tag.
    UsageSetArray of StringUse case.
    CreateTimeStringCreation time in ISO date format.
    UpdateTimeStringLast modified time in ISO date format.

    AiSampleTagOperation

    AI-based sample management - tag operation.

    Used by actions: ModifyPersonSample, ModifyWordSample.

    NameTypeRequiredDescription
    TypeStringYesOperation type. Valid values: add, delete, reset.
    TagsArray of StringYesTag. Length limit: 128 characters.

    AiSampleWord

    AI-based sample management - keyword output information.

    Used by actions: DescribeWordSamples.

    NameTypeDescription
    KeywordStringKeyword.
    TagSetArray of StringKeyword tag.
    UsageSetArray of StringKeyword use case.
    CreateTimeStringCreation time in ISO date format.
    UpdateTimeStringLast modified time in ISO date format.

    AiSampleWordInfo

    AI-based sample management - keyword input information.

    Used by actions: CreateWordSamples.

    NameTypeRequiredDescription
    KeywordStringYesKeyword. Length limit: 20 characters.
    TagsArray of StringNoKeyword tag
  • Array length limit: 20 tags;
  • Tag length limit: 128 characters.
  • AnimatedGraphicTaskInput

    Type of an animated image generating task.

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesAnimated image generating template ID.
    StartTimeOffsetFloatYesStart time of an animated image in a video in seconds.
    EndTimeOffsetFloatYesEnd time of an animated image in a video in seconds.
    OutputStorageTaskOutputStorageNoTarget 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.
    OutputObjectPathStringNoOutput 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.

    NameTypeDescription
    DefinitionIntegerUnique ID of an animated image generating template.
    TypeStringTemplate type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
  • NameStringName of an animated image generating template.
    CommentStringDescription of an animated image generating template.
    WidthIntegerMaximum 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.
    HeightIntegerMaximum 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.
    ResolutionAdaptiveStringResolution 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.
    FormatStringAnimated image format.
    FpsIntegerFrame rate.
    QualityFloatImage quality.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.

    ArtifactRepairConfig

    Artifact removal (smoothing) configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • weak
  • strong

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

    AsrFullTextConfigureInfo

    Control parameter of a full speech recognition task.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a full speech recognition task. Valid values:
  • ON: Enables an intelligent full speech recognition task;
  • OFF: Disables an intelligent full speech recognition task.
  • SubtitleFormatStringNoFormat 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.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a full speech recognition task. Valid values:
  • ON: Enables an intelligent full speech recognition task;
  • OFF: Disables an intelligent full speech recognition task.
  • SubtitleFormatStringNoFormat 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.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a speech keyword recognition task. Valid values:
  • ON: Enables a speech keyword recognition task;
  • OFF: Disables a speech keyword recognition task.
  • LabelSetArray of StringNoKeyword 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.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a speech keyword recognition task. Valid values:
  • ON: Enables a speech keyword recognition task;
  • OFF: Disables a speech keyword recognition task.
  • LabelSetArray of StringNoKeyword 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.

    AudioBeautifyConfig

    The audio improvement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypesArray of StringNoThe audio improvement options. You can specify multiple options. Valid values:
  • declick: Noise removal.
  • deesser: De-essing.

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

    AudioDenoiseConfig

    The noise reduction configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.

    AudioEnhanceConfig

    The audio enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    DenoiseAudioDenoiseConfigNoThe audio noise reduction configuration.
    Note: This field may return·null, indicating that no valid values can be obtained.
    SeparateAudioSeparateConfigNoThe audio separation configuration.
    Note: This field may return·null, indicating that no valid values can be obtained.
    VolumeBalanceVolumeBalanceConfigNoThe volume equalization configuration.
    Note: This field may return·null, indicating that no valid values can be obtained.
    BeautifyAudioBeautifyConfigNoThe audio improvement configuration.
    Note: This field may return·null, indicating that no valid values can be obtained.

    AudioSeparateConfig

    The audio separation configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe scenario. Valid values:
  • normal: Separate voice and background audio.
  • music: Separate vocals and instrumentals.

  • Default value: normal.
    Note: This field may return·null, indicating that no valid values can be obtained.
    TrackStringNoThe output audio track. Valid values:
  • vocal: Voice.
  • background: Output background audio if the scenario is normal, and output instrumentals if the scenario is music.

  • Default value: vocal.
    Note: This field may return·null, indicating that no valid values can be obtained.

    AudioTemplateInfo

    Audio stream configuration parameter

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    CodecStringYesAudio 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.
  • BitrateIntegerYesAudio 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.
    SampleRateIntegerYesAudio stream sample rate. Valid values:
  • 32,000
  • 44,100
  • 48,000

  • In Hz.
    AudioChannelIntegerNoAudio channel system. Valid values:
  • 1: Mono
  • 2: Dual
  • 6: Stereo

  • When the media is packaged in audio format (FLAC, OGG, MP3, M4A), the sound channel cannot be set to stereo.
    Default value: 2

    AudioTemplateInfoForUpdate

    Audio stream configuration parameter

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

    NameTypeRequiredDescription
    CodecStringNoAudio 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.
  • BitrateIntegerNoAudio 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.
    SampleRateIntegerNoAudio stream sample rate. Valid values:
  • 32,000
  • 44,100
  • 48,000

  • In Hz.
    AudioChannelIntegerNoAudio channel system. Valid values:
  • 1: Mono
  • 2: Dual
  • 6: Stereo

  • When the media is packaged in audio format (FLAC, OGG, MP3, M4A), the sound channel cannot be set to stereo.
    StreamSelectsArray of IntegerNoThe audio tracks to retain. All audio tracks are retained by default.

    AwsS3FileUploadTrigger

    An AWS S3 file upload trigger.

    Used by actions: CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow.

    NameTypeRequiredDescription
    S3BucketStringYesThe AWS S3 bucket bound to the scheme.
    S3RegionStringYesThe region of the AWS S3 bucket.
    DirStringNoThe bucket directory bound. It must be an absolute path that starts and ends with /, such as /movie/201907/. If you do not specify this, the root directory will be bound.
    FormatsArray of StringNoThe file formats that will trigger the scheme, such as ["mp4", "flv", "mov"]. If you do not specify this, the upload of files in any format will trigger the scheme.
    S3SecretIdStringNoThe key ID of the AWS S3 bucket.
    Note: This field may return null, indicating that no valid values can be obtained.
    S3SecretKeyStringNoThe key of the AWS S3 bucket.
    Note: This field may return null, indicating that no valid values can be obtained.
    AwsSQSAwsSQSNoThe SQS queue of the AWS S3 bucket.
    Note: The queue must be in the same region as the bucket.
    Note: This field may return null, indicating that no valid values can be obtained.

    AwsSQS

    The information of an AWS SQS queue.

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    SQSRegionStringYesThe region of the SQS queue.
    Note: This field may return·null, indicating that no valid values can be obtained.
    SQSQueueNameStringYesThe name of the SQS queue.
    Note: This field may return·null, indicating that no valid values can be obtained.
    S3SecretIdStringNoThe key ID required to read from/write to the SQS queue.
    Note: This field may return·null, indicating that no valid values can be obtained.
    S3SecretKeyStringNoThe key required to read from/write to the SQS queue.
    Note: This field may return·null, indicating that no valid values can be obtained.

    ClassificationConfigureInfo

    Control parameter of intelligent categorization task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

    NameTypeRequiredDescription
    SwitchStringNoSwitch of intelligent categorization task. Valid values:
  • ON: enables intelligent categorization task;
  • OFF: disables intelligent categorization task.
  • ColorEnhanceConfig

    Color enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • weak
  • normal
  • strong

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

    ComposeAudioItem

    The audio element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    SourceMediaComposeSourceMediaYesThe media information of the element.
    TrackTimeComposeTrackTimeNoThe time of the element in the timeline. If this is not specified, the element will follow the previous element.
    AudioOperationsArray of ComposeAudioOperationNoThe operations performed, such as muting.

    ComposeAudioOperation

    The audio operations of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TypeStringYesThe operation type. Valid values:
  • Volume: Volume adjustment.
  • VolumeFloatNoThe volume level. This parameter is valid if Type is Volume. Value range: 0–5.
  • If the parameter value is 0, the video will be muted.
  • If the parameter value is smaller than 1, the volume will be reduced.
  • If the parameter value is 1, the original volume will be kept.
  • If the parameter value is greater than 1, the volume will be increased.
  • ComposeAudioStream

    The audio stream information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    CodecStringNoThe codec of the audio stream. Valid values:
  • AAC: AAC (default), which is used for the MP4 container.
  • MP3: MP3 codec, which is used for the MP3 container.
  • SampleRateIntegerNoThe sample rate (Hz) of the audio stream.
  • 16000 (default)
  • 32000
  • 44100
  • 48000
  • AudioChannelIntegerNoThe number of sound channels. Valid values:
    u200c
  • 1: Mono.
  • 2: Dual (default).
  • ComposeCanvas

    The canvas information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    ColorStringNoThe RGB value of the background color. The format is #RRGGBB, such as #F0F0F0.
    Default value: #000000 (black).
    WidthIntegerNoThe canvas width (px), which is the width of the output video. Value range: 0–3840.
    The default value is 0, which means that the canvas is as wide as the first video.
    HeightIntegerNoThe canvas height (px), which is the height of the output video. Value range: 0–3840.
    The default value is 0, which means that the canvas is as high as the first video.

    ComposeEmptyItem

    The placeholder element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    DurationStringYesThe element duration.
  • The value of this parameter ends with s, which means seconds. For example, 3.5s indicates 3.5 seconds.
  • ComposeImageItem

    The image element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    SourceMediaComposeSourceMediaYesThe media information of the element.
    TrackTimeComposeTrackTimeNoThe time of the element in the timeline. If this is not specified, the element will follow the previous element.
    XPosStringNoThe horizontal distance of the element's center from the canvas origin. Two formats are supported:
  • If the value ends with %, it specifies the distance as a percentage of the canvas width. For example, 10% means that the distance is 10% of the canvas width.

  • u200c
  • If the value ends with px, it specifies the distance in pixels. For example, 100px means that the distance is 100 pixels.

  • Default value: 50%.
    YPosStringNoThe vertical distance of the element's center from the canvas origin. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the distance as a percentage of the canvas height. For example, 10% means that the distance is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the distance in pixels. For example, 100px means that the distance is 100 pixels.

  • Default value: 50%.
    WidthStringNoThe width of the video segment. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the width as a percentage of the canvas width. For example, 10% means that the video width is 10% of the canvas width.

  • u200c
  • If the value ends with px, it specifies the width in pixels. For example, 100px means that the video width is 100 pixels.

  • If one or both parameters are empty or set to 0:
  • If both Width and Height are empty, the original width and height of the element will be kept.
  • If Width is empty and Height is not, the width will be auto scaled.
  • If Width is not empty and Height is, the height will be auto scaled.
  • HeightStringNoThe height of the element. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the height as a percentage of the canvas height. For example, 10% means that the height is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the height in pixels. For example, 100px means that the height is 100 pixels.

  • If one or both parameters are empty or set to 0:
  • If both Width and Height are empty, the original width and height of the video will be kept.
  • If Width is empty and Height is not, the width will be auto scaled.
  • If Width is not empty and Height is, the height will be auto scaled.
  • ImageOperationsArray of ComposeImageOperationNoThe image operations, such as image rotation.

    ComposeImageOperation

    The image operations of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TypeStringYesThe type. Valid values:
    u200c
  • Rotate: Image rotation.
  • Flip: Image flipping.
  • RotateAngleFloatNoThis is valid if Type is Rotate. The angle of rotation around the image center. Value range: 0–360.
    FlipTypeStringNoThis is valid if Type is Flip. How to flip the image. Valid values:xa0
    u200c
  • Horizental: Flip horizontally.
  • Vertical: Flip vertically.
  • ComposeMediaConfig

    The information of a video editing/compositing task.

    The figure below outlines the relationships among tracks, elements, and the timeline.

    image

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TargetInfoComposeTargetInfoNoThe information of the output video.
    CanvasComposeCanvasNoThe canvas information of the output video.
    StylesArray of ComposeStylesNoThe global styles. This parameter is used together with Tracks to specify styles, such as the subtitle style.
    TracksArray of ComposeMediaTrackNoThe information of media tracks (consisting of video, audio, image, and text elements) used to composite the video. About tracks and the timeline:
    • The timeline of a track is the same as the timeline of the output video.
    • The elements of different tracks are overlaid at the same time point in the timeline.
      • Video, image, and text elements are overlaid according to their track number, with the first track on top.
      • Audio elements are mixed.
    Note: The different elements of the same track cannot be overlaid (except subtitles).

    ComposeMediaItem

    The element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TypeStringYesThe element type. Valid values:
  • Video
  • Audio
  • Image
  • Transition
  • Subtitle
  • Empty
  • VideoComposeVideoItemNoThe information of the video element, which is valid if Type is Video.
    AudioComposeAudioItemNoThe information of the audio element, which is valid if Type is Audio.
    ImageComposeImageItemNoThe information of the image element, which is valid if Type is Image.
    TransitionComposeTransitionItemNoThe information of the transition element, which is valid if Type is Transition.
    SubtitleComposeSubtitleItemNoThe information of the subtitle element, which is valid if Type is Subtitle.
    EmptyComposeEmptyItemNoThe information of the empty element, which is valid if Type is Empty. An empty element is used as a placeholder in the timeline.

    ComposeMediaTrack

    The track information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TypeStringYesThe track type. Valid values:
    • Video: Video track. A video track can consist of the following elements:
      • Video
      • Image
      • Transition
      • Empty
    • Audio: Audio track. An audio track can consist of the following elements:
      • Audio
      • Transition
      • Empty
    • Title: Text track. A text track can consist of the following elements:
      • Subtitle
    ItemsArray of ComposeMediaItemYesThe elements of a track.

    ComposeSourceMedia

    The material source of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    FileIdStringYesThe material ID, which can be found in FileInfos.
    StartTimeStringNoThe start time of the material. The following two formats are supported.
  • If the value of this parameter ends with s, it specifies the time in seconds. For example, 3.5s indicates the time when 3.5 seconds of the material elapses.

  • u200c
  • If the value of this parameter ends with %, it specifies the time as a percentage of the material's duration. For example, 10% indicates the time when 10% of the material's duration elapses.

  • Default value: 0s.
    EndTimeStringNoThe end time of the material. This parameter and StartTime determine which time segment of the material is used. The following two formats are supported:
  • If the value of this parameter ends with s, it specifies the time in seconds. For example, 3.5s indicates the time when 3.5 seconds of the material elapses.

  • u200c
  • If the value of this parameter ends with %, it specifies the time as a percentage of the material's duration. For example, 10% indicates the time when 10% of the material's duration elapses.

  • If the track duration is set, the default value is StartTime plus the track duration. If not, the default value is StartTime plus 1 second.
    Note: EndTime must be at least 0.02 seconds later than StartTime.

    ComposeStyles

    The style information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    IdStringYesThe style ID, which identifies an element style.
    Note: The style ID can be up to 32 characters long and can contain letters, digits, and special characters -_
    TypeStringYesThe type. Valid values:
  • Subtitle: The subtitle style.
  • SubtitleComposeSubtitleStyleNoThe subtitle style details. This parameter is valid if Type is Subtitle.

    ComposeSubtitleItem

    The subtitle element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    StyleIdStringYesThe subtitle style ID, which corresponds to the Id field of ComposeStyles.
    TextStringYesThe subtitle text.
    TrackTimeComposeTrackTimeNoThe time of the element in the timeline. If this is not specified, the element will follow the previous element.

    ComposeSubtitleStyle

    The subtitle style of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    HeightStringNoThe subtitle height. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the height as a percentage of the canvas height. For example, 10% means that the height is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the height in pixels. For example, 100px means that the height is 100 pixels.

  • The default value is the value of FontSize.
    MarginBottomStringNoThe bottom margin. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the margin as a percentage of the canvas height. For example, 10% means that the margin is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the margin in pixels. For example, 100px means that the margin is 100 pixels.

  • Default value: 0px.
    FontTypeStringNoThe font type. Valid values:
  • SimHei(default): Chinese font Heiti.

  • SimSun: Chinese font Songti.
  • FontSizeStringNoThe font size. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the size as a percentage of the canvas height. For example, 10% means that the size is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the size in pixels. For example, 100px means that the size is 100 pixels.

  • Default value: 2%.
    FontBoldIntegerNoWhether to bold the text (some fonts may not support bold). Valid values:
  • 0 (default): No.
  • 1: Yes.
  • FontItalicIntegerNoWhether to italicize the text (some fonts may not support italics). Valid values:
  • 0 (default): No.
  • 1: Yes.
  • FontColorStringNoThe font color (#RRGGBBAA).
    Default value: 0x000000FF (black).
    Note: AA in the color notation defines the opacity of the color. It's optional.
    FontAlignStringNoThe text alignment. Valid values:
  • Center(default)
  • Left
  • Right
  • FontAlignMarginStringNoThe margin for left/right align.
  • If FontAlign is Left, this parameter specifies the left margin of the subtitles.
  • If FontAlign is Right, this parameter specifies the right margin of the subtitles.

  • Two formats are supported:
    u200c
  • If the value ends with %, it specifies the margin as a percentage of the canvas width. For example, 10% means that the margin is 10% of the canvas width.

  • u200c
  • If the value ends with px, it specifies the margin in pixels. For example, 100px means that the margin is 100 pixels.
  • BorderWidthStringNoThe subtitle border width. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the width as a percentage of the canvas height. For example, 10% means that the width is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the width in pixels. For example, 100px means that the width is 100 pixels.

  • The default value is 0, which means the subtitles will have no borders.
    BorderColorStringNoThe border color, whose format is the same as that for FontColor. This parameter is valid if BorderWidth is not 0.
    BottomColorStringNoThe text background color, whose format is the same as that for FontColor.
    The default value is an empty string, which means the subtitles will not have a background color.

    ComposeTargetInfo

    The output video information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    ContainerStringNoThe container. Valid values:
  • mp4 (default), for video files.
  • mp3, for audio files.
  • RemoveVideoIntegerNoWhether to remove video data. Valid values:
  • 0 (default): No.
  • 1: Yes.
  • RemoveAudioIntegerNoWhether to remove audio data. Valid values:
  • 0 (default): No.
  • 1: Yes.
  • VideoStreamComposeVideoStreamNoThe information of the output video stream.
    AudioStreamComposeAudioStreamNoThe information of the output audio stream.

    ComposeTrackTime

    The time information of an element on the output video track of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    StartStringNoThe time when the element starts on the track.
  • The value of this parameter ends with s, which means seconds. For example, 3.5s indicates the time when 3.5 seconds of the video elapses.

  • Note: If this parameter is not specified, the start time will be the end time of the previous element. Therefore, you can also use the placeholder parameter ComposeEmptyItem to configure the start time.
    DurationStringNoThe element duration.
  • The value of this parameter ends with s, which means seconds. For example, 3.5s means 3.5 seconds.

  • The default value is the material duration, which is determined by EndTime and StartTime of ComposeSourceMedia. If ComposeSourceMedia is not specified, the duration will be 1 second.

    ComposeTransitionItem

    The transition element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    DurationStringNoThe element duration.
  • The value of this parameter ends with s, which means seconds. For example, 3s indicates 3 seconds.

  • Default value: 1s.
    Note
  • The number before s must be an integer. Non-integers will be rounded down to the nearest integer.
  • The transition element must be between two non-empty elements.
  • The duration of the transition element must be shorter than that of the preceding element and the following element.

  • u200c
  • The start time of the following element on the track will be automatically changed to the end time of the preceding element minus the duration of the transition element.
  • TransitionsArray of ComposeTransitionOperationNoThe transition effects.
    The default transition effect is fade.
    Note: You can add at most one image transition and one audio transition.

    ComposeTransitionOperation

    The transition information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    TypeStringYesThe transition type.

    The image transition, which connects two video segments.
  • ImageFadeInFadeOut

  • u200c
  • BowTieHorizontal

  • u200c
  • BowTieVertical

  • u200c
  • ButterflyWaveScrawler
  • Cannabisleaf
  • Circle
  • CircleCrop

  • u200c
  • Circleopen
  • Crosswarp
  • Cube
  • DoomScreenTransition
  • Doorway
  • Dreamy
  • DreamyZoom
  • FilmBurn
  • GlitchMemories
  • Heart
  • InvertedPageCurl
  • Luma
  • Mosaic
  • Pinwheel
  • PolarFunction
  • PolkaDotsCurtain
  • Radial
  • RotateScaleFade
  • Squeeze
  • Swap
  • Swirl
  • UndulatingBurnOutSwirl
  • Windowblinds
  • WipeDown
  • WipeLeft
  • WipeRight
  • WipeUp
  • ZoomInCircles

  • The audio transition, which connects two audio segments.
  • AudioFadeInFadeOut
  • ComposeVideoItem

    The video element information of a video editing/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    SourceMediaComposeSourceMediaYesThe media information of the element.
    TrackTimeComposeTrackTimeNoThe time of the element in the timeline. If this is not specified, the element will follow the previous element.
    XPosStringNoThe horizontal distance of the element's center from the canvas origin. Two formats are supported:
  • If the value ends with %, it specifies the distance as a percentage of the canvas width. For example, 10% means that the distance is 10% of the canvas width.

  • u200c
  • If the value ends with px, it specifies the distance in pixels. For example, 100px means that the distance is 100 pixels.

  • Default value: 50%.
    YPosStringNoThe vertical distance of the element's center from the canvas origin. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the distance as a percentage of the canvas height. For example, 10% means that the distance is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the distance in pixels. For example, 100px means that the distance is 100 pixels.

  • Default value: 50%.
    WidthStringNoThe width of the video segment. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the width as a percentage of the canvas width. For example, 10% means that the video width is 10% of the canvas width.

  • u200c
  • If the value ends with px, it specifies the width in pixels. For example, 100px means that the video width is 100 pixels.

  • If one or both parameters are empty or set to 0:
  • If both Width and Height are empty, the original width and height of the element will be kept.
  • If Width is empty and Height is not, the width will be auto scaled.
  • If Width is not empty and Height is, the height will be auto scaled.
  • HeightStringNoThe height of the element. Two formats are supported:
    u200c
  • If the value ends with %, it specifies the height as a percentage of the canvas height. For example, 10% means that the height is 10% of the canvas height.

  • u200c
  • If the value ends with px, it specifies the height in pixels. For example, 100px means that the height is 100 pixels.

  • If one or both parameters are empty or set to 0:
  • If both Width and Height are empty, the original width and height of the element will be kept.
  • If Width is empty and Height is not, the width will be auto scaled.
  • If Width is not empty and Height is, the height will be auto scaled.
  • ImageOperationsArray of ComposeImageOperationNoThe image operations, such as image rotation.
    AudioOperationsArray of ComposeAudioOperationNoThe audio operations, such as muting.

    ComposeVideoStream

    The video stream information of a video edit/compositing task.

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    CodecStringNoThe codec. Valid values:
  • H.264 (default)
  • FpsIntegerNoThe video frame rate (Hz). Value range: 0–60.
    The default value is 0, which means that the frame rate will be the same as that of the first video.

    ContentReviewTemplateItem

    Details of a content audit template

    Used by actions: DescribeContentReviewTemplates.

    NameTypeDescription
    DefinitionIntegerUnique ID of a content audit template.
    NameStringName of a content audit template. Length limit: 64 characters.
    CommentStringDescription of a content audit template. Length limit: 256 characters.
    PornConfigurePornConfigureInfoPorn information detection control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    TerrorismConfigureTerrorismConfigureInfoThe parameters for detecting sensitive information.
    Note: This field may return null, indicating that no valid values can be obtained.
    PoliticalConfigurePoliticalConfigureInfoThe parameters for detecting sensitive information.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProhibitedConfigureProhibitedConfigureInfoControl 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.
    UserDefineConfigureUserDefineConfigureInfoCustom content audit control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    TypeStringThe template type. Valid values:
    * Preset
    * Custom
    Note: This field may return null, indicating that no valid values can be obtained.

    CosFileUploadTrigger

    Input rule bound to COS.

    Used by actions: CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow.

    NameTypeRequiredDescription
    BucketStringYesName of the COS bucket bound to a workflow, such as TopRankVideo-125xxx88.
    RegionStringYesRegion of the COS bucket bound to a workflow, such as ap-chongiqng.
    DirStringNoInput path directory bound to a workflow, such as /movie/201907/. If this parameter is left empty, the / root directory will be used.
    FormatsArray of StringNoFormat 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

    The information of the COS object to process.

    Used by actions: DescribeMediaMetaData, EditMedia, ProcessMedia.

    NameTypeRequiredDescription
    BucketStringYesThe COS bucket of the object to process, such as TopRankVideo-125xxx88.
    RegionStringYesThe region of the COS bucket, such as ap-chongqing.
    ObjectStringYesThe path of the object to process, such as /movie/201907/WildAnimal.mov.

    CosOutputStorage

    The information of the output COS object after media processing.

    Used by actions: CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessLiveStream, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    BucketStringNoThe bucket to which the output file of media processing is saved, such as TopRankVideo-125xxx88. If this parameter is left empty, the value of the upper layer will be inherited.
    RegionStringNoThe region of the output bucket, such as ap-chongqing. If this parameter is left empty, the value of the upper layer will be inherited.

    CoverConfigureInfo

    Control parameter of intelligent cover generating task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

    NameTypeRequiredDescription
    SwitchStringNoSwitch of intelligent cover generating task. Valid values:
  • ON: enables intelligent cover generating task;
  • OFF: disables intelligent cover generating task.
  • DrmInfo

    The DRM encryption details.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    TypeStringYesThe encryption type.
  • simpleaes: AES-128 encryption.

  • Note: This field may return·null, indicating that no valid values can be obtained.
    SimpleAesDrmSimpleAesDrmNoThe AES-128 encryption details.
    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, ParseNotification.

    NameTypeRequiredDescription
    InputInfoMediaInputInfoYesVideo input information.
    StartTimeOffsetFloatNoThe start offset (seconds) for video clipping. This parameter is valid for video clipping tasks.
    EndTimeOffsetFloatNoThe end offset (seconds) for video clipping. This parameter is valid for video clipping tasks.
    IdStringNoThe ID of the material associated with an element. This parameter is required for video compositing tasks.

    Note: The ID can be up to 32 characters long and can contain letters, digits, and special characters -_
    Note: This field may return·null, indicating that no valid values can be obtained.

    EditMediaOutputConfig

    Configuration for output files of video editing

    Used by actions: EditMedia.

    NameTypeRequiredDescription
    ContainerStringNoThe container. Valid values: mp4 (default), hls, mov, flv, avi.
    Note: This field may return·null, indicating that no valid values can be obtained.
    TypeStringNoThe clip mode. Valid values: normal (default), fast.
    Note: This field may return·null, indicating that no valid values can be obtained.

    EditMediaTask

    Video editing task information

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TaskIdStringTask ID.
    StatusStringTask status. Valid values:
  • PROCESSING: processing;
  • FINISH: completed.
  • ErrCodeIntegerError code
  • 0: success;
  • Other values: failure.
  • MessageStringError message.
    InputEditMediaTaskInputInput of video editing task.
    OutputEditMediaTaskOutputOutput of video editing task.

    EditMediaTaskInput

    Input of video editing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    FileInfoSetArray of EditMediaFileInfoInformation of input video file.

    EditMediaTaskOutput

    Output of video editing task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    OutputStorageTaskOutputStorageTarget storage of edited file.
    PathStringPath of edited video file.

    EnhanceConfig

    Audio/Video enhancement configuration.

    Used by actions: CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    VideoEnhanceVideoEnhanceConfigNoVideo enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioEnhanceAudioEnhanceConfigNoThe audio enhancement configuration.
    Note: This field may return·null, indicating that no valid values can be obtained.

    FaceConfigureInfo

    Control parameter of a face recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a face recognition task. Valid values:
  • ON: Enables an intelligent face recognition task;
  • OFF: Disables an intelligent face recognition task.
  • ScoreFloatNoFace recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0-100. Default value: 95.
    DefaultLibraryLabelSetArray of StringNoThe default face filter labels, which specify the types of faces to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • entertainment (people in the entertainment industry)
  • sport (sports celebrities)
  • politician
  • UserDefineLibraryLabelSetArray of StringNoCustom face tags for filter, which specify the face recognition results to return. If this parameter is not specified or left empty, the recognition results for all custom face tags are returned.
    Up to 100 tags are allowed, each containing no more than 16 characters.
    FaceLibraryStringNoFigure 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.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a face recognition task. Valid values:
  • ON: Enables an intelligent face recognition task;
  • OFF: Disables an intelligent face recognition task.
  • ScoreFloatNoFace recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0-100.
    DefaultLibraryLabelSetArray of StringNoThe default face filter labels, which specify the types of faces to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • entertainment (people in the entertainment industry)
  • sport (sports celebrities)
  • politician
  • UserDefineLibraryLabelSetArray of StringNoCustom face tags for filter, which specify the face recognition results to return. If this parameter is not specified or left empty, the recognition results for all custom face tags are returned.
    Up to 100 tags are allowed, each containing no more than 16 characters.
    FaceLibraryStringNoFigure library. Valid values:
  • Default: Default figure library;
  • UserDefine: Custom figure library.
  • All: Both default and custom figure libraries will be used.
  • FaceEnhanceConfig

    Face enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    IntensityFloatNoThe strength. Value range: 0.0-1.0
    Default value: 0.0.
    Note: This field may return null, indicating that no valid values can be obtained.

    FrameRateConfig

    Frame interpolation configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    FpsIntegerNoThe frame rate (Hz). Value range: [0, 100].
    Default value: 0.
    Note: For transcoding, this parameter will overwrite Fps of VideoTemplate.
    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.

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

    NameTypeRequiredDescription
    SwitchStringNoSwitch of intelligent frame-specific tagging task. Valid values:
  • ON: enables intelligent frame-specific tagging task;
  • OFF: disables intelligent frame-specific tagging task.
  • HdrConfig

    HDR configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • HDR10
  • HLG

  • Default value: HDR10.
    Note: The video codec must be libx265.
    Note: The bit depth for video encoding is 10 bits.
    Note: This field may return null, indicating that no valid values can be obtained.

    HeadTailParameter

    Opening and closing credits parameters

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    HeadSetArray of MediaInputInfoNoThe opening segments.
    Note: This field may return·null, indicating that no valid values can be obtained.
    TailSetArray of MediaInputInfoNoThe closing segments.
    Note: This field may return·null, indicating that no valid values can be obtained.

    HighlightSegmentItem

    The information of a highlight segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceFloatThe confidence score.
    StartTimeOffsetFloatThe start time offset of the segment.
    EndTimeOffsetFloatThe end time offset of the segment.

    ImageQualityEnhanceConfig

    Overall enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • weak
  • normal
  • strong

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

    ImageSpriteTaskInput

    Input parameter type of an image sprite generating task

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesID of an image sprite generating template.
    OutputStorageTaskOutputStorageNoTarget 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.
    OutputObjectPathStringNoOutput 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}.
    WebVttObjectNameStringNoOutput 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}.
    ObjectNumberFormatNumberFormatNoRule 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.

    NameTypeDescription
    DefinitionIntegerUnique ID of an image sprite generating template.
    TypeStringTemplate type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
  • NameStringName of an image sprite generating template.
    WidthIntegerSubimage width of an image sprite.
    HeightIntegerSubimage height of an image sprite.
    ResolutionAdaptiveStringResolution 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.
    SampleTypeStringSampling type.
    SampleIntervalIntegerSampling interval.
    RowCountIntegerSubimage row count of an image sprite.
    ColumnCountIntegerSubimage column count of an image sprite.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    FillTypeStringFill 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.
    CommentStringTemplate description.
    FormatStringThe image format.

    ImageWatermarkInput

    Input parameter of an image watermarking template

    Used by actions: CreateWatermarkTemplate.

    NameTypeRequiredDescription
    ImageContentStringYesString generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
    WidthStringNoWatermark 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%.
    HeightStringNoWatermark 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.
    RepeatTypeStringNoRepeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
  • ImageWatermarkInputForUpdate

    Input parameter of an image watermarking template

    Used by actions: ModifyWatermarkTemplate.

    NameTypeRequiredDescription
    ImageContentStringNoString generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
    WidthStringNoWatermark 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].
  • HeightStringNoWatermark 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.
    RepeatTypeStringNoRepeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
  • ImageWatermarkTemplate

    Image watermarking template

    Used by actions: DescribeWatermarkTemplates.

    NameTypeDescription
    ImageUrlStringWatermark image address.
    WidthStringWatermark 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.
  • HeightStringWatermark 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.
    RepeatTypeStringRepeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
  • LiveActivityResItem

    The output of a live scheme subtask.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    LiveRecordTaskLiveScheduleLiveRecordTaskResultThe output of a live recording task.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveActivityResult

    The output of a live scheme subtask.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    ActivityTypeStringThe task type.
  • LiveRecord: Live recording.

  • Note: This field may return·null, indicating that no valid values can be obtained.
    LiveActivityResItemLiveActivityResItemThe task output.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveRecordFile

    The information of a live recording file.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    UrlStringThe URL of the recording file.
    Note: This field may return·null, indicating that no valid values can be obtained.
    SizeIntegerThe size of the recording file.
    Note: This field may return·null, indicating that no valid values can be obtained.
    DurationIntegerThe duration of the recording file.
    Note: This field may return·null, indicating that no valid values can be obtained.
    StartTimeStringThe recording start time in ISO date format.
    Note: This field may return·null, indicating that no valid values can be obtained.
    EndTimeStringThe recording end time in ISO date format.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveRecordResult

    The live recording result.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    OutputStorageTaskOutputStorageThe storage of the recording file.
    Note: This field may return·null, indicating that no valid values can be obtained.
    FileListArray of LiveRecordFileThe recording segments.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveRecordTaskInput

    The input parameters of a live recording task.

    Used by actions: DescribeTaskDetail.

    NameTypeRequiredDescription
    DefinitionIntegerYesThe live recording template ID.
    OutputStorageTaskOutputStorageNoThe storage of the recording file. If this parameter is left empty, the OutputStorage value of the parent folder will be inherited.
    Note: This field may return·null, indicating that no valid values can be obtained.
    OutputObjectPathStringNoThe output path of the recording file.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveScheduleLiveRecordTaskResult

    The result of a live scheme's live recording task.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value indicates the task has failed. For details, see Error Codes.
    Note: This field may return·null, indicating that no valid values can be obtained.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    Note: This field may return·null, indicating that no valid values can be obtained.
    MessageStringThe error message.
    Note: This field may return·null, indicating that no valid values can be obtained.
    InputLiveRecordTaskInputThe input of a live recording task.
    Note: This field may return·null, indicating that no valid values can be obtained.
    OutputLiveRecordResultThe output of a live recording task.
    Note: This field may return·null, indicating that no valid values can be obtained.
    BeginProcessTimeStringThe time when the task was started, in ISO date format.
    Note: This field may return·null, indicating that no valid values can be obtained.
    FinishTimeStringThe time when the task was completed, in ISO date format.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveScheduleTask

    The information of a live scheme subtask.

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    TaskIdStringThe ID of a live scheme subtask.
    Note: This field may return·null, indicating that no valid values can be obtained.
    StatusStringThe task status. Valid values:
  • PROCESSING
  • FINISH

  • Note: This field may return·null, indicating that no valid values can be obtained.
    ErrCodeIntegerIf the value returned is not 0, there was a source error. If 0 is returned, refer to the error codes of the corresponding task type.
    Note: This field may return·null, indicating that no valid values can be obtained.
    MessageStringIf there was a source error, this parameter is the error message. For other errors, refer to the error messages of the corresponding task type.
    Note: This field may return·null, indicating that no valid values can be obtained.
    UrlStringThe URL of the live stream.
    Note: This field may return·null, indicating that no valid values can be obtained.
    LiveActivityResultSetArray of LiveActivityResultThe task output.
    Note: This field may return·null, indicating that no valid values can be obtained.

    LiveStreamAiRecognitionResultInfo

    Live stream AI recognition results

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    ResultSetArray of LiveStreamAiRecognitionResultItemContent recognition result list.

    LiveStreamAiRecognitionResultItem

    AI-based live stream recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    TypeStringThe result type. Valid values:
  • FaceRecognition: Face recognition
  • AsrWordsRecognition: Speech keyword recognition
  • OcrWordsRecognition: Text keyword recognition
  • AsrFullTextRecognition: Full speech recognition
  • OcrFullTextRecognition: Full text recognition
  • TransTextRecognition: Speech translation
  • FaceRecognitionResultSetArray of LiveStreamFaceRecognitionResultFace recognition result, which is valid when Type is
    FaceRecognition.
    AsrWordsRecognitionResultSetArray of LiveStreamAsrWordsRecognitionResultSpeech keyword recognition result, which is valid when Type is
    AsrWordsRecognition.
    OcrWordsRecognitionResultSetArray of LiveStreamOcrWordsRecognitionResultText keyword recognition result, which is valid when Type is
    OcrWordsRecognition.
    AsrFullTextRecognitionResultSetArray of LiveStreamAsrFullTextRecognitionResultFull speech recognition result, which is valid when Type is
    AsrFullTextRecognition.
    OcrFullTextRecognitionResultSetArray of LiveStreamOcrFullTextRecognitionResultFull text recognition result, which is valid when Type is
    OcrFullTextRecognition.
    TransTextRecognitionResultSetArray of LiveStreamTransTextRecognitionResultThe translation result. This parameter is valid only if Type is TransTextRecognition.

    LiveStreamAiReviewImagePoliticalResult

    The result of detecting sensitive information in live streaming videos.

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    StartPtsTimeFloatStart PTS time of a suspected segment in seconds.
    EndPtsTimeFloatEnd PTS time of a suspected segment in seconds.
    ConfidenceFloatThe confidence score for the detected sensitive segments.
    SuggestionStringSuggestion for porn information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
  • LabelStringThe labels for the detected sensitive information. Valid values:
  • politician
  • violation_photo (banned icons)
  • NameStringThe name of a sensitive person or banned icon.
    AreaCoordSetArray of IntegerThe pixel coordinates of the detected sensitive people or banned icons. The format is [x1, y1, x2, y2], which indicates the coordinates of the top-left and bottom-right corners.
    UrlStringURL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTimeStringExpiration 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.

    NameTypeDescription
    StartPtsTimeFloatStart PTS time of a suspected segment in seconds.
    EndPtsTimeFloatEnd PTS time of a suspected segment in seconds.
    ConfidenceFloatScore of a suspected porn segment.
    SuggestionStringSuggestion for porn information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
  • LabelStringTag of the detected porn information in video. Valid values:
  • porn: Porn.
  • sexy: Sexiness.
  • vulgar: Vulgarity.
  • intimacy: Intimacy.
  • UrlStringURL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTimeStringExpiration time of a suspected image URL in ISO date format.

    LiveStreamAiReviewImageTerrorismResult

    The result of detecting sensitive information in live streaming videos.

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    StartPtsTimeFloatStart PTS time of a suspected segment in seconds.
    EndPtsTimeFloatEnd PTS time of a suspected segment in seconds.
    ConfidenceFloatThe confidence score for the detected sensitive segments.
    SuggestionStringThe suggestion for handling the sensitive segments. Valid values:
  • pass
  • review
  • block
  • LabelStringThe labels for the detected sensitive content. Valid values:
  • guns
  • crowd
  • police
  • bloody
  • banners (sensitive flags)
  • militant
  • explosion
  • terrorists
  • UrlStringURL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTimeStringExpiration time of a suspected image URL in ISO date format.

    LiveStreamAiReviewResultInfo

    Result of AI-based live stream audit

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    ResultSetArray of LiveStreamAiReviewResultItemList of content audit results.

    LiveStreamAiReviewResultItem

    Result of AI-based live stream audit

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    TypeStringThe type of moderation result. Valid values:
  • ImagePorn
  • ImageTerrorism
  • ImagePolitical
  • VoicePorn
  • ImagePornResultSetArray of LiveStreamAiReviewImagePornResultResult of porn information detection in image, which is valid when Type is ImagePorn.
    ImageTerrorismResultSetArray of LiveStreamAiReviewImageTerrorismResultThe result of detecting sensitive information in images, which is valid if Type is ImageTerrorism.
    ImagePoliticalResultSetArray of LiveStreamAiReviewImagePoliticalResultThe result of detecting sensitive information in images, which is valid if Type is ImagePolitical.
    VoicePornResultSetArray of LiveStreamAiReviewVoicePornResultThe result for moderation of pornographic content in audio. This parameter is valid if Type is VoicePorn.

    LiveStreamAiReviewVoicePornResult

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

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    StartPtsTimeFloatStart PTS time of a suspected segment in seconds.
    EndPtsTimeFloatEnd PTS time of a suspected segment in seconds.
    ConfidenceFloatScore of a suspected porn segment.
    SuggestionStringSuggestion for porn information detection of a suspected segment. Valid values:
  • pass
  • review
  • block
  • LabelStringTag of the detected porn information in video. Valid values:
  • sexual_moan: Sexual moans.
  • LiveStreamAsrFullTextRecognitionResult

    ASR-based full live stream recognition

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    TextStringRecognized text.
    StartPtsTimeFloatStart PTS time of recognized segment in seconds.
    EndPtsTimeFloatEnd PTS time of recognized segment in seconds.
    ConfidenceFloatConfidence of recognized segment. Value range: 0–100.

    LiveStreamAsrWordsRecognitionResult

    AI-based ASR-based live streaming keyword recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    WordStringSpeech keyword.
    StartPtsTimeFloatStart PTS time of recognized segment in seconds.
    EndPtsTimeFloatEnd PTS time of recognized segment in seconds.
    ConfidenceFloatConfidence of recognized segment. Value range: 0–100.

    LiveStreamFaceRecognitionResult

    AI-based live streaming face recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    IdStringUnique ID of figure.
    NameStringFigure name.
    TypeStringFigure library type, indicating to which figure library the recognized figure belongs:
  • Default: default figure library
  • UserDefine: custom figure library
  • StartPtsTimeFloatStart PTS time of recognized segment in seconds.
    EndPtsTimeFloatEnd PTS time of recognized segment in seconds.
    ConfidenceFloatConfidence of recognized segment. Value range: 0–100.
    AreaCoordSetArray of IntegerZone 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.

    LiveStreamOcrFullTextRecognitionResult

    OCR-based full live stream recognition

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    TextStringSpeech text.
    StartPtsTimeFloatStart PTS time of recognized segment in seconds.
    EndPtsTimeFloatEnd PTS time of recognized segment in seconds.
    ConfidenceFloatConfidence of recognized segment. Value range: 0–100.
    AreaCoordSetArray of IntegerZone 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.

    LiveStreamOcrWordsRecognitionResult

    AI-based OCR-based live streaming keyword recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    WordStringText keyword.
    StartPtsTimeFloatStart PTS time of recognized segment in seconds.
    EndPtsTimeFloatEnd PTS time of recognized segment in seconds.
    ConfidenceFloatConfidence of recognized segment. Value range: 0–100.
    AreaCoordsArray of IntegerZone 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.

    LiveStreamProcessErrorInfo

    Information of a live stream processing error

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    ErrCodeIntegerError code:
  • 0: No error;
  • If this parameter is not 0, an error has occurred. Please see the error message (Message).
  • MessageStringError message.

    LiveStreamProcessTask

    Information of a live stream processing task

    Used by actions: DescribeTaskDetail.

    NameTypeDescription
    TaskIdStringThe media processing task ID.
    StatusStringTask flow status. Valid values:
  • PROCESSING: Processing;
  • FINISH: Completed.
  • ErrCodeIntegerError code. 0: success; other values: failure.
    MessageStringError message.
    UrlStringLive stream URL.

    LiveStreamTaskNotifyConfig

    Event notification configuration of a task.

    Used by actions: ProcessLiveStream.

    NameTypeRequiredDescription
    CmqModelStringNoCMQ model. There are two types: Queue and Topic. Currently, only Queue is supported.
    CmqRegionStringNoCMQ region, such as sh and bj.
    QueueNameStringNoThis parameter is valid when the model is Queue, indicating the name of the CMQ queue for receiving event notifications.
    TopicNameStringNoThis parameter is valid when the model is Topic, indicating the name of the CMQ topic for receiving event notifications.
    NotifyTypeStringNoThe notification type, CMQ by default. If this parameter is set to URL, HTTP callbacks are sent to the URL specified by NotifyUrl.

    Note: If you do not pass this parameter or pass in an empty string, CMQ will be used. To use a different notification type, specify this parameter accordingly.
    NotifyUrlStringNoHTTP callback URL, required if NotifyType is set to URL

    LiveStreamTransTextRecognitionResult

    The live stream translation result.

    Used by actions: ParseLiveStreamProcessNotification.

    NameTypeDescription
    TextStringThe text transcript.
    StartPtsTimeFloatThe PTS (seconds) of the start of a segment.
    EndPtsTimeFloatThe PTS (seconds) of the end of a segment.
    ConfidenceFloatThe confidence score for a segment. Value range: 0-100.
    TransStringThe translation.

    LowLightEnhanceConfig

    Low-light enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • normal

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

    MediaAiAnalysisClassificationItem

    Intelligent categorization result

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ClassificationStringName of intelligently generated category.
    ConfidenceFloatConfidence of intelligently generated category between 0 and 100.

    MediaAiAnalysisCoverItem

    Information of intelligently generated cover

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    CoverPathStringStorage path of intelligently generated cover.
    ConfidenceFloatConfidence of intelligently generated cover between 0 and 100.

    MediaAiAnalysisFrameTagItem

    Result information of intelligent frame-specific tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TagStringFrame-specific tag name.
    CategorySetArray of String
    ConfidenceFloatConfidence of intelligently generated frame-specific tag between 0 and 100.

    MediaAiAnalysisFrameTagSegmentItem

    List of frame-specific tag segments

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of frame-specific tag.
    EndTimeOffsetFloatEnd time offset of frame-specific tag.
    TagSetArray of MediaAiAnalysisFrameTagItemList of tags in time period.

    MediaAiAnalysisHighlightItem

    The information of intelligently generated highlight segments.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    HighlightPathStringThe URL of the highlight segments.
    CovImgPathStringThe URL of the thumbnail.
    ConfidenceFloatThe confidence score. Value range: 0-100.
    DurationFloatThe duration of the highlights.
    SegmentSetArray of HighlightSegmentItemA list of the highlight segments.

    MediaAiAnalysisTagItem

    Result information of intelligent tagging

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TagStringTag name.
    ConfidenceFloatConfidence of tag between 0 and 100.

    MediaAnimatedGraphicsItem

    Result information of an animated image generating task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StorageTaskOutputStorageStorage location of a generated animated image file.
    PathStringPath to a generated animated image file.
    DefinitionIntegerID of an animated image generating template. For more information, please see Animated Image Generating Parameter Template.
    ContainerStringAnimated image format, such as gif.
    HeightIntegerHeight of an animated image in px.
    WidthIntegerWidth of an animated image in px.
    BitrateIntegerBitrate of an animated image in bps.
    SizeIntegerSize of an animated image in bytes.
    Md5StringMD5 value of an animated image.
    StartTimeOffsetFloatStart time offset of an animated image in the video in seconds.
    EndTimeOffsetFloatEnd time offset of an animated image in the video in seconds.

    MediaAudioStreamItem

    Information of the audio stream in a VOD file

    Used by actions: DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    BitrateIntegerBitrate of an audio stream in bps.
    Note: This field may return null, indicating that no valid values can be obtained.
    SamplingRateIntegerSample rate of an audio stream in Hz.
    Note: This field may return null, indicating that no valid values can be obtained.
    CodecStringAudio stream codec, such as aac.
    Note: This field may return null, indicating that no valid values can be obtained.
    ChannelIntegerNumber of sound channels, e.g., 2
    Note: this field may return null, indicating that no valid value was found.

    MediaContentReviewAsrTextSegmentItem

    Suspected segment identified during ASR-based text audit during content audit

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a suspected segment in seconds.
    EndTimeOffsetFloatEnd time offset of a suspected segment in seconds.
    ConfidenceFloatConfidence of a suspected segment.
    SuggestionStringSuggestion for suspected segment audit. Valid values:
  • pass.
  • review.
  • block.
  • KeywordSetArray of StringList of suspected keywords.

    MediaContentReviewOcrTextSegmentItem

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

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a suspected segment in seconds.
    EndTimeOffsetFloatEnd time offset of a suspected segment in seconds.
    ConfidenceFloatConfidence of a suspected segment.
    SuggestionStringSuggestion for suspected segment audit. Valid values:
  • pass.
  • review.
  • block.
  • KeywordSetArray of StringList of suspected keywords.
    AreaCoordSetArray of IntegerZone coordinates (at the pixel level) of suspected text: [x1, y1, x2, y2], i.e., the coordinates of the top-left and bottom-right corners.
    UrlStringURL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTimeStringExpiration time of a suspected image URL in ISO date format.

    MediaContentReviewPoliticalSegmentItem

    The information about the sensitive segments detected.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a suspected segment in seconds.
    EndTimeOffsetFloatEnd time offset of a suspected segment in seconds.
    ConfidenceFloatThe confidence score for the detected sensitive segments.
    SuggestionStringThe suggestion for handling the sensitive segments. Valid values:
  • pass
  • review
  • block
  • NameStringThe name of a sensitive person or banned icon.
    LabelStringThe labels for the detected sensitive segments. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows:
    violation_photo:
  • violation_photo (banned icons)

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

  • entertainment:
  • sensitive_entertainment (sensitive people in the entertainment industry

  • sport:
  • sensitive_sport (sensitive sports celebrities)

  • entrepreneur:
  • sensitive_entrepreneur

  • scholar:
  • sensitive_scholar

  • celebrity:
  • sensitive_celebrity
  • historical_celebrity (sensitive historical figures)

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

    MediaContentReviewSegmentItem

    The information about the detected pornographic/sensitive segments.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StartTimeOffsetFloatStart time offset of a suspected segment in seconds.
    EndTimeOffsetFloatEnd time offset of a suspected segment in seconds.
    ConfidenceFloatScore of a suspected porn segment.
    LabelStringTag of porn information detection result of a suspected segment.
    SuggestionStringSuggestion for porn information detection of a suspected segment. Valid values:
  • pass.
  • review.
  • block.
  • UrlStringURL of a suspected image (which will not be permanently stored
    and will be deleted after PicUrlExpireTime).
    PicUrlExpireTimeStringExpiration time of a suspected image URL in ISO date format.

    MediaImageSpriteItem

    Image sprite information

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerImage sprite specification. For more information, please see Image Sprite Parameter Template.
    HeightIntegerSubimage height of an image sprite.
    WidthIntegerSubimage width of an image sprite.
    TotalCountIntegerTotal number of subimages in each image sprite.
    ImagePathSetArray of StringPath to each image sprite.
    WebVttPathStringPath to a 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.
    StorageTaskOutputStorageStorage location of an image sprite file.

    MediaInputInfo

    The information of the object to process.

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

    NameTypeRequiredDescription
    TypeStringYesThe input type. Valid values:
  • COS: A COS bucket address.
  • URL: A URL.
  • AWS-S3: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks.
  • CosInputInfoCosInputInfoNoThe information of the COS object to process. This parameter is valid and required when Type is COS.
    UrlInputInfoUrlInputInfoNoThe URL of the object to process. This parameter is valid and required when Type is URL.
    Note: This field may return null, indicating that no valid value can be obtained.
    S3InputInfoS3InputInfoNoThe information of the AWS S3 object processed. This parameter is required if Type is AWS-S3.
    Note: This field may return null, indicating that no valid value can be obtained.

    MediaMetaData

    Metadata of a VOD media file

    Used by actions: DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    SizeIntegerSize of an 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.
    ContainerStringContainer, such as m4a and mp4.
    Note: This field may return null, indicating that no valid values can be obtained.
    BitrateIntegerSum 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.
    HeightIntegerMaximum value of the height of a video stream in px.
    Note: This field may return null, indicating that no valid values can be obtained.
    WidthIntegerMaximum value of the width of a video stream in px.
    Note: This field may return null, indicating that no valid values can be obtained.
    DurationFloatVideo duration in seconds.
    Note: This field may return null, indicating that no valid values can be obtained.
    RotateIntegerSelected angle during video recording in degrees.
    Note: This field may return null, indicating that no valid values can be obtained.
    VideoStreamSetArray of MediaVideoStreamItemVideo stream information.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioStreamSetArray of MediaAudioStreamItemAudio stream information.
    Note: This field may return null, indicating that no valid values can be obtained.
    VideoDurationFloatVideo duration in seconds.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioDurationFloatAudio duration in seconds.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskAdaptiveDynamicStreamingResult

    Result type of adaptive bitrate streaming task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAdaptiveDynamicStreamingTaskInputInput of an adaptive bitrate streaming task.
    OutputAdaptiveDynamicStreamingInfoItemOutput of an adaptive bitrate streaming task.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskAnimatedGraphicResult

    Result type of an animated image generating task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputAnimatedGraphicTaskInputInput for an animated image generating task.
    OutputMediaAnimatedGraphicsItemOutput of an animated image generating task.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskImageSpriteResult

    Result type of an image sprite generating task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputImageSpriteTaskInputInput for an image sprite generating task.
    OutputMediaImageSpriteItemOutput of an image sprite generating task.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskInput

    The type of media processing task.

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

    NameTypeRequiredDescription
    TranscodeTaskSetArray of TranscodeTaskInputNoList of transcoding tasks.
    AnimatedGraphicTaskSetArray of AnimatedGraphicTaskInputNoList of animated image generating tasks.
    SnapshotByTimeOffsetTaskSetArray of SnapshotByTimeOffsetTaskInputNoList of time point screencapturing tasks.
    SampleSnapshotTaskSetArray of SampleSnapshotTaskInputNoList of sampled screencapturing tasks.
    ImageSpriteTaskSetArray of ImageSpriteTaskInputNoList of image sprite generating tasks.
    AdaptiveDynamicStreamingTaskSetArray of AdaptiveDynamicStreamingTaskInputNoList of adaptive bitrate streaming tasks.

    MediaProcessTaskResult

    Query result type of a task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TypeStringTask 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
  • TranscodeTaskMediaProcessTaskTranscodeResultQuery result of a transcoding task, which is valid when task type is Transcode.
    Note: This field may return null, indicating that no valid values can be obtained.
    AnimatedGraphicTaskMediaProcessTaskAnimatedGraphicResultQuery result of an 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.
    SnapshotByTimeOffsetTaskMediaProcessTaskSnapshotByTimeOffsetResultQuery result of a 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.
    SampleSnapshotTaskMediaProcessTaskSampleSnapshotResultQuery result of a 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.
    ImageSpriteTaskMediaProcessTaskImageSpriteResultQuery result of an 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.
    AdaptiveDynamicStreamingTaskMediaProcessTaskAdaptiveDynamicStreamingResultQuery result of an adaptive bitrate streaming task, which is valid if the task type is AdaptiveDynamicStreaming.
    Note: this field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskSampleSnapshotResult

    Result type of a sampled screencapturing task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    Note: This field may return null, indicating that no valid values can be obtained.
    InputSampleSnapshotTaskInputInput for a sampled screencapturing task.
    OutputMediaSampleSnapshotItemOutput of a sampled screencapturing task.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskSnapshotByTimeOffsetResult

    Result type of a time point screencapturing task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputSnapshotByTimeOffsetTaskInputInput for a time point screencapturing task.
    OutputMediaSnapshotByTimeOffsetItemOutput of a time point screencapturing task.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaProcessTaskTranscodeResult

    Result type of a transcoding task

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringTask status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task failed. For details, see Error Codes.
    ErrCodeIntegerError code. 0 indicates the task is successful; otherwise it is failed. This parameter is no longer recommended. Consider using the new error code parameter ErrCodeExt.
    MessageStringError message.
    InputTranscodeTaskInputInput for a transcoding task.
    OutputMediaTranscodeItemOutput of a transcoding task.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProgressIntegerTranscoding progress. Value range: 0-100
    Note: This field may return null, indicating that no valid value was found.

    MediaSampleSnapshotItem

    Information of a sampled screenshot

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerSampled screenshot specification ID. For more information, please see Sampled Screencapturing Parameter Template.
    SampleTypeStringSample type. Valid values:
  • Percent: Samples at the specified percentage interval.
  • Time: Samples at the specified time interval.
  • IntervalIntegerSampling 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.
  • StorageTaskOutputStorageStorage location of a generated screenshot file.
    ImagePathSetArray of StringList of paths to generated screenshots.
    WaterMarkDefinitionArray of IntegerList of watermarking template IDs if the screenshots are watermarked.

    MediaSnapshotByTimeOffsetItem

    Information of the time point screenshots in a VOD file

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    DefinitionIntegerSpecification of a time point screenshot. For more information, please see Parameter Template for Time Point Screencapturing.
    PicInfoSetArray of MediaSnapshotByTimePicInfoItemInformation set of screenshots of the same specification. Each element represents a screenshot.
    StorageTaskOutputStorageLocation of a time point screenshot file.

    MediaSnapshotByTimePicInfoItem

    Information of a time point screenshot

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TimeOffsetFloatThe timestamp (seconds) of the screenshot.
    PathStringPath to the screenshot.
    WaterMarkDefinitionArray of IntegerList of watermarking template IDs if the screenshots are watermarked.

    MediaTranscodeItem

    Transcoding information

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    OutputStorageTaskOutputStorageTarget bucket of an output file.
    PathStringPath to an output video file.
    DefinitionIntegerTranscoding specification ID. For more information, please see Transcoding Parameter Template.
    BitrateIntegerSum of the average bitrate of a video stream and that of an audio stream in bps.
    HeightIntegerMaximum value of the height of a video stream in px.
    WidthIntegerMaximum value of the width of a video stream in px.
    SizeIntegerTotal 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).
    DurationFloatVideo duration in seconds.
    ContainerStringContainer, such as m4a and mp4.
    Md5StringMD5 value of a video.
    AudioStreamSetArray of MediaAudioStreamItemAudio stream information.
    Note: This field may return null, indicating that no valid values can be obtained.
    VideoStreamSetArray of MediaVideoStreamItemVideo stream information.
    Note: This field may return null, indicating that no valid values can be obtained.

    MediaVideoStreamItem

    Information of the video stream in a VOD file

    Used by actions: DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    BitrateIntegerBitrate of a video stream in bps.
    Note: This field may return null, indicating that no valid values can be obtained.
    HeightIntegerHeight of a video stream in px.
    Note: This field may return null, indicating that no valid values can be obtained.
    WidthIntegerWidth of a video stream in px.
    Note: This field may return null, indicating that no valid values can be obtained.
    CodecStringVideo stream codec, such as h264.
    Note: This field may return null, indicating that no valid values can be obtained.
    FpsIntegerFrame rate in Hz.
    Note: This field may return null, indicating that no valid values can be obtained.
    ColorPrimariesStringColor primaries
    Note: this field may return null, indicating that no valid value was found.
    ColorSpaceStringColor space
    Note: this field may return null, indicating that no valid value was found.
    ColorTransferStringColor transfer
    Note: this field may return null, indicating that no valid value was found.
    HdrTypeStringHDR type
    Note: This field may return null, indicating that no valid value was found.

    MosaicInput

    The mosaic effect parameters to use in a media processing task.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    CoordinateOriginStringNoOrigin 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.
    XPosStringNoThe 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.
    YPosStringNoVertical 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.
    WidthStringNoBlur 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%.
    HeightStringNoBlur 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%.
    StartTimeOffsetFloatNoStart 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.
  • EndTimeOffsetFloatNoEnd 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.
  • NumberFormat

    Rule of the {number} variable in the output file name.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    InitialValueIntegerNoStart value of the {number} variable. Default value: 0.
    IncrementIntegerNoIncrement of the {number} variable. Default value: 1.
    MinLengthIntegerNoMinimum length of the {number} variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1.
    PlaceHolderStringNoPlaceholder used when the {number} variable length is below the minimum requirement. Default value: 0.

    OcrFullTextConfigureInfo

    Control parameter of a full text recognition task

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a full text recognition task. Valid values:
  • ON: Enables an intelligent full text recognition task;
  • OFF: Disables an intelligent full text recognition task.
  • OcrFullTextConfigureInfoForUpdate

    Control parameter of a full text recognition task

    Used by actions: ModifyAIRecognitionTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a full text recognition task. Valid values:
  • ON: Enables an intelligent full text recognition task;
  • OFF: Disables an intelligent full text recognition task.
  • OcrWordsConfigureInfo

    Text keyword recognition control parameter.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a text keyword recognition task. Valid values:
  • ON: Enables a text keyword recognition task;
  • OFF: Disables a text keyword recognition task.
  • LabelSetArray of StringNoKeyword filter tag, which specifies the keyword tag that needs to be returned. If this parameter is left empty, all results will be returned.
    There can be up to 10 tags, each with a length limit of 16 characters.

    OcrWordsConfigureInfoForUpdate

    Text keyword recognition control parameter.

    Used by actions: ModifyAIRecognitionTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a text keyword recognition task. Valid values:
  • ON: Enables a text keyword recognition task;
  • OFF: Disables a text keyword recognition task.
  • LabelSetArray of StringNoKeyword 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.

    OverrideTranscodeParameter

    Custom specification parameters for video processing, which are used to override corresponding parameters in templates.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    ContainerStringNoContainer format. Valid values: mp4, flv, hls, mp3, flac, ogg, and m4a; mp3, flac, ogg, and m4a are formats of audio files.
    RemoveVideoIntegerNoWhether to remove video data. Valid values:
  • 0: retain
  • 1: remove
  • RemoveAudioIntegerNoWhether to remove audio data. Valid values:
  • 0: retain
  • 1: remove
  • VideoTemplateVideoTemplateInfoForUpdateNoVideo stream configuration parameter.
    AudioTemplateAudioTemplateInfoForUpdateNoAudio stream configuration parameter.
    TEHDConfigTEHDConfigForUpdateNoThe TSC transcoding parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubtitleTemplateSubtitleTemplateNoThe subtitle settings.
    Note: This field may return null, indicating that no valid values can be obtained.
    AddonAudioStreamArray of MediaInputInfoNoThe information of the external audio track to add.
    Note: This field may return null, indicating that no valid values can be obtained.
    StdExtInfoStringNoAn extended field for transcoding.
    Note: This field may return·null, indicating that no valid values can be obtained.
    AddOnSubtitlesArray of AddOnSubtitleNoThe subtitle file to add.
    Note: This field may return·null, indicating that no valid values can be obtained.

    PoliticalAsrReviewTemplateInfo

    The parameters for detecting sensitive information based on ASR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesWhether to detect sensitive information based on ASR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PoliticalAsrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on ASR.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to detect sensitive information based on ASR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PoliticalConfigureInfo

    The parameters for detecting sensitive information.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    ImgReviewInfoPoliticalImgReviewTemplateInfoNoThe parameters for detecting sensitive information in images.
    AsrReviewInfoPoliticalAsrReviewTemplateInfoNoThe parameters for detecting sensitive information based on ASR.
    OcrReviewInfoPoliticalOcrReviewTemplateInfoNoThe parameters for detecting sensitive information based on OCR.

    PoliticalConfigureInfoForUpdate

    The parameters for detecting sensitive information.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    ImgReviewInfoPoliticalImgReviewTemplateInfoForUpdateNoThe parameters for detecting sensitive information in images.
    AsrReviewInfoPoliticalAsrReviewTemplateInfoForUpdateNoThe parameters for detecting sensitive information based on ASR.
    OcrReviewInfoPoliticalOcrReviewTemplateInfoForUpdateNoThe parameters for detecting sensitive information based on OCR.

    PoliticalImgReviewTemplateInfo

    The parameters for detecting sensitive information in images.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesWhether to detect sensitive information in images. Valid values:
  • ON
  • OFF
  • LabelSetArray of StringNoThe filter labels for sensitive information detection in images, which specify the types of sensitive information to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • violation_photo (banned icons)
  • politician
  • entertainment (people in the entertainment industry)
  • sport (people in the sports industry)
  • entrepreneur
  • scholar
  • celebrity
  • military (people in military)
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PoliticalImgReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information in images.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to detect sensitive information in images. Valid values:
  • ON
  • OFF
  • LabelSetArray of StringNoThe filter labels for sensitive information detection in images, which specify the types of sensitive information to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • violation_photo (banned icons)
  • politician
  • entertainment (people in the entertainment industry)
  • sport (people in the sports industry)
  • entrepreneur
  • scholar
  • celebrity
  • military (people in military)
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PoliticalOcrReviewTemplateInfo

    The parameters for detecting sensitive information based on OCR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesWhether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PoliticalOcrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on OCR.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornAsrReviewTemplateInfo

    Control parameter of a porn information detection in speech task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a porn information detection in speech task. Valid values:
  • ON: Enables a porn information detection in speech task;
  • OFF: Disables a porn information detection in speech task.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PornAsrReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in speech task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a porn information detection in speech task. Valid values:
  • ON: Enables a porn information detection in speech task;
  • OFF: Disables a porn information detection in speech task.
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornConfigureInfo

    Control parameter of a porn information detection task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    ImgReviewInfoPornImgReviewTemplateInfoNoControl parameter of porn information detection in image.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrReviewInfoPornAsrReviewTemplateInfoNoControl parameter of porn information detection in speech.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrReviewInfoPornOcrReviewTemplateInfoNoControl parameter of porn information detection in text.
    Note: This field may return null, indicating that no valid values can be obtained.

    PornConfigureInfoForUpdate

    Control parameter of a porn information detection task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    ImgReviewInfoPornImgReviewTemplateInfoForUpdateNoControl parameter of porn information detection in image.
    AsrReviewInfoPornAsrReviewTemplateInfoForUpdateNoControl parameter of porn information detection in speech.
    OcrReviewInfoPornOcrReviewTemplateInfoForUpdateNoControl parameter of porn information detection in text.

    PornImgReviewTemplateInfo

    Control parameter of a porn information detection in image task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a porn information detection in image task. Valid values:
  • ON: Enables a porn information detection in image task;
  • OFF: Disables a porn information detection in image task.
  • LabelSetArray of StringNoFilter tag for porn information detection in 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.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PornImgReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in image task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a porn information detection in image task. Valid values:
  • ON: Enables a porn information detection in image task;
  • OFF: Disables a porn information detection in image task.
  • LabelSetArray of StringNoFilter tag for porn information detection in 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.
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornOcrReviewTemplateInfo

    Control parameter of a porn information detection in text task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a porn information detection in text task. Valid values:
  • ON: Enables a porn information detection in text task;
  • OFF: Disables a porn information detection in text task.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    PornOcrReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in text task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a porn information detection in text task. Valid values:
  • ON: Enables a porn information detection in text task;
  • OFF: Disables a porn information detection in text task.
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    ProhibitedAsrReviewTemplateInfo

    Control parameter of prohibited information detection in speech task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch 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.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    ProhibitedAsrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in speech task

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch 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.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    AsrReviewInfoProhibitedAsrReviewTemplateInfoNoControl parameter of prohibited information detection in speech.
    OcrReviewInfoProhibitedOcrReviewTemplateInfoNoControl parameter of prohibited information detection in text.

    ProhibitedConfigureInfoForUpdate

    Control parameter of prohibited information detection task

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    AsrReviewInfoProhibitedAsrReviewTemplateInfoForUpdateNoControl parameter of prohibited information detection in speech.
    OcrReviewInfoProhibitedOcrReviewTemplateInfoForUpdateNoControl parameter of prohibited information detection in text.

    ProhibitedOcrReviewTemplateInfo

    Control parameter of prohibited information detection in text task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch 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.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    ProhibitedOcrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in text task

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch 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.
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    QualityControlData

    The quality check output.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    NoAudioBooleanWhether there is an audio track. true indicates that there isn't.
    Note: This field may return null, indicating that no valid values can be obtained.
    NoVideoBooleanWhether there is a video track. true indicates that there isn't.
    Note: This field may return null, indicating that no valid values can be obtained.
    QualityEvaluationScoreIntegerThe no-reference video quality score. Value range: 0-100.
    Note: This field may return null, indicating that no valid values can be obtained.
    QualityControlResultSetArray of QualityControlResultThe issues detected by quality control.
    Note: This field may return null, indicating that no valid values can be obtained.

    QualityControlItem

    The information of a checked segment in quality control.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    ConfidenceIntegerThe confidence score. Value range: 0-100.
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTimeOffsetFloatThe start timestamp (second) of the segment.
    EndTimeOffsetFloatThe end timestamp (second) of the segment.
    AreaCoordSetArray of IntegerThe coordinates (px) of the top left and bottom right corner.
    Note: This field may return null, indicating that no valid values can be obtained.

    QualityControlResult

    The issues detected by quality control.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TypeStringThe issue type. Valid values:
    Jitter
    Blur
    LowLighting
    HighLighting (overexposure)
    CrashScreen (video corruption)
    BlackWhiteEdge
    SolidColorScreen (blank screen)
    Noise
    Mosaic (pixelation)
    QRCode
    AppletCode (Weixin Mini Program code)
    BarCode
    LowVoice
    HighVoice
    NoVoice
    LowEvaluation (low no-reference video quality score)
    QualityControlItemsArray of QualityControlItemThe information of a checked segment in quality control.

    RawImageWatermarkInput

    Input parameter of image watermark template

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    ImageContentMediaInputInfoYesInput content of watermark image. JPEG and PNG images are supported.
    WidthStringNoWatermark 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%.
    HeightStringNoWatermark height. % and px formats are supported:
  • If the string ends in %, the Height of the watermark will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height;
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px.

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

    Specifications for custom transcoding

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    ContainerStringYesContainer. Valid values: mp4; flv; hls; mp3; flac; ogg; m4a. Among them, mp3, flac, ogg, and m4a are for audio files.
    RemoveVideoIntegerNoWhether to remove video data. Valid values:
  • 0: retain;
  • 1: remove.

  • Default value: 0.
    RemoveAudioIntegerNoWhether to remove audio data. Valid values:
  • 0: retain;
  • 1: remove.

  • Default value: 0.
    VideoTemplateVideoTemplateInfoNoVideo stream configuration parameter. This field is required when RemoveVideo is 0.
    AudioTemplateAudioTemplateInfoNoAudio stream configuration parameter. This field is required when RemoveAudio is 0.
    TEHDConfigTEHDConfigNoTESHD transcoding parameter.

    RawWatermarkParameter

    Custom watermark specifications.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    TypeStringYesWatermark type. Valid values:
  • image: image watermark.
  • CoordinateOriginStringNoOrigin 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 watermark is in the top-left corner of the image or text.

  • Default value: TopLeft.
    XPosStringNoThe horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:
  • If the string ends in %, the XPos of the watermark 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 watermark will be the specified px; for example, 100px means that XPos is 100 px.

  • Default value: 0 px.
    YPosStringNoThe vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:
  • If the string ends in %, the YPos of the watermark 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 watermark will be the specified px; for example, 100px means that YPos is 100 px.

  • Default value: 0 px.
    ImageTemplateRawImageWatermarkInputNoImage watermark template. This field is required when Type is image and is invalid when Type is text.

    S3InputInfo

    The AWS S3 storage information of a source file.

    Used by actions: DescribeMediaMetaData, EditMedia, ProcessMedia.

    NameTypeRequiredDescription
    S3BucketStringYesThe AWS S3 bucket.
    S3RegionStringYesThe region of the AWS S3 bucket.
    S3ObjectStringYesThe path of the AWS S3 object.
    S3SecretIdStringNoThe key ID required to access the AWS S3 object.
    S3SecretKeyStringNoThe key required to access the AWS S3 object.

    S3OutputStorage

    The AWS S3 storage information of an output file.

    Used by actions: CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessLiveStream, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    S3BucketStringYesThe AWS S3 bucket.
    S3RegionStringYesThe region of the AWS S3 bucket.
    S3SecretIdStringNoThe key ID required to upload files to the AWS S3 object.
    S3SecretKeyStringNoThe key required to upload files to the AWS S3 object.

    SampleSnapshotTaskInput

    Input parameter type of a sampled screencapturing task.

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesSampled screencapturing template ID.
    WatermarkSetArray of WatermarkInputNoList of up to 10 image or text watermarks.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputStorageTaskOutputStorageNoTarget bucket of a sampled screenshot. 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.
    OutputObjectPathStringNoOutput path to a generated sampled screenshot, 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}_sampleSnapshot_{definition}_{number}.{format}.
    ObjectNumberFormatNumberFormatNoRule of the {number} variable in the sampled screenshot output path.
    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.

    NameTypeDescription
    DefinitionIntegerUnique ID of a sampled screencapturing template.
    TypeStringTemplate type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
  • NameStringName of a sampled screencapturing template.
    CommentStringTemplate description.
    WidthIntegerMaximum 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.
    HeightIntegerMaximum 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.
    ResolutionAdaptiveStringResolution 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.
    FormatStringImage format.
    SampleTypeStringSampled screencapturing type.
    SampleIntervalIntegerSampling interval.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    FillTypeStringFill 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.

    ScheduleAnalysisTaskResult

    The result of a content analysis task of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task has failed. For details, see Error Codes.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    MessageStringThe error message.
    InputAiAnalysisTaskInputThe input of the content analysis task.
    OutputArray of AiAnalysisResultThe output of the content analysis task.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScheduleQualityControlTaskResult

    The result of a quality control task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value indicates the task has failed. For details, see Error Codes.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    MessageStringThe error message.
    InputAiQualityControlTaskInputThe input of the quality control task.
    OutputQualityControlDataThe output of the quality control task.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScheduleRecognitionTaskResult

    The result of a content recognition task of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task has failed. For details, see Error Codes.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    MessageStringThe error message.
    InputAiRecognitionTaskInputThe input of the content recognition task.
    OutputArray of AiRecognitionResultThe output of the content recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScheduleReviewTaskResult

    The result of a content moderation task of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    StatusStringThe task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExtStringThe error code. An empty string indicates the task is successful; any other value returned indicates the task has failed. For details, see Error Codes.
    ErrCodeIntegerThe error code. 0 indicates the task is successful; other values indicate the task has failed. This parameter is not recommended. Please use ErrCodeExt instead.
    MessageStringThe error message.
    InputAiContentReviewTaskInputThe input of the content moderation task.
    OutputArray of AiContentReviewResultThe output of the content moderation task.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScheduleTask

    The information of a scheme.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TaskIdStringThe scheme ID.
    StatusStringThe scheme status. Valid values:
  • PROCESSING
  • FINISH
  • ErrCodeIntegerIf the value returned is not 0, there was a source error. If 0 is returned, refer to the error codes of the corresponding task type.
    MessageStringIf there was a source error, this parameter is the error message. For other errors, refer to the error messages of the corresponding task type.
    InputInfoMediaInputInfoThe information of the file processed.
    Note: This field may return null, indicating that no valid values can be obtained.
    MetaDataMediaMetaDataThe metadata of the source video.
    Note: This field may return null, indicating that no valid values can be obtained.
    ActivityResultSetArray of ActivityResultThe output of the scheme.
    Note: This field may return null, indicating that no valid values can be obtained.

    SchedulesInfo

    The details of a scheme.

    Used by actions: DescribeSchedules.

    NameTypeDescription
    ScheduleIdIntegerThe scheme ID.
    ScheduleNameStringThe scheme name.
    Note: This field may return null, indicating that no valid values can be obtained.
    TypeStringThe scheme type. Valid values:
  • Preset
  • Custom

  • Note: This field may return·null, indicating that no valid values can be obtained.
    StatusStringThe scheme status. Valid values:
    Enabled
    Disabled
    Note: This field may return null, indicating that no valid values can be obtained.
    TriggerWorkflowTriggerThe trigger of the scheme.
    Note: This field may return null, indicating that no valid values can be obtained.
    ActivitiesArray of ActivityThe subtasks of the scheme.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputStorageTaskOutputStorageThe bucket to save the output file.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputDirStringThe directory to save the output file.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskNotifyConfigTaskNotifyConfigThe notification configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTimeStringThe creation time in ISO date format.
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTimeStringThe last updated time in ISO date format.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScratchRepairConfig

    Banding removal configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    IntensityFloatNoThe strength. Value range: 0.0-1.0
    Default value: 0.0
    Note: This field may return null, indicating that no valid values can be obtained.

    SharpEnhanceConfig

    Detail enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    IntensityFloatNoThe strength. Value range: 0.0-1.0
    Default value: 0.0
    Note: This field may return null, indicating that no valid values can be obtained.

    SimpleAesDrm

    The AES-128 encryption details.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    UriStringYesThe URI of decryption key.
    Note: This field may return·null, indicating that no valid values can be obtained.
    KeyStringYesThe encryption key (a 32-byte string).
    Note: This field may return·null, indicating that no valid values can be obtained.
    VectorStringNoThe initialization vector for encryption (a 32-byte string).
    Note: This field may return·null, indicating that no valid values can be obtained.

    SnapshotByTimeOffsetTaskInput

    Input parameter type of a time point screencapturing task

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesID of a time point screencapturing template.
    ExtTimeOffsetSetArray of StringNoList of screenshot time points in the format of s or %:
  • If the string ends in s, it means that the time point is in seconds; for example, 3.5s means that the time point is the 3.5th second;
  • If the string ends in %, it means that the time point is the specified percentage of the video duration; for example, 10% means that the time point is 10% of the video duration.
  • TimeOffsetSetArray of FloatNoList of time points of screenshots in seconds.
    WatermarkSetArray of WatermarkInputNoList of up to 10 image or text watermarks.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputStorageTaskOutputStorageNoTarget bucket of a generated time point screenshot 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.
    OutputObjectPathStringNoOutput path to a generated time point screenshot, 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}_snapshotByTimeOffset_{definition}_{number}.{format}.
    ObjectNumberFormatNumberFormatNoRule of the {number} variable in the time point screenshot output path.
    Note: This field may return null, indicating that no valid values can be obtained.

    SnapshotByTimeOffsetTemplate

    Details of a time point screencapturing template.

    Used by actions: DescribeSnapshotByTimeOffsetTemplates.

    NameTypeDescription
    DefinitionIntegerUnique ID of a time point screencapturing template.
    TypeStringTemplate type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
  • NameStringName of a time point screencapturing template.
    CommentStringTemplate description.
    WidthIntegerMaximum 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.
    HeightIntegerMaximum 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.
    ResolutionAdaptiveStringResolution 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.
    FormatStringImage format.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    FillTypeStringFill 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.

    SubtitleTemplate

    The subtitle settings.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    PathStringNoThe URL of the subtitles to add to the video.
    Note: This field may return·null, indicating that no valid values can be obtained.
    StreamIndexIntegerNoThe subtitle track to add to the video. If both Path and StreamIndex are specified, Path will be used. You need to specify at least one of the two parameters.
    Note: This field may return·null, indicating that no valid values can be obtained.
    FontTypeStringNoThe font. Valid values:
  • hei.ttf: Heiti.
  • song.ttf: Songti.
  • simkai.ttf: Kaiti.
  • arial.ttf: Arial.

  • The default is hei.ttf.
    Note: This field may return·null, indicating that no valid values can be obtained.
    FontSizeStringNoThe font size (pixels). If this is not specified, the font size in the subtitle file will be used.
    Note: This field may return·null, indicating that no valid values can be obtained.
    FontColorStringNoThe font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    Note: This field may return·null, indicating that no valid values can be obtained.
    FontAlphaFloatNoThe text transparency. Value range: 0-1.
  • 0: Fully transparent.
  • 1: Fully opaque.

  • Default value: 1.
    Note: This field may return·null, indicating that no valid values can be obtained.

    SuperResolutionConfig

    Super resolution configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • lq: For low-resolution videos with obvious noise
  • hq: For high-resolution videos

  • Default value: lq.
    Note: This field may return null, indicating that no valid values can be obtained.
    SizeIntegerNoThe ratio of the target resolution to the original resolution. Valid values:
  • 2

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

    SvgWatermarkInput

    Input parameter of an SVG watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    NameTypeRequiredDescription
    WidthStringNoWatermark 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%.
    HeightStringNoWatermark 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 an SVG watermarking template

    Used by actions: ModifyWatermarkTemplate.

    NameTypeRequiredDescription
    WidthStringNoWatermark 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%.
    HeightStringNoWatermark 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.
  • TEHDConfig

    TESHD parameter configuration.

    Used by actions: CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    TypeStringYesTESHD type. Valid values:
  • TEHD-100: TESHD-100.

  • If this parameter is left empty, TESHD will not be enabled.
    MaxVideoBitrateIntegerNoMaximum bitrate, which is valid when Type is TESHD.
    If this parameter is left empty or 0 is entered, there will be no upper limit for bitrate.

    TEHDConfigForUpdate

    TESHD parameter configuration.

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

    NameTypeRequiredDescription
    TypeStringNoThe TSC type. Valid values:
  • TEHD-100: TSC-100 (video TSC).
  • TEHD-200: TSC-200 (audio TSC).

  • If this parameter is left blank, no modification will be made.
    Note: This field may return·null, indicating that no valid values can be obtained.
    MaxVideoBitrateIntegerNoThe maximum video bitrate. If this parameter is not specified, no modifications will be made.
    Note: This field may return·null, indicating that no valid values can be obtained.

    TagConfigureInfo

    Control parameter of intelligent tagging task

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

    NameTypeRequiredDescription
    SwitchStringNoSwitch of intelligent tagging task. Valid values:
  • ON: enables intelligent tagging task;
  • OFF: disables intelligent tagging task.
  • TaskNotifyConfig

    Event notification configuration of a task.

    Used by actions: CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    NotifyTypeStringNoThe notification type. Valid values:
  • CMQ: This value is no longer used. Please use TDMQ-CMQ instead.
  • TDMQ-CMQ: Message queue
  • URL: If NotifyType is set to URL, HTTP callbacks are sent to the URL specified by NotifyUrl. HTTP and JSON are used for the callbacks. The packet contains the response parameters of the ParseNotification API.
  • SCF: This notification type is not recommended. You need to configure it in the SCF console.
  • AWS-SQS: AWS queue. This type is only supported for AWS tasks, and the queue must be in the same region as the AWS bucket.

  • Note: If you do not pass this parameter or pass in an empty string, CMQ will be used. To use a different notification type, specify this parameter accordingly.
    NotifyModeStringNoWorkflow notification method. Valid values: Finish, Change. If this parameter is left empty, Finish will be used.
    NotifyUrlStringNoHTTP callback URL, required if NotifyType is set to URL
    CmqModelStringNoThe CMQ or TDMQ-CMQ model. Valid values: Queue, Topic.
    CmqRegionStringNoThe CMQ or TDMQ-CMQ region, such as sh (Shanghai) or bj (Beijing).
    TopicNameStringNoThe CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when CmqModel is Topic.
    QueueNameStringNoThe CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when CmqModel is Queue.
    AwsSQSAwsSQSNoThe AWS SQS queue. This parameter is required if NotifyType is AWS-SQS.

    Note: This field may return null, indicating that no valid values can be obtained.
    NotifyKeyStringNoThe key used to generate the callback signature.
    Note: This field may return·null, indicating that no valid values can be obtained.

    TaskOutputStorage

    The information of the media processing output object.

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

    NameTypeRequiredDescription
    TypeStringYesThe storage type for a media processing output file. Valid values:
  • COS: Tencent Cloud COS
  • >AWS-S3: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file.
  • CosOutputStorageCosOutputStorageNoThe location to save the output object in COS. This parameter is valid and required when Type is COS.
    Note: This field may return null, indicating that no valid value can be obtained.
    S3OutputStorageS3OutputStorageNoThe AWS S3 bucket to save the output file. This parameter is required if Type is AWS-S3.
    Note: This field may return null, indicating that no valid value can be obtained.

    TaskSimpleInfo

    Task overview information

    Used by actions: DescribeTasks.

    NameTypeDescription
    TaskIdStringTask ID.
    TaskTypeStringTask type. Valid values:
  • WorkflowTask: Workflow processing task;
  • LiveProcessTask: Live stream processing task.
  • CreateTimeStringCreation time of a task in ISO date format.
    BeginProcessTimeStringStart time of task execution in ISO date format. If the task has not been started yet, this field will be 0000-00-00T00:00:00Z.
    FinishTimeStringEnd time of a task in ISO date format. If the task has not been completed yet, this field will be 0000-00-00T00:00:00Z.
    SubTaskTypesArray of StringThe subtask type.

    TerrorismConfigureInfo

    The parameters for detecting sensitive information.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeDescription
    ImgReviewInfoTerrorismImgReviewTemplateInfoThe parameters for detecting sensitive information in images.
    OcrReviewInfoTerrorismOcrReviewTemplateInfoThe parameters for detecting sensitive information based on OCR.

    TerrorismConfigureInfoForUpdate

    The parameters for detecting sensitive information.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    ImgReviewInfoTerrorismImgReviewTemplateInfoForUpdateNoThe parameters for detecting sensitive information in images.
    OcrReviewInfoTerrorismOcrReviewTemplateInfoForUpdateNoThe parameters for detecting sensitive information based on OCR.

    TerrorismImgReviewTemplateInfo

    The parameters for detecting sensitive information in images.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesWhether to detect sensitive information in images. Valid values:
  • ON
  • OFF
  • LabelSetArray of StringNoThe filter labels for sensitive information detection in images, which specify the types of sensitive information to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • guns
  • crowd
  • bloody
  • police
  • banners (sensitive flags)
  • militant
  • explosion
  • terrorists
  • scenario (sensitive scenes)
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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, 80 will be used by default. Value range: 0-100.

    TerrorismImgReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information in images.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to detect sensitive information in images. Valid values:
  • ON
  • OFF
  • LabelSetArray of StringNoThe filter labels for sensitive information detection in images, which specify the types of sensitive information to return. If this parameter is left empty, the detection results for all labels are returned. Valid values:
  • guns
  • crowd
  • bloody
  • police
  • banners (sensitive flags)
  • militant
  • explosion
  • terrorists
  • scenario (sensitive scenes)
  • BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    TerrorismOcrReviewTemplateInfo

    The parameters for detecting sensitive information based on OCR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesWhether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    TerrorismOcrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on OCR.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
  • BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    TextWatermarkTemplateInput

    Text watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    NameTypeRequiredDescription
    FontTypeStringYesFont type. Currently, two types are supported:
  • simkai.ttf: Both Chinese and English are supported;
  • arial.ttf: Only English is supported.
  • FontSizeStringYesFont size in Npx format where N is a numeric value.
    FontColorStringYesFont color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlphaFloatYesText transparency. Value range: (0, 1]
  • 0: Completely transparent
  • 1: Completely opaque

  • Default value: 1.

    TextWatermarkTemplateInputForUpdate

    Text watermarking template

    Used by actions: ModifyWatermarkTemplate.

    NameTypeRequiredDescription
    FontTypeStringNoFont type. Currently, two types are supported:
  • simkai.ttf: Both Chinese and English are supported;
  • arial.ttf: Only English is supported.
  • FontSizeStringNoFont size in Npx format where N is a numeric value.
    FontColorStringNoFont color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlphaFloatNoText transparency. Value range: (0, 1]
  • 0: Completely transparent
  • 1: Completely opaque
  • TranscodeTaskInput

    Input parameter type of a transcoding task

    Used by actions: CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesID of a video transcoding template.
    RawParameterRawTranscodeParameterNoCustom video transcoding parameter, which is valid if Definition is 0.
    This parameter is used in highly customized scenarios. We recommend you use Definition to specify the transcoding parameter preferably.
    OverrideParameterOverrideTranscodeParameterNoVideo transcoding custom parameter, which is valid when Definition is not 0.
    When any parameters in this structure are entered, they will be used to override corresponding parameters in templates.
    This parameter is used in highly customized scenarios. We recommend you only use Definition to specify the transcoding parameter.
    Note: this field may return null, indicating that no valid value was found.
    WatermarkSetArray of WatermarkInputNoList of up to 10 image or text watermarks.
    Note: This field may return null, indicating that no valid values can be obtained.
    MosaicSetArray of MosaicInputNoList of blurs. Up to 10 ones can be supported.
    StartTimeOffsetFloatNoStart time offset of a transcoded video, in seconds.
  • If this parameter is left empty or set to 0, the transcoded video will start at the same time as the original video.
  • If this parameter is set to a positive number (n for example), the transcoded video will start at the nth second of the original video.
  • If this parameter is set to a negative number (-n for example), the transcoded video will start at the nth second before the end of the original video.
  • EndTimeOffsetFloatNoEnd time offset of a transcoded video, in seconds.
  • If this parameter is left empty or set to 0, the transcoded video will end at the same time as the original video.
  • If this parameter is set to a positive number (n for example), the transcoded video will end at the nth second of the original video.
  • If this parameter is set to a negative number (-n for example), the transcoded video will end at the nth second before the end of the original video.
  • OutputStorageTaskOutputStorageNoTarget bucket of an output 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.
    OutputObjectPathStringNoPath to a primary output 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}_transcode_{definition}.{format}.
    SegmentObjectNameStringNoPath to an output file part (the path to ts during transcoding to HLS), which can only be a relative path. If this parameter is left empty, the following relative path will be used by default: {inputName}_transcode_{definition}_{number}.{format}.
    ObjectNumberFormatNumberFormatNoRule of the {number} variable in the output path after transcoding.
    Note: This field may return null, indicating that no valid values can be obtained.
    HeadTailParameterHeadTailParameterNoOpening and closing credits parameters
    Note: this field may return null, indicating that no valid value was found.

    TranscodeTemplate

    Details of a transcoding template

    Used by actions: DescribeTranscodeTemplates.

    NameTypeDescription
    DefinitionStringUnique ID of a transcoding template.
    ContainerStringContainer format. Valid values: mp4, flv, hls, mp3, flac, ogg.
    NameStringName of a transcoding template.
    Note: This field may return null, indicating that no valid values can be obtained.
    CommentStringTemplate description.
    Note: This field may return null, indicating that no valid values can be obtained.
    TypeStringTemplate type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
  • RemoveVideoIntegerWhether to remove video data. Valid values:
  • 0: Retain;
  • 1: Remove.
  • RemoveAudioIntegerWhether to remove audio data. Valid values:
  • 0: Retain;
  • 1: Remove.
  • VideoTemplateVideoTemplateInfoVideo stream configuration parameter. This field is valid only when RemoveVideo is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioTemplateAudioTemplateInfoAudio stream configuration parameter. This field is valid only when RemoveAudio is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    TEHDConfigTEHDConfigTESHD transcoding parameter. To enable it, please contact your Tencent Cloud sales rep.
    Note: This field may return null, indicating that no valid values can be obtained.
    ContainerTypeStringContainer format filter. Valid values:
  • Video: Video container format that can contain both video stream and audio stream;
  • PureAudio: Audio container format that can contain only audio stream.
  • CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    EnhanceConfigEnhanceConfigAudio/Video enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    UrlInputInfo

    The URL of the object to process.

    Used by actions: DescribeMediaMetaData, EditMedia, ProcessMedia.

    NameTypeRequiredDescription
    UrlStringYesURL of a video.

    UserDefineAsrTextReviewTemplateInfo

    Control parameter of a custom speech audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a custom speech audit task. Valid values:
  • ON: Enables a custom speech audit task;
  • OFF: Disables a custom speech audit task.
  • LabelSetArray of StringNoCustom speech filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom speech keywords.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    UserDefineAsrTextReviewTemplateInfoForUpdate

    Control parameter of a custom speech audit task

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a custom speech audit task. Valid values:
  • ON: Enables a custom speech audit task;
  • OFF: Disables a custom speech audit task.
  • LabelSetArray of StringNoCustom speech filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom speech keywords.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    UserDefineConfigureInfo

    Control parameter of a custom audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    FaceReviewInfoUserDefineFaceReviewTemplateInfoNoControl parameter of custom figure audit.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrReviewInfoUserDefineAsrTextReviewTemplateInfoNoControl parameter of custom speech audit.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrReviewInfoUserDefineOcrTextReviewTemplateInfoNoControl parameter of custom text audit.
    Note: This field may return null, indicating that no valid values can be obtained.

    UserDefineConfigureInfoForUpdate

    Control parameter of a custom audit task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    FaceReviewInfoUserDefineFaceReviewTemplateInfoForUpdateYesControl parameter of custom figure audit.
    AsrReviewInfoUserDefineAsrTextReviewTemplateInfoForUpdateYesControl parameter of custom speech audit.
    OcrReviewInfoUserDefineOcrTextReviewTemplateInfoForUpdateYesControl parameter of custom text audit.

    UserDefineFaceReviewTemplateInfo

    Control parameter of a custom figure audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a custom figure audit task. Valid values:
  • ON: Enables a custom figure audit task;
  • OFF: Disables a custom figure audit task.
  • LabelSetArray of StringNoCustom figure filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for the custom figure library.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    UserDefineFaceReviewTemplateInfoForUpdate

    Control parameter of a custom figure audit task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a custom figure audit task. Valid values:
  • ON: Enables a custom figure audit task;
  • OFF: Disables a custom figure audit task.
  • LabelSetArray of StringNoCustom figure filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for the custom figure library.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    UserDefineOcrTextReviewTemplateInfo

    Control parameter of a custom text audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    NameTypeRequiredDescription
    SwitchStringYesSwitch of a custom text audit task. Valid values:
  • ON: Enables a custom text audit task;
  • OFF: Disables a custom text audit task.
  • LabelSetArray of StringNoCustom text filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom text keywords.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold 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.
    ReviewConfidenceIntegerNoThreshold 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.

    UserDefineOcrTextReviewTemplateInfoForUpdate

    Control parameter of a custom text audit task.

    Used by actions: ModifyContentReviewTemplate.

    NameTypeRequiredDescription
    SwitchStringNoSwitch of a custom text audit task. Valid values:
  • ON: Enables a custom text audit task;
  • OFF: Disables a custom text audit task.
  • LabelSetStringNoCustom text filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom text keywords.
    There can be up to 10 tags, each with a length limit of 16 characters.
    BlockConfidenceIntegerNoThreshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidenceIntegerNoThreshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    VideoDenoiseConfig

    Image noise removal configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe strength. Valid values:
  • weak
  • strong

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

    VideoEnhanceConfig

    Video enhancement configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    FrameRateFrameRateConfigNoFrame interpolation configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    SuperResolutionSuperResolutionConfigNoSuper resolution configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    HdrHdrConfigNoHDR configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    DenoiseVideoDenoiseConfigNoImage noise removal configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageQualityEnhanceImageQualityEnhanceConfigNoOverall enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ColorEnhanceColorEnhanceConfigNoColor enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    SharpEnhanceSharpEnhanceConfigNoDetail enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    FaceEnhanceFaceEnhanceConfigNoFace enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    LowLightEnhanceLowLightEnhanceConfigNoLow-light enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ScratchRepairScratchRepairConfigNoBanding removal configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ArtifactRepairArtifactRepairConfigNoArtifact removal (smoothing) configuration.
    Note: This field may return null, indicating that no valid values can be obtained.

    VideoTemplateInfo

    Video stream configuration parameter

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    CodecStringYesThe video codec. Valid values:
  • libx264: H.264
  • libx265: H.265
  • av1: AOMedia Video 1

  • Note: You must specify a resolution (not higher than 640 x 480) if the H.265 codec is used.
    Note: You can only use the AOMedia Video 1 codec for MP4 files.
    FpsIntegerYesThe video frame rate (Hz). Value range: [0, 100].
    If the value is 0, the frame rate will be the same as that of the source video.
    Note: For adaptive bitrate streaming, the value range of this parameter is [0, 60].
    BitrateIntegerYesThe video bitrate (Kbps). Value range: 0 and [128, 35000].
    If the value is 0, the bitrate of the video will be the same as that of the source video.
    ResolutionAdaptiveStringNoResolution adaption. Valid values:
  • open: Enabled. When resolution adaption is enabled, Width indicates the long side of a video, while Height indicates the short side.
  • close: Disabled. When resolution adaption is disabled, Width indicates the width of a video, while Height indicates the height.

  • Default value: open.
    Note: When resolution adaption is enabled, Width cannot be smaller than Height.
    WidthIntegerNoMaximum value of the width (or long side) of a video stream 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.
    HeightIntegerNoMaximum value of the height (or short side) of a video stream 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.
    GopIntegerNoFrame interval between I keyframes. Value range: 0 and [1,100000].
    If this parameter is 0 or left empty, the system will automatically set the GOP length.
    FillTypeStringNoThe fill mode, which indicates how a video is resized when the video’s original aspect ratio is different from the target aspect ratio. Valid values:
  • stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding.
  • black: Keep the image's original aspect ratio and fill the blank space with black bars.
  • white: Keep the image’s original aspect ratio and fill the blank space with white bars.
  • gauss: Keep the image’s original aspect ratio and apply Gaussian blur to the blank space.

  • Default value: black.
    Note: Only stretch and black are supported for adaptive bitrate streaming.
    VcrfIntegerNoThe control factor of video constant bitrate. Value range: [1, 51]
    If this parameter is specified, CRF (a bitrate control method) will be used for transcoding. (Video bitrate will no longer take effect.)
    It is not recommended to specify this parameter if there are no special requirements.

    VideoTemplateInfoForUpdate

    Video stream configuration parameter

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

    NameTypeRequiredDescription
    CodecStringNoThe video codec. Valid values:
  • libx264: H.264
  • libx265: H.265
  • av1: AOMedia Video 1

  • Note: You must specify a resolution (not higher than 640 x 480) if the H.265 codec is used.
    Note: You can only use the AOMedia Video 1 codec for MP4 files.
    FpsIntegerNoVideo frame rate in Hz. Value range: [0, 100].
    If the value is 0, the frame rate will be the same as that of the source video.
    BitrateIntegerNoBitrate of a video stream in Kbps. Value range: 0 and [128, 35,000].
    If the value is 0, the bitrate of the video will be the same as that of the source video.
    ResolutionAdaptiveStringNoResolution adaption. Valid values:
  • open: Enabled. When resolution adaption is enabled, Width indicates the long side of a video, while Height indicates the short side.
  • close: Disabled. When resolution adaption is disabled, Width indicates the width of a video, while Height indicates the height.

  • Note: When resolution adaption is enabled, Width cannot be smaller than Height.
    WidthIntegerNoMaximum value of the width (or long side) of a video stream 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.
  • HeightIntegerNoMaximum value of the height (or short side) of a video stream in px. Value range: 0 and [128, 4,096].
    GopIntegerNoFrame interval between I keyframes. Value range: 0 and [1,100000]. If this parameter is 0, the system will automatically set the GOP length.
    FillTypeStringNoFill 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.
  • VcrfIntegerNoThe control factor of video constant bitrate. Value range: [0, 51]. This parameter will be disabled if you enter 0.
    It is not recommended to specify this parameter if there are no special requirements.
    ContentAdaptStreamIntegerNoWhether to enable adaptive encoding. Valid values:
  • 0: Disable
  • 1: Enable

  • Default value: 0. If this parameter is set to 1, multiple streams with different resolutions and bitrates will be generated automatically. The highest resolution, bitrate, and quality of the streams are determined by the values of width and height, Bitrate, and Vcrf in VideoTemplate respectively. If these parameters are not set in VideoTemplate, the highest resolution generated will be the same as that of the source video, and the highest video quality will be close to VMAF 95. To use this parameter or learn about the billing details of adaptive encoding, please contact your sales rep.

    VolumeBalanceConfig

    The volume equalization configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    NameTypeRequiredDescription
    SwitchStringNoWhether to enable the feature. Valid values:
  • ON
  • OFF

  • Default value: ON.
    TypeStringNoThe type. Valid values:
  • loudNorm: Loudness normalization.
  • gainControl: Volume leveling.

  • Default value: loudNorm.
    Note: This field may return·null, indicating that no valid values can be obtained.

    WatermarkInput

    The watermark parameters to use in a media processing task.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    NameTypeRequiredDescription
    DefinitionIntegerYesID of a watermarking template.
    RawParameterRawWatermarkParameterNoCustom watermark parameter, which is valid if Definition is 0.
    This parameter is used in highly customized scenarios. We recommend you use Definition to specify the watermark parameter preferably.
    Custom watermark parameter is not available for screenshot.
    TextContentStringNoText content of up to 100 characters. This field is required only when the watermark type is text.
    Text watermark is not available for screenshot.
    SvgContentStringNoSVG content of up to 2,000,000 characters. This field is required only when the watermark type is SVG.
    SVG watermark is not available for screenshot.
    StartTimeOffsetFloatNoStart time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame.
  • If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame;
  • If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;
  • If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame.
  • EndTimeOffsetFloatNoEnd time offset of a watermark in seconds.
  • If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame;
  • If this value is greater than 0 (e.g., n), the watermark will exist till second n;
  • If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame.
  • WatermarkTemplate

    Details of a watermarking template

    Used by actions: DescribeWatermarkTemplates.

    NameTypeDescription
    DefinitionIntegerUnique ID of a watermarking template.
    TypeStringWatermark type. Valid values:
  • image: Image watermark;
  • text: Text watermark.
  • NameStringName of a watermarking template.
    CommentStringTemplate description.
    XPosStringHorizontal position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Left edge of the watermark will be at the position of the specified percentage of the video width; for example, 10% means that the Left edge is at 10% of the video width;
  • If the string ends in px, the Left edge of the watermark will be at the position of the specified px of the video width; for example, 100px means that the Left edge is at the position of 100 px.
  • YPosStringVertical position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Top edge of the watermark will beat the position of the specified percentage of the video height; for example, 10% means that the Top edge is at 10% of the video height;
  • If the string ends in px, the Top edge of the watermark will be at the position of the specified px of the video height; for example, 100px means that the Top edge is at the position of 100 px.
  • ImageTemplateImageWatermarkTemplateImage watermarking template. This field is valid only when Type is image.
    Note: This field may return null, indicating that no valid values can be obtained.
    TextTemplateTextWatermarkTemplateInputText watermarking template. This field is valid only when Type is text.
    Note: This field may return null, indicating that no valid values can be obtained.
    SvgTemplateSvgWatermarkInputSVG watermarking template. This field is valid when Type is svg.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTimeStringCreation time of a template in ISO date format.
    UpdateTimeStringLast modified time of a template in ISO date format.
    CoordinateOriginStringOrigin position. Valid values:
  • topLeft: The origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text;
  • topRight: The origin of coordinates is in the top-right corner of the video, and the origin of the watermark is in the top-right corner of the image or text;
  • bottomLeft: The origin of coordinates is in the bottom-left corner of the video, and the origin of the watermark is in the bottom-left corner of the image or text;
  • bottomRight: The origin of coordinates is in the bottom-right corner of the video, and the origin of the watermark is in the bottom-right corner of the image or text.
  • WorkflowInfo

    Workflow information details.

    Used by actions: DescribeWorkflows.

    NameTypeDescription
    WorkflowIdIntegerWorkflow ID.
    WorkflowNameStringWorkflow name.
    StatusStringWorkflow status. Valid values:
  • Enabled: Enabled,
  • Disabled: Disabled.
  • TriggerWorkflowTriggerInput rule bound to a workflow. If an uploaded video hits the rule for the object, the workflow will be triggered.
    OutputStorageTaskOutputStorageThe location to save the media processing output file.
    Note: This field may return null, indicating that no valid value can be obtained.
    MediaProcessTaskMediaProcessTaskInputThe media processing parameters to use.
    Note: This field may return null, indicating that no valid value can be obtained.
    AiContentReviewTaskAiContentReviewTaskInputType parameter of a video content audit task.
    Note: This field may return null, indicating that no valid values can be obtained.
    AiAnalysisTaskAiAnalysisTaskInputVideo content analysis task parameter.
    AiRecognitionTaskAiRecognitionTaskInputType parameter of a video content recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskNotifyConfigTaskNotifyConfigEvent notification information of a task. If this parameter is left empty, no event notifications will be obtained.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskPriorityIntegerTask flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
    OutputDirStringThe directory to save the media processing output file, such as /movie/201907/.
    CreateTimeStringCreation time of a workflow in ISO date format.
    UpdateTimeStringLast modified time of a workflow in ISO date format.

    WorkflowTask

    The information of the media processing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    NameTypeDescription
    TaskIdStringThe media processing task ID.
    StatusStringTask flow status. Valid values:
  • PROCESSING: Processing;
  • FINISH: Completed.
  • ErrCodeIntegerIf the value returned is not 0, there was a source error. If 0 is returned, refer to the error codes of the corresponding task type.
    MessageStringExcept those for source errors, error messages vary with task type.
    InputInfoMediaInputInfoThe information of the file processed.
    Note: This field may return null, indicating that no valid value can be obtained.
    MetaDataMediaMetaDataMetadata of a source video.
    Note: This field may return null, indicating that no valid values can be obtained.
    MediaProcessResultSetArray of MediaProcessTaskResultThe execution status and result of the media processing task.
    AiContentReviewResultSetArray of AiContentReviewResultExecution status and result of a video content audit task.
    AiAnalysisResultSetArray of AiAnalysisResultExecution status and result of video content analysis task.
    AiRecognitionResultSetArray of AiRecognitionResultExecution status and result of a video content recognition task.
    AiQualityControlTaskResultScheduleQualityControlTaskResultThe execution status and result of a quality control task.
    Note: This field may return null, indicating that no valid values can be obtained.

    WorkflowTrigger

    Input rule. If an uploaded video hits the rule, the workflow will be triggered.

    Used by actions: CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeWorkflows, ModifySchedule, ResetWorkflow.

    NameTypeRequiredDescription
    TypeStringYesThe trigger type. Valid values:
  • CosFileUpload: Tencent Cloud COS trigger.
  • AwsS3FileUpload: AWS S3 trigger. Currently, this type is only supported for transcoding tasks and schemes (not supported for workflows).


  • CosFileUploadTriggerCosFileUploadTriggerNoThis parameter is required and valid when Type is CosFileUpload, indicating the COS trigger rule.
    Note: This field may return null, indicating that no valid values can be obtained.
    AwsS3FileUploadTriggerAwsS3FileUploadTriggerNoThe AWS S3 trigger. This parameter is valid and required if Type is AwsS3FileUpload.

    Note: Currently, the key for the AWS S3 bucket, the trigger SQS queue, and the callback SQS queue must be the same.
    Note: This field may return null, indicating that no valid values can be obtained.