tencent cloud

APIs

文档APIsMedia Processing ServiceData Types

Data Types

下载
聚焦模式
字号
最后更新时间： 2026-09-14 12:14:48

AIAnalysisTemplateItem

AI-based intelligent analysis template details

Used by actions: DescribeAIAnalysisTemplates.

Name Type Description
Definition Integer Unique ID of intelligent analysis template.
Name String Intelligent analysis template name.
Comment String Intelligent analysis template description.
ClassificationConfigure ClassificationConfigureInfo Control parameter of intelligent categorization task.
TagConfigure TagConfigureInfo Control parameter of intelligent tagging task.
CoverConfigure CoverConfigureInfo Control parameter of intelligent cover generating task.
FrameTagConfigure FrameTagConfigureInfo Control parameter of intelligent frame-specific tagging task.
CreateTime String Creation time of template in ISO date format.
UpdateTime String Last modified time of template in ISO date format.
Type String The template type. Valid values:
* Preset
* Custom
Note: This field may return null, indicating that no valid value can be obtained.

AIDubbingTaskInput

AI dubbing task

Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

Name Type Required Description
Definition Integer No

AI Dubbing template id.
RawParameter RawAIDubbingParameter No

Custom AI dubbing parameter. It takes effect when Definition is set to 0. This parameter is used in highly customized scenarios. We recommend that you use Definition to specify dubbing parameters.
OverrideParameter OverrideAIDubbingParameter No

AI Dubbing custom parameters. Valid when Definition is not filled with 0. When some dubbing parameters in this structure are filled in, the filled parameters will be used to override the parameters in the AI Dubbing template. This parameter is used for highly customized scenarios. We recommend you use only Definition to specify dubbing parameters.
OutputStorage TaskOutputStorage No

Target storage for the file. If this is not specified, it inherits the value from the upper-level OutputStorage.
SrcSubtitleInfo MediaInputInfo No

External source subtitle file information.
DstSubtitleInfos Array of DstSubtitleInput No

External subtitle file information, translated subtitles.
OutputObjectPath String No

Output path of the file, which can be a relative or absolute path.
To define the output path, the path must end with .{format}. For variable names, see File Name Variable Description.
Relative path example:

  • File name_{variable name}.{format}
  • File name.{format}
    • Absolute path example:
  • /custom path/file name_{variable name}.{format}

    • Note: The BatchProcessMedia API is currently not supported.
    ExtendedParameter String No

    Additional parameters for AI Dubbing, serialized json string.
    DramaId String No

    ID of the associated drama series.
    Note: This value takes effect when dubbing mode is intelligent dubbing by role.

    AIRecognitionTemplateItem

    Details of a video content recognition template

    Used by actions: DescribeAIRecognitionTemplates.

    Name Type Description
    Definition Integer Unique ID of a video content recognition template.
    Name String Name of a video content recognition template.
    Comment String Description of a video content recognition template.
    FaceConfigure FaceConfigureInfo Face recognition control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrFullTextConfigure OcrFullTextConfigureInfo Full text recognition control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrWordsConfigure OcrWordsConfigureInfo Text keyword recognition control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrFullTextConfigure AsrFullTextConfigureInfo Full speech recognition control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrWordsConfigure AsrWordsConfigureInfo Speech keyword recognition control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    TranslateConfigure TranslateConfigureInfo Voice translation control parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    Type String The template type. Valid values:
    * Preset
    * Custom
    Note: This field may return null, indicating that no valid value can be obtained.

    Activity

    Used by actions: CreateSchedule, DescribeSchedules, ModifySchedule, ProcessMedia.

    Name Type Required Description
    ActivityType String Yes

    Atomic task type:

  • input: starting node
  • output: termination node
  • action-trans: transcode
  • action-samplesnapshot: sampled screenshot
  • action-AIAnalysis: analysis
  • action-AIRecognition: recognition
  • action-aiReview: review
  • action-animated-graphics: animated image
  • action-image-sprite: sprite sheet
  • action-snapshotByTimeOffset: time point screenshot
  • action-adaptive-substream: adaptive bitrate stream
  • action-AIQualityControl: media quality inspection
  • action-SmartSubtitles: smart subtitling
  • action-exec-rules: judgment rule
  • action-SmartErase: intelligent erasure
    		•
    PredriveIndex Array of Integer No

    Index array of predecessor nodes.
    Note: This parameter is invalid when creating or modifying an orchestration. It is automatically generated by the server.
    ReardriveIndex Array of Integer No

    Array of successor node indexes
    ActivityPara ActivityPara No

    Atomic task parameter

    ActivityPara

    Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

    Name Type Required Description
    TranscodeTask TranscodeTaskInput No

    Video transcoding task
    AnimatedGraphicTask AnimatedGraphicTaskInput No

    Video-to-GIF task
    SnapshotByTimeOffsetTask SnapshotByTimeOffsetTaskInput No

    Video time point screenshot task
    SampleSnapshotTask SampleSnapshotTaskInput No

    Video sampling screenshot task
    ImageSpriteTask ImageSpriteTaskInput No

    Video image sprite task
    AdaptiveDynamicStreamingTask AdaptiveDynamicStreamingTaskInput No

    Adaptive bitrate streaming task
    AiContentReviewTask AiContentReviewTaskInput No

    Video content review task
    AiAnalysisTask AiAnalysisTaskInput No

    Video content analysis task
    AiRecognitionTask AiRecognitionTaskInput No

    Video content recognition task
    QualityControlTask AiQualityControlTaskInput No

    Media quality inspection task
    ExecRulesTask ExecRulesTask No

    Conditional judgment of the task.
    SmartSubtitlesTask SmartSubtitlesTaskInput No

    Smart subtitle task.
    SmartEraseTask SmartEraseTaskInput No

    Intelligent erasure task
    AIDubbingTask AIDubbingTaskInput No

    AI Dubbing task.

    ActivityResItem

    Orchestration subtask output

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TranscodeTask MediaProcessTaskTranscodeResult
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult
    ImageSpriteTask MediaProcessTaskImageSpriteResult
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult
    RecognitionTask ScheduleRecognitionTaskResult
    ReviewTask ScheduleReviewTaskResult
    AnalysisTask ScheduleAnalysisTaskResult
    QualityControlTask ScheduleQualityControlTaskResult
    ExecRuleTask ScheduleExecRuleTaskResult
    SmartSubtitlesTask ScheduleSmartSubtitleTaskResult
    SmartEraseTask SmartEraseTaskResult

    ActivityResult

    Orchestration task output

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ActivityType String Atomic task type.
  • Transcode: transcoding.
  • SampleSnapshot: sampled screenshot taking.
  • AnimatedGraphics: Animated image.
  • SnapshotByTimeOffset: time point screenshot taking.
  • ImageSprites: sprite sheet.
  • AdaptiveDynamicStreaming: adaptive bitrate streaming.
  • AiContentReview: content moderation.
  • AIRecognition: intelligent recognition.
  • AIAnalysis: AI analysis.
  • AiQualityControl: media quality inspection

    • <Li>SmartSubtitles: smart subtitle
  • SmartErase: intelligent removal.
    		•
    ActivityResItem ActivityResItem Atomic task output.

    AdaptiveDynamicStreamingInfoItem

    Adaptive Bitrate Streaming information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Adaptive bitrate streaming specification.
    Package String Packaging format, which may be two kinds: HLS and MPEG-DASH.
    Path String Playback path.
    Storage TaskOutputStorage Storage location of the adaptive bitrate stream file.

    AdaptiveDynamicStreamingTaskInput

    Input parameter type for video to adaptive bitrate stream

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

    Name Type Required Description
    Definition Integer Yes

    Adaptive bitrate streaming template ID.
    WatermarkSet Array of WatermarkInput No

    Watermark list. Up to 10 image or text watermarks are supported.
    BlindWatermark BlindWatermarkInput No
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    Output path for the manifest file after adaptive bitrate streaming, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, see Filename Variables.
    Relative path example:

  • Filename_{variable name}.{format}
  • Filename.{format}
    • Absolute path example:
  • /custom path/Filename_{variable name}.{format}
    • If this is not specified, the default relative path is {inputName}_adaptiveDynamicStreaming_{definition}.{format}.
    SubStreamObjectName String No

    Output path for substream files after adaptive bitrate streaming, which can only be a relative path. If this is not specified, the default relative path is {inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}.
    SegmentObjectName String No

    Output path for segment files after adaptive bitrate streaming (HLS only), which can only be a relative path. If this is not specified, the default relative path is {inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}.
    AddOnSubtitles Array of AddOnSubtitle No
    DrmInfo DrmInfo No
    DefinitionType String No

    Adaptive bitrate streaming template type. Valid values:
    Common: audio and video.
    PureAudio: audio only.
    SubtitleTemplate SubtitleTemplate No
    StdExtInfo String No

    Extended transcoding parameter field.
    KeyPTSList Array of Integer No
    AddOnAudios Array of AddOnAudio No

    External audio feature. Specifies the audio files to be inserted.
    StdExtStreamInfos Array of AdaptiveStreamTemplate No

    When not empty, directly replace the StreamInfos field of the template. The field format is the same as the StreamInfos when creating an adaptive template.

    AdaptiveDynamicStreamingTemplate

    Details of an adaptive bitrate streaming template

    Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

    Name Type Description
    Definition Integer Unique ID of an adaptive bitrate streaming template.
    Type String Template type. Valid values:
  • Preset: preset template;
  • Custom: custom template.
    		•
    Name String Name of an adaptive bitrate streaming template.
    Comment String Description of an adaptive bitrate streaming template.
    Format String Adaptive bitrate streaming format. Valid values:
  • HLS;
  • MPEG-DASH.
    		•
    StreamInfos Array of AdaptiveStreamTemplate Parameter information of input streams for transcoding to adaptive bitrate streaming. Up to 10 streams can be input.
    DisableHigherVideoBitrate Integer Whether to prohibit transcoding from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.
    		•
    DisableHigherVideoResolution Integer Whether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.
    		•
    CreateTime String Creation time of template in ISO date format.
    UpdateTime String Last modified time of template in ISO date format.
    PureAudio Integer Whether it is an audio-only template. 0: video template. 1: audio-only template.Note: This field may return null, indicating that no valid values can be obtained.
    SegmentType String HLS segment type. Valid values:
  • ts-segment: HLS+TS segment.
  • ts-byterange: HLS+TS byte range.
  • mp4-segment: HLS+MP4 segment.
  • mp4-byterange: HLS+MP4 byte range.
  • ts-packed-audio: TS+Packed audio.
  • mp4-packed-audio: MP4+Packed audio.

    • Default value: ts-segment.

    Note: The HLS segment format for adaptive bitrate streaming is based on this field.Note: This field may return null, indicating that no valid values can be obtained.

    AdaptiveStreamTemplate

    Adaptive transcoding stream parameter template

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateWorkflow, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Audio AudioTemplateInfo Yes Audio parameter information.
    Video VideoTemplateInfo No Video parameter information.
    RemoveAudio Integer No Whether to remove the audio stream. Value range:
  • 0: no,
  • 1: yes.
    		•
    RemoveVideo Integer No Whether to remove the video stream. Value range:
  • 0: no,
  • 1: yes.
    		•
    AudioList Array of AudioTemplateInfo No

    AddOnAudio

    External audio.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    InputInfo MediaInputInfo Yes

    Audio file input information. Note: (1) Supported audio stream encoding formats: AAC, AC3, EAC3, FLAC, Opus, and MP3. (2) If the segment type set in the adaptive bitrate streaming template is TS, the audio stream encoding format cannot be FLAC.
    AudioName String No

    Audio track name, such as Chinese or English. Note: Only Chinese characters, letters, digits, spaces, underscores (_), hyphens (-), periods (.), and brackets are supported. The length cannot exceed 64 characters.
    AudioLanguage String No

    Audio track language, such as chi or eng. This follows the ISO 639-2 standard.
    DefaultTrack Boolean No

    Default audio track. When set to true, the current audio is designated as the default audio track. A maximum of 1 default audio track can be specified.

    Default value: false.

    AddOnSubtitle

    External subtitle.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Type String No
    Subtitle MediaInputInfo No
    SubtitleName String No
    SubtitleLanguage String No

    Subtitle language, such as eng.
    OutputFormat String No

    Subtitle output format. Valid values: {"WebVTT","TTML"}.
    Default value: "WebVTT".
    DefaultTrack Boolean No

    Default subtitle track. When set to true, the current subtitle is designated as the default subtitle track. A maximum of 1 default subtitle track can be specified.
    Default value: false.

    AdvancedSuperResolutionConfig

    Super-resolution configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

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

    • Default value: ON.
    Type String No Type, available values:
  • standard: Common super-resolution
  • super: Advanced super-resolution.
  • ultra: Advanced super-resolution ultra edition.

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

    AiAnalysisResult

    Intelligent analysis result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
  • Classification: intelligent classification.
  • Cover: intelligent cover
  • Tag: intelligent tagging.
  • FrameTag: intelligent frame tagging.
  • Highlight: Intelligent Highlights
  • DeLogo: intelligent removal.
  • Description: large model summarization.
  • Dubbing: Intelligent Dubbing
  • VideoRemake: Video deduplication
  • VideoComprehension: video (audio) recognition.
  • Cutout: Video matting
  • Reel: intelligent video editing.
    		•
    ClassificationTask AiAnalysisTaskClassificationResult
    CoverTask AiAnalysisTaskCoverResult
    TagTask AiAnalysisTaskTagResult
    FrameTagTask AiAnalysisTaskFrameTagResult
    HighlightTask AiAnalysisTaskHighlightResult
    DeLogoTask AiAnalysisTaskDelLogoResult
    SegmentTask AiAnalysisTaskSegmentResult
    HeadTailTask AiAnalysisTaskHeadTailResult
    DescriptionTask AiAnalysisTaskDescriptionResult
    HorizontalToVerticalTask AiAnalysisTaskHorizontalToVerticalResult
    DubbingTask AiAnalysisTaskDubbingResult
    VideoRemakeTask AiAnalysisTaskVideoRemakeResult
    VideoComprehensionTask AiAnalysisTaskVideoComprehensionResult
    CutoutTask AiAnalysisTaskCutoutResult
    ReelTask AiAnalysisTaskReelResult

    AiAnalysisTaskClassificationInput

    Intelligent classification task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video classification template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskClassificationOutput

    Intelligent classification results info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ClassificationSet Array of MediaAiAnalysisClassificationItem Video intelligent classification list.

    AiAnalysisTaskClassificationResult

    Intelligent classification task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiAnalysisTaskClassificationInput Intelligent classification task input.
    Output AiAnalysisTaskClassificationOutput

    AiAnalysisTaskCoverInput

    Intelligent classification task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video cover template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskCoverOutput

    Intelligent cover result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    CoverSet Array of MediaAiAnalysisCoverItem Intelligent cover list.
    OutputStorage TaskOutputStorage Intelligent cover storage location.

    AiAnalysisTaskCoverResult

    Intelligent cover result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiAnalysisTaskCoverInput Input of the intelligent cover task.
    Output AiAnalysisTaskCoverOutput

    AiAnalysisTaskCutoutInput

    Input type of the intelligent video matting task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Required Description
    Definition Integer Yes

    ID of the intelligent video matting template.
    ExtendedParameter String No

    Extended parameter.

    AiAnalysisTaskCutoutOutput

    Video matting result information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Path String File path for the intelligent video matting.
    OutputStorage TaskOutputStorage Storage location for the intelligent video matting.

    AiAnalysisTaskCutoutResult

    Data structure of the video intelligence matting result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String Error message
    Input AiAnalysisTaskCutoutInput Input of the video matting task.
    Output AiAnalysisTaskCutoutOutput
    Progress Integer Task progress
    BeginProcessTime String Starting time of task execution, in ISO date and time format.
    FinishTime String Task completion time, in ISO date and time format.

    AiAnalysisTaskDelLogoInput

    Intelligent removal task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video erasing template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskDelLogoOutput

    Intelligent removal result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Path String

    Path of a file after removal.
    OutputStorage TaskOutputStorage

    Storage location of a file after removal.
    OriginSubtitlePath String

    Path of subtitle file extracted from video.
    TranslateSubtitlePath String

    Path of a subtitle translation file extracted from a video.
    SubtitlePos SubtitlePosition
    VoiceClonedVideo String
    VoiceClonedMarkFile String
    ErasedVideoPath String

    Result path of a video for removal only
    DubbingEditInfoUrl String

    Voice cloning editing information

    Editing information for secondary modifications of voice cloning
    FileId String

    FileId of a file after removal.
    OriginSubtitleFileId String

    FileId of the subtitle file extracted from video.
    TranslateSubtitleFileId String

    FileId of a subtitle translation file extracted from a video.

    AiAnalysisTaskDelLogoResult

    Intelligent removal result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskDelLogoInput Intelligent removal task input.
    Output AiAnalysisTaskDelLogoOutput

    AiAnalysisTaskDescriptionInput

    Intelligent classification task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video description template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskDescriptionOutput

    Intelligent description result information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    DescriptionSet Array of MediaAiAnalysisDescriptionItem Intelligent video description list.

    AiAnalysisTaskDescriptionResult

    Intelligent description result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskDescriptionInput Intelligent description task input.
    Output AiAnalysisTaskDescriptionOutput

    AiAnalysisTaskDubbingInput

    Input type of the intelligent dubbing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the video localization template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskDubbingOutput

    Intelligent translation result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    VideoPath String

    Dubbed video path.
    SpeakerPath String

    Tag file path
    VoiceId String

    Voice type id
    OutputStorage TaskOutputStorage

    Storage location of the dubbed video.
    ExtraOutput String

    Additional results, currently including subtitle file result URLs
    VideoFileId String

    FileId of the dubbed video.
    SpeakerFileId String

    FileId of the tag file.

    AiAnalysisTaskDubbingResult

    Intelligent translation result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskDubbingInput Intelligent dubbing task input.
    Output AiAnalysisTaskDubbingOutput

    AiAnalysisTaskFrameTagInput

    Intelligent frame tagging task input type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video frame-by-frame tagging template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskFrameTagOutput

    Intelligent frame tagging result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of MediaAiAnalysisFrameTagSegmentItem Video frame tagging list.

    AiAnalysisTaskFrameTagResult

    Intelligent frame tagging result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiAnalysisTaskFrameTagInput Intelligent frame tagging task input.
    Output AiAnalysisTaskFrameTagOutput

    AiAnalysisTaskHeadTailInput

    Opening and closing segments recognition task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intro and outro recognition template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskHeadTailOutput

    Opening and closing segments recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    HeadTimeOffset Float
    TailTimeOffset Float

    AiAnalysisTaskHeadTailResult

    Opening and closing segments recognition result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskHeadTailInput Opening and closing segments recognition task input.
    Output AiAnalysisTaskHeadTailOutput

    AiAnalysisTaskHighlightInput

    Intelligent highlight task input type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video highlight template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskHighlightOutput

    Intelligent highlight result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    HighlightSet Array of MediaAiAnalysisHighlightItem Intelligent video highlight list.
    OutputStorage TaskOutputStorage

    AiAnalysisTaskHighlightResult

    Result type of the intelligent highlight

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskHighlightInput Input of the intelligent highlight task.
    Output AiAnalysisTaskHighlightOutput

    AiAnalysisTaskHorizontalToVerticalInput

    Intelligent landscape-to-portrait task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskHorizontalToVerticalOutput

    Intelligent landscape-to-portrait result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Path String
    OutputStorage TaskOutputStorage
    Confidence Float

    AiAnalysisTaskHorizontalToVerticalResult

    Intelligent landscape-to-portrait result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String
    ErrCode Integer
    Message String
    Input AiAnalysisTaskHorizontalToVerticalInput
    Output AiAnalysisTaskHorizontalToVerticalOutput

    AiAnalysisTaskInput

    Input parameter type for AI smart video analysis

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

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

    AiAnalysisTaskReelInput

    Input type of the intelligent video editing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video editing template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskReelOutput

    AI narration and video re-creation result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    VideoPath String Path of the commentated video.
    VideoPaths Array of String Path list of the commentated video.

    Note:
    1. When returning a file, VideoPath returns a file path, and VideoPaths is likewise populated with an element of the same path.
    2. When multiple files are returned, VideoPath returns an empty string, and VideoPaths returns a file path list.
    ScriptPath String Script file path
    OutputStorage TaskOutputStorage Storage location of the commentated video.

    AiAnalysisTaskReelResult

    AI narration and video re-creation result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskReelInput AI narration and video re-creation task input.
    Output AiAnalysisTaskReelOutput
    ErrCodeExt String
    Progress Integer
    BeginProcessTime String
    FinishTime String

    AiAnalysisTaskSegmentInput

    Splitting task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the video clipping task template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskSegmentOutput

    Intelligent splitting result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of SegmentRecognitionItem Intelligent splitting sub-segment list.
    Abstract String

    AiAnalysisTaskSegmentResult

    Splitting result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiAnalysisTaskSegmentInput Splitting task input.
    Output AiAnalysisTaskSegmentOutput

    AiAnalysisTaskTagInput

    Intelligent tag task input type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video tagging template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskTagOutput

    Intelligent tag result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TagSet Array of MediaAiAnalysisTagItem Video intelligent tag list.

    AiAnalysisTaskTagResult

    Intelligent tag result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiAnalysisTaskTagInput Intelligent tag task input.
    Output AiAnalysisTaskTagOutput

    AiAnalysisTaskVideoComprehensionInput

    Input file for the video (audio) recognition task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the video (audio) understanding template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskVideoComprehensionOutput

    Information about the video (audio) recognition output content result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    VideoComprehensionAnalysisResult String Details of the video (audio) recognition output content.
    VideoComprehensionExtInfo String Video (Audio) understanding extended information
    VideoComprehensionResultList Array of VideoComprehensionResultItem Video shot understanding result

    AiAnalysisTaskVideoComprehensionResult

    Video (audio) recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values: PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: successful; other values: failed.
    Message String Error message
    Input AiAnalysisTaskVideoComprehensionInput Input file for video (audio) recognition.
    Output AiAnalysisTaskVideoComprehensionOutput
    ErrCodeExt String Error code. A null string indicates that the task is successful, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
    Progress Integer Task progress
    BeginProcessTime String Starting time of task execution, in ISO date and time format.
    FinishTime String Completion time of task execution, in ISO date and time format.

    AiAnalysisTaskVideoRemakeInput

    Video deduplication task input type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    ID of the intelligent video deduplication template.
    ExtendedParameter String

    Extended parameter.

    AiAnalysisTaskVideoRemakeOutput

    Video deduplication result info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Path String File path for intelligent video deduplication
    OutputStorage TaskOutputStorage Storage location of intelligent video deduplication

    AiAnalysisTaskVideoRemakeResult

    Data structure of the video deduplication result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: successful; other values: failed.
    Message String Error message
    Input AiAnalysisTaskVideoRemakeInput Task input for deduplication
    Output AiAnalysisTaskVideoRemakeOutput

    AiContentReviewResult

    Content moderation result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
  • Porn: porn detection.
  • Terrorism: sensitive image.
  • Political: sensitive image.
  • Porn.Asr: Pornography detection in ASR text
  • Porn.Ocr: Pornography detection in OCR text
  • Political.Asr: ASR text sensitivity
  • Political.Ocr: OCR text sensitivity
  • Terrorism.Ocr: OCR text sensitivity
  • Prohibited.Asr: ASR text prohibited information recognition
  • Prohibited.Ocr: OCR text prohibited information recognition
    		•
    SampleRate Float Sampling frequency, i.e., the number of frames captured per second for video review.
    Duration Float Video duration for review, in seconds.
    PornTask AiReviewTaskPornResult
    TerrorismTask AiReviewTaskTerrorismResult
    PoliticalTask AiReviewTaskPoliticalResult
    PornAsrTask AiReviewTaskPornAsrResult
    PornOcrTask AiReviewTaskPornOcrResult
    PoliticalAsrTask AiReviewTaskPoliticalAsrResult
    PoliticalOcrTask AiReviewTaskPoliticalOcrResult
    TerrorismOcrTask AiReviewTaskTerrorismOcrResult
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult

    AiContentReviewTaskInput

    Task type for intelligent content moderation

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

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

    AiCutoutConfig

    Intelligent image masking configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No

    Capability configuration switch, available values: ON: Enable; OFF: Disable. Default value: ON.
    Type String No

    Target type: "foreground" (default) / "pattern"
    PatternConfig PatternConfig No

    Pattern matting configuration. This parameter is valid only when Type is pattern.
    Model String No

    Cutout model selection, optional.

    Enumeration value:

    • auto: Automatically choose appropriate model
    • WAND-cutout-1.0-lite: Standard version, fastest speed
    • WAND-cutout-2.0-lite: Enhanced, fastest speed
    • WAND-cutout-2.0-flash: Enhanced, quality-speed balance

    AiDramaInput

    AI‑generated comic input

    Used by actions: CreateAiDramaTask.

    Name Type Required Description
    Script String Yes

    AI comic playbook.

    Parameter format: None

    Input parameter limitation: None
    Style String Yes

    AI comic style

    Enumeration values:

    • chinese_ink_wash: Chinese ink‑wash
    • fantasy_cyberpunk: fantasy cyberpunk
    • japanese_anime_2d: Japanese anime 2D

    Default value: chinese_ink_wash

    Enumeration values:

    • realistic_live_action: realistic live action
    • chinese_ink_wash: Chinese ink-wash
    • fantasy_cyberpunk: fantasy cyberpunk
    • japanese_anime_2d: Japanese anime 2D

    Default value: chinese_ink_wash
    Ratio String Yes

    Aspect ratio

    Enumeration values:

    • 16:9: 16:9
    • 9:16: 9:16

    Default value: 16:9
    Resolution String Yes

    Output video resolution

    Enumeration values:

    • 720p: 720p
    • 1080p: 1080p

    Default value: 720p

    AiExpansionConfig

    Intelligent image expansion configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No

    Capability configuration switch, available values: ON: Enable; OFF: Disable. Default value: ON.
    AspectRatio String No

    Target ratio, for example "16:9"
    Width Integer No

    Target width (pixel)

    Value ranges from 0 to 2048.
    Height Integer No

    Target height (pixel)

    Value ranges from 0 to 2048.

    AiFissionInput

    Video fission input

    Used by actions: CreateAiFissionTask.

    Name Type Required Description
    ImageUrls Array of String Yes

    Video fission reference image url
    Text String No

    Video fission product information reference copywriting

    AiParagraphInfo

    Segment information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Summary String
    Title String Segment title.
    Keywords Array of String Segment keyword.
    StartTimeOffset Float
    EndTimeOffset Float

    AiPosterSuiteConfig

    Intelligent image set configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Mode String No

    Image output mode.

    Enumeration values:

    • auto: fully automatic mode. CustomVariables can be passed in this mode.
    • modify: modification mode. The corresponding description needs to be provided in the AddOnParameter.ExtPrompt field in this mode. CustomVariables cannot be passed in this mode.

    Default value: auto.
    Definition Integer No

    Ecommerce platform visual template ID.

    If you need a personalized visual template, submit a ticket.
    Recipe Array of RecipeItem No

    Sub-image configuration.
    Language String No

    Sub-image text language.

    Enumeration values:

    • zh-CN: Simplified Chinese.
    • en-US: American English.

    Default value: zh-CN.

    If you need more languages, submit a ticket.
    PanelRatio String No

    Sub-image aspect ratio.

    Enumeration values:

    • 1:1: 1:1.
    • 3:4: 3:4.
    • 4:3: 4:3.
    • 9:16: 9:16.
    • 16:9: 16:9.

    Default value: 1:1.
    PanelResolution String No

    Sub-image resolution.

    Enumeration values:

    • 720: 720.
    • 1K: 1K.
    • 2K: 2K.
    • 4K: 4K.

    Default value: 1K.
    CustomVariables Array of CustomVariable No

    User-defined variable.
    Model String No

    Model name.

    Enumeration value:

    • WAND-suite-1.0-flash: WAND-suite-1.0-flash.

    AiQualityControlTaskInput

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

    Name Type Required Description
    Definition Integer No
    ChannelExtPara String No

    AiRecognitionResult

    Intelligent recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
  • FaceRecognition: face recognition.
  • AsrWordsRecognition: speech keyword recognition.
  • OcrWordsRecognition: text keyword recognition.
  • AsrFullTextRecognition: full speech recognition.
  • OcrFullTextRecognition: full text recognition.
  • TransTextRecognition: speech translation
    		•
    FaceTask AiRecognitionTaskFaceResult
    AsrWordsTask AiRecognitionTaskAsrWordsResult
    AsrFullTextTask AiRecognitionTaskAsrFullTextResult
    OcrWordsTask AiRecognitionTaskOcrWordsResult
    OcrFullTextTask AiRecognitionTaskOcrFullTextResult
    TransTextTask AiRecognitionTaskTransTextResult
    ObjectTask AiRecognitionTaskObjectResult

    AiRecognitionTaskAsrFullTextResult

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskAsrFullTextResultInput Input information on the full speech recognition task.
    Output AiRecognitionTaskAsrFullTextResultOutput
    Progress Integer

    AiRecognitionTaskAsrFullTextResultInput

    Input for full speech recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Full speech identification template ID.

    AiRecognitionTaskAsrFullTextResultOutput

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem Full speech recognition segment list.
    SubtitlePath String Subtitle file path.

    AiRecognitionTaskAsrFullTextSegmentItem

    Segment undergone full speech recognition.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    StartTimeOffset Float

    Start time offset of the recognized segment, in seconds.
    EndTimeOffset Float

    End time offset of the recognized segment, in seconds.
    Text String

    Recognized text.
    Wordlist Array of WordResult

    Word timestamp information.

    AiRecognitionTaskAsrWordsResult

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskAsrWordsResultInput Input for the speech keyword recognition task.
    Output AiRecognitionTaskAsrWordsResultOutput

    AiRecognitionTaskAsrWordsResultInput

    Speech keyword recognition input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Speech keyword recognition template ID.

    AiRecognitionTaskAsrWordsResultItem

    Speech keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Word String Speech keyword.
    SegmentSet Array of AiRecognitionTaskAsrWordsSegmentItem List of segments for the time when speech keywords occur.

    AiRecognitionTaskAsrWordsResultOutput

    Speech keyword recognition output.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskAsrWordsSegmentItem

    ASR segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskFaceResult

    Face Recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskFaceResultInput Face Recognition task input.
    Output AiRecognitionTaskFaceResultOutput

    AiRecognitionTaskFaceResultInput

    Face recognition input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Face Recognition template ID.

    AiRecognitionTaskFaceResultItem

    Face Recognition result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Id String Unique identification ID of the figure.
    Type String Figure library type, indicates which figure library the recognized figure comes from.
  • Default: default figure library;
  • UserDefine: user-defined character library.
    		•
    Name String Figure name.
    SegmentSet Array of AiRecognitionTaskFaceSegmentItem Result set of segments that contain people.
    Gender String Gender
  • Male: man
  • Female: woman.
    		•
    Birthday String Date of birth of a person.
    Profession String Occupation or position.
    SchoolOfGraduation String Graduation institution of the person.
    Abstract String Figure description.
    PlaceOfBirth String Birthplace or place of origin of a person.
    PersonType String Person type:
  • Politician: official.
  • Artist: artist.
    		•
    Remark String Sensitivity labeling:
  • NORMAL: Normal;
  • Sensitive: sensitive.
    		•
    Url String Screenshot link

    AiRecognitionTaskFaceResultOutput

    Intelligent Face Recognition output.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskFaceSegmentItem

    Face Recognition result fragment

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskInput

    Input parameter type for video content recognition

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

    Name Type Required Description
    Definition Integer Yes Intelligent video identification template ID.
    UserExtPara String No User extension field, which does not need to be filled in for general scenarios.

    AiRecognitionTaskObjectResult

    Object recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCode Integer Error code. 0: Task successful. Other values: Task failed.
    Message String Error message.
    Input AiRecognitionTaskObjectResultInput Object recognition task input.
    Output AiRecognitionTaskObjectResultOutput

    AiRecognitionTaskObjectResultInput

    Object recognition task input type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Object recognition template ID.

    AiRecognitionTaskObjectResultItem

    Single object recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Name String Name of a recognized object.
    SegmentSet Array of AiRecognitionTaskObjectSeqmentItem List of segments that contain the object.

    AiRecognitionTaskObjectResultOutput

    Intelligent object recognition output.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ResultSet Array of AiRecognitionTaskObjectResultItem Intelligent object recognition result set.

    AiRecognitionTaskObjectSeqmentItem

    Object recognition result segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskOcrFullTextResult

    Full text recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskOcrFullTextResultInput Input information on the full text recognition task.
    Output AiRecognitionTaskOcrFullTextResultOutput

    AiRecognitionTaskOcrFullTextResultInput

    Full text recognition user-submitted input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Full text recognition template ID.

    AiRecognitionTaskOcrFullTextResultOutput

    Full text recognition output.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskOcrFullTextSegmentItem

    Full text recognition recording clip.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskOcrFullTextSegmentTextItem

    Full text recognition fragment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    AreaCoordSet Array of Integer

    Area coordinates of the recognition result. The array contains 4 elements [x1,y1,x2,y2], representing the horizontal and vertical coordinates of the top-left corner and bottom-right corner.
    Text String

    Recognized text.

    AiRecognitionTaskOcrWordsResult

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskOcrWordsResultInput Text keyword recognition task input.
    Output AiRecognitionTaskOcrWordsResultOutput

    AiRecognitionTaskOcrWordsResultInput

    Text keyword recognition input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Text keyword recognition template ID.

    AiRecognitionTaskOcrWordsResultItem

    Text keyword recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Word String Text keyword.
    SegmentSet Array of AiRecognitionTaskOcrWordsSegmentItem List of segments where the key text appears.

    AiRecognitionTaskOcrWordsResultOutput

    Text keyword recognition output.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskOcrWordsSegmentItem

    Text recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

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

    AiRecognitionTaskTransTextResult

    Translation result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskTransTextResultInput Translation task input information.
    Output AiRecognitionTaskTransTextResultOutput
    Progress Integer

    AiRecognitionTaskTransTextResultInput

    Translate the input.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Translation template ID.

    AiRecognitionTaskTransTextResultOutput

    Translation result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of AiRecognitionTaskTransTextSegmentItem Translate segments.
    SubtitlePath String Subtitle file path.

    AiRecognitionTaskTransTextSegmentItem

    Translated segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    StartTimeOffset Float

    Start time offset of the recognized segment, in seconds.
    EndTimeOffset Float

    End time offset of the recognized segment, in seconds.
    Text String

    Recognized text.
    Trans String

    Translated text.
    Wordlist Array of WordResult

    Word timestamp information.

    AiRestorationConfig

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String No

    Capability configuration switch

    Enumeration values:

    • ON: Enable
    • OFF: Disable

    Default value: OFF
    Type String No

    AiReviewPoliticalAsrTaskInput

    Content review Asr text sensitivity task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID.

    AiReviewPoliticalAsrTaskOutput

    Asr text contains sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Asr text sensitivity scoring, with a score ranging from 0 to -100.
    Suggestion String Asr text sensitive result recommendation, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Video segment list with Asr text suspected of sensitivity.

    AiReviewPoliticalOcrTaskInput

    Content review Ocr text sensitivity task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID.

    AiReviewPoliticalOcrTaskOutput

    Ocr text sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Ocr text sensitivity score, ranging from 0 to 100.
    Suggestion String Ocr text sensitive result recommendation, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Video segment list with suspect Ocr text sensitivity.

    AiReviewPoliticalTaskInput

    Content review sensitive task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID.

    AiReviewPoliticalTaskOutput

    Sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Video sensitive content score, ranging from 0 to 100.
    Suggestion String Result Suggestions for sensitive content, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    Label String Video sensitive content result tag. The mapping between the LabelSet parameter in the content moderation template's visual sensitive content task control parameter (https://www.tencentcloud.com/document/api/862/37615?from_cn_redirect=1#AiReviewPoliticalTaskOutput) and the parameter value range of this parameter:
    violation_photo:
  • violation_photo: violation icon.

    • Other (i.e., politician/entertainment/sport/entrepreneur/scholar/celebrity/military):
  • politician: sensitive person.
    		•
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem List of video segments suspected of containing sensitive content.

    AiReviewPornAsrTaskInput

    Content review Asr text porn detection task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Pornography detection template ID.

    AiReviewPornAsrTaskOutput

    Asr text pornographic information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Asr text porn score, ranging from 0 to 100.
    Suggestion String Asr text pornographic result suggestion, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Video segment list with suspect Asr text pornographic information.

    AiReviewPornOcrTaskInput

    Content review Ocr text porn detection task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID for porn detection.

    AiReviewPornOcrTaskOutput

    Ocr text pornographic information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Ocr text involves pornographic content scoring, with a score ranging from 0 to 100.
    Suggestion String Result Suggestions for Ocr text pornographic content, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Video segment list with suspect Ocr text pornographic information.

    AiReviewPornTaskInput

    Content review porn detection task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Required Description
    Definition Integer Yes

    AiReviewPornTaskOutput

    Pornographic result info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Video porn detection score, ranging from 0 to 100.
    Suggestion String Pornographic result recommendation, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    Label String Video pornographic result tag, value ranges from...to...
  • porn: pornography.
  • sexy: sexy.
  • vulgar: vulgarity.
  • intimacy: intimate behavior.
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments suspected of containing pornographic content.

    AiReviewProhibitedAsrTaskInput

    Content review Asr text prohibited information recognition task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Prohibited information recognition template ID.

    AiReviewProhibitedAsrTaskOutput

    Asr text contains prohibited information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Asr text involves prohibited content scoring, with a score ranging from 0 to 100.
    Suggestion String Asr text prohibited result suggestion, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Video segment list with Asr text suspected of prohibition violations.

    AiReviewProhibitedOcrTaskInput

    Content review Ocr text prohibited information recognition task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Prohibited information recognition template ID.

    AiReviewProhibitedOcrTaskOutput

    Ocr (Optical Character Recognition) text contains prohibited information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Ocr text involves prohibited content scoring, with a score ranging from 0 to 100.
    Suggestion String Ocr text prohibited content result suggestion, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Video segment list with Ocr text suspected of prohibition violations.

    AiReviewTaskPoliticalAsrResult

    Content review Asr text sensitivity task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPoliticalAsrTaskInput Content review Asr text sensitivity task input.
    Output AiReviewPoliticalAsrTaskOutput

    AiReviewTaskPoliticalOcrResult

    Content review Ocr text sensitive task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status, including PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPoliticalOcrTaskInput Content review Ocr text sensitivity task input.
    Output AiReviewPoliticalOcrTaskOutput

    AiReviewTaskPoliticalResult

    Content review sensitive task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPoliticalTaskInput Content review sensitive task input.
    Output AiReviewPoliticalTaskOutput

    AiReviewTaskPornAsrResult

    Content review Asr text porn detection task result kind

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPornAsrTaskInput Content review Asr text pornography detection task input.
    Output AiReviewPornAsrTaskOutput

    AiReviewTaskPornOcrResult

    Content review Ocr text pornography detection task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPornOcrTaskInput Content review Ocr text pornography detection task input.
    Output AiReviewPornOcrTaskOutput

    AiReviewTaskPornResult

    Content review porn detection task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewPornTaskInput Content review porn task input.
    Output AiReviewPornTaskOutput

    AiReviewTaskProhibitedAsrResult

    Content review Asr text prohibited content detection task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewProhibitedAsrTaskInput Content review Asr text prohibited task input.
    Output AiReviewProhibitedAsrTaskOutput

    AiReviewTaskProhibitedOcrResult

    Content review Ocr text prohibited content detection task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewProhibitedOcrTaskInput Content review Ocr text prohibited task input.
    Output AiReviewProhibitedOcrTaskOutput

    AiReviewTaskTerrorismOcrResult

    Content review Ocr text sensitive task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewTerrorismOcrTaskInput Content review Ocr text sensitivity task input.
    Output AiReviewTerrorismOcrTaskOutput

    AiReviewTaskTerrorismResult

    Content review sensitive task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiReviewTerrorismTaskInput Content review sensitive task input.
    Output AiReviewTerrorismTaskOutput

    AiReviewTerrorismOcrTaskInput

    Content review Ocr text sensitivity task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID.

    AiReviewTerrorismOcrTaskOutput

    Ocr text sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Ocr text sensitive content score, ranging from 0 to III.
    Suggestion String Ocr text sensitive result suggestion, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem List of video segments suspected of containing sensitive content in Ocr text.

    AiReviewTerrorismTaskInput

    Content review sensitive task input parameter type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Template ID.

    AiReviewTerrorismTaskOutput

    Sensitive information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float Video sensitive content score, ranging from 0 to 100.
    Suggestion String Result Suggestions for sensitive content, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    Label String Video sensitive content detection result tag, permissible range:
  • guns: weapons and firearms.
  • crowd: crowd gathering.
  • police: police force.
  • bloody: graphic violence.
  • banners: sensitive flags.
  • militant: militant.
  • explosion: explosions and fires.
  • terrorists: sensitive persons.
  • scenario: Sensitive content.
    		•
    SegmentSet Array of MediaContentReviewSegmentItem List of video segments suspected of containing sensitive content.

    AiSampleFaceInfo

    AI-based sample management - face information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

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

    AiSampleFaceOperation

    AI-based sample management - face data operation.

    Used by actions: ModifyPersonSample.

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

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

    AiSampleFailFaceInfo

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

    Used by actions: CreatePersonSample, ModifyPersonSample.

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

    AiSamplePerson

    AI-based sample management - figure information.

    Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

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

    AiSampleTagOperation

    AI-based sample management - tag operation.

    Used by actions: ModifyPersonSample, ModifyWordSample.

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

    AiSampleWord

    AI-based sample management - keyword output information.

    Used by actions: DescribeWordSamples.

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

    AiSampleWordInfo

    AI-based sample management - keyword input information.

    Used by actions: CreateWordSamples.

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

    AiStoryboardConfig

    Intelligent shot deconstruction configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No

    Capability configuration switch, available values: ON: Enable; OFF: Disable. Default value: ON.
    ProcessIndex Integer No

    Specify the serial number of the storyboard to extract. Counting begins from 0. If not specified, return all storyboards.

    AigcAudioExtraParam

    Used by actions: CreateAigcAudioTask.

    Name Type Required Description
    ResourceId String No

    AigcAudioOutputAudioInfo

    Output audio information of the AIGC audio generation task.

    Used by actions: DescribeAigcAudioTask.

    Name Type Required Description
    Url String No

    Audio URL.
    Duration Integer No

    Audio duration.

    AigcAudioOutputVideoInfo

    Output video information of the AIGC audio generation task.

    Used by actions: DescribeAigcAudioTask.

    Name Type Required Description
    Url String No

    Video URL.
    Duration Integer No

    Video duration.

    AigcAudioReferenceAudioInfo

    Used by actions: CreateAigcAudioTask.

    Name Type Required Description
    AudioUrl String No

    AigcAudioReferenceVideoInfo

    Used by actions: CreateAigcAudioTask.

    Name Type Required Description
    VideoUrl String No

    AigcImageExtraParam

    Extended parameters used for AIGC image generation.

    Used by actions: CreateAigcImageTask.

    Name Type Required Description
    AspectRatio String No

    Aspect ratio of the generated video.

    Supported aspect ratios for different models:

    1. Kling 2.1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9.
    2. Kling 3.0: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9.
    3. Kling 3.0-Omni: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9.
    4. Kling O1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9.
    5. Vidu q2: 16:9, 9:16, 1:1, 3:4, 4:3, 21:9, 2:3, and 3:2.
    6. MJ v7: The aspect ratio needs to be specified in the prompt.

    Note: For more information about the aspect ratios of specific models, see the model website.
    Resolution String No

    Output resolution of the image.

    Models that support this parameter:
    Valid values: 720P, 1080P, 2K, and 4K.
    LogoAdd Integer No

    Indicates whether to add a logo watermark. No watermark is added by default. 1 - A watermark is added. 0 - No watermark is added.

    Value range: [0, 1].

    Default value: 0.
    OutputFormat String No

    Specifies the output format of the image. JPEG and PNG formats are supported.

    AigcImageInfo

    Image information for AIGC generation.

    Used by actions: CreateAigcImageTask.

    Name Type Required Description
    ImageUrl String No Image URL for video generation. The URL must be accessible from the public network and must be accessible to crawlers.
    ReferenceType String No Reference Type.
    Note:
    1. When the model uses Vidu's q2 multi-reference image generation, it can also be used to specify the subject ID.
    2. If the GV model is used, this serves as the reference method. Valid values are asset and style.

    AigcStoreCosParam

    Used by actions: CreateAigcAudioTask, CreateAigcImageTask, CreateAigcVideoTask.

    Name Type Required Description
    CosBucketName String No
    CosBucketRegion String No
    CosBucketPath String No

    AigcTaskListItem

    Aigc task details

    Used by actions: DescribeAigcTaskList.

    Name Type Description
    TaskId String

    Task ID.
    TaskType String

    Task type

    Enumeration value:

    • VideoRedraw: Video redraw task
    • AIDrama: AI drama task
    TaskStatus String

    Task status

    Enumeration values:

    • PENDING: Task waiting for scheduling
    • RUNNING: Task running
    • FINISHED: Task executed successfully
    • STOP: Task termination
    • FAILED: Task failure
    • TIMEOUT: Task timeout
    CreateTime String

    Task creation time
    ScheduledTime String

    Task start scheduling time
    FinishedTime String

    Task end time
    Urls Array of String

    Task result Url.
    TaskResultCode Integer

    Task execution error code
    TaskResultMsg String

    Task execution error message
    Resolution String

    Output video resolution
    Ratio String

    Aspect ratio of the output video
    RequestBody String

    Task request package

    AigcVideoExtraParam

    Used by actions: CreateAigcVideoTask.

    Name Type Required Description
    Resolution String No
    AspectRatio String No
    LogoAdd Integer No
    EnableAudio Boolean No
    OffPeak Boolean No
    EnableBgm Boolean No

    AigcVideoReferenceAudioInfo

    Used by actions: CreateAigcVideoTask.

    Name Type Required Description
    AudioUrl String No

    AigcVideoReferenceImageInfo

    Used by actions: CreateAigcVideoTask.

    Name Type Required Description
    ImageUrl String No
    ReferenceType String No

    AigcVideoReferenceSubjectInfo

    Reference entity information.
    For the Vidu model:
    Id -> server_id. Principal ID obtained through the principal creation API.
    Principal ID, subsequently used in the format of @Principal ID.

    For the Kling model:
    element id, obtained through the principal creation API.

    Used by actions: CreateAigcVideoTask.

    Name Type Required Description
    Id String No

    ID of the reference subject.
    Name String No

    Subject name.
    VoiceId String No

    Main voice ID.
    ImageUrls Array of String No

    Main image list.
    VideoUrls Array of String No

    Main video list.

    AigcVideoReferenceVideoInfo

    Used by actions: CreateAigcVideoTask.

    Name Type Required Description
    VideoUrl String No

    url of the reference video. It must be accessible from the external network.
    It can be used as a feature reference video or a video for editing. By default, it is a video for editing. You can selectively retain the original sound of the video.
    The ReferType parameter specifies the reference video type: feature indicates feature reference video, and base indicates video for editing.
    When the reference video is a video for editing, you cannot define the first and last frame of the video.
    ReferType String No

    The ReferType parameter specifies the reference video type: feature indicates feature reference video, and base indicates video for editing.
    KeepOriginalSound String No

    The KeepOriginalSound parameter specifies whether to keep the original sound of the video. Valid values: yes (keep the original sound); no (remove the original sound). This parameter also applies to feature reference videos (feature).

    AnimatedGraphicTaskInput

    Type of rotating image tasks.

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

    Name Type Required Description
    Definition Integer Yes

    Video-to-GIF conversion template ID.
    StartTimeOffset Float Yes

    Start time of the GIF in the video, in seconds.
    EndTimeOffset Float Yes

    End time of the GIF in the video, in seconds.
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    Output path of the file after GIF conversion, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, see File Name Variable Description.
    Relative path example:

  • File name_{variable name}.{format}
  • File name.{format}
    • Absolute path example:
  • /custom path/file name_{variable name}.{format}
    • If this is not specified, the default relative path is {inputName}_animatedGraphic_{definition}.{format}.
    ExtInfo String No

    Extended parameter.

    AnimatedGraphicsTemplate

    Details of an animated image generating template.

    Used by actions: DescribeAnimatedGraphicsTemplates.

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

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

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

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

    ArtifactRepairConfig

    Artifact (burr) removal configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Type String No

    AsrFullTextConfigureInfo

    Speech Full-text Recognition Task Control Parameter

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Voice full-text recognition task switch, available values:
  • ON: Enable intelligent voice full-text recognition task.
  • OFF: Disables the intelligent voice full-text recognition task.
    		•
    SubtitleFormat String No Generated subtitle file format. Leaving it as an empty string or not filling it in means no subtitle file will be generated. Available values:
  • vtt: Generate a WebVTT subtitle file.
    		•
    SourceLanguage String No Video source language.

    AsrFullTextConfigureInfoForUpdate

    Task control parameter for speech full-text recognition

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Voice full-text recognition task switch, available values:
  • ON: Enable intelligent voice full-text recognition task.
  • OFF: Disables the intelligent voice full-text recognition task.
    		•
    SubtitleFormat String No Generated subtitle file format. Leaving it as an empty string means no subtitle file will be generated. Available values:
  • vtt: Generate a WebVTT subtitle file.
    		•
    SourceLanguage String No Video source language.

    AsrHotWordsConfigure

    Used by actions: BatchProcessMedia, CreateSmartSubtitleTemplate, DescribeSmartSubtitleTemplates, ModifySmartSubtitleTemplate, ProcessMedia.

    Name Type Required Description
    Switch String No
    LibraryId String No

    AsrHotwordsSet

    Returned result set of hotword lexicon query.

    Used by actions: DescribeAsrHotwordsList.

    Name Type Description
    HotwordsId String
    Status Integer
    Name String
    WordCount Integer
    FileName String
    CreateTime String
    UpdateTime String
    Type Integer

    AsrHotwordsSetItem

    Information on a single hotword.

    Used by actions: DescribeAsrHotwords.

    Name Type Description
    Id Integer Serial number of the hot word
    Text String Hotword text
    Weight Integer Hotword weight. The value can be 11 or 100 or be in the range of 1 to -10.

    AsrWordsConfigureInfo

    Voice keyword recognition control parameters.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Speech keyword recognition task switch, available values:
  • ON: Enable speech keyword recognition task.
  • OFF: Disables the speech keyword recognition task.
    		•
    LabelSet Array of String No Keyword-based filtering tag, specify the tag of the keyword to return. If left blank or empty, all results are returned.
    The number of tags is up to 10, and each tag can have up to 16 characters.

    AsrWordsConfigureInfoForUpdate

    Voice keyword recognition control parameters.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Speech keyword recognition task switch, available values:
  • ON: Enable speech keyword recognition task.
  • OFF: Disables the speech keyword recognition task.
    		•
    LabelSet Array of String No Keyword-based filtering tag. Specify the tag of the keyword that needs to be returned. If it is not filled or is empty, all results are returned.
    The number of tags is up to 10, and each tag can have up to 16 characters.

    AudioBeautifyConfig

    Volume beautification configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String No

    Capability configuration switch. Available values:

  • ON: Enable;
  • OFF: Disable.
    • Default value: ON.
    Types Array of String No

    Type. Multiple selections allowed. Available values:

  • declick: noise removal
  • deesser: de-ess
    • Default value: declick.

    AudioDenoiseConfig

    Audio noise reduction configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.

    AudioEnhanceConfig

    Audio enhancement configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Denoise AudioDenoiseConfig No
    Separate AudioSeparateConfig No
    VolumeBalance VolumeBalanceConfig No
    Beautify AudioBeautifyConfig No

    AudioSeparateConfig

    Audio separation configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Type String No
    Track String No

    AudioTemplateInfo

    Audio stream configuration parameters.

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

    Name Type Required Description
    Codec String Yes

    Audio stream encoding format.
    When audio transcoding is not needed, the valid value is:

  • copy.
    • When the outer parameter Container is mp3, the valid value is:
  • mp3.
    • When the outer parameter Container is ogg or flac, the valid value is:
  • flac.
    • When the outer parameter Container is m4a, the valid values are:
  • aac;
  • ac3.
    • When the outer parameter Container is mp4 or flv, the valid values are:
  • aac: suitable for mp4.
  • mp3: suitable for flv.
  • mp2.
    • When the outer parameter Container is hls, the valid values are:
  • aac.
  • mp3.
  • eac3: used when merging audio tracks with adaptive transcoding.
    • When the outer parameter Container is wav, the valid values are:
  • pcm16 and pcm24.
    		•
    Bitrate Integer Yes

    Audio stream bitrate, in kbps. Value range: 0 and [26, 256].
    When the value is 0, it means the audio bitrate remains consistent with that of the original audio.
    Note: If the TrackChannelInfo parameter is used for audio track merging with adaptive transcoding, the value range:
    1) cannot be 0.
    2) When Codec is aac, the value range is [26, 256].
    3) When Codec is ac3, the value range is [26, 640].
    4) When Codec is eac3, the value range is [26, 6144]. Note: When SampleRate is 44100HZ, the maximum value is 5644. When SampleRate is 48000HZ, the maximum value is 6144.
    SampleRate Integer Yes

    Audio stream sampling rate. Different sampling rate options are provided for different encoding standards. Enter 0 to use the source audio sampling rate.
    For details, see Audio Sampling Rate Range.
    Unit: Hz.
    Note: Ensure the source audio stream sampling rate is within the supported range. Otherwise, transcoding may fail.
    AudioChannel Integer No

    Audio channel mode. Valid values:

  • 0: The number of audio channels follows that of the source.
  • 1: Single channel.
  • 2: Two channels.
  • 6: 5.1 channels.
    • When the media container format is an audio format (mp3), the number of audio channels cannot be set to 5.1.

    Default value: 2.
    Note: If you set the audio channel to follow that of the source and the audio encoding format does not support the current audio channel, the transcoding task may fail.
    TrackChannelInfo AudioTrackChannelInfo No
    AudioLanguage String No

    Audio track language, such as chi or eng. Note: (1) This follows the ISO 639-2 standard. (2) This applies only to adaptive bitrate streaming templates. (3) The value "source" means that the source language is used.
    AudioName String No

    Audio track name, such as Chinese or English. Note: (1) Only Chinese characters, letters, digits, spaces, underscores (_), hyphens (-), periods (.), and brackets are supported. The length cannot exceed 64 characters. (2) This applies only to adaptive bitrate streaming templates. (3) The value "source" means that the source name is used.
    DefaultTrack Boolean No

    Default audio track. When set to true, the current audio track is designated as the default audio track. A maximum of 1 default audio track can be specified.

    Default value: false.

    AudioTemplateInfoForUpdate

    Audio stream configuration parameters

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

    Name Type Required Description
    Codec String No
    Bitrate Integer No
    SampleRate Integer No
    AudioChannel Integer No
    StreamSelects Array of Integer No

    AudioTrackChannelInfo

    Audio track information.

    Used by actions: CreateTranscodeTemplate.

    Name Type Required Description
    ChannelsRemix Integer No
    SelectType String No
    InputTrackInfo Array of TrackInfo No

    AwsS3FileUploadTrigger

    An AWS S3 file upload trigger.

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

    Name Type Required Description
    S3Bucket String Yes The AWS S3 bucket bound to the scheme.
    S3Region String Yes The region of the AWS S3 bucket.
    Dir String No The 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.
    Formats Array of String No The 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.
    S3SecretId String No Secret key ID of the bound AWS S3 bucket.
    S3SecretKey String No Secret Key of the bound AWS S3 bucket.
    AwsSQS AwsSQS No SQS event queue bound to the AWS S3 bucket.
    Note: The queue and bucket need to be in the same region.

    AwsSQS

    Aws SQS queue information

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

    Name Type Required Description
    SQSRegion String Yes
    SQSQueueName String Yes
    S3SecretId String No
    S3SecretKey String No

    BatchSmartSubtitlesResult

    Smart subtitle task result.

    Used by actions: DescribeBatchTaskDetail, ParseNotification.

    Name Type Description
    Input SmartSubtitleTaskResultInput
    Outputs Array of SmartSubtitleTaskBatchOutput

    BatchSubTaskResult

    Results of subtasks for a batch task.

    Used by actions: DescribeBatchTaskDetail, ParseNotification.

    Name Type Description
    InputInfos Array of MediaInputInfo
    Metadatas Array of MediaMetaData
    SmartSubtitlesTaskResult BatchSmartSubtitlesResult

    BlindWatermarkInput

    Digital watermark parameter type in the MPS task.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

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

    BlindWatermarkTemplate

    Digital watermark template details.

    Used by actions: DescribeBlindWatermarkTemplates.

    Name Type Description
    Definition Integer Unique identifier of the digital watermark template.
    Type String Digital watermark type. Valid values:
  • blind-basic: basic copyright digital watermark;
  • blind-nagra: NAGRA forensics watermark.
    		•
    Name String Digital watermark template name.
    TextContent String Text content of the digital watermark template. The length cannot exceed 64 characters.
    Comment String Description information of the digital watermark template.
    CreateTime String Creation time of the digital watermark template in ISO date and time format.
    UpdateTime String Last modification time of the digital watermark template in ISO date and time format.
    Strength String Digital watermark strength.
    default: default, balance between hd video quality and resilience.
    stronger: clear image quality, strong resilience.
    strongest: normal video quality, strongest resilience.

    ClassificationConfigureInfo

    Intelligent Classification Task Control Parameters

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Intelligent classification task switch.
  • ON: Turn on intelligent classification.
  • OFF: Disables the intelligent classification task.
    		•

    ClassificationConfigureInfoForUpdate

    Control parameter of intelligent categorization task

    Used by actions: ModifyAIAnalysisTemplate.

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

    CloneViralAIGC

    Hit product clone AIGC video parameters

    Used by actions: CloneViral.

    Name Type Required Description
    Duration Integer No

    Video duration

    Range: [4, 15]
    AspectRatio String No

    Aspect ratio. Options: 16:9/4:3/1:1/3:4/9:16/21:9/adaptive
    Resolution String No

    Resolution. Supports 720p (default)/1080p/2k/4k
    ModelTier String No

    Model tier. flagship (default), standard

    CloneViralContent

    Content/style parameters of hit product clone

    Used by actions: CloneViral.

    Name Type Required Description
    UserPrompt String No

    Custom prompt describing requirements for video generation
    Language String No

    Target language for video generation. Default: not specified. Supported values: zh / en / ja / ko / es / pt / instrumental (pure music without voiceover)
    Market String No

    Target market. Default: not specified. Supported values: north_america / europe / china / japan / korea / sea / brazil
    FissionLevel String No

    Fission level. Values: exact/low/medium/high. Default: exact (1:1 clone)

    CloneViralPersona

    Model appearance of hit product clone

    Used by actions: CloneViral.

    Name Type Required Description
    Gender String No

    Model gender. Values: male/female/any
    Age String No

    Age segment. Values: teenager/youth/middle_aged/senior
    Ethnicity String No

    Appearance feature. Values: caucasian/asian/latino/african/middle_eastern
    BodyType String No

    Body type. Values: slim / standard / athletic / chubby

    CloneViralProduct

    Product information of hit product clone

    Used by actions: CloneViral.

    Name Type Required Description
    Images Array of String Yes

    Product image
    Name String No

    Product name
    Description String No

    Product description

    ColorEnhanceConfig

    Color enhancement configuration

    Used by actions: CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage.

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

    • Default value: ON.
    Type String No

    ComposeAudioItem

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

    Used by actions: EditMedia.

    Name Type Required Description
    SourceMedia ComposeSourceMedia Yes The media information of the element.
    TrackTime ComposeTrackTime No The time of the element in the timeline. If this is not specified, the element will follow the previous element.
    AudioOperations Array of ComposeAudioOperation No The operations performed, such as muting.

    ComposeAudioOperation

    The audio operations of a video editing/compositing task.

    Used by actions: EditMedia.

    Name Type Required Description
    Type String Yes The operation type. Valid values:
  • Volume: Volume adjustment.
    • Volume Float No The 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.

    Name Type Required Description
    Codec String No The 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.
    • SampleRate Integer No The sample rate (Hz) of the audio stream.
  • 16000 (default)
  • 32000
  • 44100
  • 48000
    		•
    AudioChannel Integer No The number of sound channels. Valid values:
    u200c
  • 1: Mono.
  • 2: Dual (default).
    • Bitrate Integer No Reference bitrate, in kbps. Value range: 26-10000.
    If set, the encoder will try to encode at this bitrate.
    If not set, the service will automatically adopt a suitable bitrate based on audio parameters.

    ComposeCanvas

    The canvas information of a video editing/compositing task.

    Used by actions: EditMedia.

    Name Type Required Description
    Color String No The RGB value of the background color. The format is #RRGGBB, such as #F0F0F0.
    Default value: #000000 (black).
    Width Integer No The 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.
    Height Integer No The 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.

    Name Type Required Description
    Duration String Yes The 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.

    Name Type Required Description
    SourceMedia ComposeSourceMedia Yes The media information of the element.
    TrackTime ComposeTrackTime No The time of the element in the timeline. If this is not specified, the element will follow the previous element.
    XPos String No The 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%.
    YPos String No The 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%.
    Width String No The 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.
    • Height String No The 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.
    • ImageOperations Array of ComposeImageOperation No The image operations, such as image rotation.

    ComposeImageOperation

    The image operations of a video editing/compositing task.

    Used by actions: EditMedia.

    Name Type Required Description
    Type String Yes The type. Valid values:
    u200c
  • Rotate: Image rotation.
  • Flip: Image flipping.
    • RotateAngle Float No This is valid if Type is Rotate. The angle of rotation around the image center. Value range: 0–360.
    FlipType String No This 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.

    Name Type Required Description
    TargetInfo ComposeTargetInfo No The information of the output video.
    Canvas ComposeCanvas No The canvas information of the output video.
    Styles Array of ComposeStyles No The global styles. This parameter is used together with Tracks to specify styles, such as the subtitle style.
    Tracks Array of ComposeMediaTrack No The 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.

    Name Type Required Description
    Type String Yes The element type. Valid values:
  • Video
  • Audio
  • Image
  • Transition
  • Subtitle
  • Empty
    • Video ComposeVideoItem No The information of the video element, which is valid if Type is Video.
    Audio ComposeAudioItem No The information of the audio element, which is valid if Type is Audio.
    Image ComposeImageItem No The information of the image element, which is valid if Type is Image.
    Transition ComposeTransitionItem No The information of the transition element, which is valid if Type is Transition.
    Subtitle ComposeSubtitleItem No The information of the subtitle element, which is valid if Type is Subtitle.
    Empty ComposeEmptyItem No The 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.

    Name Type Required Description
    Type String Yes Track type. Valid values:
    • Video: video track. It can consist of the following elements:
      • Video elements
      • Image elements
      • Transition elements
      • Empty elements
    • Audio: audio track. It can consist of the following elements:
      • Audio elements
      • Transition elements
      • Empty elements
    • Title: text track. It can consist of the following elements:
      • Subtitle elements
    Items Array of ComposeMediaItem Yes The elements of a track.

    ComposeSourceMedia

    The material source of a video editing/compositing task.

    Used by actions: EditMedia.

    Name Type Required Description
    FileId String Yes The material ID, which can be found in FileInfos.
    StartTime String No The 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.
    EndTime String No The 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.

    Name Type Required Description
    Id String Yes The 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 -_
    Type String Yes The type. Valid values:
  • Subtitle: The subtitle style.
    • Subtitle ComposeSubtitleStyle No The 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.

    Name Type Required Description
    StyleId String Yes The subtitle style ID, which corresponds to the Id field of ComposeStyles.
    Text String Yes Subtitle text. note: long text may exceed the frame. recommend using \n for line breaks.
    TrackTime ComposeTrackTime No The 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.

    Name Type Required Description
    Height String No The 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.
    MarginBottom String No The 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.
    FontType String No The font type. Valid values:
  • SimHei(default): Chinese font Heiti.

    • <Li>SimSun: Chinese font Songti.
    FontSize String No The 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%.
    FontBold Integer No Whether to bold the text (some fonts may not support bold). Valid values:
  • 0 (default): No.
  • 1: Yes.
    • FontItalic Integer No Whether to italicize the text (some fonts may not support italics). Valid values:
  • 0 (default): No.
  • 1: Yes.
    • FontColor String No The font color (#RRGGBBAA).
    Default value: 0x000000FF (black).
    Note: AA in the color notation defines the opacity of the color. It's optional.
    FontAlign String No The text alignment. Valid values:
  • Center(default)
  • Left
  • Right
    • FontAlignMargin String No The 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.
    • BorderWidth String No The 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.
    BorderColor String No The border color, whose format is the same as that for FontColor. This parameter is valid if BorderWidth is not 0.
    BottomColor String No The 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.

    Name Type Required Description
    Container String No The container. Valid values:
  • mp4 (default), for video files.
  • mp3, for audio files.
    • RemoveVideo Integer No Whether to remove video data. Valid values:
  • 0 (default): No.
  • 1: Yes.
    • RemoveAudio Integer No Whether to remove audio data. Valid values:
  • 0 (default): No.
  • 1: Yes.
    • VideoStream ComposeVideoStream No The information of the output video stream.
    AudioStream ComposeAudioStream No The 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.

    Name Type Required Description
    Start String No The 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.
    Duration String No The 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.

    Name Type Required Description
    Duration String No The 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.
    • Transitions Array of ComposeTransitionOperation No The 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.

    Name Type Required Description
    Type String Yes The 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.

    Name Type Required Description
    SourceMedia ComposeSourceMedia Yes The media information of the element.
    TrackTime ComposeTrackTime No The time of the element in the timeline. If this is not specified, the element will follow the previous element.
    XPos String No The 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%.
    YPos String No The 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%.
    Width String No The 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.
    • Height String No The 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.
    • ImageOperations Array of ComposeImageOperation No The image operations, such as image rotation.
    AudioOperations Array of ComposeAudioOperation No The audio operations, such as muting.

    ComposeVideoStream

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

    Used by actions: EditMedia.

    Name Type Required Description
    Codec String No The codec. Valid values:
  • H.264 (default)
    • Fps Integer No The 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.
    Bitrate Integer No Reference bitrate, in kbps. Value range: 50-35000.
    If set, the encoder will try to encode at this bitrate.
    If not set, the service will automatically adopt a suitable bitrate based on the complexity of an image.

    ContainerDiagnoseResultItem

    Container format diagnostic result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Category String
    Type String
    SeverityLevel String
    DateTimeSet Array of String
    TimestampSet Array of Float

    ContentReviewTemplateItem

    Details of a content audit template

    Used by actions: DescribeContentReviewTemplates.

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

    • Note: this field may return null, indicating that no valid values can be obtained.
    UserDefineConfigure UserDefineConfigureInfo Custom content audit control parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    Type String The 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.

    Name Type Required Description
    Bucket String Yes Name of the COS bucket bound to a workflow, such as TopRankVideo-125xxx88.
    Region String Yes Region of the COS bucket bound to a workflow, such as ap-chongiqng.
    Dir String No Input path directory bound to a workflow, such as /movie/201907/. If this parameter is left empty, the / root directory will be used.
    Formats Array of String No All supported formats are as follows:
    - Video file extension. The following 15 options are supported:
    .mp4, .avi, .mov, .wmv, .flv, .mkv, .mpg, .mpeg, .rm, .rmvb, .asf, .3gp, .webm, .ts, and .m4v.
    - Audio file extension. The following 7 options are supported:
    .mp3, .wav, .aac, .flac, .ogg, .m4a, and .amr.
    - Subtitle file extension. The following 2 options are supported:
    .vtt and .srt.
    - *: any file format is supported.
    - Unspecified or input an empty list: the system supports the following preset file formats: video (.mp4, .ts, .flv, .wmv, .asf, .rm, .rmvb, .mpg, .mpeg, .3gp, .mov, .webm, .mkv, .avi, and .m4v); audio (.mp3, .m4a, .flac, .ogg, .wav, .amr, and .aac); subtitle (.vtt and .srt).
    Note:
    1. If the input format list includes *, it indicates that any file format is supported.
    2. File extensions can be provided with or without ., such as .mp4 or mp4, both are supported.
    3. Custom file extensions should consist of digits, letters, and characters, and have a length between 1 and 64 characters.

    CosInputInfo

    Media processing COS object information.

    Used by actions: BatchProcessMedia, CreateSubtitleEmbedTemplate, DescribeImageTaskDetail, DescribeMediaMetaData, DescribeSubtitleEmbedTemplates, DetectVideoSubtitleArea, DetectVideoWatermark, ExtractBlindWatermark, ModifySubtitleEmbedTemplate, ProcessImage, ProcessMedia.

    Name Type Required Description
    Bucket String Yes Name of the COS Bucket where the media processing object file resides, for example, TopRankVideo-125xxx88.
    Region String Yes Region of the COS Bucket where the media processing object file resides, for example, ap-chongqing.
    Object String Yes Input path of the media processing object file, for example /movie/201907/WildAnimal.mov.

    CosOutputStorage

    Media processing COS output object information.

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

    Name Type Required Description
    Bucket String No Target Bucket name for the output files generated by media processing, for example, TopRankVideo-125xxx88. If left empty, the upper-level Bucket is inherited.
    Region String No Park of the target Bucket for outputting media processing generated files, for example, ap-chongqing. If left empty, it is inheritable from the upper layer.

    CoverConfigureInfo

    Intelligent Cover Task Control Parameters

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Intelligent Cover Task Switch. Valid values:
  • ON: Enable intelligent thumbnail generation.
  • OFF: Disables the intelligent thumbnail generation task.
    		•

    CoverConfigureInfoForUpdate

    Control parameter of intelligent cover generating task

    Used by actions: ModifyAIAnalysisTemplate.

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

    CustomModel

    Product fission model info

    Used by actions: CreateAiFissionTask.

    Name Type Required Description
    Gender String No

    Gender

    Enumeration value:

    • male: man
    • female: woman
    • any: unlimited
    Age String No

    Age range.

    Enumeration values:

    • teen: youth
    • young_adult: adulthood
    • middle_aged: middle-aged
    • mature: mature
    Appearance String No

    Appearance

    Enumeration value:

    • caucasian: White
    • asian: Asian
    • latino: Latino
    • african: African
    • middle_eastern: Middle Eastern
    BodyType String No

    Body shape

    Enumeration value:

    • slim: Slim
    • standard: Standard
    • athletic: Healthy
    • chubby: Chubby

    CustomVariable

    Custom description variable.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Type String No

    User-defined variable type.

    Parameter format: PascalCase format.

    This cannot be UserPrompt. The default platform template is not adapted for custom content. Submit a ticket if needed.
    Description String No

    Custom variable description.

    DiagnoseResult

    Diagnosis result item.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Category String
    Type String
    Timestamp Float
    Description String
    DateTime String
    SeverityLevel String

    DiffusionEnhanceConfig

    LLM enhancement.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String No Capability configuration switch. Valid values:

    ON: enabled.
    OFF: disabled.
    Default value: OFF.
    Type String No

    DocToVideoBackgroundInfo

    Background image information for AIGC document-to-video generation

    Used by actions: CreateDocToVideoTask.

    Name Type Required Description
    ImageUrl String No

    Background image URL for video generation.

    DocToVideoCosInfo

    cos information. Stores user-provided cos information for saving results

    Used by actions: CreateDocToVideoTask.

    Name Type Required Description
    CosBucketRegion String No

    cos bucket region
    CosBucketName String No

    cos bucket name
    CosBucketPath String No

    cos bucket path

    DocToVideoInput

    AIGC document-to-video input

    Used by actions: CreateDocToVideoTask.

    Name Type Required Description
    FileUrl Array of String Yes

    Document link for video generation.

    Supported document types: pdf, pptx, docx, png, jpg
    Document count limit: 3
    Document size limit: 10MB
    Document page limit: 100
    Prompt String Yes

    Prompt information for video generation.

    Prompt length limit: 2,000 characters.
    ModelName String Yes

    Document-to-video model name

    Default value: Wand
    ModelVersion String Yes

    Document-to-video model version number

    Default value: 1.0
    Ratio String No

    Aspect ratio of the generated video.

    Enumeration values:

    • 16:9: 16:9
    • 9:16: 9:16
    • 1:1: 1:1

    Default value: 16:9
    Language String No

    Language of the generated video.

    Enumeration values:

    • zh: Chinese
    • en: English
    • ja: Japanese
    • ko: Korean
    • ru: Russian
    • fr: French
    • es: Spanish
    • de: German

    Default value: zh
    ReferenceDuration Integer No

    Video duration for reference.

    This is not an exact duration; it serves as a reference for the LLM only.

    Range: [15, 1200]

    Unit: second
    EnableTTS Boolean No

    Whether the AI dubbing feature is enabled.

    Default value: false
    VoiceId String No

    Voice ID. Valid only when AI dubbing feature is enabled.
    PPTXFidelity Boolean No

    Whether PPTX high-fidelity clone mode is enabled.

    When enabled, the content of the input PPTX document will be cloned as much as possible, but perfect cloning is not possible.
    Animated effects cannot be cloned temporarily.

    When enabled, ensure the input document contains at least one PPTX document.
    If there are multiple PPTX documents, only the first document will be cloned with high fidelity.

    Default value: false
    Mode String No

    Video generation mode.

    Enumeration values:

    • stage: Generation mode upon confirmation
    • auto: End-to-end direct generation mode
    Background DocToVideoBackgroundInfo No

    Background image information used to generate the video.

    It only takes effect when PreserveLayout is false.
    Watermark DocToVideoWatermarkInfo No

    Watermark image information for video generation.

    It only takes effect when PreserveLayout is false.
    EnableCaption Boolean No

    Whether subtitle generation is enabled.

    Default value: false

    DocToVideoRegenerateInput

    Input information for regenerating an AIGC document-to-video task

    Used by actions: ModifyDocToVideoTaskStatus.

    Name Type Required Description
    Scope String Yes

    Regeneration scope.

    Enumeration values:

    • full: Full regeneration at this stage (for example, modifying the overall number of scenarios)
    • scenes: Partial regeneration by scenario (for example, modifying the specific content of a scenario)
    Prompt String Yes

    Prompt content for regeneration.
    SceneIds Array of String No

    Target page ID array for partial regeneration by page. Required only when Scope=scenes. Not repeatable. Up to 5 pages can be regenerated at a time.

    DocToVideoWatermarkInfo

    Watermark image information for AIGC document-to-video generation

    Used by actions: CreateDocToVideoTask.

    Name Type Required Description
    ImageUrl String No

    Watermark image URL for video generation.
    Position String No

    Watermark image location.

    Enumeration values:

    • top-left: top-left corner
    • top-right: top-right corner
    • bottom-left: bottom-left corner
    • bottom-right: bottom-right corner

    DrmInfo

    Drm encryption information.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Type String Yes Encryption type.

    - simpleaes
    Can only be used for HLS. Format support: ts and mp4.
    Only slice mode can be used. singlefile mode cannot be used.

    - fairplay:
    Can only be used for HLS. The segment format can only be mp4.
    Slice mode or singlefile mode can be used.

    - widevine:
    Can be used for HLS and DASH. The segment format can only be mp4.
    Output HLS: The slicing or singlefile mode can be used.
    Output DASH: can only be in singlefile mode

    - playready:
    Can be used for HLS and DASH. The segment format can only be mp4.
    Output HLS: The slicing or singlefile mode can be used.
    Output DASH: can only be in singlefile mode

    - widevine+fairplay,playready+fairplay,widevine+playready+fairplay:
    Can only be used for HLS. The segment format can only be mp4.
    Slice mode or singlefile mode can be used.

    - widevine+playready:
    Applicable to HLS and MPEG-DASH. The segment format can only be mp4.
    For HLS format, you can use the slicing mode or singlefile mode.
    For MPEG-DASH, only singlefile mode can be used.
    SimpleAesDrm SimpleAesDrm No
    SpekeDrm SpekeDrm No Information about FairPlay, WideVine, and PlayReady encryption.

    DstSubtitleInput

    AI Dubbing external translation subtitle information

    Used by actions: ProcessMedia.

    Name Type Required Description
    DstSubtitleInfo MediaInputInfo No

    External translation subtitle information.

    DubbingConfig

    dubbing task configuration

    Used by actions: ProcessMedia.

    Name Type Required Description
    DubbingMode String Yes

    Dubbing type. Available values: FullAutoEmotionClone: fully automated high-emotion clone dubbing; RoleBasedSmartDubbing: intelligent dubbing by role; SingleVoice: specify a single voice type;
    BackgroundVolume Integer No

    Background sound volume, range: 0-100

    Default value: 80
    SecondaryTuning String No

    Secondary fine-tuning switch. Available values:
    ON: enable secondary fine-tuning;
    OFF: disable secondary fine-tuning;

    Default value: OFF

    It can be set to ON only for RoleBasedSmartDubbing.
    VoiceId String No

    Specify voice tone

    Valid only for SingleVoice and required for Create
    DubbingVersion String No

    Dubbing version. Available values: v1, v2

    Default value: v2

    Only takes effect in FullAutoEmotionClone (fully automated high-emotion clone dubbing) mode

    DubbingEmbedSubtitleConfig

    Subtitle suppression configuration for a dubbing task

    Used by actions: ProcessMedia.

    Name Type Required Description
    SubtitleEmbedId Integer No

    id of the suppressed subtitles.
    UseOriginalPos Integer No

    Continue to use the original subtitle position.

    Default value: 1
    UseOriginalSize Integer No

    Continue to use the original subtitle font size.

    Default value: 1

    DubbingOutputConfig

    dubbing task output configuration

    Used by actions: ProcessMedia.

    Name Type Required Description
    OutputMode String No

    Output method

    Enumeration values:

    • FinalVideoOnly: default, final video only
    • AudioAndSubtitle: translation audio + translation subtitle
    • Custom: customization

    Default value: FinalVideoOnly

    No translation audio and subtitle are returned when using external subtitles
    OutputFinalVideo String No

    Output video switch

    Enumeration values:

    • ON: Enable
    • OFF: Disable

    Default value: ON

    Only takes effect in Custom mode
    OutputSubtitle String No

    Switch to output subtitle files (contains both original voice subtitles and target language subtitles)

    Enumeration values:

    • ON: enable
    • OFF: disable

    Default value: OFF
    OutputDstAudio String No

    Audio switch for output translation dubbing

    Enumeration values:

    • ON: Enable
    • OFF: Disable

    Default value: OFF

    Only takes effect in Custom mode
    EmbedSubtitleConfig DubbingEmbedSubtitleConfig No

    Subtitle suppression configuration message.

    DubbingSubtitleConfig

    dubbing task translation configuration

    Used by actions: ProcessMedia.

    Name Type Required Description
    SubtitleSource String No

    Subtitle source.

    Enumeration values:

    • OCR: OCR text recognition, recognizes text in video frames.
    • ASR: ASR speech recognition, recognizes voice dialogue in videos.
    • External: External subtitle file, provide the URL of the original/translated subtitles.
    AsrAssistOcr String No

    Use ASR to assist OCR.

    Enumeration values:

    • ON: Enable the use of ASR to assist OCR.
    • OFF: Disable the use of ASR to assist OCR.

    Default value: OFF

    Can be set to ON only when SubtitleSource=OCR
    EraseOriginalSubtitle String No

    Erase the original subtitle.

    Enumeration values:

    • ON: Erase the original subtitle.
    • OFF: Retain the original subtitle.

    Default value: OFF

    Cannot be set to ON when SubtitleSource=External
    SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig No

    Subtitle location information.

    DubbingTranslateConfig

    dubbing task translation configuration

    Used by actions: ProcessMedia.

    Name Type Required Description
    VideoSrcLanguage String Yes

    Source language.
    TranslateDstLanguage String Yes

    Target language of the translation.
    SimplifyTranslation String No

    Intelligent translation simplification.

    Enumeration values:

    • ON: Turn on intelligent translation simplification.
    • OFF: Turn off intelligent translation simplification.

    Default value: OFF

    EditMediaFileInfo

    Edit on-demand video file information

    Used by actions: DescribeTaskDetail, EditMedia, ParseNotification.

    Name Type Required Description
    InputInfo MediaInputInfo Yes Input video information.
    StartTimeOffset Float No [Edit] task takes effect, video editing start time offset, measurement unit: second.
    EndTimeOffset Float No [Edit] task takes effect, video editing end time offset, measurement unit: second.
    Id String No

    EditMediaOutputConfig

    Configuration for output files of video editing

    Used by actions: EditMedia.

    Name Type Required Description
    Container String No The container. Valid values: mp4 (default), hls, mov, flv, avi.
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String No Editing mode. Optional values:
    normal (default): Precise editing
    fast: Fast editing, with faster processing speed but lower precision to some extent
    Note: fast only supports individual files, and the default output transcoding format of normal is h264.
    Note: This field may return null, indicating that no valid value can be obtained.

    EditMediaTask

    Edit video task info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TaskId String Task ID.
    Status String Task status. Valid values:
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCode Integer Error code.
  • 0: Success;
  • Additional values: fail.
    		•
    Message String Error message.
    Input EditMediaTaskInput Input for video editing tasks.
    Output EditMediaTaskOutput

    EditMediaTaskInput

    Input for the video editing task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    FileInfoSet Array of EditMediaFileInfo Input video file information.

    EditMediaTaskOutput

    Output of the video editing task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    OutputStorage TaskOutputStorage Target storage for the edited file.
    Path String Path of the edited video file.
    MetaData MediaMetaData

    EmbeddingData

    Embedding API input:
    Type Data type; currently only supports textData Data content; currently only supports text strings

    Used by actions: EmbeddingData.

    Name Type Required Description
    Type String Yes

    Data type

    Enumeration values:

    • text: Text
    Data String Yes

    Data content. When Type is text, it is a text string.

    EmbeddingResultItem

    Embedding result

    Used by actions: EmbeddingData.

    Name Type Description
    Result Array of Float

    Vector

    EnhanceConfig

    Audio/video enhancement configuration

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

    Name Type Required Description
    VideoEnhance VideoEnhanceConfig No
    AudioEnhance AudioEnhanceConfig No

    EraseArea

    Used by actions: CreateSmartEraseTemplate, CreateSmartSubtitleTemplate, DetectVideoSubtitleArea, ModifySmartEraseTemplate, ModifySmartSubtitleTemplate, ProcessMedia.

    Name Type Required Description
    LeftTopX Float Yes

    Top-left X-axis coordinate of the area.
    For example, when Unit is 1, meaning percentage is used, 0.05 indicates the horizontal distance from the top-left corner of the area to the top-left corner of the entire frame is 5% of the frame width.
    LeftTopY Float Yes

    Y-coordinate of the upper left corner of the region.
    For example, when Unit is 1, meaning usage percentage, 0.1 indicates the vertical distance from the upper left corner of the region to the upper left corner of the entire frame is 10% of the screen height.
    RightBottomX Float Yes

    X-coordinate of the bottom-right corner of the region.
    For example, when Unit is 1, meaning percentage is used, 0.75 indicates the horizontal distance from the bottom-right corner of the region to the top-left corner of the entire frame is 75% of the frame width.
    RightBottomY Float Yes

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

    Coordinate unit

    • 1 Percentage
    • 2 Pixel value

    EraseTimeArea

    Used by actions: CreateSmartEraseTemplate, ModifySmartEraseTemplate, ProcessMedia.

    Name Type Required Description
    BeginMs Integer Yes
    EndMs Integer Yes
    Areas Array of EraseArea Yes

    ExecRuleTaskData

    Conditional judgment output.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    RearDriveIndex Array of Integer Indexes of nodes that needs to be executed based on the conditional judgment for quality inspection.

    ExecRulesTask

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

    Name Type Required Description
    Rules Array of Rules No

    ExtractBlindWatermarkTask

    Extract video digital watermark task information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TaskId String Media processing task ID.
    Status String Task flow status. Valid values:
  • WAITING: waiting.
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCode Integer Error code. 0 indicates success. Other values indicate failure.
    Message String Error message.
    InputInfo MediaInputInfo Target file info of Media Processing Service.
    Type String Digital watermark type. Valid values:
  • blind-basic: basic copyright digital watermark;
  • blind-ab: ab copyright digital watermark.
    		•
    IsDetected Boolean Tag whether a watermark is detected. If this parameter is true, the Result field will return the watermark extraction Result. If this parameter is false, the Result field will not return it.
    Result String Watermark content fetched. Field will not be returned if no digital watermark is detected.
    ExtractBlindWatermarkConfig ExtractBlindWatermarkTaskConfig Extract digital watermark configuration.

    ExtractBlindWatermarkTaskConfig

    Extracts the digital watermark task configuration for video transcoding.

    Used by actions: DescribeTaskDetail, ExtractBlindWatermark, ParseNotification.

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

    FaceConfigureInfo

    Face Recognition task control parameter

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Face Recognition task switch. Valid values:
  • ON: Enable intelligent face recognition task.
  • OFF: Disables the intelligent face recognition task.
    		•
    Score Float No Face recognition filter score. Returns recognition result when the recognition result reaches or exceeds this score. Default is 95. Value ranges from 0 to 100.
    DefaultLibraryLabelSet Array of String No Default character filter tag. Specify the tag of the default character to be returned. If left blank or empty, all default character results will be returned. Tag value range:
  • entertainment: entertainment star;
  • Sport: sports celebrity;
  • politician: sensitive person.
    		•
    UserDefineLibraryLabelSet Array of String No User-defined character filter tag. Specify the tag of the user-defined character to be returned. If left blank or empty, all customized figure results will be returned.
    The number of tags is up to 100, and each tag can have up to 16 characters.
    FaceLibrary String No Figure library selection. Available values:
  • Default: Use default character library;
  • UserDefine: Use a user-defined character library.
  • All: Use default character library and user-defined character library simultaneously.

    • Default value: All, using the default figure library and user-defined character library.

    FaceConfigureInfoForUpdate

    Face Recognition Task Control Parameter

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Face Recognition task switch. Valid values:
  • ON: Enable intelligent face recognition task.
  • OFF: Disables the intelligent face recognition task.
    		•
    Score Float No Face recognition filter score. Returns the recognition result when the recognition result reaches this score or higher. Value ranges from 0 to 100.
    DefaultLibraryLabelSet Array of String No Default character filter tag. Specify the tag of the default character to be returned. If left blank or empty, all default character results will be returned. Tag value range:
  • entertainment: entertainment star;
  • Sport: sports celebrity;
  • politician: sensitive person.
    		•
    UserDefineLibraryLabelSet Array of String No User-defined character filter tag. Specify the tag of the user-defined character to return. If left blank or empty, all custom character results are returned.
    The number of tags is up to 100, and each tag can have up to 16 characters.
    FaceLibrary String No Figure library selection. Available values:
  • Default: Use default character library;
  • UserDefine: Use the user-defined character library.
  • All: Use default character library and user-defined character library simultaneously.
    		•

    FaceEnhanceConfig

    Face enhancement configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No Whether to enable the feature. Valid values:
  • ON
  • OFF

    • Default value: ON.
    Intensity Float No Intensity, value ranges from 0.0 to 1.0.
    Default: 0.0.

    File3D

    Query returns each output file

    Used by actions: QueryHunyuan3DTask.

    Name Type Required Description
    Type String No

    File type: OBJ / GLB / FBX / STL / USDZ

    Enumeration values:

    • OBJ: common 3D exchange format
    • GLB: glTF 2.0 binary ("the JPEG of the 3D world")
    • FBX: Autodesk film/gaming industry standard
    • STL: 3D print/CAD triangle mesh
    • USDZ: Pixar/Apple packaged scenario description
    Url String No

    File download URL (temporary signature, general TTL 24h)
    PreviewImageUrl String No

    Preview image URL (if it exists)

    FissionTaskInfo

    Product fission task info

    Used by actions: CreateAiFissionTask.

    Name Type Required Description
    Duration Integer No

    Video output duration

    Range: [1, 15]

    Unit: seconds

    Default value: 15
    ModelTier String No

    Model gearbox

    Enumeration value:

    • standard: Standard version
    • flagship: Flagship edition
    Ratio String No

    Video image ratio

    Enumeration values:

    • 9:16: 9:16
    • 16:9: 16:9
    • 1:1: -1:1
    • 3:4: 3:4
    • 4:3: 4:3
    Resolution String No

    Output resolution

    Enumeration values:

    • 720p: 720p
    • 1080p: 1080p
    • 2k: 2k
    • 4k: 4k
    Market String No

    Target market

    Enumeration values:

    • north_america: North America
    • europe: Europe
    • china: China
    • japan: Japan
    • korea: South Korea
    • southeast_asia: Southeast Asia
    • brazil: Brazil
    • global: Global
    • other: Other

    Impacts the default model ethnicity and localized style. When CustomModel is not specified, the ethnicity is automatically determined by the market.
    Language String No

    Voiceover/subtitle language

    Enumeration value:

    • english: English
    • chinese: Chinese
    • japanese: Japanese
    • korean: Korean
    • spanish: Spanish
    • portuguese: Portuguese
    • music_only: Music only, no voiceover
    VideoType String No

    Video type

    Enumeration value:

    • ugc: UGC seeding
    • talk: Product talk
    • display: Product display (product only, no voice)
    • unboxing: Out-of-the-box sharing
    • reaction: Reaction show
    SplitCount Integer No

    Fission count

    Value ranges from 0 to 1

    Unit: unit
    CustomModel CustomModel No

    Customize an on-camera model

    FrameRateConfig

    Frame interpolation frame rate configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Fps Integer No

    FrameRateWithDenConfig

    New frame interpolation configuration, which supports fractional frame rates.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    FpsNum Integer No
    FpsDen Integer No

    FrameTagConfigureInfo

    Intelligent Frame Tagging Task Control Parameter

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Intelligent frame tagging task switch. Valid values:
  • ON: Enable intelligent frame-specific tagging task.
  • OFF: Disables the intelligent frame-specific tagging task.
    		•

    FrameTagConfigureInfoForUpdate

    Control parameter of intelligent frame-specific tagging task

    Used by actions: ModifyAIAnalysisTemplate.

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

    HLSConfigureInfo

    HLS configuration parameters

    Used by actions: CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate.

    Name Type Required Description
    ItemDuration Integer No Duration of TS file, unit: second, value ranges from 5 to 30 seconds.

    Leave it blank and it defaults to 30 seconds.
    Interval Integer No Recording period, unit: second, value ranges from 10 minutes to 12 hr.

    Leave it blank defaults to 10 minutes (3600 seconds).
    ContinueTimeout Integer No Continuation waiting time, unit: second. Value range: 60 seconds to 1800 seconds.
    Leave blank defaults to 0 (recording continuation disabled).

    HdrConfig

    HDR configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Type String No

    HeadTailParameter

    Opening and ending segments parameter.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    HeadSet Array of MediaInputInfo No
    TailSet Array of MediaInputInfo No

    HighlightSegmentItem

    Intelligent highlight collection segments.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Confidence Float Confidence degree.
    StartTimeOffset Float Segment start time offset.
    EndTimeOffset Float End time offset of the recording clip.
    SegmentTags Array of String
    BeginTime String The start time of a live streaming segment, in the ISO date format.
    EndTime String The end time of a live streaming segment, in the ISO date format.
    Title String Highlight title.
    Summary String Highlight overview.

    ImageAreaBoxInfo

    Information on the box selection area in an image.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Type String No Type of the box selection area in the image. Valid values:
  • logo: icon.
  • Text: text.

    • Default value: logo.
    AreaCoordSet Array of Integer No Coordinates (pixel-level) of the box selection area in the image, in the format of [x1, y1, x2, y2]. It indicates the coordinates of the top left corner and the bottom right corner. Note: The maximum value of this field is 4096.
    For example, [101, 85, 111, —].
    BoundingBox Array of Float No Coordinates of the box selection area in the image, in the format of [x1, y1, x2, y2]. It indicates the coordinates of the top left corner and the bottom right corner. This parameter is valid only when AreaCoordSet is not specified. When it indicates the pixel, the maximum value of this field is 4096.
    - [0.1, 0.1, 0.3, 0.3]: indicates the ratio (values are less than 1).
    - [50, 50, 350, 280]: indicates the pixel (values are greater than or equal to 1).
    BoundingBoxUnitType Integer No BoundingBox field unit. When the value is set to 0, select the unit automatically according to the field rule. When it is set to 1, the unit is ratio. When it is set to 2, the unit is pixel.

    ImageDenoiseConfig

    Image denoising configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No Capability configuration enabling status. Valid values:
  • ON: enabled.
  • OFF: disabled.

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

    • Default value: weak.

    ImageEncodeConfig

    Image encoding format parameters

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Format String No Image format. Valid values: JPEG, PNG, BMP, and WebP. If it is not specified, the original image format is used. Animations are not supported.
    Quality Integer No Relative image quality. Valid range: 1 - 100. The value is based on the original image quality, and the default is the original image quality.

    ImageEnhanceConfig

    Image enhancement parameters

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    SuperResolution SuperResolutionConfig No Super-resolution configuration.
    AdvancedSuperResolutionConfig AdvancedSuperResolutionConfig No Advanced super-resolution configuration.
    Denoise ImageDenoiseConfig No Denoising configuration.
    ImageQualityEnhance ImageQualityEnhanceConfig No Comprehensive enhancement configuration.
    ColorEnhance ColorEnhanceConfig No Color enhancement configuration.
    SharpEnhance SharpEnhanceConfig No Detail enhancement configuration.
    FaceEnhance FaceEnhanceConfig No Face enhancement configuration.
    LowLightEnhance LowLightEnhanceConfig No Low-light enhancement configuration.

    ImageEraseConfig

    Image erasing parameter.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    ImageEraseLogo ImageEraseLogoConfig No Icon erasing configuration.

    ImageEraseLogoConfig

    Icon erasing configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

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

    • Default value: ON.
    ImageAreaBoxes Array of ImageAreaBoxInfo No Multiple box selection areas that need to be erased, with a maximum of 16 areas available.
    Note: This field may return null, indicating that no valid values can be obtained.

    ImageProcessTaskOutput

    Image processing result information.

    Used by actions: DescribeImageTaskDetail.

    Name Type Description
    Path String
    OutputStorage TaskOutputStorage
    Content String

    Processing result of the image-to-text task.
    FileId String

    VOD Standard Edition FileId

    ImageProcessTaskResult

    Result type of the image processing task.

    Used by actions: DescribeImageTaskDetail.

    Name Type Description
    Status String
    ErrMsg String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String
    Output ImageProcessTaskOutput
    Progress Integer

    ImageQualityEnhanceConfig

    Comprehensive enhancement configuration

    Used by actions: CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage.

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

    • Default value: ON.
    Type String No

    ImageSpriteTaskInput

    Sprite sheet capturing task input parameter type

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

    Name Type Required Description
    Definition Integer Yes

    Sprite screenshot template ID.
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    Output path of the sprite screenshot image file after the sprite screenshot is taken, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, see File Name Variable Description.
    Relative path example:

  • File name_{variable name}.{format}
  • File name.{format}
    • Absolute path example:
  • /custom path/file name_{variable name}.{format}
    • If this is not specified, the default relative path is {inputName}_imageSprite_{definition}_{number}.{format}.
    WebVttObjectName String No

    Output path of the Web VTT file after the sprite screenshot is taken, which can only be a relative path. If this is not specified, the default relative path is {inputName}_imageSprite_{definition}.{format}.
    ObjectNumberFormat NumberFormat No
    ExtInfo String No

    Extended parameter.

    ImageSpriteTemplate

    Details of an image sprite generating template

    Used by actions: DescribeImageSpriteTemplates.

    Name Type Description
    Definition Integer Unique ID of an image sprite generating template.
    Type String Template type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
    		•
    Name String Name of an image sprite generating template.
    Width Integer Subimage width of an image sprite.
    Height Integer Subimage height of an image sprite.
    ResolutionAdaptive String Resolution adaption. Valid values:
  • open: enabled. In this case, Width represents the long side of a video, while Height the short side;
  • close: disabled. In this case, Width represents the width of a video, while Height the height.

    • Default value: open.
    SampleType String Sampling type.
    SampleInterval Integer Sampling interval.
    RowCount Integer Subimage row count of an image sprite.
    ColumnCount Integer Subimage column count of an image sprite.
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    FillType String Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
  • stretch: Stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
  • black: Fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.

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

    ImageTaskInfo

    Used by actions: DescribeImageTasks.

    Name Type Required Description
    TaskId String No
    Status String No
    Input String No
    CreateTime String No
    BeginProcessTime String No
    FinishTime String No
    SubTaskHasFailed Boolean No

    ImageTaskInput

    Image task input parameters

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, DescribeProcessImageTemplates, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    EncodeConfig ImageEncodeConfig No

    Image encoding configuration.
    EnhanceConfig ImageEnhanceConfig No

    Image enhancement configuration.
    EraseConfig ImageEraseConfig No

    Image erasing configuration.
    AiPosterSuiteConfig AiPosterSuiteConfig No

    AI image set configuration.
    AiCutoutConfig AiCutoutConfig No

    Ai image cutout configuration
    AiExpansionConfig AiExpansionConfig No

    Ai Image Expansion Configuration
    AiStoryboardConfig AiStoryboardConfig No

    Ai storyboard deconstruction configuration
    UnderstandImageConfig UnderstandImageConfig No

    Image understanding configuration.

    ImageWatermarkInput

    Input parameter of an image watermarking template

    Used by actions: CreateWatermarkTemplate.

    Name Type Required Description
    ImageContent String Yes String generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
    Width String No Width of a watermark, supporting two formats: % and px.
  • If a string ends with %, it indicates that the Width of a watermark is a percentage of a video's width. For example, 10% means that Width is 10% of a video's width.
  • If a string ends with px, the Width of a watermark will be in pixels. For example, 100px means that Width is 100 pixels. Value range: [8, 4096].


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

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

    ImageWatermarkInputForUpdate

    Input parameter of an image watermarking template

    Used by actions: ModifyWatermarkTemplate.

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


    		•
    RepeatType String No Repeat type of an animated watermark. Valid values:
  • once: no longer appears after watermark playback ends.
  • repeat_last_frame: stays on the last frame after watermark playback ends.
  • repeat (default): repeats the playback until the video ends.
    		•

    ImageWatermarkTemplate

    Image watermarking template

    Used by actions: DescribeWatermarkTemplates.

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

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

    LLMDetectionIssue

    Issue detected by the LLM.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Tag String

    Issue category tag.
    Description String

    Issue description.
    Score Float

    Quality score of the issue. Value range: [0, 100].
    Confidence Float

    Detection confidence for the issue. Value range: [0, 100].
    StartTimeMs Integer

    Issue start time (ms).
    EndTimeMs Integer

    Issue end time (ms).
    ExtraData String

    Additional data (JSON format), such as severity and other supplementary information.

    LLMDetectionReport

    LLM detection result report.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    ResultCount Integer

    Number of detection results.
    ResultSet Array of LLMDetectionResultItem

    Detection item result list.

    LLMDetectionResultItem

    Aggregation results of each LLM detection item.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Category String

    Detection category.

    Enumeration value:

    • AIGCQualityCharacteristics: AIGC quality characteristics.
    Group String

    Detection group.

    Enumeration values:

    • AIGCAuthenticity: AIGC authenticity, including human body plausibility, physical plausibility, and cross-frame consistency.
    • AIGCTechQuality: AIGC technology quality, including aspect ratio, black border, and forced portrait mode.
    Type String

    Detection type name.

    Enumeration values:

    • BodyPoseCheck: Human body pose plausibility, which belongs to AIGCAuthenticity.
    • BodyDetailCheck: Human body detail plausibility, including finger count and facial symmetry, which belongs to AIGCAuthenticity.
    • PhysicRulesCheck: Physics rules plausibility, including perspective, lighting, and gravity, which belongs to AIGCAuthenticity.
    • ObjectConsistencyCheck: Cross-frame object consistency, which belongs to AIGCAuthenticity.
    • FormatCheck: Aspect ratio, black border, forced portrait mode, and other format issues, which belong to AIGCTechQuality.
    Score Float

    Overall quality score. Value range: [0, 100]. Higher values indicate better quality.
    Confidence Float

    Detection confidence. Value range: [0, 100]. Higher values indicate greater certainty.
    IssueSet Array of LLMDetectionIssue

    List of issues detected. This is empty if no issue is detected.

    LiveActivityResItem

    The output of a live scheme subtask.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    LiveRecordTask LiveScheduleLiveRecordTaskResult The output of a live recording task.
    Note: This field may return null, indicating that no valid values can be obtained.
    LiveQualityControlTask ScheduleQualityControlTaskResult Media quality inspection task output.
    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.

    Name Type Description
    ActivityType String Atomic task type.
  • LiveRecord: live recording
  • AiQualityControl: media quality inspection
    		•
    LiveActivityResItem LiveActivityResItem The task output.
    Note: This field may return null, indicating that no valid values can be obtained.

    LiveAiAnalysisDescriptionItem

    Information about the live streaming summary result.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Paragraphs Array of LiveAiParagraphInfo

    LiveAiParagraphInfo

    Segment information.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Summary String Segment summary.
    Title String Segment title.
    Keywords Array of String Segment keyword.
    StartTimeOffset Float Starting time point of the segment, in seconds.
    EndTimeOffset Float End time point of the segment, in seconds.
    BeginTime String The start time of a live streaming segment, in the ISO date format.
    EndTime String The end time of a live streaming segment, in the ISO date format.

    LiveRecordFile

    Live streaming Recording output file information

    Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification.

    Name Type Description
    Url String
    Size Integer
    Duration Integer
    StartTime String
    EndTime String

    LiveRecordResult

    The live recording result.

    Used by actions: DescribeTaskDetail.

    Name Type Description
    OutputStorage TaskOutputStorage The storage of the recording file.
    Note: This field may return null, indicating that no valid values can be obtained.
    FileList Array of LiveRecordFile The 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.

    Name Type Required Description
    Definition Integer Yes The live recording template ID.
    OutputStorage TaskOutputStorage No The 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.
    OutputObjectPath String No The output path of the recording file.
    Note: This field may return null, indicating that no valid values can be obtained.

    LiveRecordTemplate

    Live recording template description

    Used by actions: DescribeLiveRecordTemplates.

    Name Type Description
    Definition Integer Unique identifier of the recording template.
    HLSConfigure HLSConfigureInfo HLS configuration parameters
    MP4Configure MP4ConfigureInfo MP4 configuration parameter.
    Name String Recording template name.
    Comment String Template description information.
    Type String Template type. Valid values:
  • Preset: system preset template;
  • Custom: user-defined template.
    		•
    CreateTime String Template creation time in ISO datetime format.
    UpdateTime String Last modification time of the template in ISO datetime format.
    RecordType String Recording type. Valid values: video: audio and video recording; audio: audio recording; auto: automatic detection.

    LiveScheduleLiveRecordTaskResult

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

    Used by actions: DescribeTaskDetail.

    Name Type Description
    Status String The task status. Valid values: PROCESSING, SUCCESS, FAIL.
    ErrCodeExt String The error code. An empty string indicates the task is successful; 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.
    ErrCode Integer The 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.
    Message String The error message.
    Note: This field may return null, indicating that no valid values can be obtained.
    Input LiveRecordTaskInput The input of a live recording task.
    Note: This field may return null, indicating that no valid values can be obtained.
    Output LiveRecordResult The output of a live recording task.
    Note: This field may return null, indicating that no valid values can be obtained.
    BeginProcessTime String The time when the task was started, in ISO date format.
    Note: This field may return null, indicating that no valid values can be obtained.
    FinishTime String The 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.

    Name Type Description
    TaskId String Live orchestration task ID.
    Status String Task stream status. Valid values:
  • PROCESSING: processing
  • FINISH: completed
    		•
    ErrCode Integer An error code other than 0 is returned in case of a source exception. Use the error code of the specific task when a value of 0 is returned.
    Message String The corresponding exception message is returned in case of a source exception. If no source exception occurs, use the message of each specific task.
    Url String Live stream URL.
    LiveActivityResultSet Array of LiveActivityResult The task output.
    Note: This field may return null, indicating that no valid values can be obtained.

    LiveSmartSubtitleResult

    Live stream smart subtitle result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Text String Recognized text.
    StartPTSTime Float Start PTS time of a translated recording clip, in seconds.
    EndPTSTime Float End PTS time of a translated recording clip, in seconds.
    Trans String Translated text.
    StartTime String
    EndTime String
    SteadyState Boolean
    UserId String

    LiveSmartSubtitlesTaskInput

    Used by actions: ProcessLiveStream.

    Name Type Required Description
    Definition Integer No
    UserExtPara String No

    LiveStreamAiAnalysisResultInfo

    Live stream analysis result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    ResultSet Array of LiveStreamAiAnalysisResultItem

    LiveStreamAiAnalysisResultItem

    Live streaming AI analysis result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Type String Result type. Valid values:
  • SegmentRecognition: video splitting.
  • Highlight: highlight.
  • Description: summary.
    		•
    SegmentResultSet Array of SegmentRecognitionItem
    HighlightResultSet Array of MediaAiAnalysisHighlightItem
    DescriptionResult LiveAiAnalysisDescriptionItem Summary result. It is valid when Type is Description.

    LiveStreamAiQualityControlResultInfo

    Live stream media quality inspection result.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    QualityControlResultSet Array of QualityControlResult
    DiagnoseResultSet Array of DiagnoseResult

    LiveStreamAiRecognitionResultInfo

    Live streaming AI recognition result

    Used by actions: ParseLiveStreamProcessNotification.

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

    LiveStreamAiRecognitionResultItem

    Live stream AI recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Type String Result type. Valid values:
  • FaceRecognition: face recognition.
  • AsrWordsRecognition: speech keyword recognition.
  • OcrWordsRecognition: text keyword recognition.
  • AsrFullTextRecognition: full speech recognition.
  • OcrFullTextRecognition: full text recognition.
  • TransTextRecognition: speech translation
  • ObjectRecognition: object detection.
  • TagRecognition: highlights marking.
    		•
    FaceRecognitionResultSet Array of LiveStreamFaceRecognitionResult Face recognition result, which is valid when Type is
    FaceRecognition is valid at that time.
    AsrWordsRecognitionResultSet Array of LiveStreamAsrWordsRecognitionResult Speech keyword recognition result. When Type is
    AsrWordsRecognition.
    OcrWordsRecognitionResultSet Array of LiveStreamOcrWordsRecognitionResult Text keyword recognition result. When Type is
    OcrWordsRecognition.
    AsrFullTextRecognitionResultSet Array of LiveStreamAsrFullTextRecognitionResult Full speech recognition result. When Type is
    AsrFullTextRecognition.
    OcrFullTextRecognitionResultSet Array of LiveStreamOcrFullTextRecognitionResult Full text recognition result, when Type is
    OcrFullTextRecognition.
    TransTextRecognitionResultSet Array of LiveStreamTransTextRecognitionResult Translation result. Valid when Type is TransTextRecognition.
    ObjectRecognitionResultSet Array of LiveStreamObjectRecognitionResult Object recognition result, which is valid when Type is ObjectRecognition.
    TagRecognitionResultSet Array of LiveStreamTagRecognitionResult

    LiveStreamAiReviewImagePoliticalResult

    Live stream AI content review image sensitive result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment, in seconds.
    EndPtsTime Float End PTS time of a suspected segment, in seconds.
    Confidence Float Sensitive score of the suspected segment.
    Suggestion String Result suggestion for suspected segment porn detection, permissible range:
  • pass
  • review
  • block
    		•
    Label String Video sensitive result tag, value ranges from...to...
  • politician: sensitive person.
  • violation_photo: violation icon.
    		•
    Name String Sensitive person, violative icon name.
    AreaCoordSet Array of Integer Area coordinates (pixel-level) where sensitive persons or violation icons appear. Format: [x1, y1, x2, y2], which indicates the coordinates of the top-left corner and the bottom-right corner.
    Url String Suspected image URL (Images are not retained permanently upon arrival)
    The image will be deleted after the PicUrlExpireTime time point.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    LiveStreamAiReviewImagePornResult

    Live stream AI content review image pornographic result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment, in seconds.
    EndPtsTime Float End PTS time of a suspected segment, in seconds.
    Confidence Float Suspected segment porn score.
    Suggestion String Pornographic result suggestion for suspected segment, value ranges from...to...
  • pass
  • review
  • block
    		•
    Label String Pornographic result tag for video, value ranges from...to...
  • porn: pornography.
  • sexy: sexy.
  • vulgar: vulgarity.
  • intimacy: intimate behavior.
    		•
    Url String Suspected image URL (Images are not retained permanently upon arrival)
    The image will be deleted after the PicUrlExpireTime time point.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    LiveStreamAiReviewImageTerrorismResult

    Live stream AI content review image sensitive result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment, in seconds.
    EndPtsTime Float End PTS time of a suspected segment, in seconds.
    Confidence Float Suspected segment sensitivity score.
    Suggestion String Suspected segment sensitive result suggestion, permissible range:
  • pass
  • review
  • block
    		•
    Label String Video sensitive content result tag, value ranges from...to...
  • guns: weapons and firearms.
  • crowd: crowd gathering.
  • police: police force.
  • bloody: graphic violence.
  • banners: sensitive flags.
  • militant: militant.
  • explosion: explosions and fires.
  • terrorists: sensitive persons.
    		•
    Url String Suspected image URL (Images are not retained permanently upon arrival)
    The image will be deleted after the PicUrlExpireTime time point.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    LiveStreamAiReviewResultInfo

    Live stream AI review result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    ResultSet Array of LiveStreamAiReviewResultItem Content moderation result list.

    LiveStreamAiReviewResultItem

    Live stream AI review result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Type String Review result type. Valid values:
  • ImagePorn: image porn detection.
  • ImageTerrorism: image terrorism.
  • ImagePolitical: image political sensitivity.
  • VoicePorn: sound rule violation.
    		•
    ImagePornResultSet Array of LiveStreamAiReviewImagePornResult Image porn detection result, valid when Type is ImagePorn.
    ImageTerrorismResultSet Array of LiveStreamAiReviewImageTerrorismResult Result of image terrorism detection, valid when Type is ImageTerrorism.
    ImagePoliticalResultSet Array of LiveStreamAiReviewImagePoliticalResult The result of image sensitivity, valid when Type is ImagePolitical.
    VoicePornResultSet Array of LiveStreamAiReviewVoicePornResult Result of sound rule violation, valid when Type is VoicePorn.

    LiveStreamAiReviewVoicePornResult

    Live stream AI content review sound pornographic result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    StartPtsTime Float Start PTS time of a suspected segment, in seconds.
    EndPtsTime Float End PTS time of a suspected segment, in seconds.
    Confidence Float Suspected segment porn score.
    Suggestion String Pornographic result suggestion for suspected segment, value ranges from...to...
  • pass
  • review
  • block
    		•
    Label String Video porn detection result tag, value ranges from...to...
  • sexual_moan: Moan.
    		•

    LiveStreamAiSmartSubtitleResultInfo

    Live stream smart subtitle result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    SmartSubtitleResult Array of LiveSmartSubtitleResult Live stream smart subtitle task result list.

    LiveStreamAsrFullTextRecognitionResult

    Live stream recognition Asr full text recognition

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Text String Recognized text.
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.
    StartTime String
    EndTime String
    SteadyState Boolean
    UserId String

    LiveStreamAsrWordsRecognitionResult

    Live streaming AI Asr word recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Word String Speech keyword.
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.

    LiveStreamFaceRecognitionResult

    Live streaming AI face recognition result.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Id String Unique identification ID of a figure.
    Name String Figure name.
    Type String Figure library type, which indicates which figure library the recognized figure comes from.
  • Default: Default figure library;
  • UserDefine: User-defined character library.
    		•
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of the recognition result. An array contains four elements: [x1, y1, x2, y2], representing the horizontal and vertical coordinates of the top-left and bottom-right corners, respectively.

    LiveStreamObjectRecognitionResult

    Live streaming AI object recognition result.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Name String Name of a recognized object.
    StartPtsOffset Float Start PTS time of a recognized segment, in seconds.
    EndPtsOffset Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of the recognition result. An array contains four elements: [x1, y1, x2, y2], representing the horizontal and vertical coordinates of the top-left and bottom-right corners, respectively.
    Url String

    LiveStreamOcrFullTextRecognitionResult

    Live stream recognition Ocr full text recognition

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Text String Speech and text.
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.
    AreaCoordSet Array of Integer Zone coordinates of the recognition result. An array contains four elements: [x1, y1, x2, y2], representing the horizontal and vertical coordinates of the top-left and bottom-right corners, respectively.

    LiveStreamOcrWordsRecognitionResult

    Live streaming AI Ocr word recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Word String Text keyword.
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.
    AreaCoords Array of Integer Zone coordinates of the recognition result. An array contains four elements: [x1, y1, x2, y2], representing the horizontal and vertical coordinates of the top-left and bottom-right corners, respectively.

    LiveStreamProcessErrorInfo

    Live stream processing error information

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    ErrCode Integer Error code.
  • 0 means no error.
  • Non-zero means error. Refer to the error information in Message.
    		•
    Message String Error message.

    LiveStreamProcessTask

    Information of a live stream processing task

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String The media processing task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: Processing;
  • FINISH: Completed.
    		•
    ErrCode Integer Error code. 0: success; other values: failure.
    Message String Error message.
    Url String Live stream URL.

    LiveStreamRecordResultInfo

    Live stream recording result.

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    RecordOver Integer
    FileResults Array of LiveRecordFile

    LiveStreamTagRecognitionResult

    Live streaming AI timestamp recognition result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Id String Timestamp events.
    StartPtsTime Float Start PTS time of a recognized segment, in seconds.
    EndPtsTime Float End PTS time of a recognized segment, in seconds.
    Confidence Float Confidence of a recognized segment. Value range: 0-100.

    LiveStreamTaskNotifyConfig

    Used by actions: ProcessLiveStream.

    Name Type Required Description
    NotifyType String No
    NotifyUrl String No
    CmqModel String No
    CmqRegion String No
    QueueName String No
    TopicName String No
    NotifyKey String No

    LiveStreamTransTextRecognitionResult

    Live stream real-time translation result

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Text String Recognized text.
    StartPtsTime Float Start PTS time of a translated fragment, in seconds.
    EndPtsTime Float End PTS time of a translated segment, in seconds.
    Confidence Float Confidence of a translated segment. Value range: 0-100.
    Trans String Translated text.
    StartTime String
    EndTime String
    SteadyState Boolean
    UserId String

    LowLightEnhanceConfig

    Low-light enhancement configuration

    Used by actions: CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage.

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

    • Default value: ON.
    Type String No

    MP4ConfigureInfo

    MP4 configuration parameter.

    Used by actions: CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate.

    Name Type Required Description
    Interval Integer No Recording duration, in seconds. The interval can range from 10 minutes to 720 minutes. It is 60 minutes (3,600 seconds) by default.

    MediaAiAnalysisClassificationItem

    Intelligent classification result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Classification String Category name for intelligent classification.
    Confidence Float Reliability of intelligent classification, with a value range from 0 to 100.

    MediaAiAnalysisCoverItem

    Intelligent cover information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    CoverPath String Intelligent cover storage path.
    Confidence Float Reliability of the intelligent cover, with a value range from 0 to -100.

    MediaAiAnalysisDescriptionItem

    Intelligent description information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Description String Intelligent description.
    Confidence Float Confidence of the intelligent description, with a value range from 0 to 100.
    Title String Intelligent description title.
    Keywords Array of String Intelligent description keywords.
    Paragraphs Array of AiParagraphInfo
    MindMapUrl String
    MindMapPath String Path of the mind map of a summary task.
    SubtitlePath String Subtitle file path of the video.
    OutputStorage TaskOutputStorage Storage location of the summary file.

    MediaAiAnalysisFrameTagItem

    Intelligent frame tagging result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Tag String Tag name by frame.
    CategorySet Array of String Classification list by frame tag name. CategorySet.N indicates the (N+1)th level classification.
    For example, when the Tag is "tower", CategorySet contains two elements: CategorySet.0 is "scenario" and CategorySet.1 is "building", which means the frame Tag is "tower", the first-level category is "scenario", and the second-level category is "building".
    Confidence Float Reliability of frame tagging, with a value range from 0 to -100.

    MediaAiAnalysisFrameTagSegmentItem

    Frame tagging segments

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Offset time starting from frame tagging.
    EndTimeOffset Float Offset time for frame tagging completion.
    TagSet Array of MediaAiAnalysisFrameTagItem Tag list within the time segment.

    MediaAiAnalysisHighlightItem

    Intelligent highlight info

    Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification.

    Name Type Description
    HighlightPath String Intelligent highlight address.
    CovImgPath String Intelligent highlight cover address.
    Confidence Float Reliability of the intelligent highlights, with a value range from 0 to 100.
    Duration Float Intelligent highlight duration.
    SegmentSet Array of HighlightSegmentItem Intelligent highlight sub-clip list.
    HighlightUrl String
    CovImgUrl String

    MediaAiAnalysisTagItem

    Intelligent tag result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Tag String Tag name.
    Confidence Float Reliability of the tag, with a value range from 0 to -100.
    SpecialInfo String Varies based on different types.

    MediaAnimatedGraphicsItem

    Video motion graphic result information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Storage TaskOutputStorage Storage location of the animated image file.
    Path String File path of the animated image.
    Definition Integer Rotating image template ID. Please refer to the Rotating Image Template.
    Container String Animated image file format, for example gif.
    Height Integer Height of the animated image, measurement unit: px.
    Width Integer Width of the animated image, measurement unit: px.
    Bitrate Integer Animated image bitrate. Measurement unit: bps.
    Size Integer Animated image size, unit: byte.
    Md5 String md5 value of the animated image.
    StartTimeOffset Float Start time offset of the GIF in the video, in seconds.
    EndTimeOffset Float End time offset of the GIF in the video, in seconds.

    MediaAudioStreamItem

    Audio stream information of VOD files

    Used by actions: DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Bitrate Integer Bitrate of the audio stream. Unit: bps.
    SamplingRate Integer Sampling rate of the audio stream. Unit: hz.
    Codec String Audio stream encoding format, for example, aac.
    Channel Integer
    Codecs String
    Loudness Float

    MediaContentReviewAsrTextSegmentItem

    Content review Asr text audit suspected segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment, in seconds.
    EndTimeOffset Float End time offset of a suspected segment, in seconds.
    Confidence Float Confidence degree of the suspected segment.
    Suggestion String Review result suggestion for suspected segment, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    KeywordSet Array of String Suspicious keyword list.

    MediaContentReviewOcrTextSegmentItem

    Content review Ocr text audit suspected segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment, in seconds.
    EndTimeOffset Float End time offset of a suspected segment, in seconds.
    Confidence Float Confidence degree of the suspected segment.
    Suggestion String Result Suggestions for suspected segment review, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    KeywordSet Array of String Suspicious keyword list.
    AreaCoordSet Array of Integer Area coordinates of suspected text occurrence (pixel-level), [x1, y1, x2, y2], i.e., coordinates of the top-left corner and bottom-right corner.
    Url String Suspected image URL (Images are not retained permanently, reaching
    The image will be deleted after the PicUrlExpireTime time point.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    MediaContentReviewPoliticalSegmentItem

    Content review suspected segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment, in seconds.
    EndTimeOffset Float End time offset of a suspected segment, in seconds.
    Confidence Float Suspected segment sensitivity score.
    Suggestion String Suspected segment sensitive result suggestion, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    Name String Sensitive person, violative icon name.
    Label String Suspected segment sensitive result Tag. The mapping between the LabelSet parameter in the content moderation template visual sensitive task control parameter and the parameter value range of this parameter:
    violation_photo:
  • violation_photo: violation icon.

    • politician:
  • nation_politician: State leaders;
  • province_politician: provincial and ministerial leaders;
  • bureau_politician: bureau-level official;
  • county_politician: county-level official;
  • rural_politician: township-level official;
  • sensitive_politician: sensitive person.
  • foreign_politician: state leaders of other countries.

    • entertainment:
  • sensitive_entertainment: sensitive entertainment figure.

    • sport:
  • Sensitive_sport: sensitive sports celebrity.

    • entrepreneur:
  • sensitive_entrepreneur: sensitive entrepreneur.

    • scholar:
  • sensitive_scholar: Sensitive educational scholars.

    • celebrity:
  • sensitive_celebrity: sensitive celebrity.
  • historical_celebrity: historical celebrity.

    • military:
  • sensitive_military: sensitive military figure.
    		•
    Url String Suspected image URL (Images are not retained permanently upon arrival)
    The image will be deleted after the PicUrlExpireTime time point.
    AreaCoordSet Array of Integer Area coordinates of sensitive person and violation icon occurrence (pixel-level), [x1, y1, x2, y2], i.e., coordinates of the top-left corner and coordinate of the bottom-right corner.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    MediaContentReviewSegmentItem

    Content review suspected pornographic/sensitive segment

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTimeOffset Float Start time offset of a suspected segment, in seconds.
    EndTimeOffset Float End time offset of a suspected segment, in seconds.
    Confidence Float Suspected segment porn score.
    Label String Tag of the pornographic result for the suspected segment.
    Suggestion String Pornographic result suggestion for suspected segment, value ranges from...to...
  • pass.
  • review.
  • block.
    		•
    Url String Suspected image URL (Images are not retained permanently upon arrival)
    The image will be deleted after the PicUrlExpireTime time point.
    PicUrlExpireTime String Expiration time of the suspected image URL, using the ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

    MediaImageSpriteItem

    Sprite image information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Sprite sheet specification, please refer to the Sprite Sheet Parameter Template.
    Height Integer Height of small images in sprite sheet.
    Width Integer Width of small images in sprite sheet.
    TotalCount Integer Number of small images in each sprite sheet.
    ImagePathSet Array of String Path of each sprite sheet.
    WebVttPath String
    Storage TaskOutputStorage Storage location of the sprite sheet file.

    MediaInputInfo

    Input object information for media processing.

    Used by actions: BatchProcessMedia, CreateWorkflow, DescribeBatchTaskDetail, DescribeImageTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, DetectVideoSubtitleArea, DetectVideoWatermark, EditMedia, ExtractBlindWatermark, ParseNotification, ProcessImage, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Type String Yes Type of the input source object. Supported values:
  • COS: COS origin
  • URL: URL source
  • AWS-S3: AWS source, currently only support transcoding task
  • VOD: VOD Pro Edition
    • CosInputInfo CosInputInfo No Required when Type is COS. It represents the COS object information for media processing.
    UrlInputInfo UrlInputInfo No
    S3InputInfo S3InputInfo No
    VODInputInfo VODInputInfo No

    MediaMetaData

    Meta-information of on-demand media files

    Used by actions: DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Size Integer Size of the uploaded media file (for HLS videos, the size is the total of the m3u8 and ts file sizes), unit: byte.
    Container String Container type, for example, m4a and mp4.
    Bitrate Integer Sum of the average video stream bitrate and average audio stream bitrate. Unit: bps.
    Height Integer Maximum height of a video stream. Unit: px.
    Width Integer Maximum video stream width in px.
    Duration Float Video duration, unit: seconds.
    Rotate Integer Selection angle during video shooting. Unit: degree.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    AudioStreamSet Array of MediaAudioStreamItem Audio stream information.
    VideoDuration Float Video duration, unit: seconds.
    AudioDuration Float Audio duration, in seconds.

    MediaProcessTaskAdaptiveDynamicStreamingResult

    Result type for the video to adaptive streaming task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AdaptiveDynamicStreamingTaskInput Input for the video to adaptive streaming task.
    Output AdaptiveDynamicStreamingInfoItem
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskAnimatedGraphicResult

    Result type of the rotating image task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AnimatedGraphicTaskInput Input of the animated image task.
    Output MediaAnimatedGraphicsItem
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskImageSpriteResult

    Result type of image sprite

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input ImageSpriteTaskInput Input of the image sprite task for videos.
    Output MediaImageSpriteItem
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    MediaProcessTaskInput

    Media processing task type

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

    Name Type Required Description
    TranscodeTaskSet Array of TranscodeTaskInput No Video transcoding task list.
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput No List of video-to-GIF tasks.
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput No List of time point screenshot tasks for videos.
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput No List of sampled screenshot tasks for videos.
    ImageSpriteTaskSet Array of ImageSpriteTaskInput No List of image sprite tasks for videos.
    AdaptiveDynamicStreamingTaskSet Array of AdaptiveDynamicStreamingTaskInput No List of adaptive bitrate streaming tasks.

    MediaProcessTaskResult

    Task query result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
  • Transcode: Transcode
  • AnimatedGraphics: Animated image
  • SnapshotByTimeOffset: time point screenshot.
  • SampleSnapshot: sampled screenshot.
  • ImageSprites: sprite sheet
  • CoverBySnapshot: screencapturing for cover image.
  • AdaptiveDynamicStreaming: adaptive bitrate streaming.
    		•
    TranscodeTask MediaProcessTaskTranscodeResult
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult
    ImageSpriteTask MediaProcessTaskImageSpriteResult
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult

    MediaProcessTaskSampleSnapshotResult

    Result type of the sampling screenshot task for a video

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SampleSnapshotTaskInput Input for the sampling screenshot task on a video.
    Output MediaSampleSnapshotItem
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    MediaProcessTaskSnapshotByTimeOffsetResult

    Task result type for screenshot taking at specified time points

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SnapshotByTimeOffsetTaskInput Task input for screenshot taking at specified time points.
    Output MediaSnapshotByTimeOffsetItem
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    MediaProcessTaskTranscodeResult

    Transcoding task result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input TranscodeTaskInput Input of the transcoding task.
    Output MediaTranscodeItem
    Progress Integer Transcoding progress, with a value range of [0-100].

    MediaSampleSnapshotItem

    Sampling screenshot information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Sampled screenshot specification ID. Please refer to the sampling screenshot parameter template (https://www.tencentcloud.com/document/product/266/33480?from_cn_redirect=1#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF).
    SampleType String Sampling method, Valid value:
  • Percent: interval sampling based on percentage.
  • Time: sampling based on time interval.
    		•
    Interval Integer Sampling interval
  • When SampleType is Percent, this value indicates how many percentage points per image.
  • When SampleType is Time, this value indicates how many time intervals per image, in seconds. The first image is the first video frame.
    		•
    Storage TaskOutputStorage Storage location of a file after screenshot.
    ImagePathSet Array of String List of generated screenshot paths.
    WaterMarkDefinition Array of Integer If a screenshot is watermarked, the watermark template ID list.

    MediaSnapshotByTimeOffsetItem

    Screenshot information at the specified time point for on-demand files

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer Specification for SnapshotByTimeOffset, please refer to the SnapshotByTimeOffset parameter template.
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem A screenshot information set of the same specification, each element represents a screenshot.
    Storage TaskOutputStorage Storage location of the SnapshotByTimeOffset file.

    MediaSnapshotByTimePicInfoItem

    Screenshot information at the specified time point

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TimeOffset Float The screenshot corresponds to the time offset in the video file, expressed in seconds.
    Path String Path of the screenshot.
    WaterMarkDefinition Array of Integer If a screenshot is watermarked, list of template IDs used for watermarking.

    MediaTranscodeItem

    Transcoding info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    OutputStorage TaskOutputStorage Target storage of the transcoded file.
    Path String Video file path after transcoding.
    Definition Integer Transcoding specification ID. Please refer to the transcoding parameter template (https://www.tencentcloud.com/document/product/862/37042?from_cn_redirect=1).
    Bitrate Integer Sum of the average video stream bitrate and the average audio stream bit rate. Measurement unit: bps.
    Height Integer Maximum value of video stream height, measurement unit: px.
    Width Integer Maximum value of the video stream width in px.
    Size Integer Total size of media files (when the video is HLS, the size is the sum of m3u8 and ts file sizes), measurement unit: byte.
    Duration Float Video duration, in seconds.
    Container String Container type, such as m4a and mp4.
    Md5 String md5 value of the video.
    AudioStreamSet Array of MediaAudioStreamItem Audio stream information.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    CallBackExtInfo String

    MediaVideoStreamItem

    Video stream information of VOD files

    Used by actions: DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Bitrate Integer Bitrate of the video stream. Unit: bps.
    Height Integer Height of a video stream. Unit: px.
    Width Integer Video stream width in px.
    Codec String Video stream encoding format, for example, h264.
    Fps Integer Frame rate. Measurement unit: hz.
    ColorPrimaries String
    ColorSpace String
    ColorTransfer String
    HdrType String
    Codecs String
    FpsNumerator Integer
    FpsDenominator Integer

    ModifyDocToVideoTaskStatusInput

    Modify the status input of an AIGC document‑to‑video task

    Used by actions: ModifyDocToVideoTaskStatus.

    Name Type Required Description
    Action String Yes

    Modification action type.

    Enumeration values:

    • confirm: Confirm completion of the stage and advance to the next stage
    • regenerate: Regenerate the specified stage
    Stage String Yes

    Modify the target stage.

    Enumeration values:

    • STAGE_1:
      When Action=confirm: confirm the outline, continue generating subsequent dubbing, animation effects, and subtitles;
      When Action=regenerate: regenerate the outline.
    • STAGE_2:
      When Action=confirm: confirm the generated dubbing, animation effects, and subtitles, and generate the final video;
      When Action=regenerate: regenerate the dubbing, animation effects, and subtitles.
    SourceTaskId String Yes

    ID of the target task that needs to be modified.
    Regenerate DocToVideoRegenerateInput No

    Regenerate the parameter.

    Required only when Action=regenerate.

    MosaicInput

    Mosaic parameter type in a media processing task

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    CoordinateOrigin String No

    Origin position. Currently, only the following is supported:

  • TopLeft: indicates that the coordinate origin is at the top left corner of the video image and the mosaic origin is at the top left corner of the image or text.
    • Default value: TopLeft.
    XPos String No

    Horizontal position of the mosaic origin relative to the origin of coordinates of the video image. Supports two formats: % and px:

  • If a string ends with %, the mosaic XPos is a specified percentage of the video width. For example, 10% means XPos is 10% of the video width;
  • If a string ends with px, the mosaic XPos is a specified pixel. For example, 100px means XPos is 100 pixels.
    • Default value: 0px.
    YPos String No

    Vertical position of the mosaic origin relative to the origin of coordinates of the video image. Supports two formats: % and px:

  • If a string ends with %, the mosaic YPos is the specified percentage of the video height. For example, 10% means YPos is 10% of the video height.
  • If a string ends with px, the mosaic YPos is the specified pixel. For example, 100px means YPos is 100 pixels.
    • Default value: 0px.
    Width String No

    Mosaic width. Supports two formats: % and px:

  • If a string ends with %, it indicates that the mosaic Width is a percentage of a video's width. For example, 10% means that Width is 10% of a video's width.
  • If a string ends with px, it indicates that the mosaic Width is in pixels. For example, 100px means that Width is 100 pixels.
    • Default value: 10%.
    Height String No

    Height of a mosaic. Two formats are supported: % and px.

  • If a string ends with %, it indicates that the Height of a mosaic is a percentage of a video's height. For example, 10% means that Height is 10% of a video's height.
  • If a string ends with px, it indicates that the Height of a mosaic is in pixels. For example, 100px means that Height is 100 pixels.
    • Default value: 10%.
    StartTimeOffset Float No

    Start time offset of mosaic, in seconds. If not specified or set to 0, the mosaic appears when the frame appears.

  • If not specified or set to 0, the mosaic appears from the start of the frame;
  • If the value is greater than 0 (assuming n), the mosaic appears at the nth second from the start of the frame;
  • If the value is less than 0 (assuming -n), the mosaic appears n seconds before the end of the frame.
    		•
    EndTimeOffset Float No

    End time offset of mosaic, in seconds.

  • If not specified or set to 0, the mosaic lasts until the end of a video;
  • If the value is greater than 0 (assuming n), the mosaic disappears at second n;
  • If the value is less than 0 (assuming -n), the mosaic disappears n seconds before the end of a video.
    		•

    NumberFormat

    Rules for the {number} variable in the output filename.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    InitialValue Integer No The starting value of the {number} variable. Default value: 0.
    Increment Integer No The growth step length of the {number} variable, with a default value of 1.
    MinLength Integer No Minimum length of the {number} variable. Placeholder is used if the length is not sufficient. Default value: 1.
    PlaceHolder String No Placeholder to add when the length of the {number} variable is not sufficient. Default value: "0".

    OcrFullTextConfigureInfo

    Task control parameter for full text recognition

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Task switch for full text recognition, available values:
  • ON: Enable intelligent full text recognition task;
  • OFF: Disables the intelligent full text recognition task.
    		•

    OcrFullTextConfigureInfoForUpdate

    Full Text Recognition Task Control Parameter

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Task switch for full text recognition, available values:
  • ON: Enable intelligent full text recognition task;
  • OFF: Disables the intelligent full text recognition task.
    		•

    OcrWordsConfigureInfo

    Text keyword recognition control parameters.

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Task switch for text keyword recognition, available values:
  • ON: Enable text keyword recognition task;
  • OFF: Disables the text keyword recognition task.
    		•
    LabelSet Array of String No Keyword-based filtering tag, specify the tag of the keyword to return. If left blank or empty, all results are returned.
    The number of tags is up to 10, and each tag can have up to 16 characters.

    OcrWordsConfigureInfoForUpdate

    Text keyword recognition control parameters.

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Task switch for text keyword recognition, available values:
  • ON: Enable text keyword recognition task;
  • OFF: Disables the text keyword recognition task.
    		•
    LabelSet Array of String No Keyword-based filtering tag, specify the tag of the keyword that needs to be returned. If left blank or empty, all results are returned.
    The number of tags is up to 10, and each tag can have up to 16 characters.

    OverrideAIDubbingParameter

    Custom parameters for AI Dubbing

    Used by actions: ProcessMedia.

    Name Type Required Description
    TranslateConfig DubbingTranslateConfig No

    Translation configuration message.
    SubtitleConfig DubbingSubtitleConfig No

    Subtitle configuration message.
    DubbingConfig DubbingConfig No

    Dubbing configuration message.
    OutputConfig DubbingOutputConfig No

    Output configuration information.

    OverrideEraseParameter

    Used by actions: ProcessMedia.

    Name Type Required Description
    EraseType String No
    EraseSubtitleConfig UpdateSmartEraseSubtitleConfig No
    EraseWatermarkConfig UpdateSmartEraseWatermarkConfig No
    ErasePrivacyConfig UpdateSmartErasePrivacyConfig No
    SubtitleEmbedId Integer No

    OverrideTranscodeParameter

    Specification parameters for custom transcoding. Used to overwrite the corresponding parameter values in the template.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Container String No Muxing format. Available values: mp4, flv, hls, mp3, flac, ogg, and m4a. Among them, mp3, flac, ogg, and m4a are for audio-only files.
    RemoveVideo Integer No Indicates whether to remove video data. Parameter value:
  • 0: retention;
  • 1: Remove.
    		•
    RemoveAudio Integer No Indicates whether to remove audio data. Parameter value:
  • 0: retention;
  • 1: Remove.
    		•
    VideoTemplate VideoTemplateInfoForUpdate No Video stream configuration parameters.
    AudioTemplate AudioTemplateInfoForUpdate No Audio stream configuration parameters.
    TEHDConfig TEHDConfigForUpdate No
    SubtitleTemplate SubtitleTemplate No Subtitle stream configuration parameters.
    AddonAudioStream Array of MediaInputInfo No External audio track parameter.
    StdExtInfo String No Transcoding extension field.
    AddOnSubtitles Array of AddOnSubtitle No Subtitle file to be inserted.

    PatternConfig

    Stamp extraction configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    TransparencyThreshold Integer No

    Transparency threshold

    Value ranges from 0 to 255.

    Default value: 30
    OpaqueThreshold Integer No

    Opaque threshold must be greater than TransparencyThreshold.

    Value ranges from 0 to 255.

    Default value: 127.
    EdgeSamplingStep Integer No

    Edge sampling steps, default 5.

    Value ranges from 1 to 10.
    EdgeExpansionStep Integer No

    Edge expansion steps. Default: 5
    EdgeBlendingIntensity Float No

    Edge fusion strength, default 0.5

    Value ranges from 0 to 1.0

    PoliticalAsrReviewTemplateInfo

    The parameters for detecting sensitive information based on ASR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to detect sensitive information based on ASR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    PoliticalAsrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on ASR.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to detect sensitive information based on ASR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PoliticalConfigureInfo

    The parameters for detecting sensitive information.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfo No The parameters for detecting sensitive information in images.
    AsrReviewInfo PoliticalAsrReviewTemplateInfo No The parameters for detecting sensitive information based on ASR.
    OcrReviewInfo PoliticalOcrReviewTemplateInfo No The parameters for detecting sensitive information based on OCR.

    PoliticalConfigureInfoForUpdate

    The parameters for detecting sensitive information.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfoForUpdate No The parameters for detecting sensitive information in images.
    AsrReviewInfo PoliticalAsrReviewTemplateInfoForUpdate No The parameters for detecting sensitive information based on ASR.
    OcrReviewInfo PoliticalOcrReviewTemplateInfoForUpdate No The parameters for detecting sensitive information based on OCR.

    PoliticalImgReviewTemplateInfo

    The parameters for detecting sensitive information in images.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to detect sensitive information in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No The 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)
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 97 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 95 will be used by default. Value range: 0-100.

    PoliticalImgReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information in images.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to detect sensitive information in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No The 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)
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PoliticalOcrReviewTemplateInfo

    The parameters for detecting sensitive information based on OCR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    PoliticalOcrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on OCR.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornAsrReviewTemplateInfo

    Control parameter of a porn information detection in speech task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    PornAsrReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in speech task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornConfigureInfo

    Control parameter of a porn information detection task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

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

    PornConfigureInfoForUpdate

    Control parameter of a porn information detection task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfoForUpdate No Control parameter of porn information detection in image.
    AsrReviewInfo PornAsrReviewTemplateInfoForUpdate No Control parameter of porn information detection in speech.
    OcrReviewInfo PornOcrReviewTemplateInfoForUpdate No Control parameter of porn information detection in text.

    PornImgReviewTemplateInfo

    Control parameter of a porn information detection in image task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch 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.
    		•
    LabelSet Array of String No Filter 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 90 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 0 will be used by default. Value range: 0-100.

    PornImgReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in image task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch 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.
    		•
    LabelSet Array of String No Filter 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    PornOcrReviewTemplateInfo

    Control parameter of a porn information detection in text task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    PornOcrReviewTemplateInfoForUpdate

    Control parameter of a porn information detection in text task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch 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.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    ProcessImageTemplate

    Image processing template.

    Used by actions: DescribeProcessImageTemplates.

    Name Type Description
    Definition Integer Unique identifier of the image processing template.
    Name String Image processing template name.
    Comment String Description information of the image processing template.
    Type String Template type.
    ProcessImageConfig ImageTaskInput Image processing template configuration parameter.
    CreateTime String Template creation time.
    UpdateTime String Last modification time of the template.

    ProhibitedAsrReviewTemplateInfo

    Control parameter of prohibited information detection in speech task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of prohibited information detection in speech task. Valid values:
  • ON: enables prohibited information detection in speech task;
  • OFF: disables prohibited information detection in speech task.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    ProhibitedAsrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in speech task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of prohibited information detection in speech task. Valid values:
  • ON: enables prohibited information detection in speech task;
  • OFF: disables prohibited information detection in speech task.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    ProhibitedConfigureInfo

    Control parameter of prohibited information detection task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfo No Control parameter of prohibited information detection in speech.
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo No Control parameter of prohibited information detection in text.

    ProhibitedConfigureInfoForUpdate

    Control parameter of prohibited information detection task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfoForUpdate No Control parameter of prohibited information detection in speech.
    OcrReviewInfo ProhibitedOcrReviewTemplateInfoForUpdate No Control parameter of prohibited information detection in text.

    ProhibitedOcrReviewTemplateInfo

    Control parameter of prohibited information detection in text task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of prohibited information detection in text task. Valid values:
  • ON: enables prohibited information detection in text task;
  • OFF: disables prohibited information detection in text task.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    ProhibitedOcrReviewTemplateInfoForUpdate

    Control parameter of prohibited information detection in text task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of prohibited information detection in text task. Valid values:
  • ON: enables prohibited information detection in text task;
  • OFF: disables prohibited information detection in text task.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    Project

    Episode project information.

    Used by actions: QueryProject.

    Name Type Required Description
    ProjectId String No

    Project ID.
    ProjectName String No

    Project name.
    Description String No

    Project description.
    TermBase Array of TermBase No

    Project term base.
    Speakers Array of Speakers No

    List of characters.
    CreatedAt Integer No

    Creation time (Unix timestamp).
    UpdatedAt Integer No

    Update time (Unix timestamp).

    PureSubtitleTransResult

    Translation result of pure subtitle files.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status (the three valid values are as follows):
    - PROCESSING
    - SUCCESS
    - FAIL
    ErrCodeExt String Error code. A null string indicates that the task is successful, while other values indicate that the task has failed. For valid values, see the list of Media Processing Service (MPS) error codes.
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message
    Input SmartSubtitleTaskResultInput Translation task input information.
    Output PureSubtitleTransResultOutput
    Progress Integer Task progress.

    PureSubtitleTransResultOutput

    Detailed output result of translation.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    OutputStorage TaskOutputStorage
    SubtitleResults Array of SubtitleTransResultItem Result set of multilingual translation.

    QualityControlData

    Media quality inspection result output.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    NoAudio Boolean

    A value of true indicates that the video has no audio track.
    NoVideo Boolean

    A value of true indicates that the video has no video track.
    QualityEvaluationScore Integer

    No-reference quality score of the video, on a scale of 0 to 100.
    QualityEvaluationMeanOpinionScore Float

    No-reference quality score of the video (MOS).
    AestheticEvaluationScore Integer

    Video aesthetic score. Value range: [0, 100].
    QualityControlResultSet Array of QualityControlResult

    Exception items detected in content quality inspection.
    ContainerDiagnoseResultSet Array of ContainerDiagnoseResultItem

    Exception items detected in format diagnosis.
    LLMDetectionReport LLMDetectionReport

    LLM AIGC quality detection result.

    QualityControlItem

    Quality inspection result item

    Used by actions: ParseLiveStreamProcessNotification.

    Name Type Description
    Confidence Integer
    StartTimeOffset Float Start time of occurrence, in seconds.
    EndTimeOffset Float End timestamp of the occurrence, in seconds.
    AreaCoordSet Array of Integer

    QualityControlItemConfig

    Quality inspection item configurations.

    Used by actions: CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate.

    Name Type Required Description
    Type String Yes Quality inspection item name. Valid values:
  • LowEvaluation: Video no-reference scoring (MOS).
  • AudioEvaluation: Audio no-reference scoring (MOS).
  • Mosaic: mosaic detection.
  • CrashScreen: screen glitch detection.
  • Blur: blur detection.
  • Jitter: jitter detection.
  • Noise: noise detection.
  • QRCode: QR code detection.
  • BarCode: barcode detection.
  • AppletCode: mini program code detection.
  • BlackWhiteEdge: black and white edge detection.
  • SolidColorScreen: solid color screen detection.
  • LowLighting: low light.
  • HighLighting: overexposure.
  • NoVoice: silence detection.
  • LowVoice: bass detection.
  • HighVoice: explosion noise detection
  • AudioNoise: audio noise detection.
  • VideoResolutionChanged: video resolution change.
  • AudioSampleRateChanged: audio sampling rate change.
  • AudioChannelsChanged: audio channels changed.
  • ParameterSetsChanged: stream parameter set information has changed.
  • DarOrSarInvalid: abnormal video aspect ratio.
  • TimestampFallback: DTS timestamp rollback.
  • DtsJitter: DTS jitter too high.
  • PtsJitter: PTS jitter too high.
  • AACDurationDeviation: improper AAC frame timestamp interval.
  • AudioDroppingFrames: audio frame dropping.
  • VideoDroppingFrames: video frame dropping.
  • AVTimestampInterleave: improper audio-video interleaving.
  • PtsLessThanDts: The pts of the media stream is less than the dts.
  • ReceiveFpsJitter: excessive network received frame rate jitter
  • ReceiveFpsTooSmall: network receive video frame rate too low.
  • FpsJitter: excessive stream frame rate jitter calculated by PTS
  • StreamOpenFailed: stream open failure.
  • StreamEnd: stream end.
  • StreamParseFailed: stream parsing failure.
  • VideoFirstFrameNotIdr: first frame not an IDR frame.
  • StreamNALUError: NALU start code error.
  • TsStreamNoAud: The H26x stream of mpegts misses AUD NALU.
  • AudioStreamLack: no audio stream.
  • VideoStreamLack: no video stream.
  • LackAudioRecover: missing audio stream recovery.
  • LackVideoRecover: missing video stream recovery.
  • VideoBitrateOutofRange: video stream bitrate (kbps) out of range.
  • AudioBitrateOutofRange: audio stream bitrate (kbps) out of range.
  • VideoDecodeFailed: video decoding error.
  • AudioDecodeFailed: audio decoding error.
  • AudioOutOfPhase: opposite phase in dual-channel audio.
  • VideoDuplicatedFrame: duplicate frames in video streams.
  • AudioDuplicatedFrame: duplicate frames in audio streams.
  • VideoRotation: video rotation.
  • TsMultiPrograms: multiple programs in MPEG2-TS streams.
  • Mp4InvalidCodecFourcc: The codec fourcc in MP4 does not meet Apple HLS requirements.
  • HLSBadM3u8Format: invalid M3U8 file.
  • HLSInvalidMasterM3u8: invalid main M3U8 file.
  • HLSInvalidMediaM3u8: invalid media M3U8 file.
  • HLSMasterM3u8Recommended: parameters recommended by standards missing in main M3U8.
  • HLSMediaM3u8Recommended: parameters recommended by standards missing in media M3U8.
  • HLSMediaM3u8DiscontinuityExist: EXT-X-DISCONTINUITY in media M3U8.
  • HLSMediaSegmentsStreamNumChange: Number of streams in segments changes.
  • HLSMediaSegmentsPTSJitterDeviation: PTS jumps between segments without EXT-X-DISCONTINUITY.
  • HLSMediaSegmentsDTSJitterDeviation: DTS jumps between segments without EXT-X-DISCONTINUITY.
  • TimecodeTrackExist: TMCD track in MP4.
    		•
    Switch String No
    Sampling String No
    IntervalTime Integer No
    Duration Integer No
    Threshold String No

    QualityControlResult

    Quality inspection exception item.

    Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification.

    Name Type Description
    Type String Exception type. Valid values:
    Jitter: jitter.
    Blur: blurry.
    LowLighting: low light.
    HighLighting: overexposure.
    CrashScreen: screen glitch.
    BlackWhiteEdge: Black and white edges
    SolidColorScreen: solid color screen.
    Noise: noise.
    Mosaic: Mosaic
    QRCode: QR code.
    AppletCode: Mini program code.
    BarCode: barcode.
    LowVoice: bass.
    HighVoice: high voice detection.
    NoVoice: mute.
    LowEvaluation: The video no-reference score (MOS) is below the threshold.
    AudioEvaluation: The audio no-reference scoring (MOS) is below the threshold.
    AudioNoise: Audio noise.
    QualityControlItems Array of QualityControlItem Quality inspection result item.

    QualityControlStrategy

    Detection policy for media quality inspection.

    Used by actions: CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate.

    Name Type Required Description
    StrategyType String No Policy type. Value:
    - TimeSpotCheck
    TimeSpotCheck TimeSpotCheck No Spot check policy based on time.

    QualityControlTemplate

    Media quality inspection template details.

    Used by actions: DescribeQualityControlTemplates.

    Name Type Description
    Definition Integer Unique identifier of a media quality inspection template.
    Name String Media quality inspection template name.
    Note: This field may return null, indicating that no valid values can be obtained.
    Comment String Template description.


    Note: This field may return null, indicating that no valid values can be obtained.
    Type String Template type. Valid values:
  • Preset: system preset template;
  • Custom: custom template.


    • Note: This field may return null, indicating that no valid values can be obtained.
    QualityControlItemSet Array of QualityControlItemConfig Media quality inspection configuration parameters.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of a template in ISO date format.

    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime String Last modified time of a template in ISO date format.

    Note: This field may return null, indicating that no valid values can be obtained.
    Strategy QualityControlStrategy Spot check policy for media quality inspection.

    QueryTaskFilter

    Query the list filter criteria for AIGC tasks

    Used by actions: DescribeAigcTaskList.

    Name Type Required Description
    TaskId String No

    Task ID.
    TaskType String No

    Task type
    TaskStatus String No

    Task status.
    Resolution String No

    Resolution
    Ratio String No

    Aspect ratio.

    RawAIDubbingParameter

    Custom parameters for AI Dubbing

    Used by actions: ProcessMedia.

    Name Type Required Description
    TranslateConfig DubbingTranslateConfig No

    Translation configuration message.
    SubtitleConfig DubbingSubtitleConfig No

    Subtitle configuration information.
    DubbingConfig DubbingConfig No

    Dubbing configuration message.
    OutputConfig DubbingOutputConfig No

    Output configuration message.

    RawImageWatermarkInput

    Image watermark template input parameters.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    ImageContent MediaInputInfo Yes Input content of the watermark image. jpeg and png image formats are supported.
    Width String No Width of a watermark, supporting two formats: % and px.
  • If a string ends with %, it indicates that the Width of a watermark is a percentage of a video's width. For example, 10% means that Width is 10% of a video's width.
  • If a string ends with px, it means the watermark Width is in pixels. For example, 100px means the Width is 100 pixels.

    • Default value: 10%.
    Height String No Height of a watermark. Supports two formats: % and px.
  • If a string ends with %, it indicates that the Height of a watermark is a percentage of a video's height. For example, 10% means that Height is 10% of a video's height.
  • If a string ends with px, it means the watermark Height is in pixels. For example, 100px means the Height is 100 pixels.

    • Default value: 0px, which means Height is scaled according to the aspect ratio of the raw watermark image.
    RepeatType String No Watermark repeat type. Usage scenario: the watermark is a dynamic image. Value range:
  • once: The dynamic watermark will no longer appear after it has finished playing;
  • repeat_last_frame: Stay on the last frame after the watermark finished playing;
  • repeat: Watermark loops until the video ends (default value).
    		•

    RawSmartEraseParameter

    Used by actions: ProcessMedia.

    Name Type Required Description
    EraseType String Yes
    EraseSubtitleConfig SmartEraseSubtitleConfig No
    EraseWatermarkConfig SmartEraseWatermarkConfig No
    ErasePrivacyConfig SmartErasePrivacyConfig No
    SubtitleEmbedId Integer No
    UseOriginalPos Integer No
    UseOriginalSize Integer No

    RawSmartSubtitleParameter

    Used by actions: BatchProcessMedia, DescribeBatchTaskDetail, ParseNotification, ProcessMedia.

    Name Type Required Description
    SubtitleType Integer Yes
    VideoSrcLanguage String Yes
    SubtitleFormat String No
    TranslateSwitch String No
    TranslateDstLanguage String No
    AsrHotWordsConfigure AsrHotWordsConfigure No
    ExtInfo String No
    ProcessType Integer No
    SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig No
    SubtitleEmbedId Integer No
    SpeakerMode Integer No
    SpeakerLabel Integer No

    RawTranscodeParameter

    Specification parameters of custom transcoding.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Container String Yes Muxing format. Available values: mp4, flv, hls, mp3, flac, ogg, and m4a. Among them, mp3, flac, ogg, and m4a are for audio-only files.
    RemoveVideo Integer No Indicates whether to remove video data. Parameter value:
  • 0: retention;
  • 1: Remove.

    • Default value: 0.
    RemoveAudio Integer No Whether to remove audio data. Parameter Value:
  • 0: retention;
  • 1: Remove.

    • Default value: 0.
    VideoTemplate VideoTemplateInfo No Video stream configuration parameters. This field is required when RemoveVideo is 0.
    AudioTemplate AudioTemplateInfo No Audio stream configuration parameters. This field is required when RemoveAudio is 0.
    TEHDConfig TEHDConfig No TSC transcoding parameters.
    StdExtInfo String No Additional parameter, which is a serialized JSON string.
    EnhanceConfig EnhanceConfig No
    SubtitleTemplate SubtitleTemplate No

    RawWatermarkParameter

    Customize watermark specification parameters.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Type String Yes Watermark type. Valid values:
  • image: image watermark.
    		•
    CoordinateOrigin String No Origin position. Valid values:
  • TopLeft: indicates that the coordinate origin is at the top left corner of the video image and the watermark origin is at the top left corner of the image or text.
  • TopRight: indicates that the coordinate origin is at the top right corner of the video image and the watermark origin is at the top right corner of the image or text.
  • BottomLeft: indicates that the coordinate origin is at the bottom-left corner of the video image and the watermark origin is at the bottom-left corner of the image or text.
  • BottomRight: indicates that the coordinate origin is at the bottom right corner of the video image and the watermark origin is at the bottom right corner of the image or text.

    • Default value: TopLeft.
    XPos String No Horizontal position of the watermark origin from the origin of coordinates of the video image. Supports % and px formats.
  • If a string ends with %, it indicates that the XPos of a watermark is a specified percentage of a video's width. For example, 10% means that XPos is 10% of a video's width.
  • If a string ends with px, it means the watermark XPos is specified in pixels. For example, 100px means XPos is 100 pixels.

    • Default value: 0px.
    YPos String No Vertical position of the watermark origin relative to the origin of coordinates of the video image. Supports two formats: % and px.
  • If a string ends with %, it indicates that the YPos of a watermark is a specified percentage of a video's height. For example, 10% means that YPos is 10% of a video's height.
  • If a string ends with px, it means the watermark YPos is specified in pixels. For example, 100px means YPos is 100 pixels.

    • Default value: 0px.
    ImageTemplate RawImageWatermarkInput No Image watermark template. This field is required when Type is image, and invalid when Type is text.

    RecipeItem

    Image set information.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Theme String No

    Sub-image type.

    Enumeration values:

    • hero: product hero image.
    • detail: product details image.
    • selling: core selling point image.
    • atmosphere: scene atmosphere image.
    • angles: multiple-angle image.
    • scene: usage scenario image.
    Num Integer No

    Number of corresponding sub-images.

    Value range: 1 to 4.

    Unit: image.

    Each type can have up to 4 sub-images. The total number of sub-images must be within the range of 4 to 12.

    RecognizeAudioSentence

    Result of the sentence recognition.

    Used by actions: RecognizeAudio.

    Name Type Description
    Start Float Start time in the audio, in seconds.
    End Float End time in the audio, in seconds.
    Text String Audio recognition result.
    WordsInfo Array of WordResult Word timestamp result.

    RuleConditionItem

    Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

    Name Type Required Description
    Key String No
    Value String No

    Rules

    Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

    Name Type Required Description
    Id String No
    Conditions Array of RuleConditionItem No
    Linker String No
    RearDriveIndexs Array of Integer No

    S3InputInfo

    AWS S3 storage input

    Used by actions: BatchProcessMedia, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, DetectVideoWatermark, ExtractBlindWatermark, ProcessImage, ProcessMedia.

    Name Type Required Description
    S3Bucket String Yes S3 bucket。
    S3Region String Yes
    S3Object String Yes
    S3SecretId String No
    S3SecretKey String No

    S3OutputStorage

    AWS S3 output location

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

    Name Type Required Description
    S3Bucket String Yes S3 bucket。
    S3Region String Yes
    S3SecretId String No
    S3SecretKey String No

    SampleSnapshotTaskInput

    Sampled screenshot taking task input parameter type.

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

    Name Type Required Description
    Definition Integer Yes

    Sampled screenshot template ID.
    WatermarkSet Array of WatermarkInput No

    Watermark list. Up to 10 image or text watermarks are supported.
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    Output path of the image file after the sampled screenshot is taken, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, see File Name Variable Description.
    Relative path example:

  • File name_{variable name}.{format}
  • File name.{format}
    • Absolute path example:
  • /custom path/file name_{variable name}.{format}
    • If this is not specified, the default relative path is {inputName}_sampleSnapshot_{definition}_{number}.{format}.
    ObjectNumberFormat NumberFormat No
    ExtInfo String No

    Extended parameter.

    SampleSnapshotTemplate

    Details of a sampled screenshot template

    Used by actions: DescribeSampleSnapshotTemplates.

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

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

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

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

    Orchestrate the task result type of video analysis

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiAnalysisTaskInput Analyze the input of the task.
    Output Array of AiAnalysisResult Analysis task output.
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    ScheduleExecRuleTaskResult

    Media quality inspection task result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String Error message.
    Input ExecRulesTask Input of the conditional judgment task.
    Output ExecRuleTaskData

    ScheduleQualityControlTaskResult

    Media quality inspection task result type.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiQualityControlTaskInput Media quality inspection task input.
    Output QualityControlData
    Progress Integer Task execution progress.

    ScheduleRecognitionTaskResult

    Orchestrate the result type of a video recognition task

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiRecognitionTaskInput Recognition task input.
    Output Array of AiRecognitionResult Recognition task output.
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    ScheduleReviewTaskResult

    Orchestrate the moderation job result type

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input AiContentReviewTaskInput Review task input.
    Output Array of AiContentReviewResult
    BeginProcessTime String
    FinishTime String

    ScheduleSmartSubtitleTaskResult

    Result of the smart subtitle scheduling task.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SmartSubtitlesTaskInput Recognition task input.
    Output Array of SmartSubtitlesResult Recognition task output.
    BeginProcessTime String Task execution start time in ISO date and time format.
    FinishTime String Task execution completion time in ISO date and time format.

    ScheduleTask

    Orchestration task info

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TaskId String Orchestration task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCode Integer An error code other than 0 is returned in case of a source exception. Use the error code of the specific task when a value of 0 is returned.
    Message String The corresponding exception message is returned in case of a source exception. If no source exception occurs, use the message of each specific task.
    InputInfo MediaInputInfo
    MetaData MediaMetaData
    ActivityResultSet Array of ActivityResult

    SchedulesInfo

    The details of a scheme.

    Used by actions: DescribeSchedules.

    Name Type Description
    ScheduleId Integer The scheme ID.
    ScheduleName String The scheme name.
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String The scheme type. Valid values:
  • Preset
  • Custom

    • Note: This field may return null, indicating that no valid values can be obtained.
    Status String The scheme status. Valid values:
    Enabled
    Disabled
    Note: This field may return null, indicating that no valid values can be obtained.
    Trigger WorkflowTrigger The trigger of the scheme.
    Note: This field may return null, indicating that no valid values can be obtained.
    Activities Array of Activity The subtasks of the scheme.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputStorage TaskOutputStorage The bucket to save the output file.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputDir String The directory to save the output file.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskNotifyConfig TaskNotifyConfig The notification configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String The creation time in ISO date format.
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime String The last updated time in ISO date format.
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourceId String Resource ID. For those without an associated resource ID, fill in with an account's primary resource ID.
    Note: This field may return null, indicating that no valid values can be obtained.

    ScratchRepairConfig

    Remove scratch configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Intensity Float No

    SecurityGroupInfo

    Security group information.

    Used by actions: DescribeStreamLinkSecurityGroup.

    Name Type Description
    Id String Security group ID.
    Name String Security group name.
    Whitelist Array of String Allowlist list.
    OccupiedInputs Array of String List of bound input streams.
    Note: This field may return null, indicating that no valid value can be obtained.
    Region String Security group address.
    OccupiedOutputs Array of String List of bound output streams.
    Note: This field may return null, indicating that no valid value can be obtained.

    SegmentRecognitionItem

    Intelligent video splitting recording clip.

    Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification.

    Name Type Description
    Confidence Float Confidence degree.
    StartTimeOffset Float Start time offset of a recording clip.
    EndTimeOffset Float End time offset of the recording clip.
    SegmentUrl String Split segment URL.
    CovImgUrl String Segment cover.
    Title String Segment title.
    Summary String Segment summary.
    Keywords Array of String Segmentation keywords.
    BeginTime String The start time of a live streaming segment, in the ISO date format.
    EndTime String The end time of a live streaming segment, in the ISO date format.
    PersonId String Specify the figure ID.

    SegmentSpecificInfo

    Information on special segment configuration.

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String No
    FragmentTime Integer No
    FragmentEndNum Integer No

    SelectingSubtitleAreasConfig

    Used by actions: BatchProcessMedia, CreateSmartSubtitleTemplate, DescribeSmartSubtitleTemplates, ModifySmartSubtitleTemplate, ProcessMedia.

    Name Type Required Description
    AutoAreas Array of EraseArea No
    SampleWidth Integer No
    SampleHeight Integer No

    SharpEnhanceConfig

    Detail enhancement configuration.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Switch String No Whether to enable the feature. Valid values:
  • ON
  • OFF

    • Default value: ON.
    Intensity Float No Strength, value ranges from 0.0 to 1.0.
    Default: 0.0.

    SimpleAesDrm

    SimpleAes encryption information.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Uri String Yes
    Key String Yes
    Vector String No

    SmartErasePrivacyConfig

    Used by actions: CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia.

    Name Type Required Description
    PrivacyModel String Yes
    PrivacyTargets Array of String Yes

    SmartEraseSubtitleConfig

    Used by actions: CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia.

    Name Type Required Description
    SubtitleEraseMethod String Yes
    SubtitleModel String Yes
    OcrSwitch String No
    SubtitleLang String No
    SubtitleFormat String No
    TransSwitch String No
    TransDstLang String No
    AutoAreas Array of EraseArea No
    CustomAreas Array of EraseTimeArea No
    SubtitleEmbedId Integer No
    UseOriginalPos Integer No
    UseOriginalSize Integer No

    SmartEraseTaskInput

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

    Name Type Required Description
    Definition Integer No
    RawParameter RawSmartEraseParameter No
    OverrideParameter OverrideEraseParameter No
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    SmartEraseTaskResult

    Intelligent erasure task result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    Message String Error message.
    Input SmartEraseTaskInput
    Output AiAnalysisTaskDelLogoOutput
    Progress Integer Task progress.
    BeginProcessTime String Starting time of task execution, in ISO date and time format.
    FinishTime String Task completion time, in ISO date and time format.

    SmartEraseTemplateItem

    Smart erasing template details.

    Used by actions: DescribeSmartEraseTemplates.

    Name Type Description
    Definition Integer Unique identifier of the smart erasing template.
    Name String Smart erasing template name.
    Comment String Smart erasing template description information.
    Type String Template type. Valid values:
    * Preset: system preset template.
    * Custom: user-defined template.
    EraseType String Erasing type.
    -subtitle: subtitle removal.
    -watermark: watermark removal.
    -privacy: privacy protection.
    EraseSubtitleConfig SmartEraseSubtitleConfig Subtitle erasing configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    EraseWatermarkConfig SmartEraseWatermarkConfig Watermark erasing configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    ErasePrivacyConfig SmartErasePrivacyConfig Privacy protection configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Template creation time in ISO datetime format.
    UpdateTime String Last modification time of the template in ISO datetime format.
    AliasName String Alias of the preset smart erasing template.

    SmartEraseWatermarkConfig

    Used by actions: CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia.

    Name Type Required Description
    WatermarkEraseMethod String Yes
    WatermarkModel String Yes
    AutoAreas Array of EraseArea No
    CustomAreas Array of EraseTimeArea No

    SmartSubtitleTaskAsrFullTextResult

    Full speech recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SmartSubtitleTaskResultInput
    Output SmartSubtitleTaskAsrFullTextResultOutput
    Progress Integer

    SmartSubtitleTaskAsrFullTextResultOutput

    Full speech recognition result.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of SmartSubtitleTaskAsrFullTextSegmentItem
    Path String

    Subtitle file path
    SubtitlePath String

    Subtitle file URL.
    SubtitleInfo SubtitleResult

    Subtitle recognition result info.
    OutputStorage TaskOutputStorage

    Storage location of the subtitle file.

    SmartSubtitleTaskAsrFullTextSegmentItem

    Segment undergone full speech recognition.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    StartTimeOffset Float

    Start time offset of the recognized segment, in seconds.
    EndTimeOffset Float

    End time offset of the recognized segment, in seconds.
    Text String

    Recognized text.
    Wordlist Array of WordResult
    SpeakerId String

    Speaker ID (if speaker recognition is enabled).

    SmartSubtitleTaskBatchOutput

    Output information for smart subtitle tasks.

    Used by actions: DescribeBatchTaskDetail, ParseNotification.

    Name Type Description
    Progress Integer

    Task progress.
    Status String

    Task status. Valid values are PROCESSING, SUCCESS, WAITING, and FAIL.
    ErrCodeExt String

    Error code. An empty string indicates that the task is successful, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
    Message String

    Error message.
    TransTextTask SmartSubtitleTaskTransTextResultOutput
    AsrFullTextTask SmartSubtitleTaskAsrFullTextResultOutput

    SmartSubtitleTaskFullTextResult

    Full-text recognition result for smart subtitle tasks.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SmartSubtitleTaskResultInput
    Output SmartSubtitleTaskTextResultOutput
    Progress Integer

    SmartSubtitleTaskFullTextSegmentItem

    Smart subtitle recognition segment.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    StartTimeOffset Float

    Start time offset of the recognized segment, in seconds.
    EndTimeOffset Float

    End time offset of the recognized segment, in seconds.
    Text String

    Recognized text.
    Trans String

    Translated text.
    SpeakerId String

    Speaker ID.

    SmartSubtitleTaskResultInput

    Smart subtitle translation input.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Definition Integer

    Smart subtitle template ID.
    RawParameter RawSmartSubtitleParameter
    UserExtPara String

    Extended parameter.

    SmartSubtitleTaskTextResultOutput

    Smart subtitle recognition result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of SmartSubtitleTaskFullTextSegmentItem
    RecognizeSubtitleResult Array of SubtitleResult
    TransSubtitleResult Array of SubtitleResult
    OutputStorage TaskOutputStorage

    SmartSubtitleTaskTransTextResult

    Translation result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
    ErrCodeExt String Error code. An empty string indicates that the task is successful, and other values indicate that the task has failed. For specific values, see [Error Codes] (https://www.tencentcloud.com/document/product/862/50369?from_cn_redirect=1#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81).
    ErrCode Integer Error code. 0 indicates that the task is successful, and other values indicate that the task has failed. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
    Message String Error message.
    Input SmartSubtitleTaskResultInput
    Output SmartSubtitleTaskTransTextResultOutput
    Progress Integer

    SmartSubtitleTaskTransTextResultOutput

    Translation result.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    SegmentSet Array of SmartSubtitleTaskTransTextSegmentItem
    SubtitlePath String

    Subtitle file URL.
    OutputStorage TaskOutputStorage

    Smart subtitling result storage information.
    Path String

    Subtitle file path
    SubtitleResults Array of SubtitleTransResultItem

    Returned translation result during multilingual translation.

    SmartSubtitleTaskTransTextSegmentItem

    Translated segment.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Confidence Float

    Confidence of the recognized segment. Value range: 0–100.
    StartTimeOffset Float

    Start time offset of the recognized segment, in seconds.
    EndTimeOffset Float

    End time offset of the recognized segment, in seconds.
    Text String

    Recognized text.
    Trans String

    Translated text.
    Wordlist Array of WordResult
    SpeakerId String

    Speaker ID (if speaker recognition is enabled).

    SmartSubtitleTemplateItem

    Smart subtitle template details.

    Used by actions: DescribeSmartSubtitleTemplates.

    Name Type Description
    Definition Integer

    Unique identifier of the smart subtitle template.
    Name String

    Smart subtitle template name.


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

    Smart subtitle template description.


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

    Template type. Valid values:

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

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

    ASR hotword lexicon parameters.


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

    Name of the hotword lexicon associated with the template.


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

    Video source language list for smart subtitle:

    zh: Simplified Chinese
    yue: Cantonese
    zh-PY: Chinese, English, and Cantonese
    zh_medical: Chinese healthcare
    zh_dialect: Chinese dialect
    prime_zh: Chinese and English dialects
    zh_en: Chinese and English
    en: English
    ja: Japanese
    ko: Korean
    fr: French
    es: Spanish
    it: Italian
    de: German
    tr: Turkish
    ru: Russian
    pt: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    vi: Vietnamese
    id: Indonesian
    ms: Malay
    th: Thai
    ar: Arabic
    hi: Hindi
    fil: Filipino
    auto: Automatic identification (only supported for subtitle translation)
    SubtitleFormat String

    Smart subtitle file format.

    • vtt: WebVTT.
    • srt: SRT.
    • original: same as the source subtitle file (for subtitle translation templates).
    • Not specified or empty: no subtitle file generated.

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

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

    Subtitle translation switch.
    ON: enables translation.
    OFF: disables translation.


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

    Target language for subtitle translation.
    This parameter takes effect when TranslateSwitch is ON.
    zh: Simplified Chinese
    zh-TW: Traditional Chinese
    en: English
    ja: Japanese
    ko: Korean
    fr: French
    es: Spanish
    it: Italian
    de: German
    tr: Turkish
    ru: Russian
    pt: Portuguese (Brazil)
    pt-PT: Portuguese (Portugal)
    vi: Vietnamese
    id: Indonesian
    ms: Malay
    th: Thai
    ar: Arabic
    hi: Hindi
    fil: Filipino

    Note: Use / to separate multiple languages, such as en/ja, which indicates English and Japanese.


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

    Template creation time, in ISO date format.
    UpdateTime String

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

    Preset template alias for smart subtitle.


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

    Subtitle processing type:

    • 0: ASR.
    • 1: subtitle translation.
    • 2: OCR.
    SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig

    Area configurations for the subtitle OCR extraction box.


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

    Subtitle burn-in template ID.
    SpeakerMode Integer

    Speaker identification mode. Valid values:
    0: Speaker identification is disabled.
    1: Speaker identification is enabled.
    Default value: 0.
    SpeakerLabel Integer

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

    SmartSubtitlesResult

    Smart subtitle task result.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    Type String Task type. Valid values:
    - AsrFullTextRecognition: full speech recognition
    - TransTextRecognition: speech translation
    - PureSubtitleTrans: pure subtitle translation.
    - OcrFullTextRecognition: text-based subtitle extraction.
    AsrFullTextTask SmartSubtitleTaskAsrFullTextResult
    TransTextTask SmartSubtitleTaskTransTextResult
    PureSubtitleTransTask PureSubtitleTransResult
    OcrFullTextTask SmartSubtitleTaskFullTextResult

    SmartSubtitlesTaskInput

    Used by actions: BatchProcessMedia, CreateSchedule, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia.

    Name Type Required Description
    Definition Integer No
    UserExtPara String No
    RawParameter RawSmartSubtitleParameter No
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    SnapshotByTimeOffsetTaskInput

    Screenshot taking at specified time points task input parameter type

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

    Name Type Required Description
    Definition Integer Yes

    Time point screenshot template ID.
    ExtTimeOffsetSet Array of String No

    List of screenshot time points. Time points support two formats: s and %.

  • The unit for a string that ends with s is second. For example, 3.5s means the time point is at 3.5 seconds.
  • The unit for a string that ends with % is a percentage of the video duration. For example, 10% means the time point is at 10% of the video's total duration.
    		•
    TimeOffsetSet Array of Float No

    List of screenshot time points, in seconds. This parameter is not recommended. We recommend that you use the ExtTimeOffsetSet parameter.
    WatermarkSet Array of WatermarkInput No

    Watermark list. Up to 10 image or text watermarks are supported.
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No

    Output path of the image file after the time point screenshot is taken, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, see File Name Variable Description.
    Relative path example:

  • File name_{variable name}.{format}
  • File name.{format}
    • Absolute path example:
  • /custom path/file name_{variable name}.{format}
    • If this is not specified, the default relative path is {inputName}_snapshotByTimeOffset_{definition}_{number}.{format}.
    ObjectNumberFormat NumberFormat No
    ExtInfo String No

    Extended parameter.

    SnapshotByTimeOffsetTemplate

    Details of a time point screenshot template.

    Used by actions: DescribeSnapshotByTimeOffsetTemplates.

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

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

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

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

    Speakers

    List of characters.

    Used by actions: CreateProject, QueryProject, UpdateProject.

    Name Type Required Description
    SpeakerId String Yes

    Unique character ID.
    VoiceId String Yes

    Bound voice ID.
    Gender String No

    Gender: male/female. Default: male.
    AgeGroup String No

    Age segment: child/teenager/youth/middle_aged/senior. Default: youth.
    Description String No

    Character description.
    NameTerms Array of TermBase No

    Glossary of character names.

    SpecificationDataItem

    Statistical data for the task of the specified specification.

    Used by actions: DescribeUsageData.

    Name Type Description
    Specification String Task specification.
    Data Array of TaskStatDataItem Statistical data.

    SpekeDrm

    FairPlay, WideVine, PlayReady, and other DRM encryption technologies.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    ResourceId String Yes Resource tagging. The field content is user-customized;
    Supports 1 to 128 characters consisting of digits, letters, underscores (_), and hyphens (-).
    This field corresponds to the cid field in the Speke request.
    Note: Different DRM vendors have different restrictions on this field (for example, SDMC Technology Co., Ltd. does not support this field containing underscores). For specific rules, check with the vendors.
    KeyServerUrl String Yes DRM manufacturer access address. This field content is obtained from the DRM manufacturer.

    Note: Different DRM manufacturers have different limits on the number of substreams. For example, PallyCon limits the number to 5 substreams, while DRMtoday supports stream encryption for a maximum of 9 substreams.
    Vector String Yes Encryption initialization vector (32-byte hexadecimal string). This field content is user-customized.
    EncryptionMethod String No Encryption method. Valid values:
    cbcs: PlayReady, Widevine, FairPlay, WideVine+FairPlay, Widevine+Playready, Playready+Fairplay, Widevine+Playready+Fairplay are supported.
    cenc: PlayReady, Widevine, and Widevine+PlayReady are supported.

    If it is left unspecified:
    Use cbcs for FairPlay by default.
    Use cenc for PlayReady and Widevine by default.
    WideVine+FairPlay, Playready+Fairplay, Widevine+Playready+Fairplay default to cbcs.
    Use cenc for Widevine+PlayReady by default.
    EncryptionPreset String No Substream encryption rule. Default value: preset0.
    preset 0: use the same key to encrypt all substreams;
    preset1: use different keys for each substream

    SubtitleArea

    Data structure that indicates the subtitle area coordinates for the automatic hard subtitle area detection. The confidence is also included.

    Used by actions: DetectVideoSubtitleArea.

    Name Type Description
    Area EraseArea

    Detected subtitle area.
    Confidence Float

    Confidence of the detected area.

    Value range: [0, 100].

    SubtitleBoardConfig

    Subtitle suppression module background settings

    Used by actions: CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate.

    Name Type Required Description
    SubtitleBoardConfigSwitch Integer No Subtitle suppression module background configuration switch, 0 for off, 1 for on, default 0
    BoardX Integer No Subtitle background base plate x-axis coordinate position; Supports pixel and percentage format:

    - Pixel: Npx. Value range of N: [-4096,4096].
    - Percentage: N%, N range: [-100,100]. For example, 10% means the X-coordinate of the subtitle background base plate is 10% of the source video width.

    Default value: 0px.
    Note: The origin point of the coordinate axis is located at the bottom of the central axis of the source video, and the benchmark of the subtitle base plate is at the bottom of its central axis, refer to the figure below.
    image
    BoardXUnit Integer No BoardX unit, 0 pixel, 1 percentage, default is 0, pixel
    BoardY Integer No y-axis coordinate position of the subtitle background base plate; supports pixel and percentage format.

    -.
    -Percentage: N%, N range: [0,100]; for example, 10% means the y-coordinate of the subtitle background base plate = 10% * video height.

    If this parameter is not specified, the subtitle background is disabled.
    Note: The origin of the coordinate axes is at the bottom of the central axis of the source video, and the benchmark of the subtitle background base plate is at the bottom of its central axis. See the following diagram:
    image
    BoardYUnit Integer No BoardY unit, 0 pixel, 1 percentage, default is 0, pixel
    BoardWidth Integer No Background width. The value should be a positive integer.
    - Value range for pixels: [0,4096].
    - Value range for percentages: [0, 100].
    If background is enabled and this parameter is not specified, the default width is 90% of the source video width.
    BoardWidthUnit Integer No Background width measurement unit. 0: pixel, 1: percentage. Default is 0 (pixel).
    BoardHeight Integer No Background height. The value should be a positive integer.
    - Value range for pixels: [0,4096].
    - Value range for percentages: [0, 100].
    If background is enabled and this parameter is not specified, the default height is 15% of the source video height.
    BoardHeightUnit Integer No Base plate height unit, 0 pixel, 1 percentage, defaults to 0, pixel
    BoardColor String No Board color. Format: 0xRRGGBB.
    Default value: 0x000000 (black).
    BoardAlpha Float No Subtitle background transparency. Value range: [0, 1].
  • 0: completely transparent.
  • 1: completely opaque.

    • Default value: 0.8.

    SubtitleEmbedConfig

    Subtitle suppression module settings

    Used by actions: CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate.

    Name Type Required Description
    FontType String No

    Font type, supports:

  • hei.ttf: Heiti
  • song.ttf: Song Typeface
  • kai.ttf (recommended) or simkai.ttf: KaiTi
  • msyh.ttf: Microsoft YaHei
  • msyhbd.ttf: Microsoft YaHei in bold
  • hkjgt.ttf: Hwakangangtai
  • dhttx.ttf: Dianheiti Ultra Light
  • xqgdzt.ttf: Xique Ancient Dictionary
  • qpcyt.ttf: Smart Splice Super Round Body
  • arial.ttf: only supports English
  • dinalternate.ttf: DIN Alternate Bold
  • helveticalt.ttf: Helvetica
  • helveticains.ttf: Helvetica Inserat
  • trajanpro.ttf: TrajanPro-Bold
  • korean.ttf: Korean
  • japanese.ttf: Japanese
  • thai.ttf: Thai
  • roboto.ttf: Roboto
  • notosans.ttf: NotoSans
  • notosansthai.ttf: Thai NotoSansThai
  • sarabun.ttf: Thai Sarabun
  • kanit.ttf: Thai Kanit
  • charmonman.ttf: Thai Charmonman
  • notonaskharabic.ttf: Arabic NotoNaskhArabic
  • notosansdevanagari.ttf: India NotoSansDevanagari
  • notosanstc.ttf: Cantonese NotoSansTC
  • notosanskr.ttf: Korean NotoSansKR
  • gothica1.ttf: Korean GothicA1
  • nanummyeongjo.ttf: Korean NanumMyeongjo
  • notosansjp.ttf: Japanese NotoSansJP
  • notoserifjp.ttf: Japanese NotoSerifJP
  • shipporimincho.ttf: Japanese ShipporiMincho
    • Default: hei.ttf Heiti.
    Note:
  • KaiTi is recommended for use with kai.ttf
  • FontPath takes precedence when filled
    		•
    FontPath String No

    Custom font file url address, either this or CosInputInfo
    CosInputInfo CosInputInfo No

    Custom font file cos bucket address
    FontSize Integer No

    Font size. If not specified, the font size of the subtitle file applies. Pixel and percentage formats are supported:

    • Pixel: Npx, where N ranges from (0,4096].
    • Percentage: N%, where N ranges from (0,100]. For example, 10% means the subtitle font size equals 10% of the source video height.

    If left blank and the subtitle file has no settings, the default is 5% of the source video height.
    FontSizeUnit Integer No

    FontSize unit, 0 pixel, 1 percentage, defaults to 0, pixel
    FontColor String No

    Font color. Format: 0xRRGGBB. Default value: 0xFFFFFF (white).
    FontAlpha Float No

    Text opacity, value ranges from 0 to 1.

  • 0: completely transparent
  • 1: completely opaque
    • Default value: 1.
    PosX Integer No

    The X-coordinate position of subtitles. Specifying this parameter will ignore the built-in coordinates in the subtitle file. Supports pixel and percentage formats:

    • Pixel: Npx, where N ranges from [-4096, 4096].
    • Percentage: N%, where N ranges from [-100, 100]; for example, 10% means the X-coordinate of the subtitle equals 10% of the source video width.

    Default value: 0px.
    Note: The origin of the coordinate axes is at the bottom of the central axis of the source video, and the subtitle reference position is at the bottom of the central axis of the subtitles, as shown in the figure below:
    image
    PosXUnit Integer No

    PosX unit, 0 pixel, 1 percentage, defaults to 0, pixel
    PosY Integer No

    Subtitle Y-coordinate position. Specify this parameter to ignore the built-in coordinates in the subtitle file. Supports pixel and percentage formats:

    • Pixel: Npx, where N ranges from [0,4096].
    • Percentage: N%, where N ranges from [0,100]. For example, 10% means the subtitle Y-coordinate = 10% * source video height.

    Default value: source video height * 4%.
    Note: The coordinate axis origin is at the bottom of the central axis of the source video, and the subtitle reference point is at the bottom of the central axis of the subtitle. Refer to the figure below:
    image
    PosYUnit Integer No

    PosY measurement unit, 0 pixel, 1 percentage, defaults to 0, pixel
    SubtitleBoardConfig SubtitleBoardConfig No

    Background configuration
    SubtitleLayoutConfig SubtitleLayoutConfig No

    Column configuration
    SubtitleOutlineConfig SubtitleOutlineConfig No

    Text stroke configuration
    SubtitleShadowConfig SubtitleShadowConfig No

    Text shadow configuration
    SampleWidth Integer No

    Width of the source video dimensions, in pixels
    SampleHeight Integer No

    Height of the source video dimensions, in unit pixel

    SubtitleEmbedTemplateItem

    Subtitle suppression template details

    Used by actions: DescribeSubtitleEmbedTemplates.

    Name Type Description
    Definition Integer Unique identifier of the subtitle suppression template
    Name String
    Comment String
    Type String
    DeleteTag Integer Deletion mark. 0 Not deleted. 1 Deleted.
    CreateTime String Template creation time in ISO datetime format.
    UpdateTime String Last modification time of the template in ISO datetime format.
    SubtitleEmbedConfig SubtitleEmbedConfig Subtitle suppression module settings
    AliasName String

    SubtitleLayoutConfig

    Subtitle suppression module column configuration

    Used by actions: CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate.

    Name Type Required Description
    SubtitleLayoutConfigSwitch Integer No Subtitle arrangement configuration switch, 0 for off, 1 for on, default 0
    LineSpacing Integer No Line spacing. The value should be a positive integer.
    - Value range for pixels: [0, 1000].
    - Value range for percentages: [0, 100]. If left blank, the default is 0.
    LineSpacingUnit Integer No LineSpacing measurement unit, 0 pixel, 1 percentage, defaults to 0, pixel
    Alignment String No Alignment mode. Valid values: top: The top position of the subtitle is fixed, while the bottom position changes according to the line count. bottom: The bottom position of the subtitle is fixed, while the top position changes according to the line count. If this is not specified, bottom alignment is used by default.

    SubtitleOutlineConfig

    Subtitle suppression module text stroke configuration

    Used by actions: CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate.

    Name Type Required Description
    SubtitleOutlineConfigSwitch Integer No

    Text stroke configuration switch, 0 for off, 1 for on, default 0
    OutlineWidth Float No

    Stroke width, default unit pixel, underlying default value is 0.3% of the source video height
    OutlineWidthUnit Integer No

    Stroke width unit, 0 pixel, 1 percentage, defaults to 0, pixel
    OutlineColor String No

    Border color. 6-digit base 16 RGB. Black by default if left blank.
    OutlineAlpha Float No

    Stroke transparency. The value should be a positive floating-point number in the range of (0, 1]. If this is not specified, the default value is 1, which means completely opaque.

    SubtitlePosition

    Subtitle position information.

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    CenterY Integer Y-coordinate value when the subtitle is centered.

    SubtitleResult

    Smart subtitle task result.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Required Description
    Language String No

    Language of the subtitle file
    Status String No

    Whether the processing is successful.
    Path String No

    Subtitle file path
    SubtitleEmbedPath String No

    Subtitle suppression video path.
    SubtitleFileId String No

    FileId of the subtitle file.

    SubtitleShadowConfig

    Subtitle suppression module text shadow configuration

    Used by actions: CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate.

    Name Type Required Description
    SubtitleShadowConfigSwitch Integer No Text shadow configuration switch, 0 for off, 1 for on, default 0
    ShadowWidth Float No Shadow width, default unit pixel, underlying default value 0, no shading
    ShadowWidthUnit Integer No Shadow width unit. 0 for pixel, 1 for percentage. Default is 0 (pixel).
    ShadowColor String No Shadow color. 6-digit base 16 RGB. Black by default if left blank (when shadow is set).
    ShadowAlpha Float No Shadow transparency. A positive floating-point number in the range of (0, 1]. By default if left blank, the value is 1, which means completely opaque (with shadow configured).

    SubtitleTemplate

    Subtitle stream configuration parameters.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Path String No
    StreamIndex Integer No
    SubtitleFileInput MediaInputInfo No
    FontFileInput MediaInputInfo No Input information for the subtitle font file to be suppressed. Currently only support url and cos. If both are filled, url takes precedence over cos. If FontFileInput is filled, FontFileInput takes precedence over FontType.
    FontType String No
    FontSize String No
    FontColor String No
    FontAlpha Float No
    YPos String No
    BoardY String No
    BoardWidth Integer No
    BoardHeight Integer No
    BoardColor String No
    BoardAlpha Float No
    OutlineWidth Float No Stroke width. The value should be a floating-point number.
    - Value range for pixels: [0, 1000].
    - Value range for percentages: [0, 100].
    0.3% of the source video height by default if left blank.
    OutlineColor String No Border color. 6-digit hexadecimal RGB. Black by default if left blank.
    OutlineAlpha Float No Stroke transparency. The value should be a positive floating-point number in the range of (0, 1]. If this is not specified, the default value is 1, which means completely opaque.
    ShadowWidth Float No Shadow width. Floating-point number.
    - Value range for pixels: [0, 1000].
    - Value range for percentages: [0, 100].
    No shading by default if left blank.
    ShadowColor String No Shadow color. 6-bit base RGB. Black by default if left blank (when shadow has set).
    ShadowAlpha Float No Shadow transparency. The value should be a positive floating-point number in the range of (0, 1]. If this is not specified, the default value is 1, which means completely opaque (with shadow configured).
    LineSpacing Integer No Line spacing. The value should be a positive integer.
    - Value range for pixels: [0, 1000].
    - Value range for percentages: [0, 100]. If this is not specified, the default value is 0.
    Alignment String No Alignment mode. Valid values: top: The top position of the subtitle is fixed, while the bottom position changes according to the number of lines. bottom: The bottom position of the subtitle is fixed, while the top position changes according to the number of lines. If this is not specified, bottom alignment is used by default.
    BoardWidthUnit Integer No Default value is 0. If this is set to 1, the value of BoardWidth is a percentage based on the video width.
    BoardHeightUnit Integer No Default value is 0. If this is set to 1, the value of BoardHeight is a percentage based on the video height.
    OutlineWidthUnit Integer No Default value is 0. If this is set to 1, the value of OutlineWidth is a percentage based on the video height.
    ShadowWidthUnit Integer No Default value is 0. If this is set to 1, the value of ShadowWidth is a percentage based on the video height.
    LineSpacingUnit Integer No Default value: 0. If this is set to 1, the value of LineSpacing is a percentage based on the video height.

    SubtitleTransResultItem

    Subtitle translation output result.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

    Name Type Description
    Status String

    Translation flag:

    • Success
    • Error
    TransSrc String

    Source language (such as "en")
    TransDst String

    Target language (such as "zh")
    Path String

    Subtitle file URL
    SubtitleEmbedPath String

    Subtitle translation suppression video path.
    SubtitleFileId String

    FileId of the subtitle file.

    SuperResolutionConfig

    Super-resolution configuration.

    Used by actions: CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage.

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

    • Default value: ON.
    Type String No
    Size Integer No

    SvgWatermarkInput

    Input parameter of an SVG watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    Width String No Watermark width, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px; if 0px is entered
    and Height is not 0px, the watermark width will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark width will be the width of the source SVG image;
  • If the string ends in W%, the Width of the watermark will be the specified percentage of the video width; for example, 10W% means that Width is 10% of the video width;
  • If the string ends in H%, the Width of the watermark will be the specified percentage of the video height; for example, 10H% means that Width is 10% of the video height;
  • If the string ends in S%, the Width of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Width is 10% of the short side of the video;
  • If the string ends in L%, the Width of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Width is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as W%.

    • Default value: 10W%.
    Height String No Watermark height, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px; if 0px is entered
    and Width is not 0px, the watermark height will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark height will be the height of the source SVG image;
  • If the string ends in W%, the Height of the watermark will be the specified percentage of the video width; for example, 10W% means that Height is 10% of the video width;
  • If the string ends in H%, the Height of the watermark will be the specified percentage of the video height; for example, 10H% means that Height is 10% of the video height;
  • If the string ends in S%, the Height of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Height is 10% of the short side of the video;
  • If the string ends in L%, the Height of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Height is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as H%.

    • Default value: 0 px.

    SvgWatermarkInputForUpdate

    Input parameter of an SVG watermarking template

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    Width String No Watermark width, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px; if 0px is entered
    and Height is not 0px, the watermark width will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark width will be the width of the source SVG image;
  • If the string ends in W%, the Width of the watermark will be the specified percentage of the video width; for example, 10W% means that Width is 10% of the video width;
  • If the string ends in H%, the Width of the watermark will be the specified percentage of the video height; for example, 10H% means that Width is 10% of the video height;
  • If the string ends in S%, the Width of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Width is 10% of the short side of the video;
  • If the string ends in L%, the Width of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Width is 10% of the long side of the video;
  • If the string ends in %, the meaning is the same as W%.

    • Default value: 10W%.
    Height String No Watermark Height, which supports six formats of px, %, W%, H%, S%, and L%:
  • If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px; if 0px is entered
    and Width is not 0px, the watermark height will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark size will be the size 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 W%.

    • Default value: 0px.

    SyncDubbingOutputOption

    Used by actions: ChangeVoice, CloneVoice, SyncDubbing, TextToSpeech.

    Name Type Required Description
    Type String No

    TEHDConfig

    TSC parameter configuration.

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

    Name Type Required Description
    Type String Yes Top speed Codec type. Available values:
  • TEHD-100: top speed codec-100 (video top speed codec).
  • TEHD-200: top speed codec-200 (audio top speed codec).

    • If not specified, top speed Codec is not enabled.
    MaxVideoBitrate Integer No Maximum video bitrate. Valid when Type is set to top speed Codec.
    If this is not specified or is set to 0, no upper limit is set for the video bitrate.

    TEHDConfigForUpdate

    TSC parameter configuration.

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

    Name Type Required Description
    Type String No
    MaxVideoBitrate Integer No

    TagConfigureInfo

    Intelligent Tag Task Control Parameters

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes Intelligent tag task switch, available values:
  • ON: Enable intelligent tag task.
  • OFF: Disables the intelligent tag task.
    		•

    TagConfigureInfoForUpdate

    Control parameter of intelligent tagging task

    Used by actions: ModifyAIAnalysisTemplate.

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

    TaskNotifyConfig

    Event notification configuration of the task.

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

    Name Type Required Description
    NotifyType String No

    Notification type. Valid values:

  • CMQ: Removed. We recommend that you switch to TDMQ-CMQ.
  • TDMQ-CMQ: TDMQ.
  • URL: If URL is specified, HTTP callbacks are pushed to the URL specified in NotifyUrl. The callback protocol is HTTP and JSON. The packet body is the same as the output parameter of the event parsing notification API.
  • SCF: This is not recommended. Additional configuration for SCF is required in the console.
  • AWS-SQS: AWS queue. This is only suitable for AWS tasks in the same region.
    • Note: The default value is TDMQ-CMQ if this is not specified or empty. To use another type, you need to specify the corresponding value. If TDMQ-CMQ is used, oversized task response may cause failure to write to the queue.
    NotifyMode String No

    Workflow notification mode. Valid values are Finish and Change. If this is not specified, the default value is Finish.
    NotifyUrl String No

    HTTP callback URL. This is required if NotifyType is URL.
    CmqModel String No

    CMQ or TDMQ for CMQ model. Valid values are Queue and Topic.
    CmqRegion String No

    CMQ or TDMQ for CMQ region, such as sh or bj.
    TopicName String No

    This field takes effect if the model is Topic. It indicates the topic name of the CMQ or TDMQ for CMQ for receiving event notifications.
    QueueName String No

    This field takes effect if the model is Queue. It indicates the queue name of the CMQ or TDMQ for CMQ for receiving event notifications.
    AwsSQS AwsSQS No
    NotifyKey String No

    Key used to generate the callback signature.

    TaskOutputStorage

    Media processing output object information.

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

    Name Type Required Description
    Type String Yes Type of the media processing output object storage location. Supported values:
  • COS: COS storage
  • AWS-S3: AWS storage, suitable for AWS tasks only and requires the same region
  • VOD: VOD Pro Edition
    • CosOutputStorage CosOutputStorage No
    S3OutputStorage S3OutputStorage No
    VODOutputStorage VODOutputStorage No

    TaskSimpleInfo

    Task overview information

    Used by actions: DescribeTasks.

    Name Type Description
    TaskId String Task ID.
    TaskType String Task type. Valid values:
  • WorkflowTask: Workflow processing task;
  • LiveProcessTask: Live stream processing task.
    		•
    CreateTime String Creation time of a task in ISO date format.
    BeginProcessTime String Start time of task execution in ISO date format. If the task has not been started yet, this field will be 0000-00-00T00:00:00Z.
    FinishTime String End 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.
    SubTaskTypes Array of String The subtask type.

    TaskStatData

    Statistical data of the task.

    Used by actions: DescribeUsageData.

    Name Type Description
    TaskType String Task type.
  • Transcode: transcoding.
  • Enhance: enhancement.
  • AIAnalysis: intelligent analysis
  • AIRecognition: intelligent recognition
  • AIReview: content moderation
  • Snapshot: screenshot.
  • AnimatedGraphics: Animated image
  • ImageProcess: image processing.
    		•
    Summary Array of TaskStatDataItem Statistics overview of the number of tasks.
  • Transcode: The unit of usage is seconds.
  • Enhance: The unit of usage is seconds.
  • AIAnalysis: The unit of usage is seconds.
  • AIRecognition: The unit of usage is seconds.
  • AIReview: The unit of usage is seconds.
  • Snapshot: The unit of usage is images.
  • AnimatedGraphics: The unit of usage is seconds.
  • ImageProcess: The unit of usage is images.
    • .
    Details Array of SpecificationDataItem Task statistics data for varying specifications.

    1. Transcoding specification:
  • Audio: audio-only.
  • Remuxing: conversion to muxing.
  • Other transcoding specifications: {TYPE}.{CODEC}.{SPECIFICATION}.
    • Among them, valid values for TYPE:
        Standard: standard transcoding
        TESHD-10: TSC transcoding for videos.
        TESHD-20: TSC transcoding for audio.
        TESHD-30: TSC transcoding for audio and video.
        TESHD-30-SDK: duration-based billing of TSC transcoding SDK for audios/videos.
        TESHD-30-SDKCores: Top Speed Codec (TSC) transcoding SDK for audio and video is billed based on core count.
        Edit: video editing
      Specifically, valid values for CODEC:
        H264: H. 264 encoding.
        H265: H.265 encoding.
        AV1: AV1 encoding.
        MV-HEVC: MV-HEVC encoding.
      Specifically, valid values for SPECIFICATION:
        SD: standard definition.
        HD: high definition.
        FHD: full HD.
        2K:2K
        4K:4K
    For example, TESHD-10.H265.HD means H.265 encoding type high-definition TSC transcoding.

    2. Enhancement specification: video enhancement format: {TYPE}.{CODEC}.{SPECIFICATION}.{FPS}, where CODEC and SPECIFICATION follow the transcoding specifications, and FPS is valid only for atomic types; audio enhancement format: {TYPE}.
    Valid values for enhancement TYPE:
  • Enhance: Common enhancement type, which might be any atomic enhancement type.
  • Atomic enhancement type
    • . Valid values for video atomic enhancement type:
        Sdr2hdr:SDR2HDR
        SuperResolution: Super-resolution
        InsertFrame: frame interpolation.
        ComprehensiveEnhancement: comprehensive enhancement.
        NoiseReduction: video noise
        ColorEnhancement: Color enhancement
        RemoveScratches: scratch removal
        Deburr: artifacts removal.
        DetailEnhancement: detail enhancement.
        LightEnhancement: low-light enhancement.
        FaceEnhancement: face enhancement
      Valid value for audio atomic enhancement type.
        AudioNoiseReduction
        VolumeBalance
        AudioBeautify
        AudioSeparation

    3. Screenshot specification:
  • ImageSprite: sprite sheet
  • SampleSnapshot: sampled screenshot.
  • SnapshotByTime: time point screenshot.

    • 4. Image processing specification: {TYPE}.{CODEC}.{SPECIFICATION}.
  • ImageCompression: image encoding.
  • ImageSuperResolution: image super-resolution.
  • EnhanceImageColor: image color enhancement.

    • 5. Intelligent analysis specification:
  • AIAnalysis: Analytical major category
  • VideoTag: video tag.
  • VideoClassification: video classification.
  • SmartCover: intelligent cover.
  • FrameLabel: frame tag.
  • VideoSplit: video splitting.
  • Highlights: highlights.
  • OpeningAndEnding: opening and ending clips.

    • 6. Intelligent recognition specification:
  • AIRecognition: major category for recognition.
  • FaceRecognition: face recognition.
  • TextRecognition: optical character recognition.
  • ObjectRecognition: object recognition.
  • VoiceRecognition: automatic speech recognition.
  • VoiceTranslation: speech translation.

    • 7. There are no segmentation specifications for content moderation and conversion to GIF.

    TaskStatDataItem

    Statistical data of the task, including the number of tasks and usage.

    Used by actions: DescribeUsageData.

    Name Type Description
    Time String Start time of the time interval where the data resides, using ISO date format. For example, when the time granularity is day, 2018-12-01T00:00:00+08:00 indicates the interval from December 1, 2018 (inclusive) to December III, 2018 (exclusive).
    Count Integer Number of tasks.
    Usage Integer Task usage.

    TermBase

    Term base.

    Used by actions: CreateProject, QueryProject, UpdateProject.

    Name Type Required Description
    Src String Yes

    Source language of the term.
    Dst String Yes

    Target language of the term.
    SrcLanguage String No

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

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

    TerrorismConfigureInfo

    The parameters for detecting sensitive information.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfo No The parameters for detecting sensitive information in images.
    OcrReviewInfo TerrorismOcrReviewTemplateInfo No The parameters for detecting sensitive information based on OCR.

    TerrorismConfigureInfoForUpdate

    The parameters for detecting sensitive information.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfoForUpdate No The parameters for detecting sensitive information in images.
    OcrReviewInfo TerrorismOcrReviewTemplateInfoForUpdate No The parameters for detecting sensitive information based on OCR.

    TerrorismImgReviewTemplateInfo

    The parameters for detecting sensitive information in images.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to detect sensitive information in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Sensitive content filter tags. The auditing results including the selected tags are returned. If the filter tag is empty, all auditing results will be returned. Valid values:
  • guns: weapons and guns;
  • crowd: crowd gathering;
  • bloody: bloodiness;
  • police: police force;
  • banners: sensitive flags;
  • militant: militants;
  • explosion: explosions and fires;
  • terrorists: sensitive persons.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 90 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 80 will be used by default. Value range: 0-100.

    TerrorismImgReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information in images.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to detect sensitive information in images. Valid values:
  • ON
  • OFF
    		•
    LabelSet Array of String No Sensitive content filter tags. The auditing results including the selected tags are returned. If the filter tag is empty, all auditing results will be returned. Valid values:
  • guns: weapons and guns;
  • crowd: crowd gathering;
  • bloody: bloodiness;
  • police: police force;
  • banners: sensitive flags;
  • militant: militants;
  • explosion: explosions and fires;
  • terrorists: sensitive persons.
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    TerrorismOcrReviewTemplateInfo

    The parameters for detecting sensitive information based on OCR.

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Whether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    TerrorismOcrReviewTemplateInfoForUpdate

    The parameters for detecting sensitive information based on OCR.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Whether to detect sensitive information based on OCR. Valid values:
  • ON
  • OFF
    		•
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

    TextWatermarkTemplateInput

    Text watermarking template

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    FontType String Yes Font type. Currently, two types are supported:
  • simkai.ttf: Both Chinese and English are supported;
  • arial.ttf: Only English is supported.
    		•
    FontSize String Yes Font size, in the format of Npx. N is a numerical value with a value range of [0, 1] or [8, 4096].
    FontColor String Yes Font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlpha Float Yes Text transparency. Value range: (0, 1]
  • 0: Completely transparent
  • 1: Completely opaque

    • Default value: 1.
    TextContent String No Text content, up to 100 characters.
    Note: This field may return null, indicating that no valid values can be obtained.

    TextWatermarkTemplateInputForUpdate

    Text watermarking template

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    FontType String No Font type. Currently, two types are supported:
  • simkai.ttf: Both Chinese and English are supported;
  • arial.ttf: Only English is supported.
    		•
    FontSize String No Font size, in the format of Npx. N is a numerical value with a value range of [0, 1] or [8, 4096].
    FontColor String No Font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
    FontAlpha Float No Text transparency. Value range: (0, 1]
  • 0: Completely transparent
  • 1: Completely opaque
    		•
    TextContent String No Text content, up to 100 characters.

    TimeSpotCheck

    Detection policy for media quality inspection.

    Used by actions: CreateQualityControlTemplate, ModifyQualityControlTemplate.

    Name Type Required Description
    CheckDuration Integer No Duration of each loop detection, in seconds. Value range:

    - Minimum value: 10.
    - Maximum value: 86400.
    CheckInterval Integer No Detection interval, in seconds. It indicates the duration after a detection is completed and before the next detection is conducted. Value range:
    - Minimum value: 10.
    - Maximum value: 3600.
    SkipDuration Integer No Skipped opening duration, in seconds. Value range:
    - Minimum value: 1.
    - Maximum value: 1800.
    CirclesNumber Integer No Number of loops. Value range:
    - Minimum value: 0.
    - Maximum value: 1000.

    If the value is 0 or not specified, it indicates that loops are executed until the video ends.

    TokensUsage

    token usage

    Used by actions: EmbeddingData.

    Name Type Description
    InputTokens Integer

    Input token count
    OutputTokens Integer

    Output token count
    TotalTokens Integer

    Total token count, generally input + output

    TrackInfo

    Audio track information.

    Used by actions: CreateTranscodeTemplate.

    Name Type Required Description
    TrackNum String No
    ChannelVolume Array of Float No

    TranscodeTaskInput

    Transcode task input parameter type

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

    Name Type Required Description
    Definition Integer Yes Video transcoding template ID.
    RawParameter RawTranscodeParameter No Custom video transcoding parameter. It takes effect when Definition is set to 0.
    This parameter is used in high customization scenarios. It is recommended that you preferentially use Definition to specify transcoding parameters.
    OverrideParameter OverrideTranscodeParameter No
    WatermarkSet Array of WatermarkInput No Watermark list. Multiple image or text watermarks up to a maximum of 10 are supported.
    BlindWatermark BlindWatermarkInput No
    MosaicSet Array of MosaicInput No Mosaic list. A maximum of 10 images is supported.
    StartTimeOffset Float No Start time offset of the transcoded video, in seconds.
  • If this parameter is not specified or is set to 0, the transcoded video starts from the start position of the original video;
  • When the value is greater than 0 (assuming n), it means the transcoded video starts from the nth second of the original video;
  • When the value is less than 0 (assuming -n), it means the transcoded video starts n seconds before the end of the original video.
    		•
    EndTimeOffset Float No End time offset of the transcoded video, in seconds.
  • If not set or set to 0, the transcoded video will last until the end of the original video.
  • When the value is greater than 0 (assuming n), it means the transcoded video ends at the nth second of the original video.
  • When the value is less than 0 (assuming -n), it means the transcoded video lasts until n seconds before the end of the original video.
    		•
    OutputStorage TaskOutputStorage No
    OutputObjectPath String No Output path of the main file after transcoding, which can be a relative or absolute path.
    To define the output path, the path must end with .{format}. For variable names, please refer to Filename Variable Explanation.
    Relative path example:
  • Filename_{Variable name}.{format}
  • Filename.{format}.

    • Absolute path example:
  • /Custom path/Filename_{Variable name}.{format}

    • If left empty, the default relative path is {inputName}_transcode_{definition}.{format}.
    SegmentObjectName String No Output path for segment files after transcoding (the path of TS files when transcoding to HLS), which can only be a relative path. If left empty, it defaults to {inputName}_transcode_{definition}_{number}.{format}.
    ObjectNumberFormat NumberFormat No
    HeadTailParameter HeadTailParameter No

    TranscodeTemplate

    Details of a transcoding template

    Used by actions: DescribeTranscodeTemplates.

    Name Type Description
    Definition String Unique ID of a transcoding template.
    Container String Container format. Valid values: mp4, flv, hls, mp3, flac, ogg.
    Name String Name of a transcoding template.
    Note: This field may return null, indicating that no valid values can be obtained.
    Comment String Template description.
    Note: This field may return null, indicating that no valid values can be obtained.
    Type String Template type. Valid values:
  • Preset: Preset template;
  • Custom: Custom template.
    		•
    RemoveVideo Integer Whether to remove video data. Valid values:
  • 0: Retain;
  • 1: Remove.
    		•
    RemoveAudio Integer Whether to remove audio data. Valid values:
  • 0: Retain;
  • 1: Remove.
    		•
    VideoTemplate VideoTemplateInfo Video stream configuration parameter. This field is valid only when RemoveVideo is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    AudioTemplate AudioTemplateInfo Audio stream configuration parameter. This field is valid only when RemoveAudio is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    TEHDConfig TEHDConfig TESHD transcoding parameter. To enable it, please contact your Tencent Cloud sales rep.
    Note: This field may return null, indicating that no valid values can be obtained.
    ContainerType String Container 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.
    		•
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    EnhanceConfig EnhanceConfig Audio/Video enhancement configuration.
    Note: This field may return null, indicating that no valid values can be obtained.
    AliasName String Transcoding template alias.
    Note: This field may return null, indicating that no valid value can be obtained.

    TranslateConfigureInfo

    Speech Translation Task Control Parameter

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes Voice translation task switch, available values:
  • ON: Enable Intelligent Voice Translation task.
  • OFF: Disables the Intelligent Voice Translation task.
    		•
    SourceLanguage String No Video source language.
    DestinationLanguage String No Target language.
    SubtitleFormat String No

    TranslateConfigureInfoForUpdate

    Task control parameter for voice translation

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No Voice translation task switch, available values:
  • ON: Enable Intelligent Voice Translation task.
  • OFF: Disables the intelligent voice translation task.
    		•
    SourceLanguage String No Video source language.
    DestinationLanguage String No Target language.
    SubtitleFormat String No Generated subtitle file format. Leaving it as an empty string means no subtitle file will be generated. Available values:
  • vtt: Generate a WebVTT subtitle file.
    		•

    UnderstandImageConfig

    Image understanding task.

    Used by actions: CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage.

    Name Type Required Description
    Model String Yes

    Image understanding model

    Enumeration value:

    • WAND-understand-1.0-lite: Lightweight understanding model
    • WAND-understand-1.0-flash: Quality-speed balanced understanding model
    • WAND-understand-1.0-pro: High-quality understanding model
    Prompt String Yes

    Image understanding directive

    UpdateSmartErasePrivacyConfig

    Used by actions: ProcessMedia.

    Name Type Required Description
    PrivacyModel String No
    PrivacyTargets Array of String No

    UpdateSmartEraseSubtitleConfig

    Used by actions: ProcessMedia.

    Name Type Required Description
    SubtitleEraseMethod String No
    SubtitleModel String No
    OcrSwitch String No
    SubtitleLang String No
    SubtitleFormat String No
    TransSwitch String No
    TransDstLang String No
    AutoAreas Array of EraseArea No
    CustomAreas Array of EraseTimeArea No

    UpdateSmartEraseWatermarkConfig

    Used by actions: ProcessMedia.

    Name Type Required Description
    WatermarkEraseMethod String No
    WatermarkModel String No
    AutoAreas Array of EraseArea No
    CustomAreas Array of EraseTimeArea No

    UrlInputInfo

    Media processing URL object information.

    Used by actions: BatchProcessMedia, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, DetectVideoWatermark, ExtractBlindWatermark, ProcessImage, ProcessMedia.

    Name Type Required Description
    Url String Yes Video URL.

    UserDefineAsrTextReviewTemplateInfo

    Control parameter of a custom speech audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of a custom speech audit task. Valid values:
  • ON: Enables a custom speech audit task;
  • OFF: Disables a custom speech audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    UserDefineAsrTextReviewTemplateInfoForUpdate

    Control parameter of a custom speech audit task

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of a custom speech audit task. Valid values:
  • ON: Enables a custom speech audit task;
  • OFF: Disables a custom speech audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    UserDefineConfigureInfo

    Control parameter of a custom audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfo No Control parameter of custom figure audit.
    Note: This field may return null, indicating that no valid values can be obtained.
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo No Control parameter of custom speech audit.
    Note: This field may return null, indicating that no valid values can be obtained.
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo No Control 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.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate Yes Control parameter of custom figure audit.
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate Yes Control parameter of custom speech audit.
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate Yes Control parameter of custom text audit.

    UserDefineFaceReviewTemplateInfo

    Control parameter of a custom figure audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of a custom figure audit task. Valid values:
  • ON: Enables a custom figure audit task;
  • OFF: Disables a custom figure audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 97 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 95 will be used by default. Value range: 0-100.

    UserDefineFaceReviewTemplateInfoForUpdate

    Control parameter of a custom figure audit task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of a custom figure audit task. Valid values:
  • ON: Enables a custom figure audit task;
  • OFF: Disables a custom figure audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    UserDefineOcrTextReviewTemplateInfo

    Control parameter of a custom text audit task

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes Switch of a custom text audit task. Valid values:
  • ON: Enables a custom text audit task;
  • OFF: Disables a custom text audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0-100.

    UserDefineOcrTextReviewTemplateInfoForUpdate

    Control parameter of a custom text audit task.

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No Switch of a custom text audit task. Valid values:
  • ON: Enables a custom text audit task;
  • OFF: Disables a custom text audit task.
    		•
    LabelSet Array of String No Custom 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.
    BlockConfidence Integer No Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0-100.
    ReviewConfidence Integer No Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0-100.

    VODInputInfo

    Used by actions: BatchProcessMedia, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, DetectVideoWatermark, ExtractBlindWatermark, ProcessImage, ProcessMedia.

    Name Type Required Description
    Bucket String No
    Region String No
    Object String No
    SubAppId Integer No
    VodBasic Integer No
    FileId String No

    VODOutputStorage

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

    Name Type Required Description
    Bucket String No
    Region String No
    SubAppId Integer No
    VodBasic Integer No

    VideoComprehensionResultItem

    Video shot recognition result

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    StartTime Float Segment start time (unit: seconds)
    EndTime Float Segment end time (unit: seconds)
    Title String Storyboard clip title
    Description String Segment information description
    Keywords Array of String Storyboard clip keywords

    VideoDenoiseConfig

    Video noise reduction configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Type String No

    VideoDramaCosInfo

    aigc cos information. Stores user‑provided cos information for saving results

    Used by actions: CreateAiDramaTask, CreateAiFissionTask.

    Name Type Required Description
    CosBucketRegion String No

    cos bucket region
    CosBucketName String No

    cos bucket name
    CosBucketPath String No

    cos bucket path

    VideoEnhanceConfig

    Video enhancement configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    FrameRate FrameRateConfig No
    SuperResolution SuperResolutionConfig No
    Hdr HdrConfig No
    Denoise VideoDenoiseConfig No
    ImageQualityEnhance ImageQualityEnhanceConfig No
    ColorEnhance ColorEnhanceConfig No
    LowLightEnhance LowLightEnhanceConfig No
    ScratchRepair ScratchRepairConfig No
    ArtifactRepair ArtifactRepairConfig No
    EnhanceSceneType String No
    DiffusionEnhance DiffusionEnhanceConfig No
    FrameRateWithDen FrameRateWithDenConfig No
    AiRestoration AiRestorationConfig No

    VideoRedrawCosInfo

    aigc cos information. Stores user‑provided cos information for saving results

    Used by actions: CreateVideoRedrawTask.

    Name Type Required Description
    CosBucketRegion String No

    cos bucket region
    CosBucketName String No

    cos bucket name
    CosBucketPath String No

    cos bucket path

    VideoRedrawInput

    Input source for video redrawing

    Used by actions: CreateVideoRedrawTask.

    Name Type Required Description
    Url String Yes

    Input the video URL to be redrawn

    VideoRedrawTaskInfo

    AIGC redrawing and replacement task parameters

    Used by actions: CreateVideoRedrawTask.

    Name Type Required Description
    Style String No

    Convert the video style, such as anime, cyberpunk, and ink wash

    VideoTemplateInfo

    Video stream configuration parameters

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

    Name Type Required Description
    Codec String Yes Encoding format for video streams. Optional values:
  • h264: H.264 encoding.
  • h265: H.265 encoding.
  • h266: H.266 encoding.
  • av1: AOMedia Video 1 encoding
  • vp8: VP8 encoding.
  • vp9: VP9 encoding.
  • mpeg2: MPEG2 encoding.
  • dnxhd: DNxHD encoding.
  • mv-hevc: MV-HEVC encoding.


    • Note: av1 encoding container currently only supports mp4, webm, and mkv.
    Note: H.266 encoding containers currently only support mp4, hls, ts, and mov.
    Note: VP8 and VP9 encoding containers currently only support webm and mkv.
    Note: MPEG2 and dnxhd encoding containers currently only support mxf.
    Note: The MV-HEVC codec currently only supports mp4, hls, and mov. Among them, the HLS format only supports the MP4 segmented format and requires the input source to be a panoramic video (with multiple views).
    Fps Integer Yes Video frame rate. Value range:
    When FpsDenominator is empty, the range is [0, 120], in Hz.
    When FpsDenominator is not empty, the Fps/FpsDenominator range is [0, 120].
    If the value is 0, the frame rate will be the same as that of the source video.
    Bitrate Integer Yes Bitrate of the video stream. Value range: 0 and [128, 100000]. Unit: kbps.
    If the value is 0, the bitrate of the video will be the same as that of the source video.
    ResolutionAdaptive String No Resolution adaptation, available values:
  • open: turn on. At this point, Width represents the long side of the video, and Height indicates the short side of the video;
  • close: close. At this point, Width represents the width of the video, and Height indicates the height of the video.

    • Default value: open.
    Note: In self-adaptation mode, Width cannot be less than Height.
    Width Integer No Maximum value of the video stream width (or long edge) in px. Value range: 0 and [128, 4096].
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • Default value: 0.
    Note: If Codec is set to MV-HEVC, the maximum value can be 7680.
    Height Integer No Maximum value of the video stream height (or short side). Value range: 0 and [128, 4096]. Unit: px.
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • Default value: 0.
    Note: If Codec is set to MV-HEVC, the maximum value can be 7680.
    Gop Integer No Interval between I-frames (keyframes), which can be customized in frames or seconds. GOP value range: 0 and [1, 100000].
    If this parameter is 0 or left blank, the system will automatically set the GOP length.
    GopUnit String No
    FillType String No Filling method, when video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "padding". Optional filling modes:
  • stretch: stretches each frame to fill the entire screen, possibly causing the transcoded video to be "squashed" or "stretched";
  • black: Keep black, maintain video aspect ratio, edges filled with black.
  • White: Leave blank, maintain video aspect ratio, edge remainder filled with white.
  • gauss: Gaussian blur, maintain video aspect ratio, and use Gaussian blur filling for the rest of the edges.
  • smarttailor: intelligent cropping: smartly select video images to ensure proportional image cropping.

    • Default value: black.
    Vcrf Integer No
    HlsTime Integer No
    SegmentType Integer No
    FpsDenominator Integer No
    Stereo3dType String No
    VideoProfile String No
    VideoLevel String No
    Bframes Integer No
    Mode String No
    Sar String No
    NoScenecut Integer No
    BitDepth Integer No
    RawPts Integer No
    Compress Integer No
    SegmentSpecificInfo SegmentSpecificInfo No
    ScenarioBased Integer No
    SceneType String No
    CompressType String No

    VideoTemplateInfoForUpdate

    Video stream configuration parameters

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

    Name Type Required Description
    Codec String No
    Fps Integer No
    Bitrate Integer No
    ResolutionAdaptive String No
    Width Integer No
    Height Integer No
    Gop Integer No
    GopUnit String No
    FillType String No
    Vcrf Integer No
    ContentAdaptStream Integer No
    HlsTime Integer No
    SegmentType Integer No
    FpsDenominator Integer No
    Stereo3dType String No
    VideoProfile String No
    VideoLevel String No
    Bframes Integer No
    Mode String No
    Sar String No
    NoScenecut Integer No
    BitDepth Integer No
    RawPts Integer No
    Compress Integer No
    SegmentSpecificInfo SegmentSpecificInfo No
    ScenarioBased Integer No
    SceneType String No
    CompressType String No

    ViewImage

    One viewing angle in the MultiViewImages array in the multi-perspective image-to-3D scenario.

    Used by actions: SubmitHunyuan3DTask.

    Name Type Required Description
    ViewType String Yes

    View type

    Enumeration values:

    • front: Front view (required)
    • back: Back view
    • left: Left view
    • right: Right view
    • top: Top view
    • bottom: Bottom view
    • left_front: Left front 45°
    • right_front: Right front 45°

    MultiViewImages array length ≥ 2; must contain the front view; the same ViewType cannot be duplicated; each item must provide ViewImageUrl
    ViewImageUrl String Yes

    Image URL (http/https)

    VoiceInfo

    Voice information.

    Used by actions: DescribeVoices, UpdateVoice.

    Name Type Required Description
    VoiceId String No

    Voice ID.
    Name String No

    Voice name.
    Description String No

    Voice description.
    Category String No

    Voice type.

    Enumeration value:

    • system: System audio.
    Gender String No

    Gender.

    Enumeration values:

    • male: Male,
    • female: Female.
    Age String No

    Age.

    Enumeration values:

    • child: child
    • teenager: teenager
    • youth: youth
    • middle_aged: middle-aged
    • senior: senior
    • unknown: unknown
    Languages Array of String No

    List of supported languages.

    For example: en.
    AudioUrl String No

    Audition audio URL.
    Labels Array of String No

    List of tags.

    For example: gentle.
    Scenes Array of String No

    Recommended scenarios.

    For example: education.
    Engine String No

    VoiceProfile

    Used by actions: CloneVoice, DesignVoiceAsync, SyncDubbing.

    Name Type Required Description
    Name String No
    Description String No
    Gender String No
    Age String No
    Languages Array of String No
    Labels Array of String No
    Scenes Array of String No

    VoiceUpdateFields

    Fields of the updated voice.

    Used by actions: UpdateVoice.

    Name Type Required Description
    Name String No

    Voice name.
    Description String No

    Voice description.
    Gender String No

    Gender.

    Enumeration values:

    • male: male
    • female: female
    • unknown: unknown
    Age String No

    Age.

    Enumeration values:

    • child: child
    • teenager: teenager
    • youth: youth
    • middle_aged: middle-aged
    • senior: senior
    • unknown: unknown
    Languages Array of String No

    Language.
    Labels Array of String No

    Tag.
    Scenes Array of String No

    Scenario.
    AudioUrl String No

    Audition audio.

    VolumeBalanceConfig

    Volume equalization configuration

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

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

    • Default value: ON.
    Type String No

    WatermarkInput

    Watermark parameter type in the media processing task.

    Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

    Name Type Required Description
    Definition Integer Yes

    Watermark template ID.
    RawParameter RawWatermarkParameter No

    Watermark custom parameter, valid when Definition is set to 0.
    This parameter is used for highly customized scenarios. We recommend you prioritize using Definition to specify watermark parameters.
    Watermark custom parameters are not supported for screenshot watermarking.
    TextContent String No

    Text content, length not exceeding 100 characters. Fill in only when the watermark type is text watermark.
    Text watermark does not support screenshot watermarking.
    SvgContent String No

    SVG content. Length not exceeding 2000000 characters. Fill in only when the watermark type is SVG watermark.
    SVG watermark does not support screenshot watermarking.
    StartTimeOffset Float No

    Start time offset of a watermark, in seconds. If not set or set to 0, a watermark starts appearing when a video starts.

  • If not set or set to 0, a watermark starts appearing when a video starts;
  • If the value is greater than 0 (assuming n), the watermark appears at second n after the video starts;
  • If the value is less than 0 (assuming -n), the watermark appears n seconds before the end of the video.
    • Note: Only used for video scenes. Screenshots do not support it.
    EndTimeOffset Float No

    End time offset of a watermark, in seconds.

  • Leave empty or set to 0: the watermark lasts until the end of the video.
  • Value greater than 0 (assuming n): the watermark disappears at second n.
  • Value smaller than 0 (assuming -n): the watermark disappears n seconds before the end of the video.
    • Note: Only used for video scenes. Screenshot is not supported.

    WatermarkTemplate

    Details of a watermarking template

    Used by actions: DescribeWatermarkTemplates.

    Name Type Description
    Definition Integer Unique ID of a watermarking template.
    Type String Watermark type. Valid values:
  • image: Image watermark;
  • text: Text watermark.
    		•
    Name String Name of a watermarking template.
    Comment String Template description.
    XPos String Horizontal position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Left edge of the watermark will be at the position of the specified percentage of the video width; for example, 10% means that the Left edge is at 10% of the video width;
  • If the string ends in px, the Left edge of the watermark will be at the position of the specified px of the video width; for example, 100px means that the Left edge is at the position of 100 px.
    		•
    YPos String Vertical position of the origin of the watermark image relative to the origin of the video.
  • If the string ends in %, the Top edge of the watermark will beat the position of the specified percentage of the video height; for example, 10% means that the Top edge is at 10% of the video height;
  • If the string ends in px, the Top edge of the watermark will be at the position of the specified px of the video height; for example, 100px means that the Top edge is at the position of 100 px.
    		•
    ImageTemplate ImageWatermarkTemplate Image watermarking template. This field is valid only when Type is image.
    Note: This field may return null, indicating that no valid values can be obtained.
    TextTemplate TextWatermarkTemplateInput Text watermarking template. This field is valid only when Type is text.
    Note: This field may return null, indicating that no valid values can be obtained.
    SvgTemplate SvgWatermarkInput SVG watermarking template. This field is valid when Type is svg.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time of a template in ISO date format.
    UpdateTime String Last modified time of a template in ISO date format.
    CoordinateOrigin String Origin position. Valid values:
  • TopLeft: indicates that the coordinate origin is at the top left corner of the video image and the watermark origin is at the top left corner of the image or text.
  • TopRight: indicates that the coordinate origin is at the top right corner of the video image and the watermark origin is at the top right corner of the image or text.
  • BottomLeft: indicates that the coordinate origin is at the bottom left corner of the video image and the watermark origin is at the bottom left corner of the image or text.
  • BottomRight: indicates that the coordinate origin is at the bottom right corner of the video image and the watermark origin is at the bottom right corner of the image or text.
    		•

    WordResult

    Word information.

    Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification, RecognizeAudio.

    Name Type Description
    Word String Word text.
    Start Float Word start timestamp, in seconds.
    End Float Word end timestamp, in seconds.
    Trans String Text after translation.

    WorkflowInfo

    Workflow information details.

    Used by actions: DescribeWorkflows.

    Name Type Description
    WorkflowId Integer Workflow ID.
    WorkflowName String Workflow name.
    Status String Workflow status. Valid values:
  • Enabled: Enabled,
  • Disabled: Disabled.
    		•
    Trigger WorkflowTrigger Input rule bound to a workflow. If an uploaded video hits the rule for the object, the workflow will be triggered.
    OutputStorage TaskOutputStorage The location to save the media processing output file.
    Note: This field may return null, indicating that no valid value can be obtained.
    MediaProcessTask MediaProcessTaskInput The media processing parameters to use.
    Note: This field may return null, indicating that no valid value can be obtained.
    AiContentReviewTask AiContentReviewTaskInput Type parameter of a video content audit task.
    Note: This field may return null, indicating that no valid values can be obtained.
    AiAnalysisTask AiAnalysisTaskInput Video content analysis task parameter.
    AiRecognitionTask AiRecognitionTaskInput Type parameter of a video content recognition task.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskNotifyConfig TaskNotifyConfig Event 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.
    TaskPriority Integer Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
    OutputDir String The directory to save the media processing output file, such as /movie/201907/.
    CreateTime String Creation time of a workflow in ISO date format.
    UpdateTime String Last modified time of a workflow in ISO date format.

    WorkflowTask

    Media Processing Service task information

    Used by actions: DescribeTaskDetail, ParseNotification.

    Name Type Description
    TaskId String Media processing task ID.
    Status String Task flow status. Valid values:
  • PROCESSING: Processing;
  • FINISH: completed
    		•
    ErrCode Integer An error code other than 0 is returned in case of a source exception. Use the error code of the specific task when a value of 0 is returned.
    Message String The corresponding exception message is returned in case of a source exception. If no source exception occurs, use the message of each specific task.
    InputInfo MediaInputInfo
    MetaData MediaMetaData
    MediaProcessResultSet Array of MediaProcessTaskResult Execution status and results of a Media Processing Service task.
    AiContentReviewResultSet Array of AiContentReviewResult Execution status and results of a video content review task.
    AiAnalysisResultSet Array of AiAnalysisResult Execution status and results of a video content analysis task.
    AiRecognitionResultSet Array of AiRecognitionResult Task execution status and results of the video content recognition task.
    AiQualityControlTaskResult ScheduleQualityControlTaskResult
    SmartSubtitlesTaskResult Array of SmartSubtitlesResult
    SmartEraseTaskResult SmartEraseTaskResult

    WorkflowTrigger

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

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

    Name Type Required Description
    Type String Yes The 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).


    		•
    CosFileUploadTrigger CosFileUploadTrigger No Required and valid when Type is CosFileUpload. This is a COS trigger rule.
    AwsS3FileUploadTrigger AwsS3FileUploadTrigger No Required and valid when Type is AwsS3FileUpload. This is the AWS S3 trigger rule.

    Note: Currently, the keys for AWS S3, the corresponding trigger queue SQS, and the callback queue SQS should be the same.
    上一篇: ExecuteFunction下一篇: Error Codes

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈

    搜索
      请输入关键词搜索文档