Data Types

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, DescribeTaskDetail, ModifySchedule, ParseNotification, 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	Custom parameters for AI dubbing. Valid when Definition is not 0. If you fill in some dubbing parameters in this structure, 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 not specified, it inherits the upper-level OutputStorage value.
SrcSubtitleInfo	MediaInputInfo	No	External source subtitle file information.
DstSubtitleInfos	Array of DstSubtitleInput	No	External subtitle file info, 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	AI dubbing extension parameter, serialized json string.
DramaId	String	No	Associated drama series ID. Note: This value takes effect when the dubbing mode is intelligent dubbing by role.

AIDubbingTaskOutput

AI dubbing result information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
OriginSubtitlePath	String	Path of subtitle file extracted from video.
TranslateSubtitlePath	String	Path of a subtitle translation file extracted from a video.
VoiceClonedVideo	String	File URL of the video after voice type cloning
VoiceClonedMarkFile	String	File address of the voice type clone annotation
VideoPath	String	Video output path.
OriginSubtitleFileId	String	FileId of the subtitle file extracted from video.
TranslateSubtitleFileId	String	FileId of a subtitle translation file extracted from a video.
SpeakerPath	String	Tag file path.
SpeakerFileId	String	Fileid of the tag file.
EraseVideoFileId	String	FileId of the video output after removal.
EraseVideoPath	String	Erase video output path.
DstAudioPath	String	Dubbed audio file path of the translation.
DstAudioFileId	String	FileId of the audio file for the translated dubbing.
DubbingEditInfoUrl	String	Voice cloning editing information Editing information for secondary modifications of voice cloning
SubtitlePos	SubtitlePosition	Subtitle position after removal. Note: only applicable to subtitle extraction when return of subtitle position is enabled.
OutputStorage	TaskOutputStorage	Storage location of the output file of the AI dubbing task.

AIDubbingTaskResult

AI dubbing 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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
Message	String	Error message.
Input	AIDubbingTaskInput	AI dubbing task input.
Output	AIDubbingTaskOutput	AI dubbing task output.
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 format.

AIRecognitionTemplateItem

Details of a video content recognition template

Used by actions: DescribeAIRecognitionTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a video content recognition template.
Name	String	Name of a video content recognition template.
Comment	String	Description of a video content recognition template.
FaceConfigure	FaceConfigureInfo	Face recognition control parameter. Note: This field may return null, indicating that no valid values can be obtained.
OcrFullTextConfigure	OcrFullTextConfigureInfo	Full text recognition control parameter. Note: This field may return null, indicating that no valid values can be obtained.
OcrWordsConfigure	OcrWordsConfigureInfo	Text keyword recognition control parameter. Note: This field may return null, indicating that no valid values can be obtained.
AsrFullTextConfigure	AsrFullTextConfigureInfo	Full speech recognition control parameter. Note: This field may return null, indicating that no valid values can be obtained.
AsrWordsConfigure	AsrWordsConfigureInfo	Speech keyword recognition control parameter. Note: This field may return null, indicating that no valid values can be obtained.
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

Output of the orchestration subtask

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
TranscodeTask	MediaProcessTaskTranscodeResult	Transcoding task output
AnimatedGraphicTask	MediaProcessTaskAnimatedGraphicResult	Output of rotating image tasks
SnapshotByTimeOffsetTask	MediaProcessTaskSnapshotByTimeOffsetResult	Time point screenshot task output
SampleSnapshotTask	MediaProcessTaskSampleSnapshotResult	Output of sampling screenshot task
ImageSpriteTask	MediaProcessTaskImageSpriteResult	Image sprite output
AdaptiveDynamicStreamingTask	MediaProcessTaskAdaptiveDynamicStreamingResult	Adaptive bitrate streaming task output
RecognitionTask	ScheduleRecognitionTaskResult	Identification task output
ReviewTask	ScheduleReviewTaskResult	Review task output
AnalysisTask	ScheduleAnalysisTaskResult	Analysis task output
QualityControlTask	ScheduleQualityControlTaskResult	Media quality inspection task output
ExecRuleTask	ScheduleExecRuleTaskResult	Conditional judgment task output
SmartSubtitlesTask	ScheduleSmartSubtitleTaskResult	Smart subtitle task output
SmartEraseTask	SmartEraseTaskResult	Output of the intelligent erasure task
AIDubbingTask	AIDubbingTaskResult	AI dubbing task output.

ActivityResult

Output of the orchestration task

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
ActivityType	String	Atomic task type. Transcode: Transcoding. SampleSnapshot: Sampled screenshot. AnimatedGraphics: Animated image. SnapshotByTimeOffset: Time point screenshot. ImageSprites: Sprite sheet. AdaptiveDynamicStreaming: Adaptive bitrate stream. AiContentReview: Content review. AIRecognition: Intelligent recognition. AIAnalysis: Intelligent analysis. AiQualityControl: Media quality inspection. SmartSubtitles: Smart subtitle. SmartErase: Smart erasing. Dubbing: AI dubbing.
ActivityResItem	ActivityResItem	Output of the atomic task.

AdaptiveDynamicStreamingInfoItem

Adaptive bitrate streaming information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Adaptive bitstreaming specification.
Package	String	Packaging format. Possible values: 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	Digital watermark parameter.
OutputStorage	TaskOutputStorage	No	Target storage for files after adaptive bitrate streaming. If this is not specified, the upper-level OutputStorage value is used.
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	External subtitle feature. Specifies the subtitle file to be inserted.
DrmInfo	DrmInfo	No	Drm information.
DefinitionType	String	No	Adaptive bitrate streaming template type. Valid values: Common: audio and video. PureAudio: audio only.
SubtitleTemplate	SubtitleTemplate	No	Hard subtitle (burned-in subtitle) feature. Specifies the subtitle source, font size, location, and other subtitle parameters.
StdExtInfo	String	No	Extended transcoding parameter field.
KeyPTSList	Array of Integer	No	Set the frame at the specified pts time as a key frame and segment it. Unit: milliseconds (a relative deviation of <=1ms is allowed). When gop and segment duration are specified simultaneously, they will work together. Note that RawPts needs to be enabled, keep the frame rate following the source, and ensure the passed-in pts time has a corresponding frame in the source.
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	Audio parameter information list. Note: This parameter is used only when audio tracks are merged in self-adaptive transcoding. The maximum length of the parameter array is 64.

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	Insertion method. Valid values: subtitle-stream: Inserts a subtitle track. close-caption-708: Encodes CEA-708 subtitles into SEI frames. close-caption-608: Encodes CEA-608 subtitles into SEI frames.
Subtitle	MediaInputInfo	No	Subtitle file.
SubtitleName	String	No	Subtitle name. Note: Only Chinese characters, letters, digits, spaces, underscores (_), hyphens (-), periods (.), and brackets are supported. The length cannot exceed 64 characters.
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. Valid values: standard: common super resolution super: advanced super-resolution super version. ultra: Advanced super resolution ultra version. 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: magnification factor of super-resolution, which can be a decimal.
Percent	Float	No	Super resolution multiplication rate, which can be a decimal. Note: Used when Mode is equal to percent.
Width	Integer	No	Target image width. Cannot exceed 4096. Note: When Mode is equal to aspect or fixed, preferentially use this configuration.
Height	Integer	No	Target image height. Must not exceed 4096. Note: When Mode is equal to aspect or fixed, preferentially use this configuration.
LongSide	Integer	No	Long side length of the target image. Must not exceed 4096. Note: This configuration is used when Mode is equal to aspect or fixed, and Width and Height fields are not configured.
ShortSide	Integer	No	Short side length of the target image. Must not exceed 4096. Note: This configuration is used when Mode is equal to aspect or fixed, and Width and Height fields are not configured.

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 tag FrameTag: intelligent frame tagging Highlight: intelligent highlights DeLogo: smart erasing Description: LLM summarization Dubbing: intelligent dubbing VideoRemake: video deduplication VideoComprehension: video (audio) understanding Cutout: video matting Reel: intelligent video creation
ClassificationTask	AiAnalysisTaskClassificationResult	Query result of the video content analysis intelligent categorization task. Valid when the task type is Classification.
CoverTask	AiAnalysisTaskCoverResult	Query result of the video content analysis Intelligent Cover Task. Valid when the task type is Cover.
TagTask	AiAnalysisTaskTagResult	Query result of the video content analysis intelligent tag task. Valid when the task type is Tag.
FrameTagTask	AiAnalysisTaskFrameTagResult	Query result of the intelligent frame tagging task for video content analysis. Valid when the task type is FrameTag.
HighlightTask	AiAnalysisTaskHighlightResult	Query result of the video content analysis highlight task. Valid when the task type is Highlight.
DeLogoTask	AiAnalysisTaskDelLogoResult	Query result of the video content analysis smart erasing task. Valid when the task type is DeLogo.
SegmentTask	AiAnalysisTaskSegmentResult	The query result of a splitting task for video analysis, which is valid when the task type is SegmentRecognition.
HeadTailTask	AiAnalysisTaskHeadTailResult	The query result of an opening and closing segments recognition task for video analysis, which is valid when the task type is HeadTailRecognition.
DescriptionTask	AiAnalysisTaskDescriptionResult	The query result of a video content analysis summary task, valid when the task type is Description.
HorizontalToVerticalTask	AiAnalysisTaskHorizontalToVerticalResult	The query result of a landscape-to-portrait task for video content analysis, which is valid when the task type is HorizontalToVertical.
DubbingTask	AiAnalysisTaskDubbingResult	Query result of the video content analysis dubbing task. Valid when the task type is Dubbing.
VideoRemakeTask	AiAnalysisTaskVideoRemakeResult	The query result of a deduplication task for video content analysis, which is valid when the task type is VideoRemake.
VideoComprehensionTask	AiAnalysisTaskVideoComprehensionResult	Query result of the video (audio) understanding task. This parameter is valid when the task type is VideoComprehension.
CutoutTask	AiAnalysisTaskCutoutResult	Query result of the video content analysis intelligent image masking task. Valid when the task type is Cutout.
ReelTask	AiAnalysisTaskReelResult	Query result of the video content analysis AI narration and video re-creation task. Valid when the task type is Reel.
GenericTask	AiAnalysisTaskGenericResult	Query result of the intelligent analysis common task. Valid when the task type is Generic.

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

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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
Message	String	Error message.
Input	AiAnalysisTaskClassificationInput	Intelligent categorization task input.
Output	AiAnalysisTaskClassificationOutput	Intelligent categorization task output.

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	List of smart covers.
OutputStorage	TaskOutputStorage	Storage location of the intelligent cover.

AiAnalysisTaskCoverResult

Result type of intelligent cover

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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
Message	String	Error message.
Input	AiAnalysisTaskCoverInput	Intelligent Cover Task input.
Output	AiAnalysisTaskCoverOutput	Output of the intelligent cover task.

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 intelligent video masking 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	Output of the video matting task.
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	Subtitle position after removal. Note: only applicable to subtitle extraction when return of subtitle position is enabled.
VoiceClonedVideo	String	File URL of the video after voice type cloning
VoiceClonedMarkFile	String	File address of the voice type clone annotation
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	Output of intelligent erasure task.

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	Intelligent description task output.

AiAnalysisTaskDubbingInput

Input type of the intelligent captioning task.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	ID of the video localization template.
ExtendedParameter	String	Extended parameter.

AiAnalysisTaskDubbingOutput

Intelligent dubbing 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 dubbing 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 captioning task input.
Output	AiAnalysisTaskDubbingOutput	Intelligent captioning task output.

AiAnalysisTaskFrameTagInput

Intelligent frame-specific 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	Frame-specific tag list of the video.

AiAnalysisTaskFrameTagResult

Result type of intelligent frame tagging

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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
Message	String	Error message.
Input	AiAnalysisTaskFrameTagInput	Intelligent frame-specific tagging task input.
Output	AiAnalysisTaskFrameTagOutput	Output of the intelligent frame-by-frame tagging task.

AiAnalysisTaskGenericInput

Intelligent analysis common task input type.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	ID of the intelligent analysis template.
ExtendedParameter	String	Extended parameter.

AiAnalysisTaskGenericOutput

Intelligent analysis common result information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
OutputStorage	TaskOutputStorage	Storage location.
Result	String	Task result.

AiAnalysisTaskGenericResult

Intelligent Analysis common result type.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values are PROCESSING, SUCCESS, and FAIL. Enumeration values: PROCESSING: Processing SUCCESS: Success FAIL: Failure
ErrCode	Integer	Error code. 0: Successful. Other values: Failed.
Message	String	Error message.
Input	AiAnalysisTaskGenericInput	Intelligent analysis task input.
Output	AiAnalysisTaskGenericOutput	Intelligent analysis task output.

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	Opening pts.
TailTimeOffset	Float	Outro pts.

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	Output of the opening and closing credits task.

AiAnalysisTaskHighlightInput

Input type of the intelligent highlight task.

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	Storage location of highlights.

AiAnalysisTaskHighlightResult

Type of the intelligent highlight 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	AiAnalysisTaskHighlightInput	Input of the intelligent highlight task.
Output	AiAnalysisTaskHighlightOutput	Output of the intelligent highlight task.

AiAnalysisTaskHorizontalToVerticalInput

Intelligent landscape-to-portrait task input type.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	ID of the horizontal-to-vertical video transformation template.
ExtendedParameter	String	Extended parameter.

AiAnalysisTaskHorizontalToVerticalOutput

Intelligent landscape-to-portrait result.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Path	String	Intelligent landscape-to-portrait video list.
OutputStorage	TaskOutputStorage	Storage location of intelligent landscape-to-portrait videos.
Confidence	Float	Confidence degree.

AiAnalysisTaskHorizontalToVerticalResult

Intelligent landscape-to-portrait 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: successful; other values: failed.
Message	String	Error message
Input	AiAnalysisTaskHorizontalToVerticalInput	Intelligent horizontal-to-vertical task input.
Output	AiAnalysisTaskHorizontalToVerticalOutput	Intelligent horizontal-to-vertical task output.

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	Extended parameter, whose value is a serialized json string. Note: This parameter is used to meet customization requirements. References: [Smart Erase Tutorial]: https://www.tencentcloud.com/document/product/862/101530?from_cn_redirect=1 Video Splitting (Long Videos to Short Videos) Tutorial Intelligent Highlights Tutorial Horizontal-to-Vertical Video Transformation

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 commentary video.
VideoPaths	Array of String	List of commentated video paths. Note: 1. When a file is returned, VideoPath returns a file path, and VideoPaths also fills an element with the same path. 2. When multiple files are returned, VideoPath returns an empty string, and VideoPaths returns the file path list.
ScriptPath	String	Script file path.
OutputStorage	TaskOutputStorage	Storage location of the commentary video.

AiAnalysisTaskReelResult

Result type for AI narration and video re-creation

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	Task input for AI narration and video re-creation.
Output	AiAnalysisTaskReelOutput	Task output for AI narration and video re-creation.
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.
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.

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	Video summary, used for offline scenarios.

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	Splitting task output.

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	Intelligent video 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	Intelligent tag task output.

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	Extended information for video (audio) understanding.
VideoComprehensionResultList	Array of VideoComprehensionResultItem	Video storyboard 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	Output file for video (audio) recognition.
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	Input of the deduplication task.
Output	AiAnalysisTaskVideoRemakeOutput	Output of the deduplication task.

AiComposeConfig

Layer fusion configuration for image processing

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

Name	Type	Required	Description
Switch	String	No	Capability configuration switch. ON: Enable (default value); OFF: Disable.
Model	String	No	Compose model. Available values: compose-1.0-lite (default value, can be omitted).
Canvas	ImageComposeCanvas	No	Canvas definition. Can be omitted: if omitted, the natural size of the layer with the minimum ZIndex (bottom layer) is used.
Layers	Array of ImageComposeLayer	No	Layer list, the unique source of layers. At least 1 layer and up to 20 layers.

AiContentReviewResult

Content moderation result

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Type	String	Task type. Valid values: Porn: image porn detection. Terrorism: sensitive image Political: sensitive image Porn.Asr: ASR text-based porn detection Porn.Ocr: OCR text-based porn detection Political.Asr: ASR text sensitive 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 from the video for review.
Duration	Float	Video duration reviewed, in seconds.
PornTask	AiReviewTaskPornResult	Query result of the intelligent porn detection in image task for video content review. Valid when the task type is Porn.
TerrorismTask	AiReviewTaskTerrorismResult	Query result of sensitive tasks for intelligent screen in video content review. Valid when the task type is Terrorism.
PoliticalTask	AiReviewTaskPoliticalResult	Query result of sensitive tasks for intelligent screen in video content review. Valid when the task type is Political.
PornAsrTask	AiReviewTaskPornAsrResult	Query result of the ASR text pornography detection task for video content review. Valid when TaskType is Porn.Asr.
PornOcrTask	AiReviewTaskPornOcrResult	Query result of the OCR text pornography detection task for video content review. Valid when the task type is Porn.Ocr.
PoliticalAsrTask	AiReviewTaskPoliticalAsrResult	Query result of the sensitive task for ASR text in video content review. Valid when the task type is Political.Asr.
PoliticalOcrTask	AiReviewTaskPoliticalOcrResult	Query result of sensitive tasks for OCR text in video content review. Valid when the task type is Political.Ocr.
TerrorismOcrTask	AiReviewTaskTerrorismOcrResult	Query result of the OCR text sensitive task for video content review. Valid when the task type is Terrorism.Ocr.
ProhibitedAsrTask	AiReviewTaskProhibitedAsrResult	Query result of the ASR text prohibited content detection task for video content review. Valid when TaskType is Prohibited.Asr.
ProhibitedOcrTask	AiReviewTaskProhibitedOcrResult	Query result of the OCR text prohibited content detection task for video content review. Valid when the task type is Prohibited.Ocr.

AiContentReviewTaskInput

Intelligent content review task type

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	Matting target type: "foreground" (default) / "pattern"
PatternConfig	PatternConfig	No	Pattern cutout configuration. This parameter is valid only when Type is pattern.
Model	String	No	Matting model selection. Enumeration values: cutout-1.0-lite: basic version, fastest speed cutout-1.0-flash: standard version, quality-speed balance

AiDecomposeConfig

Intelligent layer split configuration.

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

Name	Type	Required	Description
Switch	String	No	Capability configuration switch. Enumeration values: ON: Enable the layer separation feature. OFF: Disable the layer separation feature. Default value: ON
Layers	Integer	No	Expected number of layers. Value range: [2, 17]
Prompt	String	No	Prompt content.
Model	String	No	Model name. Enumeration value: decompose-1.0-flash: 1.0 version flash model.

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 range: [0, 2048]
Height	Integer	No	Target height (pixel) Value range: [0, 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	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.

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: suite-1.0-flash: suite-1.0-flash.

AiQualityControlTaskInput

Input parameter type for media quality inspection.

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

Name	Type	Required	Description
Definition	Integer	No	Media quality inspection template ID. You can directly use a preset template or customize a template in the console. The preset templates are as follows: - 10: Enable all quality inspection items. - 20: Only enable quality inspection items corresponding to format diagnosis. - 30: Only enable quality inspection items corresponding to no-reference scoring. - 40: Only enable quality inspection items corresponding to screen quality.
ChannelExtPara	String	No	Channel expansion parameter, json serialized string.

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	Face recognition result, which is valid when Type is Valid for FaceRecognition.
AsrWordsTask	AiRecognitionTaskAsrWordsResult	Speech keyword recognition result, which is valid when Type is Valid when set to AsrWordsRecognition.
AsrFullTextTask	AiRecognitionTaskAsrFullTextResult	Full speech recognition result. When Type is Valid when AsrFullTextRecognition is used.
OcrWordsTask	AiRecognitionTaskOcrWordsResult	Text keyword recognition result. When Type is Valid when set to OcrWordsRecognition.
OcrFullTextTask	AiRecognitionTaskOcrFullTextResult	Full text recognition result. When Type is Valid when OcrFullTextRecognition is used.
TransTextTask	AiRecognitionTaskTransTextResult	Translation result. When Type is Valid when set to TransTextRecognition.
ObjectTask	AiRecognitionTaskObjectResult	Object recognition result, which is valid when Type is Valid for ObjectRecognition.

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	Output information on the full speech recognition task.
Progress	Integer	Task progress.

AiRecognitionTaskAsrFullTextResultInput

Input for full speech recognition.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Full speech recognition template ID.

AiRecognitionTaskAsrFullTextResultOutput

Full speech recognition result.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
SegmentSet	Array of AiRecognitionTaskAsrFullTextSegmentItem	List of segments for full speech recognition.
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 information on the speech keyword recognition task.
Output	AiRecognitionTaskAsrWordsResultOutput	Output information on the speech keyword recognition task.

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 time segments where the speech keyword appears.

AiRecognitionTaskAsrWordsResultOutput

Speech keyword recognition output.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
ResultSet	Array of AiRecognitionTaskAsrWordsResultItem	Result set of speech keyword recognition.

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

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 person.
Type	String	Person library type. It indicates the person library that a 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 where the person appears.
Gender	String	Person gender: Male: man; Female: woman.
Birthday	String	Date of birth of the person.
Profession	String	Person's occupation or position.
SchoolOfGraduation	String	University of the person
Abstract	String	Figure introduction.
PlaceOfBirth	String	Birthplace or place of origin of the person.
PersonType	String	Person type: Politician: official. Artist: artist.
Remark	String	Sensitivity labeling: Normal: The status is 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	Object recognition task output information.

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	Output information on the full text recognition task.

AiRecognitionTaskOcrFullTextResultInput

Input for full text recognition.

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

Segment undergone full text recognition.

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

Segment undergone full text recognition.

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

Keyword recognition result of the text.

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	Input information for the text keyword recognition task.
Output	AiRecognitionTaskOcrWordsResultOutput	Output message of the text keyword recognition task.

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

OCR text recognition 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.
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	Translation task output information.
Progress	Integer	Task progress.

AiRecognitionTaskTransTextResultInput

Input for translation.

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	List of segments for translation.
SubtitlePath	String	Subtitle file URL.

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

LLM repair

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	Strength type Enumeration values: weak: Weak normal: Medium strong: Strong Default value: normal

AiReviewPoliticalAsrTaskInput

Input parameter type of the sensitive Asr text task in content review

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Template ID.

AiReviewPoliticalAsrTaskOutput

Sensitive information in Asr text

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Sensitive score of the Asr text. Value range: 0–100.
Suggestion	String	Sensitive result suggestions for Asr text. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments with sensitive Asr text.

AiReviewPoliticalOcrTaskInput

Content review Ocr text sensitivity task input parameter type

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Template ID.

AiReviewPoliticalOcrTaskOutput

Sensitive information in Ocr text

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Sensitive score of the Ocr text. Value range: 0–100.
Suggestion	String	Sensitive result suggestions for Ocr text. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments with sensitive Ocr text.

AiReviewPoliticalTaskInput

Content review sensitivity 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	Sensitive score of the video. The score ranges from 0 to 100.
Suggestion	String	Sensitive result suggestion. Value range: pass. review. block.
Label	String	Video sensitive information tag. Mapping between the LabelSet parameter in the frame sensitive information task control parameter (https://www.tencentcloud.com/document/api/862/37615?from_cn_redirect=1#AiReviewPoliticalTaskOutput) of the content review template and the value range of this parameter: violation_photo: violation_photo: violation icon. Other (politician/entertainment/sport/entrepreneur/scholar/celebrity/military): politician: sensitive person.
SegmentSet	Array of MediaContentReviewPoliticalSegmentItem	List of video segments suspected of containing sensitive content.

AiReviewPornAsrTaskInput

Task input parameter type for porn detection in Asr text during content review.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Porn detection template ID.

AiReviewPornAsrTaskOutput

Pornographic information in Asr text

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Porn score of the Asr text. The score ranges from 0 to 100.
Suggestion	String	Asr text porn detection result suggestion. Value ranges from pass to review to block. pass. review. block.
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments whose Asr text is suspected of involving pornography.

AiReviewPornOcrTaskInput

Task input parameter type for porn detection in Ocr text during content review.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Porn detection template ID.

AiReviewPornOcrTaskOutput

Pornographic information in Ocr text.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Ocr text porn score. Value range: 0-100.
Suggestion	String	Suggestion for the porn detection result of Ocr text. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments where the Ocr text is suspected of containing pornographic content.

AiReviewPornTaskInput

Task input parameter type for porn detection during content review.

Used by actions: DescribeTaskDetail, ParseNotification.

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

AiReviewPornTaskOutput

Pornographic result information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Porn information detection score in a video. The score ranges from 0 to 100.
Suggestion	String	Pornographic result suggestion. Value range: pass. review. block.
Label	String	Porn information detection result tag. Value range: porn: pornography. sexy: sexy. vulgar: vulgar. intimacy: intimate behavior.
SegmentSet	Array of MediaContentReviewSegmentItem	List of video segments suspected of pornography.

AiReviewProhibitedAsrTaskInput

Input parameter type for the Asr text prohibited information recognition task of content review

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 violation score. Value range: 0-100.
Suggestion	String	Asr text violation result suggestion. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments where the Asr text is 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

Prohibited information in Ocr text

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Confidence	Float	Prohibited content score of the Ocr text. Value range: 0–100.
Suggestion	String	Ocr text violation result suggestion. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments with Ocr text suspected of prohibition violations.

AiReviewTaskPoliticalAsrResult

Result type of the sensitive Asr text task in content review

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	Input of the sensitive Asr text task in content review.
Output	AiReviewPoliticalAsrTaskOutput	Output of the Asr text sensitive task in content review.

AiReviewTaskPoliticalOcrResult

Result type of the sensitive Ocr text task in content review

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	Input of the sensitive Ocr text task in content review.
Output	AiReviewPoliticalOcrTaskOutput	Content review Ocr text sensitivity task output.

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	Sensitive task input for content review.
Output	AiReviewPoliticalTaskOutput	Output of sensitive tasks in content review.

AiReviewTaskPornAsrResult

Result type of the Asr text pornography detection task in content review

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	Input for the Asr text pornography detection task in content review.
Output	AiReviewPornAsrTaskOutput	Content review Asr text porn detection task output.

AiReviewTaskPornOcrResult

Result type of the Ocr text pornography detection task for content review

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	Task input for porn detection in Ocr text during content review.
Output	AiReviewPornOcrTaskOutput	Output of the Ocr text pornography detection task for content review.

AiReviewTaskPornResult

Result type of the porn detection task during content review.

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	Input for the content review pornography detection task.
Output	AiReviewPornTaskOutput	Pornography detection task output of content review.

AiReviewTaskProhibitedAsrResult

Content review Asr text prohibited information recognition 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	Input of the prohibited task for content review of Asr text.
Output	AiReviewProhibitedAsrTaskOutput	Output of the prohibited task for content review of Asr text.

AiReviewTaskProhibitedOcrResult

Result type of the prohibited Ocr text task in content review

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	Input of the prohibited Ocr text task in content review.
Output	AiReviewProhibitedOcrTaskOutput	Content review Ocr text prohibited information recognition task output.

AiReviewTaskTerrorismOcrResult

Content review Ocr 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	AiReviewTerrorismOcrTaskInput	Content review Ocr text sensitive task input.
Output	AiReviewTerrorismOcrTaskOutput	Content review Ocr text sensitive task output.

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	Sensitive task input for content review.
Output	AiReviewTerrorismTaskOutput	Output of sensitive tasks in content review.

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	Sensitive score of the Ocr text. The score ranges from 0 to 100.
Suggestion	String	Sensitive data detection result suggestion for Ocr text. Value range: pass. review. block.
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments whose Ocr text is suspected of containing sensitive content.

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	Sensitive score of the video. The score ranges from 0 to 100.
Suggestion	String	Sensitive result suggestion. Value range: pass. review. block.
Label	String	Video moderation result tag. Value range: guns: weapons and firearms. crowd: crowd gathering. police: police force. bloody: graphic violence. banners: sensitive flags. militant: militants. 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 storyboard deconstruct 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 image to extract. Counting begins from 0. If not specified, return all storyboard images.

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: Kling 2.1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9. Kling 3.0: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9. Kling 3.0-Omni: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9. Kling O1: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, and 21:9. Vidu q2: 16:9, 9:16, 1:1, 3:4, 4:3, 21:9, 2:3, and 3:2. 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

Information required for uploading AIGC result files to COS. The MPS_QcsRole role needs to be created and authorized.

Used by actions: CreateAigcAudioTask, CreateAigcImageTask, CreateAigcVideoTask.

Name	Type	Required	Description
CosBucketName	String	No	Name of the COS bucket to store to. This value is required if you need to store the results in COS. Example value: bucket.
CosBucketRegion	String	No	Region of the COS bucket to store to. This is required if you need to upload the results to COS. Example value: ap-guangzhou.
CosBucketPath	String	No	bucket path stored to cos. Optional. Example value: my_file.

AigcTaskListItem

Aigc task details

Used by actions: DescribeAigcTaskList.

Name	Type	Description
TaskId	String	Task ID.
TaskType	String	Task type Enumeration values: 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	Resolution of the output video
Ratio	String	Aspect ratio of the output video
RequestBody	String	Task request packet
TaskInfo	String	Other task information.
Stage	String	Task sub-status.

AigcVideoExtraParam

Extended parameters used for AIGC video generation.

Used by actions: CreateAigcVideoTask.

Name	Type	Required	Description
Resolution	String	No	Resolution of the generated video. The resolution is related to the selected model and set video duration. Supported resolution options for different models: Kling: 720P (default) and 1080P. Kling 3.0 and Kling 3.0-Omni support 4K. Hailuo: 768P (default) and 1080P. Vidu: 540P, 720P (default), and 1080P. PixVerse: 540P, 720P (default), and 1080P. H2: 720P and 1080P (default). Note: In addition to the resolution supported by the model, 2K and 4K resolutions are also available.
AspectRatio	String	No	Aspect ratio of the generated video. Support for this parameter by different models: Kling only supports this parameter for text-to-video, with aspect ratios of 16:9 (default), 9:16, and 1:1. Hailuo does not support this parameter. Vidu supports [16:9, 9:16, 4:3, 3:4, 1:1] for text-to-video and reference image-to-video only. Only q2 supports 4:3 and 3:4. PixVerse supports [16:9, 9:16, 4:3, 3:4, 1:1, 2:3, 3:2, 21:9] for text-to-video and reference image-to-video only. Only v6 and c1 support 2:3, 3:2, and 21:9. H2 supports [16:9, 9:16, 4:3, 3:4, 4:5, 5:4, 1:1, 21:9, 9:21] for text-to-video and reference image-to-video only. Note: For more information about the supported aspect ratios of specific models, see the model website.
LogoAdd	Integer	No	Indicates whether to add a logo watermark. Hailuo supports this parameter. Kling supports this parameter. Vidu supports this parameter. H2 supports this parameter.
EnableAudio	Boolean	No	Indicates whether to generate audio for the video. Valid values: true or false. Models that support this parameter: Vidu. Only q3 series models support this parameter. Default value: false. PixVerse. Default value: false. Kling. Default value: false.
OffPeak	Boolean	No	Indicates whether to use the off-peak scheduling mode. Only Vidu supports this parameter. Tasks submitted in off-peak mode will be processed within 48 hours. Uncompleted tasks will be canceled.
EnableBgm	Boolean	No	Indicates whether to add background music to the generated video. Default value: false. Valid values: true or false. Note: Only some model versions support this.

AigcVideoReferenceAudioInfo

Reference audio information.

Used by actions: CreateAigcVideoTask.

Name	Type	Required	Description
AudioUrl	String	No	Reference audio URL, which must be accessible from the public network.

AigcVideoReferenceImageInfo

Reference image information for AIGC video generation.

Used by actions: CreateAigcVideoTask.

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. If the GV model is used, this serves as the reference method. Valid values are asset and style.

AigcVideoReferenceSubjectInfo

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

For the Kling model:
id -> element_id, the principal ID obtained through the principal creation API.

Used by actions: CreateAigcVideoTask.

Name	Type	Required	Description
Id	String	No	ID of the referenced entity.
Name	String	No	Subject name.
VoiceId	String	No	Main voice type ID.
ImageUrls	Array of String	No	Main image list.
VideoUrls	Array of String	No	Main video list.

AigcVideoReferenceVideoInfo

Reference video asset for AIGC video generation.

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, with the default being 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

Rotating image task type.

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	Target storage for the file after animated image conversion. If not specified, it inherits the upper-level OutputStorage value.
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

Artifacts removal (burr) 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	Type. Valid values: weak strong Default value: weak.

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

Smart subtitle hotword parameter.

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

Name	Type	Required	Description
Switch	String	No	Hotword switch.
LibraryId	String	No	Hotword lexicon ID

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	Audio noise reduction configuration.
Separate	AudioSeparateConfig	No	Audio separation configuration.
VolumeBalance	VolumeBalanceConfig	No	Volume equalization configuration.
Beautify	AudioBeautifyConfig	No	Audio beautification configurations.
AudioEnhanceEdit	AudioEnhanceEditConfig	No	Audio enhancement edit.

AudioEnhanceEditConfig

Audio enhancement edit

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	Audio editing type Enumeration values: restore: Repair When enabled, you must explicitly specify the enumeration value

AudioSeparateConfig

Audio separation 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	Scenario type. Valid values: normal: voice and background audio scenario music: singing accompaniment scenario Default value: normal.
Track	String	No	Output audio track. Available values: vocal: output voice. background: output background sound when the scenario is normal, and output accompaniment when the scenario is music Default value: vocal.

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	Audio track merging information. Note: This field only takes effect for adaptive transcoding.
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	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. When the outer parameter Container is wav, the valid values are: pcm16 and pcm24.
Bitrate	Integer	No	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.
SampleRate	Integer	No	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.
StreamSelects	Array of Integer	No	Specifies the retained audio tracks for output. All source tracks are retained by default.

AudioTrackChannelInfo

Audio track information.

Used by actions: CreateTranscodeTemplate.

Name	Type	Required	Description
ChannelsRemix	Integer	No	Whether to enable audio mixing. Available values: 0: audio mixing disabled 1: Whether to enable audio mixing Default value: 0
SelectType	String	No	Merge audio track input type. Available values: track: indicates usage of the audio track id. track_channel: indicates usage of the audio track id and sound channel id. Default value: track. Note: If the original video is multichannel, recommend using track_channel.
InputTrackInfo	Array of TrackInfo	No	Audio track information.

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	SQS queue area.
SQSQueueName	String	Yes	SQS queue name.
S3SecretId	String	No	id for read-write access to SQS.
S3SecretKey	String	No	key for read-write access to SQS.

BatchSmartSubtitlesResult

Smart subtitle task result.

Used by actions: DescribeBatchTaskDetail, ParseNotification.

Name	Type	Description
Input	SmartSubtitleTaskResultInput	Input information for smart subtitle tasks.
Outputs	Array of SmartSubtitleTaskBatchOutput	Output information for smart subtitle tasks.

BatchSubTaskResult

Results of subtasks for a batch task.

Used by actions: DescribeBatchTaskDetail, ParseNotification.

Name	Type	Description
InputInfos	Array of MediaInputInfo	Input information for a batch task.
Metadatas	Array of MediaMetaData	Metadata of the original video.
SmartSubtitlesTaskResult	BatchSmartSubtitlesResult	Execution result of the smart subtitle task.

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. Valid values: ON: enabled; OFF: disabled Default value: ON.
Type	String	No	Type. Valid values: weak normal strong Default value: weak.

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.

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	Diagnosed exception category. Valid values: DecodeParamException: decoding parameter exception TimeStampException: timestamp exception. FrameException: frame rate exception. StreamStatusException: stream status exception. StreamInfo: stream information exception. StreamAbnormalCharacteristics: stream characteristics exception. DecodeException: decoding exception. HLSRequirements: HLS format exception
Type	String	Diagnosed specific exception type. Valid values: VideoResolutionChanged: video resolution change. AudioSampleRateChanged: audio sample rate change. AudioChannelsChanged: audio channels changed ParameterSetsChanged: stream parameter set information change. DarOrSarInvalid: video aspect ratio exception. TimestampFallback: DTS timestamp fallback 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 dts. ReceiveFpsJitter: excessive network received frame rate jitter ReceiveFpsTooSmall: network received video frame rate too small. 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 MPEG-TS 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: MPEG2-TS stream has multiple programs 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: changed number of streams in segments. HLSMediaSegmentsPTSJitterDeviation: PTS jumps between slices without EXT-X-DISCONTINUITY. HLSMediaSegmentsDTSJitterDeviation: DTS jumps between segments with no EXT-X-DISCONTINUITY TimecodeTrackExist: MP4 has a tmcd track
SeverityLevel	String	Diagnosed exception level. Valid values: Fatal: affecting subsequent playback and parsing. Error: may affect playback. Warning: potential risk, which may not necessarily affect playback. Notice: Important stream information Info: general stream information.
DateTimeSet	Array of String	Timestamp of warning, format such as "2022-12-25T13:14:16Z"
TimestampSet	Array of Float	Timestamp.

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 is located, for example, TopRankVideo-125xxx88.
Region	String	Yes	Park where the COS Bucket of the media processing object file is located, for example, ap-chongqing.
Object	String	Yes	Input path of the MPS 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 output files generated by media processing, for example, TopRankVideo-125xxx88. If left empty, it is inheritable from the upper layer.
Region	String	No	Park of the target Bucket for output files generated by MPS, for example, ap-chongqing. If left empty, it inherits 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

Diagnostic result item.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Category	String	Diagnosed exception category. Valid values: DecodeParamException: decoding parameter exception. TimeStampException: timestamp exception. FrameException: frame rate exception. StreamStatusException: stream status exception. StreamInfo: Stream information exception StreamAbnormalCharacteristics: stream characteristic exception. DecodeException: decoding exception. HLSRequirements: HLS format exception.
Type	String	Diagnosed specific exception type. Valid values: VideoResolutionChanged: video resolution change. AudioSampleRateChanged: audio sample rate change. AudioChannelsChanged: audio channels changed ParameterSetsChanged: stream parameter set information change. DarOrSarInvalid: video aspect ratio exception. TimestampFallback: DTS timestamp fallback 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 dts. ReceiveFpsJitter: excessive network received frame rate jitter. ReceiveFpsTooSmall: network received video frame rate too small. 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 MPEG-TS 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: MPEG2-TS stream has multiple programs 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: changed number of streams in segments. HLSMediaSegmentsPTSJitterDeviation: PTS jumps between slices without EXT-X-DISCONTINUITY. HLSMediaSegmentsDTSJitterDeviation: DTS jumps between segments without EXT-X-DISCONTINUITY. TimecodeTrackExist: MP4 has a tmcd track
Timestamp	Float	PTS timestamp when the anomaly is diagnosed.
Description	String	Exception description from diagnosis.
DateTime	String	Diagnose the abnormal UTC+8 time in ISO date format.
SeverityLevel	String	Diagnosed exception level. Valid values: Fatal: affecting subsequent playback and parsing. Error: may affect playback. Warning: potential risk, which may not necessarily affect playback. Notice: Important stream information Info: general stream information.

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	Strength type. Available values: weak normal strong Default value: normal.

DiffusionEnhanceV2Config

LLM enhancement - Professional Edition

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	Strength type Enumeration values: weak: Weak normal: Medium strong: Strong

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 single-file 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 can be used in singlefile mode.
SimpleAesDrm	SimpleAesDrm	No	SimpleAes encryption information.
SpekeDrm	SpekeDrm	No	Information about FairPlay, WideVine, and PlayReady encryption.

DstSubtitleInput

External translation subtitle information for AI dubbing

Used by actions: ProcessMedia.

Name	Type	Required	Description
DstSubtitleInfo	MediaInputInfo	No	External translated subtitle info.

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 configuration for dubbing task suppression

Used by actions: ProcessMedia.

Name	Type	Required	Description
SubtitleEmbedId	Integer	No	Subtitle suppression id.
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

Output configuration of a dubbing task

Used by actions: ProcessMedia.

Name	Type	Required	Description
OutputMode	String	No	Output method Enumeration values: FinalVideoOnly: default, final video only AudioAndSubtitle: translated audio + translated subtitles Custom: custom Default value: FinalVideoOnly No translated audio + subtitles are returned when external subtitles are used
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 for output subtitle files (contains both original voice subtitles and target language subtitles) Enumeration values: ON: turn on OFF: turn off Default value: OFF
OutputDstAudio	String	No	Output translation dubbing audio switch Enumeration values: ON: Enable OFF: Disable Default value: OFF Only takes effect in Custom mode
EmbedSubtitleConfig	DubbingEmbedSubtitleConfig	No	Suppression subtitle configuration message.

DubbingSubtitleConfig

Translation configuration for a dubbing task

Used by actions: ProcessMedia.

Name	Type	Required	Description
SubtitleSource	String	No	Subtitle source. Enumeration values: OCR: OCR text recognition, recognizes text in video footage. ASR: ASR speech recognition, recognizes voice dialogue in videos. External: External subtitle file, provided by original/translated subtitle URL.
AsrAssistOcr	String	No	Use ASR to assist OCR. Enumeration values: ON: Enable ASR to assist OCR. OFF: Disable ASR to assist OCR. Default value: OFF Can be set to ON only when SubtitleSource is OCR
EraseOriginalSubtitle	String	No	Erase the original subtitle. Enumeration values: ON: Erase the original subtitle. OFF: Keep the original subtitle. Default value: OFF Cannot be set to ON when SubtitleSource=External
SelectingSubtitleAreasConfig	SelectingSubtitleAreasConfig	No	Subtitle position 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: Enable intelligent translation simplification. OFF: Disable intelligent translation simplification. Default value: OFF

EditMediaFileInfo

Edit video-on-demand file information.

Used by actions: DescribeTaskDetail, EditMedia, ParseNotification.

Name	Type	Required	Description
InputInfo	MediaInputInfo	Yes	Video input information.
StartTimeOffset	Float	No	[Edit] task takes effect. Start time offset for video editing, in seconds.
EndTimeOffset	Float	No	[Edit] task takes effect. End time offset of video editing. Measurement unit: second.
Id	String	No	[Compose] task required, used for media in track elements to associate source material ID. Note: It can include letters (case insensitive), digits, -, and _, up to 32 characters.

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

Video editing task information

Used by actions: DescribeTaskDetail, ParseNotification.

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

EditMediaTaskInput

Input of 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	Metadata of the edited video file.

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	Video enhancement configuration.
AudioEnhance	AudioEnhanceConfig	No	Audio enhancement configuration.

EraseArea

Smart erasing, coordinate configuration of the removal area.
The region is determined by the coordinates of the top-left and bottom-right corners.
The coordinate origin is the top-left corner of the frame. Coordinate points can be specified in pixel values or percentage units.
For the auto erase area:
When the unit is %, the coordinate range is [0,1];
When the unit is px, the X value ranges from 0 to the video image width, and the Y value ranges from 0 to the video image height.
For the specified removal area:
When the unit is %, the coordinate range is [0,1);
When the unit is px, the X value range is [0, video image width], and the Y value range is [0, video image height].

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

Name	Type	Required	Description
LeftTopX	Float	Yes	Top-left X-axis coordinate of the region. For example, when Unit is 1, meaning usage percentage, 0.05 indicates the horizontal distance from the top-left corner of the region 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, i.e., using percentage as the measurement unit, 0.1 means 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 region's bottom-right corner. For example, when Unit is 1 (percentage), 0.75 means the horizontal distance from the bottom-right corner of the region to the upper left corner of the entire frame is 75% of the frame width.
RightBottomY	Float	Yes	Y-axis coordinate of the bottom-right corner of the region. For example, when Unit is 1 (usage 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

Smart erasing: specify the region configuration for removal.
Directly erase the specified region within a specified period.
When both BeginMs and EndMs are 0, directly erase the specified region in the entire video.

Used by actions: CreateSmartEraseTemplate, ModifySmartEraseTemplate, ProcessMedia.

Name	Type	Required	Description
BeginMs	Integer	Yes	Start time in milliseconds.
EndMs	Integer	Yes	End time in ms.
Areas	Array of EraseArea	Yes	List of regions removed within the period

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

Task judgment conditions.

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

Name	Type	Required	Description
Rules	Array of Rules	No	Conditional judgment information.

ExtractBlindWatermarkTask

Task information for extracting video digital watermark

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
TaskId	String	Media processing task ID.
Status	String	Task stream 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	Information of the media processing target file.
Type	String	Digital watermark type. Valid values: blind-basic: basic copyright digital watermark; blind-ab: ab copyright digital watermark.
IsDetected	Boolean	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.
Result	String	Fetched digital watermark content. This field will not be returned if no watermark is detected.
ExtractBlindWatermarkConfig	ExtractBlindWatermarkTaskConfig	Configuration of digital watermark extraction.

ExtractBlindWatermarkTaskConfig

Extraction task configuration of video transcoding digital watermark

Used by actions: DescribeTaskDetail, ExtractBlindWatermark, ParseNotification.

Name	Type	Required	Description
SegmentDuration	Integer	Yes	Valid when the digital watermark extraction 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	Capability configuration switch. Valid values: ON: enabled; OFF: disabled. Default value: ON.
Intensity	Float	No	Strength. Value range: 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	Frame rate. Value ranges from 0 to 100. Measurement unit: Hz. Default value: 0. Note: For transcoding, this parameter overrides the internal Fps in VideoTemplate.

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	Frame rate numerator. Value range: non-negative number, which should be less than 120 when divided by the denominator, and in the unit of Hz. The default value is 0. Note: For transcoding, this parameter will overwrite the Fps in the VideoTemplate.
FpsDen	Integer	No	Frame rate denominator. Value range: numbers equal to or greater than 1. The default value is 1. Note: For transcoding, this parameter will override the FpsDenominator in the VideoTemplate.

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	Type. Valid values: HDR10 HLG Default Value: HDR10. Note: The video encoding method should be h264 or h265. Note: The video encoding bit depth is 10.

HeadTailParameter

Opening and ending content parameters

Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

Name	Type	Required	Description
HeadSet	Array of MediaInputInfo	No	List of opening scenes.
TailSet	Array of MediaInputInfo	No	Ending list.

HighlightSegmentItem

List of intelligent highlight segments.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Confidence	Float	Confidence degree.
StartTimeOffset	Float	Segment start time offset.
EndTimeOffset	Float	End time offset of a recording clip.
SegmentTags	Array of String	Segment tag.
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. Available 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, 95].
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 field is valid only when AreaCoordSet is not specified. When it represents pixels, 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.

ImageComposeCanvas

Canvas parameter of the layer fusion feature for image processing

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

Name	Type	Required	Description
Width	Integer	No	Canvas width, value ranges from 1 to 10240. Set both this and Height at the same time.
Height	Integer	No	Canvas height, in the range of [1, 10240]. Set it simultaneously with Width.
Background	String	No	Canvas background color, unified as an 8-digit hexadecimal #RRGGBBAA (including alpha), used as the canvas background color. Default #00000000 (fully transparent). Example: #FFFFFFFF opaque white, #FFFFFF80 semi-transparent white. When the output format does not support transparent channel (such as JPEG), transparent areas are collapsed according to the RGB of this background color. The default value will get a black background. If a white background is required, explicitly pass #FFFFFFFF.

ImageComposeLayer

Layer fusion functionality of image processing layer data structure

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

Name	Type	Required	Description
ZIndex	Integer	No	Layer stacking sequence, required. It cannot be repeated in the same request. The larger the value, the higher the layer (it is recommended to start consecutive numbering from 0).
InputInfo	MediaInputInfo	No	Layer source, required. Supports URL / COS / AWS-S3 / VOD.
BoundingBox	Array of Float	No	The position and size of the layer in the canvas. Required. An array of length 4 [X1, Y1, X2, Y2]: coordinates of the top-left and bottom-right corners. X2 > X1 and Y2 > Y1 are required. Two semantics (aligned with the BoundingBox of the image removal capability): Pixel: coordinate values in the range of [-10240, 10240]. Negative values or values beyond the canvas are allowed (the excess part is cropped). Ratio: each value ∈ [-1, 1], converted based on the canvas width and height (x multiplied by canvas width, y multiplied by canvas height). The layer is scaled to fill this rectangle. Any part beyond the canvas is cropped, and the output size is always equal to the canvas size.
BoundingBoxUnitType	Integer	No	Coordinate unit, aligned with the image removal capacity. Values: 0: automatic judgment (default value if not passed); 1: ratio; 2: pixel. Automatic judgment rules: if all four values are greater than 1, they are interpreted as pixels; if all are not greater than 1, they are interpreted as ratios. Mixed values will return InvalidParameter. It is recommended to always explicitly specify.

ImageDenoiseConfig

Image denoising configuration.

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

Name	Type	Required	Description
Switch	String	No	Capability configuration switch. Available values: ON: enabled OFF: disabled Default value: ON.
Type	String	No	Type. Valid 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. Available values: ON: Enable; OFF: Disable. Default value: ON.
ImageAreaBoxes	Array of ImageAreaBoxInfo	No	Multiple box selection regions to erase, with up to 16 regions enabled. Note: This field may return null, indicating that no valid value can be obtained.
EraseStrength	String	No	Watermark removal capacity gear selection. Available values: Enumeration values: low: quick removal gear mid: balanced removal effect and speed gear high: advanced removal effect gear Note: Select the corresponding removal gear based on the complexity of the removal scenario.
WatermarkType	String	No	When erasing image watermarks, select a specific watermark type. Available values: Enumeration values: corner_watermark: Erase a normal fixed-location watermark tiled_watermark: Erase a tile watermark across the entire image auto_detect_type: Automatically identify the watermark type and erase it selected_watermark: Skip automatic removal and perform watermark removal at a specified position

ImageProcessTaskOutput

Image processing result information.

Used by actions: DescribeImageTaskDetail.

Name	Type	Description
Path	String	Path of the output file.
OutputStorage	TaskOutputStorage	Storage location of the output file.
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	Task status. Valid values are PROCESSING, SUCCESS, and FAIL.
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	Error message.
Output	ImageProcessTaskOutput	Transcoding task output.
Progress	Integer	Transcoding progress, with a value range of [0-100].

ImageQualityConfig

Image quality assessment task.

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

Name	Type	Required	Description
Attributes	Array of String	Yes	Image quality assessment dimensions Enumeration values: Brightness: Brightness assessment Contrast: Contrast assessment Sharpness: Clarity assessment IQA: Comprehensive quality assessment

ImageQualityEnhanceConfig

Comprehensive 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	Type. Valid values: weak normal strong Default value: weak.

ImageSpriteTaskInput

Task input parameter type for sprite screenshot taking of a video.

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

Name	Type	Required	Description
Definition	Integer	Yes	Sprite screenshot template ID.
OutputStorage	TaskOutputStorage	No	Target storage for the file after the sprite screenshot is taken. If this is not specified, it inherits the value from the upper-level OutputStorage.
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	Rule of the {number} variable in the output path after the sprite screenshot is taken.
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

Task overview for image processing.

Used by actions: DescribeImageTasks.

Name	Type	Required	Description
TaskId	String	No	TaskId of the image processing task.
Status	String	No	Task status. Enumeration values: FINISH: Task completion PROCESSING: Task processing
Input	String	No	Input file.
CreateTime	String	No	Creation time. Parameter format: YYYY-MM-DDThh:mm:ssZ
BeginProcessTime	String	No	Processing start time. Parameter format: YYYY-MM-DDThh:mm:ssZ
FinishTime	String	No	End time. Parameter format: YYYY-MM-DDThh:mm:ssZ
SubTaskHasFailed	Boolean	No	Subtask failure identifier.

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 cutout configuration
AiExpansionConfig	AiExpansionConfig	No	Ai outpainting configuration
AiStoryboardConfig	AiStoryboardConfig	No	Ai storyboard deconstruction configuration
UnderstandImageConfig	UnderstandImageConfig	No	Image understanding configuration
ImageQualityConfig	ImageQualityConfig	No	Image quality assessment configuration
AiComposeConfig	AiComposeConfig	No	Layer fusion configuration.
AiDecomposeConfig	AiDecomposeConfig	No	Layer separation 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	Segmentation result.

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 recording output file information

Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification.

Name	Type	Description
Url	String	Live recording file URL
Size	Integer	Live recording file size
Duration	Integer	Recording file duration of live stream
StartTime	String	Start time of the live streaming recording file in ISO date format.
EndTime	String	End time of the live streaming recording file in ISO date format.

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

Smart subtitle result of the live stream.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Text	String	Recognized text.
StartPTSTime	Float	Start PTS time of a translated segment, in seconds.
EndPTSTime	Float	End PTS time of a translated segment, in seconds.
Trans	String	Translated text.
StartTime	String	Translation start UTC time.
EndTime	String	UTC time when translation is completed.
SteadyState	Boolean	Steady-state tag.
UserId	String	UserId for real-time translation over websocket and trtc

LiveSmartSubtitlesTaskInput

Live stream smart subtitle input struct.

Used by actions: ProcessLiveStream.

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

LiveStreamAiAnalysisResultInfo

Live stream analysis result.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
ResultSet	Array of LiveStreamAiAnalysisResultItem	Live stream analysis subtask result. Supports: Live streaming video splitting. Live streaming highlight. Live streaming summary.

LiveStreamAiAnalysisResultItem

Live stream 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	Split result. When Type is Valid for SegmentRecognition.
HighlightResultSet	Array of MediaAiAnalysisHighlightItem	Highlight result. This field is valid when Type is set to Highlight.
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	Content quality inspection result list.
DiagnoseResultSet	Array of DiagnoseResult	Format diagnostic result list.

LiveStreamAiRecognitionResultInfo

AI recognition result of the live stream

Used by actions: ParseLiveStreamProcessNotification.

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

LiveStreamAiRecognitionResultItem

AI recognition result of the live stream

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 Valid for FaceRecognition.
AsrWordsRecognitionResultSet	Array of LiveStreamAsrWordsRecognitionResult	Speech keyword recognition result. When Type is Valid when AsrWordsRecognition is used.
OcrWordsRecognitionResultSet	Array of LiveStreamOcrWordsRecognitionResult	Text keyword recognition result. When Type is Valid for OcrWordsRecognition.
AsrFullTextRecognitionResultSet	Array of LiveStreamAsrFullTextRecognitionResult	Full speech recognition result. When Type is Valid when AsrFullTextRecognition is used.
OcrFullTextRecognitionResultSet	Array of LiveStreamOcrFullTextRecognitionResult	Full text recognition result. This parameter is returned only when Type is set to Valid for 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	Marking point result. Valid when Type is TagRecognition.

LiveStreamAiReviewImagePoliticalResult

Live stream AI content moderation result of images involving sensitive content

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
StartPtsTime	Float	Starting 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	Pornographic result advice for the suspected segment. Value range: pass review block
Label	String	Video sensitive result tag. Value range: politician: sensitive person. violation_photo: violation icon.
Name	String	Sensitive person and violative icon name.
AreaCoordSet	Array of Integer	Zone 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 and will reach Images will be deleted after the PicUrlExpireTime time point).
PicUrlExpireTime	String	Expiration time of the suspected image URL in ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

LiveStreamAiReviewImagePornResult

Live stream AI content moderation pornographic result of images

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	Pornography score of the suspected segment.
Suggestion	String	Porn detection result suggestion for the suspected segment. Pass in the range of [min,max]. pass review block
Label	String	Pornographic result tag of the video. Value range: porn: pornography. sexy: sexy. vulgar: vulgar. intimacy: intimate behavior.
Url	String	Suspected image URL (images are not retained permanently and will be deleted upon reaching Images will be deleted after the PicUrlExpireTime time point).
PicUrlExpireTime	String	Expiration time of the suspected image URL, using the ISO date format.

LiveStreamAiReviewImageTerrorismResult

Live stream AI content moderation result of images involving sensitive content

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
StartPtsTime	Float	Starting PTS time of a suspected segment, in seconds.
EndPtsTime	Float	End PTS time of a suspected segment, in seconds.
Confidence	Float	Sensitivity score of the suspected segment.
Suggestion	String	Suspected segment sensitive result suggestion. Value range: pass review block
Label	String	Sensitive result tag of the video. Value range: guns: weapons and firearms. crowd: crowd gathering. police: police force. bloody: graphic violence. banners: sensitive flags. militant: militants. explosion: explosions and fires. terrorists: sensitive persons.
Url	String	Suspected image URL (images are not retained permanently and will be deleted upon reaching Images will be deleted after the PicUrlExpireTime time point).
PicUrlExpireTime	String	Expiration time of the suspected image URL, using the ISO date format.

LiveStreamAiReviewResultInfo

AI review result of the live stream

Used by actions: ParseLiveStreamProcessNotification.

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

LiveStreamAiReviewResultItem

AI review result of the live stream

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Type	String	Type of the review result. Valid values: ImagePorn: image moderation. ImageTerrorism: image involving sensitive content. ImagePolitical: politically sensitive image. VoicePorn: sound violation.
ImagePornResultSet	Array of LiveStreamAiReviewImagePornResult	Result of porn detection on the image. Valid when Type is ImagePorn.
ImageTerrorismResultSet	Array of LiveStreamAiReviewImageTerrorismResult	Image moderation result. Valid when Type is ImageTerrorism.
ImagePoliticalResultSet	Array of LiveStreamAiReviewImagePoliticalResult	Image moderation result. Valid when Type is ImagePolitical.
VoicePornResultSet	Array of LiveStreamAiReviewVoicePornResult	Result of sound rule violation. Valid when Type is VoicePorn.

LiveStreamAiReviewVoicePornResult

Live stream AI content moderation pornographic result of sound

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	Porn score of the suspected segment.
Suggestion	String	Porn detection result suggestion for the suspected segment. Value range: pass review block
Label	String	Porn information detection result tag. Value range: sexual_moan: moan.

LiveStreamAiSmartSubtitleResultInfo

Smart subtitle result of the live stream.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
SmartSubtitleResult	Array of LiveSmartSubtitleResult	List of live stream smart subtitle task results.

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	Recognition start UTC time.
EndTime	String	UTC time when recognition is completed.
SteadyState	Boolean	Steady-state tag.
UserId	String	UserId of the websocket and trtc recognition result

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 person.
Name	String	Character name.
Type	String	Library type of the figure, indicating 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	Screenshot link.

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

Error information of live stream processing

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
ErrCode	Integer	Error code. 0: no error; Non-zero indicates an error. Refer to Message for error information.
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	Whether recording ends. 0: Recording does not end, returning a single file. 1: Recording ends, returning all recording files.
FileResults	Array of LiveRecordFile	File list.

LiveStreamTagRecognitionResult

Live streaming AI timestamp recognition result.

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Id	String	Timestamp event.
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

Event notification configuration for task processing.

Used by actions: ProcessLiveStream.

Name	Type	Required	Description
NotifyType	String	No	Notification type: TDMQ-CMQ: message queue. "URL": When a URL is specified, the HTTP callback is pushed to the address specified by NotifyUrl. The callback protocol is http+json. The content of the packet body is the same as the output parameters of the ParseLiveStreamProcessNotification API. <Font color="red"> Note: if it is unspecified or left blank, no callback will be sent. To send a callback, fill in the corresponding type value.
NotifyUrl	String	No	HTTP callback URL. This is required if NotifyType is URL.
CmqModel	String	No	Queue and Topic models are provided.
CmqRegion	String	No	Region when NotifyType is set to TDMQ-CMQ. For example, sh or bj.
QueueName	String	No	This field is valid when the model is Queue. It indicates the name of the TDMQ for CMQ queue for receiving event notifications.
TopicName	String	No	This field is valid when the model is Topic. It indicates the name of the TDMQ for CMQ topic for receiving event notifications.
NotifyKey	String	No	Key used to generate a callback signature.

LiveStreamTransTextRecognitionResult

Real-time translation result of the live stream

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Text	String	Recognized text.
StartPtsTime	Float	Start PTS time of a translated segment, 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	Translation start UTC time.
EndTime	String	UTC time when translation is completed.
SteadyState	Boolean	Steady-state tag.
UserId	String	UserId for real-time translation over websocket and trtc

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	Type. Valid values: normal Default value: normal.

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	Confidence of the intelligent categorization, 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	Confidence 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	Segmentation result.
MindMapUrl	String	Address of the mind map of a summary task.
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	Frame-specific tag name.
CategorySet	Array of String	Classification list by frame tag name. CategorySet.N refers to the (N+1)-level category. For example, when Tag is "tower", CategorySet contains two elements: CategorySet.0 is "scenario" and CategorySet.1 is "building", which means the frame tag is "tower", the level-1 category is "scenario", and the level-2 category is "building".
Confidence	Float	Confidence of frame tagging, with a value range from 0 to 100.

MediaAiAnalysisFrameTagSegmentItem

Segments for frame tagging

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
StartTimeOffset	Float	Time offset starting from the frame tag.
EndTimeOffset	Float	Offset time for frame tagging to end.
TagSet	Array of MediaAiAnalysisFrameTagItem	Tag list in 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	Confidence 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	Intelligent highlight address.
CovImgUrl	String	Intelligent highlight cover address.

MediaAiAnalysisTagItem

Intelligent tag result information.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Tag	String	Tag name.
Confidence	Float	Confidence 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	ID of the rotating image template. See video-to-animated image conversion parameter 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 in px.
Bitrate	Integer	Animated image bitrate. Unit: bps.
Size	Integer	Animation 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	Number of audio channels, for example, 2.
Codecs	String	Audio Codecs.
Loudness	Float	Audio loudness.

MediaContentReviewAsrTextSegmentItem

Suspected segment of Asr text audit in content review

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	Suggested review result for the suspected segment. Value range: pass. review. block.
KeywordSet	Array of String	List of suspicious keywords.

MediaContentReviewOcrTextSegmentItem

Suspected segment of Ocr text audit in content review

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	Suggested review result for the suspected segment. Value range: pass. review. block.
KeywordSet	Array of String	List of suspicious keywords.
AreaCoordSet	Array of Integer	Coordinates of the area where suspected text appears (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 and will reach Images will be deleted after the PicUrlExpireTime time point).
PicUrlExpireTime	String	Expiration time of the suspected image URL in ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

MediaContentReviewPoliticalSegmentItem

Suspected sensitive segment in content review

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	Sensitivity score of the suspected segment.
Suggestion	String	Sensitivity result suggestion for the suspected segment. Value range: pass. review. block.
Name	String	Sensitive person and violative icon name.
Label	String	Suspected segment moderation result tag. Mapping between the LabelSet parameter in the moderation template frame moderation task control parameter (https://www.tencentcloud.com/document/api/862/37615?from_cn_redirect=1#PoliticalImgReviewTemplateInfo) and the 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 scholar. 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 and will be deleted upon reaching Images will be deleted after the PicUrlExpireTime time point).
AreaCoordSet	Array of Integer	Zone coordinates where sensitive persons and violation icons appear (pixel-level), [x1, y1, x2, y2], i.e. coordinates of the top-left corner and bottom-right corner.
PicUrlExpireTime	String	Expiration time of the suspected image URL in ISO date format (https://www.tencentcloud.com/document/product/862/37710?from_cn_redirect=1#52).

MediaContentReviewSegmentItem

Suspected pornographic/sensitive segment in content review

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	Porn score of the suspected segment.
Label	String	Tag of the pornographic result for the suspected segment.
Suggestion	String	Porn detection result suggestion for the suspected segment. Value range: pass. review. block.
Url	String	Suspected image URL (images are not retained permanently and will reach Images will be deleted after the PicUrlExpireTime time point).
PicUrlExpireTime	String	Expiration time of the suspected image URL, in ISO date format.

MediaImageSpriteItem

Sprite image information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	Sprite screenshot specification. See sprite sheet parameter template.
Height	Integer	Height of small images in sprite image.
Width	Integer	Width of a small image in the sprite sheet.
TotalCount	Integer	Number of small images in each sprite image.
ImagePathSet	Array of String	Path of each sprite sheet.
WebVttPath	String	Path of the WebVtt file that describes the temporal relationship between sprite sub-images and their positions. The WebVtt file indicates the time point corresponding to each sprite sub-image and its coordinate position in the sprite sheet. It is generally used by the player to implement preview.
Storage	TaskOutputStorage	Storage location of the sprite sheet file.

MediaInputInfo

Information of the media processing input object.

Used by actions: BatchProcessMedia, CreateProcessImageTemplate, CreateWorkflow, DescribeBatchTaskDetail, DescribeImageTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, DetectVideoSubtitleArea, DetectVideoWatermark, EditMedia, ExtractBlindWatermark, ModifyProcessImageTemplate, 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 refers to the COS object information for media processing.
UrlInputInfo	UrlInputInfo	No	Valid when Type is URL. This item is required and refers to media processing URL object information.
S3InputInfo	S3InputInfo	No	Valid when Type is AWS-S3. This item is required and refers to the AWS S3 object information for media processing.
VODInputInfo	VODInputInfo	No	Required when Type is VOD. It represents the object information of MPS on-demand pro edition.

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 sum 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 the video stream. Measurement unit: px.
Width	Integer	Maximum video stream width in px.
Duration	Float	Video duration, unit: seconds.
Rotate	Integer	Selection angle during video shooting. Measurement 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 of 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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
Message	String	Error message.
Input	AdaptiveDynamicStreamingTaskInput	Input for a video to adaptive streaming task.
Output	AdaptiveDynamicStreamingInfoItem	Output of a video to adaptive streaming task.
BeginProcessTime	String	Starting time of task execution, in ISO date and time format.
FinishTime	String	Task completion time, in ISO date and time format.

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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (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	Rotating image task output.
BeginProcessTime	String	Starting time of task execution, in ISO date and time format.
FinishTime	String	Task completion time, in ISO date and time format.

MediaProcessTaskImageSpriteResult

Result type of an image sprite 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	ImageSpriteTaskInput	Input of the image sprite task for videos.
Output	MediaImageSpriteItem	Output of the image sprite task for videos.
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 sheets. CoverBySnapshot: screencapturing for cover image AdaptiveDynamicStreaming: adaptive bitrate streaming
TranscodeTask	MediaProcessTaskTranscodeResult	Query result of video transcoding tasks. Valid when the task type is Transcode.
AnimatedGraphicTask	MediaProcessTaskAnimatedGraphicResult	Query result of a video-to-GIF task. Valid when the task type is AnimatedGraphics.
SnapshotByTimeOffsetTask	MediaProcessTaskSnapshotByTimeOffsetResult	Query result of a time point screencapturing task for a video. Valid when the task type is SnapshotByTimeOffset.
SampleSnapshotTask	MediaProcessTaskSampleSnapshotResult	Query result of the video sampling screenshot task. Valid when the task type is SampleSnapshot.
ImageSpriteTask	MediaProcessTaskImageSpriteResult	Query result of the image sprite task for video. Valid when the task type is ImageSprite.
AdaptiveDynamicStreamingTask	MediaProcessTaskAdaptiveDynamicStreamingResult	Query result of adaptive bitrate streaming tasks. Valid when the task type is AdaptiveDynamicStreaming.

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 of the sampling screenshot task for videos.
Output	MediaSampleSnapshotItem	Output of the sampling screenshot task for videos.
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

Type of the video time point screenshot job 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	SnapshotByTimeOffsetTaskInput	Input of the time point screenshot task for videos.
Output	MediaSnapshotByTimeOffsetItem	Output of the time point screenshot task for videos.
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

Result type of the transcoding 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	TranscodeTaskInput	Input of the transcoding task.
Output	MediaTranscodeItem	Transcoding task output.
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 sampling screenshot parameter template.
SampleType	String	Sampling method, valid value: Percent: Sampling based on percentage interval. Time: Sampling based on time interval.
Interval	Integer	Sampling interval When SampleType is Percent, this value indicates the percentage of images. When SampleType is Time, this value indicates the time interval for each image, in seconds. The first image is always 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	List of template IDs of watermarked screenshots.

MediaSnapshotByTimeOffsetItem

Screenshot information of a VOD file at the specified time point

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
Definition	Integer	SnapshotByTimeOffset specification. See SnapshotByTimeOffset parameter template.
PicInfoSet	Array of MediaSnapshotByTimePicInfoItem	Screenshot information set of the same specification, where each element represents a screenshot.
Storage	TaskOutputStorage	Storage location of the time point screenshot file.

MediaSnapshotByTimePicInfoItem

Specified time point screenshot information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
TimeOffset	Float	Time offset of this screenshot in the video file, in seconds.
Path	String	Path of the screenshot.
WaterMarkDefinition	Array of Integer	List of template IDs for watermarking if the screenshot is watermarked.

MediaTranscodeItem

Transcoding information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
OutputStorage	TaskOutputStorage	Target storage for the transcoded file.
Path	String	Transcoded video file path.
Definition	Integer	Transcoding specification ID. Please refer to transcoding parameter template.
Bitrate	Integer	Sum of the mean video stream bitrate and the mean audio stream bitrate. Unit: bps.
Height	Integer	Maximum height of the video stream. Unit: px.
Width	Integer	Maximum video stream width. Unit: px.
Size	Integer	Total size of media files (for HLS videos, the size is the sum of m3u8 and ts file sizes), unit: byte.
Duration	Float	Video duration, in seconds.
Container	String	Container type, for example, m4a, mp4.
Md5	String	md5 value of the video.
AudioStreamSet	Array of MediaAudioStreamItem	Audio stream information.
VideoStreamSet	Array of MediaVideoStreamItem	Video stream information.
CallBackExtInfo	String	Video transcoding enhancement item descriptions and explanations hdr: HDR configuration wd_fps: Frame interpolation frame rate configuration video_super_resolution: Super-resolution configuration repair: Comprehensive enhancement configuration denoise: Video noise reduction configuration color_enhance: Color enhancement configuration scratch: Scratches removal configuration artifact: Artifacts removal (burrs) configuration sharp: Detail enhancement configuration low_light: Low-light enhancement configuration face_enhance: Face enhancement configuration
Usage	MediaUsageItem	MediaTranscodeItem

MediaUsageItem

AIGC usage data display

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Required	Description
InputImageCount	Integer	No	Number of input images Unit: count
InputSeconds	Integer	No	Input seconds Unit: seconds
OutputSeconds	Integer	No	Output seconds Measurement unit: seconds
TotalSeconds	Integer	No	Total number of seconds Unit: seconds

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 the video stream. Unit: px.
Width	Integer	Video stream width. Unit: px.
Codec	String	Video stream encoding format, for example, h264.
Fps	Integer	Frame rate. Measurement unit: hz.
ColorPrimaries	String	Colorspace.
ColorSpace	String	Colorspace.
ColorTransfer	String	Colorspace.
HdrType	String	HDR type.
Codecs	String	Video Codecs.
FpsNumerator	Integer	Numerator of the frame rate.
FpsDenominator	Integer	Denominator of the frame rate.

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 the XPos is 10% of the video width. If a string ends with px, the mosaic XPos is a specified pixel. For example, 100px means the 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	Width of the mosaic. 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 unit of the mosaic Width is pixel. For example, 100px means that Width is 100 pixels. Default value: 10%.
Height	String	No	Mosaic height. Supports two formats: % 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 unit of a mosaic is pixel. For example, 100px means that Height is 100 pixels. Default value: 10%.
StartTimeOffset	Float	No	Start time offset of mosaic, in seconds. Leave empty or enter 0 to make the mosaic appear when the frame appears. Leave empty or enter 0 to make the mosaic appear at the start of the frame; If the value is greater than 0 (assuming n), the mosaic appears at the nth second after the frame starts; 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 the 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 increase step length of the {number} variable. Default value: 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 parameter 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	Outputs configuration message.

OverrideEraseParameter

Custom parameters for smart erasing.

Used by actions: ProcessMedia.

Name	Type	Required	Description
EraseType	String	No	Removal Type subtitle removal watermark removal privacy protection
EraseSubtitleConfig	UpdateSmartEraseSubtitleConfig	No	Subtitle erasing configuration; This field is required when the value of EraseType is set to subtitle.
EraseWatermarkConfig	UpdateSmartEraseWatermarkConfig	No	Watermark erasing configuration. This field is required when the value of EraseType is set to watermark.
ErasePrivacyConfig	UpdateSmartErasePrivacyConfig	No	Privacy protection configuration. This field is required when the value of EraseType is privacy.
SubtitleEmbedId	Integer	No	id of the subtitle removal suppression template.

OverrideTranscodeParameter

Specification parameters for custom transcoding. Used to override 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	Top Speed Codec transcoding parameters.
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 range: [0, 255] Default value: 30
OpaqueThreshold	Integer	No	Opaque threshold, must be greater than TransparencyThreshold Value range: [0, 255] Default value: 127
EdgeSamplingStep	Integer	No	Edge sampling steps. Default value: 5 Value range: [1, 10]
EdgeExpansionStep	Integer	No	Edge expansion steps. Default value: 5
EdgeBlendingIntensity	Float	No	Edge fusion strength, default 0.5 Value range: [0, 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	Translation output result of pure subtitle files.
Progress	Integer	Task progress.

PureSubtitleTransResultOutput

Detailed output result of translation.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
OutputStorage	TaskOutputStorage	Storage location of the subtitle file.
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	Confidence, with a value range from 0 to 100.
StartTimeOffset	Float	Start timestamp of the occurrence, in seconds.
EndTimeOffset	Float	End timestamp of the occurrence, in seconds.
AreaCoordSet	Array of Integer	Area coordinates (px), i.e. coordinates of the top-left corner and coordinate of the bottom-right corner.

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 edge SolidColorScreen: solid color screen. Noise: noise. Mosaic: mosaic. QRCode: QR code. AppletCode: mini program code BarCode: barcode. LowVoice: bass. HighVoice: high voice. NoVoice: mute. LowEvaluation: The no-reference score (MOS) of the video is below the threshold. AudioEvaluation: 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

List filter criteria for querying AIGC tasks

Used by actions: DescribeAigcTaskList.

Name	Type	Required	Description
TaskId	String	No	Task ID.
TaskType	String	No	Task type Enumeration values: RedrawVideo: Video redraw AIDrama: AI drama DocGenVideo: Document to video FissionVideo: Video fission
TaskStatus	String	No	Task status.
Resolution	String	No	Resolution
Ratio	String	No	Aspect ratio.
ExecuteMode	String	No	Task execution mode Enumeration values: auto: Direct generation phased: Generate after confirmation
VideoType	String	No	Fission task video type filter: ugc, talk, display, unboxing, reaction Enumeration values: ugc: UGC recommendation talk: Product talk-over display: Product display unboxing: Unboxing sharing reaction: Reaction display
ModelTier	String	No	Model type Enumeration values: standard: standard version flagship: advanced edition

RawAIDubbingParameter

Custom parameter 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	Outputs configuration message.

RawImageWatermarkInput

Input parameter of an image watermark template

Used by actions: CreateWorkflow, ProcessMedia, ResetWorkflow.

Name	Type	Required	Description
ImageContent	MediaInputInfo	Yes	Input content of the watermark image. Supports jpeg and png image formats.
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, Width is in pixels. For example, 100px means Width is 100 pixels. Default value: 10%.
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, 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 no longer appears after it is finished playing; repeat_last_frame: after the watermark finishes playing, stay on the last frame; repeat: watermark loops until the video ends (default value).

RawSmartEraseParameter

Custom parameters for smart erasing.

Used by actions: ProcessMedia.

Name	Type	Required	Description
EraseType	String	Yes	Removal Type subtitle removal watermark removal privacy protection
EraseSubtitleConfig	SmartEraseSubtitleConfig	No	Subtitle erasing configuration; This field is required when the value of EraseType is set to subtitle.
EraseWatermarkConfig	SmartEraseWatermarkConfig	No	Watermark erasing configuration. This field is required when the value of EraseType is set to watermark.
ErasePrivacyConfig	SmartErasePrivacyConfig	No	Privacy protection configuration. This field is required when the value of EraseType is privacy.
SubtitleEmbedId	Integer	No	id of the subtitle removal suppression template.
UseOriginalPos	Integer	No	Suppression configuration, enabled by default, moves subtitles back to the original subtitle position.
UseOriginalSize	Integer	No	Suppression configuration, enabled by default. When enabled, use the original subtitle font size.

RawSmartSubtitleParameter

Custom smart subtitle parameter.

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

Name	Type	Required	Description
SubtitleType	Integer	Yes	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.
VideoSrcLanguage	String	Yes	Smart subtitling video source language OCR recognition supports the following languages: zh_en: Chinese-English multi: Other ASR recognition and pure caption translation currently support the following languages: auto: Auto-identification zh: Simplified Chinese en: English ja: Japanese ko: Korean zh-PY: Chinese-English-Cantonese zh_medical: Chinese health care vi: Vietnamese ms: Malay id: Indonesian fil: Filipino th: Thai pt: Portuguese tr: Turkish ar: Arabic es: Spanish hi: Hindi fr: French de: German it: Italian zh_dialect: Chinese dialect zh_en: Chinese-English yue: Cantonese ru: Russian prime_zh: Chinese-English dialect af-ZA: Afrikaans (South Africa) sq-AL: Albanian (Albania) am-ET: Amharic (Ethiopia) ar-DZ: Arabic (Algeria) ar-BH: Arabic (Bahrain) ar-EG: Arabic (Egypt) ar-IQ: Arabic (Iraq) ar-IL: Arabic (Israel) ar-JO: Arabic (Jordan) ar-KW: Arabic (Kuwait) ar-LB: Arabic (Lebanon) ar-MR: Arabic (Mauritania) ar-MA: Arabic (Morocco) ar-OM: Arabic (Oman) ar-QA: Arabic (Qatar) ar-SA: Arabic (Saudi Arabia) ar-PS: Arabic (State of Palestine) ar-SY: Arabic (Syria) ar-TN: Arabic (Tunisia) ar-AE: Arabic (United Arab Emirates) ar-YE: Arabic (Yemen) hy-AM: Armenian (Armenia) az-AZ: Azerbaijani (Azerbaijan) eu-ES: Basque (Spain) bn-BD: Bengali (Bangladesh) bn-IN: Bengali (India) bs-BA: Bosnian (Bosnia and Herzegovina) bg-BG: Bulgarian (Bulgaria) my-MM: Burmese (Myanmar) ca-ES: Catalan (Spain) hr-HR: Croatian (Croatia) cs-CZ: Czech (Czech Republic) da-DK: Danish (Denmark) nl-BE: Dutch (Belgium) nl-NL: Dutch (Netherlands) en-AU: English (Australia) en-CA: English (Canada) en-GH: English (Ghana) en-HK: English (Hong Kong (China)) en-IN: English (India) en-IE: English (Ireland) en-KE: English (Kenya) en-NZ: English (New Zealand) en-NG: English (Nigeria) en-PK: English (Pakistan) en-PH: English (Philippines) en-SG: English (Singapore) en-ZA: English (South Africa) en-TZ: English (Tanzania) en-GB: English (UK) en-US: English (United States) et-EE: Estonian (Estonia) fil-PH: Filipino (Philippines) fi-FI: Finnish (Finland) fr-BE: French (Belgium) fr-CA: French (Canada) fr-FR: French (France) fr-CH: French (Switzerland) gl-ES: Galician (Spain) ka-GE: Georgian (Georgia) el-GR: Greek (Greece) gu-IN: Gujarati (India) iw-IL: Hebrew (Israel) hi-IN: Hindi (India) hu-HU: Hungarian (Hungary) is-IS: Icelandic (Iceland) id-ID: Indonesian (Indonesia) it-IT: Italian (Italy) it-CH: Italian (Switzerland) ja-JP: Japanese (Japan) jv-ID: Javanese (Indonesia) kn-IN: Kannada (India) kk-KZ: Kazakh (Kazakhstan) km-KH: Khmer (Cambodia) rw-RW: Kinyarwanda (Rwanda) ko-KR: Korean (South Korea) lo-LA: Lao (Laos) lv-LV: Latvian (Latvia) lt-LT: Lithuanian (Lithuania) mk-MK: Macedonian (North Macedonia) ms-MY: Malay (Malaysia) ml-IN: Malayalam (India) mr-IN: Marathi (India) mn-MN: Mongolian (Mongolia) ne-NP: Nepali (Nepal) no-NO: Norwegian Bokmål (Norway) fa-IR: Persian (Iran) pl-PL: Polish (Poland) pt-BR: Portuguese (Brazil) pt-PT: Portuguese (Portugal) ro-RO: Romanian (Romania) ru-RU: Russian (Russia) sr-RS: Serbian (Serbia) si-LK: Sinhalese (Sri Lanka) sk-SK: Slovak (Slovakia) sl-SI: Slovenian (Slovenia) st-ZA: Southern Sotho (South Africa) es-AR: Spanish (Argentina) es-BO: Spanish (Bolivia) es-CL: Spanish (Chile) es-CO: Spanish (Colombia) es-CR: Spanish (Costa Rica) es-DO: Spanish (Dominican Republic) es-EC: Spanish (Ecuador) es-SV: Spanish (El Salvador) es-GT: Spanish (Guatemala) es-HN: Spanish (Honduras) es-MX: Spanish (Mexico) es-NI: Spanish (Nicaragua) es-PA: Spanish (Panama) es-PY: Spanish (Paraguay) es-PE: Spanish (Peru) es-PR: Spanish (Puerto Rico) es-ES: Spanish (Spain) es-US: Spanish (United States) es-UY: Spanish (Uruguay) es-VE: Spanish (Venezuela) su-ID: Sundanese (Indonesia) sw-KE: Swahili (Kenya) sw-TZ: Swahili (Tanzania) sv-SE: Swedish (Sweden) ta-IN: Tamil (India) ta-MY: Tamil (Malaysia) ta-SG: Tamil (Singapore) ta-LK: Tamil (Sri Lanka) te-IN: Telugu (India) th-TH: Thai (Thailand) ts-ZA: Tsonga (South Africa) tr-TR: Turkish (Türkiye) uk-UA: Ukrainian (Ukraine) ur-IN: Urdu (India) ur-PK: Urdu (Pakistan) uz-UZ: Uzbek (Uzbekistan) ve-ZA: Venda (South Africa)vi-VN: Vietnamese (Vietnam) xh-ZA: Xhosa (South Africa) zu-ZA: Zulu (South Africa)
SubtitleFormat	String	No	Smart subtitle file format: For ASR recognition translation processing type: vtt: WebVTT format subtitle srt: SRT format subtitle Blank or fill in the blank: no subtitle file generated For pure caption translation processing type: original: consistent with the source file vtt: WebVTT format subtitle srt: SRT format subtitle For OCR recognition translation processing type: vtt: WebVTT format subtitle srt: SRT format subtitle Note: For ASR recognition method, passing blank or unspecified is not allowed when translating at least 2 languages. For pure caption translation and OCR recognition translation methods, passing blank or unspecified is not allowed. For OCR type tasks, passing blank or unspecified is allowed when suppression is enabled.
TranslateSwitch	String	No	Subtitle translation switch ON: Enable translation OFF: Disable translation Note: For pure subtitle translation mode, the default value is enabled if the field is unspecified. The field cannot be left blank or set to OFF.
TranslateDstLanguage	String	No	Subtitle target language Take effect when TranslateSwitch is ON. Translation language list: 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 Language 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 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 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: Sinhalese sk: Slovak sl: Slovenian sm: Samoan sn: Shona so: Somali sq: Albanian sr: Serbian ss: Swati st: Sesotho su: Sundanese sv: Swedish sw: Swahili szl: Silesian ta: Tamil te: Telugu tet: Tetum tg: Tajik th: Thai ti: Tigrinya tk: Turkmen 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 Note: Use the multilingual method. / to separate, such as en/ja, which indicates English and Japanese.
AsrHotWordsConfigure	AsrHotWordsConfigure	No	ASR hot word lexicon parameter
ExtInfo	String	No	Custom parameter
ProcessType	Integer	No	Subtitle processing type: 0: ASR recognition subtitle 1: Pure caption translation 2: OCR recognition subtitle Note: The default type is ASR recognition subtitle if the field is unspecified.
SelectingSubtitleAreasConfig	SelectingSubtitleAreasConfig	No	Area configurations for the subtitle OCR extraction box
SubtitleEmbedId	Integer	No	Suppression Template id. Only allowed to fill in when ProcessType is 0 or 2 (task type is ASR or OCR).
SpeakerMode	Integer	No	Speaker identification mode. Valid values: 0: Speaker identification is disabled. 1: Speaker identification is enabled. Default value: 0.
SpeakerLabel	Integer	No	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.

RawTranscodeParameter

Specification parameters for 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	Top Speed Codec transcoding parameters.
StdExtInfo	String	No	Additional parameter, which is a serialized JSON string.
EnhanceConfig	EnhanceConfig	No	Audio/Video enhancement configuration.
SubtitleTemplate	SubtitleTemplate	No	Subtitle parameters.

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 relative to the origin of coordinates of the video image. Supports two formats: % and px. 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. This field is 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

Rule condition configuration.

Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

Name	Type	Required	Description
Key	String	No	Key of the quality inspection item condition.
Value	String	No	Value corresponding to the condition.

Rules

Task judgment conditions.

Used by actions: CreateSchedule, ModifySchedule, ProcessMedia.

Name	Type	Required	Description
Id	String	No	Judgment condition id
Conditions	Array of RuleConditionItem	No	Judgment condition configuration
Linker	String	No	Logical operator for the list of conditions. Valid values: - &&: logical AND - ||: logical OR
RearDriveIndexs	Array of Integer	No	Indexes of the nodes to execute if the judgment conditions are met.

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	Region of the S3 bucket. Currently supports: us-east-1 eu-west-3
S3Object	String	Yes	Media resource path in the S3 bucket.
S3SecretId	String	No	AWS private network access key id for media content.
S3SecretKey	String	No	key for accessing media content over the AWS private network.

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	Region of the S3 bucket.
S3SecretId	String	No	AWS private network upload key id for media content.
S3SecretKey	String	No	key for uploading media content over the AWS private network.

SampleSnapshotTaskInput

Task input parameter type for sampling screenshot taking of a video.

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	Target storage for the file after the sampled screenshot is taken. If this is not specified, it inherits the value from the upper-level OutputStorage.
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	Rule of the {number} variable in the output path after the sampled screenshot is taken.
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

Result type of the orchestration video analysis 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	AiAnalysisTaskInput	Input of the analysis 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	Output of the conditional judgment task.

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	Output of a media quality inspection task.
Progress	Integer	Task execution progress.

ScheduleRecognitionTaskResult

Result type of the orchestration 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	Input of the recognition task.
Output	Array of AiRecognitionResult	Output of the identification task.
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

Type of the orchestration video moderation job 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, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
ErrCode	Integer	Error code. 0 indicates success, and other values indicate failure. (This field is not recommended. Use the new error code field ErrCodeExt instead.)
Message	String	Error message.
Input	AiContentReviewTaskInput	Input of the review task.
Output	Array of AiContentReviewResult	Output of the moderation task.
BeginProcessTime	String	Starting time of task execution, in ISO date and time format.
FinishTime	String	Task completion time, in ISO date and time format.

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	Input of the recognition task.
Output	Array of SmartSubtitlesResult	Output of the identification task.
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 information

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
TaskId	String	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.
InputInfo	MediaInputInfo	Information about the target file for media processing.
MetaData	MediaMetaData	Metadata of the original video.
ActivityResultSet	Array of ActivityResult	Output of the orchestration task.

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

Scratch removal 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.
Intensity	Float	No	Strength. Value range: 0.0 to 1.0. Default: 0.0.

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 splitting video clip.

Used by actions: DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification.

Name	Type	Description
Confidence	Float	Confidence degree.
StartTimeOffset	Float	Start time offset of the segment.
EndTimeOffset	Float	Segment end time offset.
SegmentUrl	String	Segment URL.
CovImgUrl	String	Split clip 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 person ID.

SegmentSpecificInfo

Information on special segment configuration.

Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

Name	Type	Required	Description
Switch	String	No	Switch for segment duration at startup. Optional values: on: enable off: Turn off the switch Default value: off
FragmentTime	Integer	No	Segment duration at startup. Unit: second
FragmentEndNum	Integer	No	Number of effective segments, indicating the first FragmentEndNum segments with FragmentTime. Value range: >=1

SelectingSubtitleAreasConfig

Area configurations for the subtitle OCR extraction box.

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

Name	Type	Required	Description
AutoAreas	Array of EraseArea	No	Automatically select a custom region. For the selected areas, the AI model is used to automatically detect and extract the target content.
SampleWidth	Integer	No	Width of the sample video or image, in pixels.
SampleHeight	Integer	No	Height of the sample video or image, in pixels.

SharpEnhanceConfig

Detail enhancement 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.
Intensity	Float	No	Strength. Value range: 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	Request decryption key uri address.
Key	String	Yes	Encryption key (32-byte hexadecimal string).
Vector	String	No	Encryption initialization vector (32-byte hexadecimal string).

SmartErasePrivacyConfig

Privacy protection configuration for the smart erasing template.

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

Name	Type	Required	Description
PrivacyModel	String	Yes	Erasing method of privacy protection. - Blur: blur. - mosaic
PrivacyTargets	Array of String	Yes	Privacy protection target. (When API Explorer is used, it is not required to specify an array. Add the corresponding items and enter the corresponding values.) - face Human face - plate: license plate.

SmartEraseSubtitleConfig

Subtitle removal configuration for the smart erasing template.

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

Name	Type	Required	Description
SubtitleEraseMethod	String	Yes	Subtitle erasure method. Automatic erasing: Video subtitles are automatically recognized using an AI model and are erased without traces to generate a new video. However, missed or incorrect erasing may occur due to image interference and special subtitle styles. In this case, you can specify the erasing area. When using automatic erasing, if you do not specify AutoAreas, the default region (lower middle part of the frame) will be erased automatically. If AutoAreas is specified, the designated region will be erased instead. Specified area erasure: If your subtitle position is fixed, it is recommended to directly specify the erasure area to minimize missed erasures. When choosing specified area erasure, please input at least one designated region in CustomAreas. auto: Automatic erasing custom: Specified area erasure
SubtitleModel	String	Yes	Subtitle erasure model. Standard version (recommended): If your subtitles have a standard style, it is usually recommended to select this version for better effectiveness in seamless detail removal. Area edition: If the subtitles have special styles, such as calligraphy, shadow, or motion effects, you are recommended to select this edition to ensure a larger erasing area. However, the erasing effect in the details is not as good as the standard edition. standard Standard model area Regional model
OcrSwitch	String	No	Whether OCR subtitle extraction is enabled. The default value is OFF. OCR subtitle extraction is supported if and only if SubtitleEraseMethod is set to auto. When enabled, it identifies the text region that appears most persistently and stably within the automatic erasing area as the subtitle area. The text within the subtitle area is extracted and erased. ON Enable OFF Disable
SubtitleLang	String	No	Subtitle language, used to guide OCR recognition, default value is zh_en. This parameter is valid only when OcrSwitch is "ON". zh_en Chinese and English multi other The following languages are supported for recognition: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, Hindi, Arabic, Bengali, Gujarati, Kannada, Malayalam, Tamil, Telugu, Slovenian, Polish, Catalan, Bosnia, Czech, Estonian, Croatian, Punjabi, Marathi, Azerbaijan, Indonesian, Luxembourg, Lithuanian, Latvian, Malta, Slovak, Turkish, Kazakh, Greek, Irish, Belarus, Khmer, Tagalog, Pashto, Persian, Tajikistan
SubtitleFormat	String	No	Subtitle file format. Default value is vtt. This parameter is valid only when OcrSwitch takes value "ON". srt srt format vtt WebVTT format When SubtitleEmbedId is filled, it can take value empty string, which means no subtitle file is output.
TransSwitch	String	No	Whether to enable subtitle translation. The default value is OFF. This parameter is valid only when OcrSwitch is set to "ON". ON: Enable OFF: Disable
TransDstLang	String	No	The target language for subtitle translation defaults to en. This parameter is valid only when TransSwitch is set to "ON". The following languages are currently supported: zh: Simplified Chinese en: English ja: Japanese ko: Korean fr: French es: Spanish it: Italian de: German tr: Turkish ru: Russian pt: Portuguese vi: Vietnamese id: Indonesian ms: Malay th: Thai ar: Arabic hi: Hindi
AutoAreas	Array of EraseArea	No	Automatically erase custom regions. For selected regions, use the AI model to automatically detect and erase existing targets. Note: When the erase method is set to custom, this parameter will not take effect. To modify the template, input [] for region cleanup. If not provided, the template region information remains unchanged.
CustomAreas	Array of EraseTimeArea	No	Designate the removal of custom regions. For specified regions, directly perform erasure without detection and recognition within a selected time range. Note: When modifying the template, import [] to clear regions. The template region information remains unchanged if not imported.
SubtitleEmbedId	Integer	No	Subtitle suppression template id. Only allowed to fill in when OCR translation is enabled.
UseOriginalPos	Integer	No	Suppression configuration, enabled by default, compresses subtitles back to their original position. It can be filled only when OCR translation is turned on. A value of 0 indicates disabled suppression.
UseOriginalSize	Integer	No	Suppression configuration, enabled by default. After being turned on, the original subtitle font size is used. It can only be filled when OCR translation is enabled. Setting it to 0 means non-use of the original font size.

SmartEraseTaskInput

Intelligent erasure task

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

Name	Type	Required	Description
Definition	Integer	No	Smart erasing template id.
RawParameter	RawSmartEraseParameter	No	Custom parameter for smart erasing. Valid when Definition is set to 0. This parameter is used for highly customized scenarios. We recommend you prioritize using Definition to specify smart erasing parameters.
OverrideParameter	OverrideEraseParameter	No	Custom parameters for smart erasing. When the value of Definition is not 0, this parameter is valid. When certain erasing parameters in this structure are specified, the specified parameters will be used to overwrite those in the smart erasing template. This parameter is used in highly customized scenarios. It is recommended to use only Definition to specify smart erasing parameters.
OutputStorage	TaskOutputStorage	No	Target storage for files. If left blank, it inherits the upper-level OutputStorage value.
OutputObjectPath	String	No	Output path of the file, which can be a relative or absolute path. To define the output path, it 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} Note: The BatchProcessMedia API is currently not supported.

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	Intelligent removal input.
Output	AiAnalysisTaskDelLogoOutput	Output of the intelligent erasure task.
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

Watermark removal configuration for the smart erasing template.

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

Name	Type	Required	Description
WatermarkEraseMethod	String	Yes	Watermark erasing method. Automatic erasing: ** Video watermarks are automatically recognized using an AI model and are erased to generate a new video. It applies to dynamic watermarks. When automatic erasing is used, if AutoAreas is not specified, the full-screen video image area will be erased automatically. If AutoAreas is specified, the specified area will be erased automatically. Specified area erasure:** For static watermarks in fixed positions, we recommend you directly specify the erasure area. When you choose specified area erasure, import at least one specified region. - auto: automatic erasing. - custom: specified area erasing.
WatermarkModel	String	Yes	Watermark erasing model. Basic Edition: provide average effects and high cost performance. It applies to animations or videos with clean backgrounds. Advanced Edition: provide better effects. It applies to reality-style videos, such as short dramas. - basic: Basic Edition. - advanced: Advanced Edition.
AutoAreas	Array of EraseArea	No	Custom area for automatic erasing. For the specified area, AI models are used to automatically detect and erase the target objects. Note: When the erasing method is set to custom, this parameter is invalid. When a template is modified, input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.
CustomAreas	Array of EraseTimeArea	No	Specify a custom region for erasure. For the specified area, erase the target objects directly without detection and recognition within a selected time period. Note: When a template is modified, input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.

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	Input information on the full speech recognition task.
Output	SmartSubtitleTaskAsrFullTextResultOutput	Output information on the full speech recognition task.
Progress	Integer	Task progress.

SmartSubtitleTaskAsrFullTextResultOutput

Full speech recognition result.

Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

Name	Type	Description
SegmentSet	Array of SmartSubtitleTaskAsrFullTextSegmentItem	List of segments for full speech recognition.
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	Word timestamp information.
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	Translation task output information.
AsrFullTextTask	SmartSubtitleTaskAsrFullTextResultOutput	Full speech recognition task output information.

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	Input information for smart subtitle tasks.
Output	SmartSubtitleTaskTextResultOutput	Smart subtitle task output information.
Progress	Integer	Task progress.

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	Custom smart subtitle 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 smart subtitle parameters.
UserExtPara	String	Extended parameter.

SmartSubtitleTaskTextResultOutput

Smart subtitle recognition result.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
SegmentSet	Array of SmartSubtitleTaskFullTextSegmentItem	List of segments for smart subtitle recognition.
RecognizeSubtitleResult	Array of SubtitleResult	Subtitle recognition result
TransSubtitleResult	Array of SubtitleResult	Translated subtitles
OutputStorage	TaskOutputStorage	Storage location of the subtitle file

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	Translation task input information.
Output	SmartSubtitleTaskTransTextResultOutput	Translation task output information.
Progress	Integer	Task progress.

SmartSubtitleTaskTransTextResultOutput

Translation result.

Used by actions: DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification.

Name	Type	Description
SegmentSet	Array of SmartSubtitleTaskTransTextSegmentItem	List of segments for translation.
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	Word timestamp information.
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	Full speech recognition result. When Type is Valid when AsrFullTextRecognition is set.
TransTextTask	SmartSubtitleTaskTransTextResult	Translation result. When Type is Valid when set to TransTextRecognition.
PureSubtitleTransTask	PureSubtitleTransResult	The translation result of the pure subtitle file is returned when the translation type is PureSubtitleTrans.
OcrFullTextTask	SmartSubtitleTaskFullTextResult	Text-based subtitle extraction result. This field is valid when the value of Type is Valid when OcrFullTextRecognition is set.

SmartSubtitlesTaskInput

Smart subtitle input struct.

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

Name	Type	Required	Description
Definition	Integer	No	Smart subtitle template ID.
UserExtPara	String	No	User extension field, which does not need to be filled in for general scenarios.
RawParameter	RawSmartSubtitleParameter	No	Custom smart subtitle 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 smart subtitle parameters.
OutputStorage	TaskOutputStorage	No	Target storage of media processing output files. If not specified, inherits the storage location in InputInfo. Note: This parameter is required when InputInfo.Type is set to URL.
OutputObjectPath	String	No	Output path of the generated subtitle file, 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: - File name_{variable name}.{format}. -File name.{format} Absolute path example: -/Custom path/File name_{variable name}.{format}. If this field is left unspecified, the default value is the relative path in the following format: {inputName}_smartsubtitle_{definition}.{format}.

SnapshotByTimeOffsetTaskInput

Task input parameter type for time point screenshot taking of a video.

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	Target storage for the file after the time point screenshot is taken. If this is not specified, it inherits the value from the upper-level OutputStorage.
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	Rule of the {number} variable in the output path after the time point screenshot is taken.
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 tag. 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 cannot exceed 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	Encryption rule for substreams. Default value: preset 0 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.
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:
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:
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:
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	Subtitle file URL to be suppressed into the video.
StreamIndex	Integer	No	Specifies the subtitle track for embedding subtitles into the video. The Streamindex value starts from 0, where 0 indicates usage of the first subtitle track in the source video. If Path is specified, use Path preferentially. Either Path or Streamindex should be specified. -Note: StreamIndex must match the subtitle track index in the source file. For example, if the subtitle track in the source file is stream#0:3, StreamIndex should be 3. Otherwise, task processing may fail.
SubtitleFileInput	MediaInputInfo	No	Input information on the subtitle file to be embedded into the video. Currently, only subtitle files stored in COS are supported.
FontFileInput	MediaInputInfo	No	Input information for suppressing subtitle font files. 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	Font type. Valid values: hei.ttf: SimHei song.ttf: SimSun. kai.ttf (recommend) or simkai.ttf: KaiTi. msyh.ttf: Microsoft YaHei. msyhbd.ttf: Microsoft YaHei Bold. hkjgt.ttf: DynaFont King Gothic. dhttx.ttf: DianHei Extra Light. xqgdzt.ttf: XiQue GuZiDian. qpcyt.ttf: Smart Splice Super Round Body arial.ttf: English only. 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: NotoSansDevanagari for India. notosanstc.ttf: Cantonese Source Han Sans 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 value: hei.ttf. Note: kai.ttf is recommended for SimKai. FontFileInput takes precedence when specified.
FontSize	String	No	Font size. If not specified, the font size of the subtitle file applies. Pixel and percentage formats are supported: - Pixel: Npx. Value range of N: (0,4096]. - Percentage: N%. Value range of N: (0,100]. For example, 10% means the subtitle font size is 10% of the source video height. The default size is 5% of the source video height if this parameter is not specified or the font size is not configured in the subtitle file.
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.
YPos	String	No	Subtitle y-axis coordinate position. If you specify this parameter, the built-in coordinates of the subtitle file are ignored. Pixel and percentage formats are supported. - Pixel: Npx. Value range of N: [0,4096]. -Percentage: N%, N range: [0,100]. For example, 10% means the subtitle y-coordinate = 10% * source video height. Default value: 4% of the source video height. 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.
BoardY	String	No	y-axis coordinate position of the subtitle background base plate. Supports pixel and percentage formats. - Pixel: Npx. Value range of N: [0,4096]. -Percentage: N%, N range: [0,100]. For example, 10% means the y-coordinate of the subtitle background base plate = 10% * source video height. If this parameter is not specified, the subtitle background base plate is disabled. Note: The origin of the coordinate axes is at the bottom of the central axis of the source video, and the reference position of the subtitle background base plate is at the bottom of its central axis, as shown in the figure below.
BoardWidth	Integer	No	Base plate 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.
BoardHeight	Integer	No	Height of the base plate. 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.
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.
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]. If this is not specified, the default width is 0.3% of the source video height.
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]. If this is not specified, no shadow is applied by default.
ShadowColor	String	No	Shadow color. 6-bit base-16 RGB. Black by default if left blank (when shadow has been set).
ShadowAlpha	Float	No	Shadow transparency. The value should be a positive floating-point number in the range of (0, 1]. If 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 is 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. Valid values: ON: enabled OFF: disabled Default value: ON.
Type	String	No	Type. Valid values: lq: super resolution for low resolution videos with considerable noise; hq: For high resolution video super-resolution. Default value: lq.
Size	Integer	No	Upscaling multiple. Available values: 2: currently only support 2x super resolution. Default value: 2.

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

Output parameter setting for synchronous dubbing.

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

Name	Type	Required	Description
Type	String	No	Output type of the synthesis result. Enumeration values: data: Audio base64 encoding, url: Audio URL, valid for 24 hours.

TEHDConfig

Top Speed Codec parameter configuration.

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

Name	Type	Required	Description
Type	String	Yes	TSC type. Available values: TEHD-100: TSC-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 parameter is not specified or is set to 0, no upper limit is set for the video bitrate.

TEHDConfigForUpdate

Top Speed Codec parameter configuration.

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

Name	Type	Required	Description
Type	String	No	Top Speed Codec type. Available values: TEHD-100: Top Speed Codec-100 (video top speed codec). TEHD-200: Top Speed Codec-200 (audio TSC). Leave it blank to indicate no modification.
MaxVideoBitrate	Integer	No	Maximum video bitrate. If this parameter is left empty, no modification is made.

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 a 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	AWS SQS callback. This is required if NotifyType is AWS-SQS.
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 storage location for MPS output objects. Supported values: COS: COS storage AWS-S3: AWS storage, only suitable for AWS tasks and requires the same region VOD: VOD Pro Edition
CosOutputStorage	CosOutputStorage	No	Required when Type is COS. It refers to the COS output location for media processing.
S3OutputStorage	S3OutputStorage	No	Valid when Type is AWS-S3. Required. Indicates the AWS S3 output location for media processing.
VODOutputStorage	VODOutputStorage	No	Valid when Type is VOD. This item is required and indicates the output location of MPS VOD Pro Edition.

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	Audio track and number of sound channels. Description: When SelectType is track, this value is an integer, for example: 1; When SelectType is track_channel, this value is a decimal, for example: 1.0; Default value: 1.0. Note: The integer part represents the audio track serial number, and the decimal part represents the sound channel. The audio track serial number is the stream index of the audio track, and supports input of 0 and positive integers. The decimal part supports up to 2 decimal places and only supports 0-63. However, if Codec is aac/eac3/ac3, the decimal part only supports 0-15. For example: For an audio track with stream index 1, 1.0 represents the first sound channel of this audio track, and 1.1 represents the second sound channel of this audio track.
ChannelVolume	Array of Float	No	Sound channel volume. Description: When the value of AudioChannel is 1, the length of this array is 1, for example: [6]; When the value of AudioChannel is 2, the length of this array is 2, for example: [0,6]; When the value of AudioChannel is 6, the length of this array is greater than 2 and less than 16, for example: [-60,0,0,6]. Value range: [-60, 6]. -60 means mute, 0 means keep the original volume, and 6 means double the original volume. Default value: -60. Note: Supports 3 decimal places.

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	Custom video transcoding parameter. It takes effect when Definition is not set to 0. When some transcoding parameters in this structure are filled in, the filled parameters will be used to override the parameters in the transcoding template. This parameter is used in high customization scenarios. It is recommended that you use only Definition to specify transcoding parameters.
WatermarkSet	Array of WatermarkInput	No	Watermark list. Multiple image or text watermarks up to a maximum of 10 are supported.
BlindWatermark	BlindWatermarkInput	No	Digital watermark parameter.
MosaicSet	Array of MosaicInput	No	Mosaic list. Up to 10 images supported.
StartTimeOffset	Float	No	Start time offset of the transcoded video, in seconds. Leave this parameter empty or set it to 0: transcoding starts from the start 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 from the position 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 lasts until the nth second of the original video and then ends; When the value is less than 0 (assuming -n), it means the transcoded video lasts until n seconds before the original video ends.
OutputStorage	TaskOutputStorage	No	Target storage for transcoded files. If left blank, it inherits the upper-level OutputStorage value.
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 not filled in, default relative path: {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	Rule of the {number} variable in the output path after transcoding.
HeadTailParameter	HeadTailParameter	No	Opening and ending content parameters.

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 values: understand-1.0-lite: Lightweight understanding model understand-1.0-flash: Quality-speed balanced understanding model understand-1.0-pro: High-quality understanding model
Prompt	String	Yes	Image understanding instruction
Parameters	String	No	Image understanding model parameters, of JSON string type.

UpdateSmartErasePrivacyConfig

Privacy protection configuration for the smart erasing template.

Used by actions: ProcessMedia.

Name	Type	Required	Description
PrivacyModel	String	No	Erasing method of privacy protection. - Blur: blur. - mosaic
PrivacyTargets	Array of String	No	Privacy protection target. (When API Explorer is used, it is not required to specify an array. Add the corresponding items and enter the corresponding values.) - face: human face. - plate: license plate.

UpdateSmartEraseSubtitleConfig

Subtitle removal configuration for the smart erasing template.

Used by actions: ProcessMedia.

Name	Type	Required	Description
SubtitleEraseMethod	String	No	Subtitle erasing method. Automatic erasing: Video subtitles are automatically recognized using an AI model and are erased without traces to generate a new video. However, missed or incorrect erasing may occur due to image interference and special subtitle styles. In this case, you can specify the erasing area. When automatic erasing is used, if AutoAreas is not specified, the default area (lower middle part of the image) will be erased automatically. If AutoAreas is specified, the specified area will be erased automatically. Specified area erasing: If the subtitle position is relatively fixed, you are recommended to specify the erasing area directly to minimize missed erasing. When you choose specified area erasing, specify at least one area for CustomAreas. - auto: automatic erasing. - custom: specified area erasing.
SubtitleModel	String	No	Subtitle erasing model. Standard edition (recommended): For standard subtitle styles, you are recommended to select this edition to ensure better traceless effects in the details. Area edition: If the subtitles have special styles, such as calligraphy, shadow, or motion effects, you are recommended to select this edition to ensure a larger erasing area. However, the erasing effect in the details is not as good as the standard edition. - standard: standard edition. - area: area edition.
OcrSwitch	String	No	Whether to enable OCR subtitle extraction. The default value is OFF. OCR subtitle extraction is supported if and only if SubtitleEraseMethod is set to auto. When enabled, it identifies the text region that appears most persistently and stably within the automatic erasing area as the subtitle area. The text within the subtitle area is extracted and erased. - ON: enabled. -OFF: disabled.
SubtitleLang	String	No	Subtitle language, used for OCR recognition. Default value: zh_en. This parameter is valid only when OcrSwitch is ON. - zh_en: Chinese and English. - multi: others. The following are other languages supported for recognition: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, Hindi, Arabic, Bengali (India), Gujarati (India), Kannada (India), Malayalam (India), Tamil (India), Telugu (India), Slovenian, Polish, Catalan, Bosnian, Czech, Estonian, Croatian, Punjabi, Marathi, Azerbaijani, Indonesian, Luxembourgish, Lithuanian, Latvian, Maltese, Slovak, Turkish, Kazakh, Greek, Irish, Belarusian, Khmer, Tagalog, Pashto, Persian, Tajik
SubtitleFormat	String	No	Subtitle file format. Default value: vtt. This parameter is valid only when OcrSwitch is set to ON. -srt format - vtt: WebVTT format.
TransSwitch	String	No	Whether to enable subtitle translation. Default value: OFF. This parameter is valid only when OcrSwitch is ON. - ON: enabled. -OFF: disabled.
TransDstLang	String	No	Subtitle translation target language. Default value: en. This parameter is valid only when TransSwitch is set to "ON". Supported languages: zh: Simplified Chinese English ja: Japanese ko: Korean fr: French es: Spanish it: Italian de: German tr: Turkish ru: Russian pt: Portuguese vi: Vietnamese id: Indonesian ms: Malay th: Thai ar: Arabic hi: Hindi
AutoAreas	Array of EraseArea	No	Custom area for automatic erasing. For the specified area, AI models are used to automatically detect and erase the target objects. Note: When the erasing method is set to custom, this parameter is invalid. When a template is modified, input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.
CustomAreas	Array of EraseTimeArea	No	Specify a custom region for erasure. For the specified area, erase the target objects directly without detection and recognition within a selected time period. Note: When a template is modified, input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.

UpdateSmartEraseWatermarkConfig

Watermark removal configuration for the smart erasing template.

Used by actions: ProcessMedia.

Name	Type	Required	Description
WatermarkEraseMethod	String	No	Watermark erasing method. Automatic erasing: ** Video watermarks are automatically recognized using an AI model and are erased to generate a new video. It applies to dynamic watermarks. When automatic erasing is used, if AutoAreas is not specified, the full-screen video image area will be erased automatically. If AutoAreas is specified, the specified area will be erased automatically. Specified area erasure:** For static watermarks with fixed positions, we recommend you directly specify the erasure area. If you choose specified area erasure, input at least one specified region. - auto: automatic erasing. - custom: specified area erasing.
WatermarkModel	String	No	Watermark erasing model. Basic Edition: provide average effects and high cost performance. It applies to animations or videos with clean backgrounds. Advanced Edition: provide better effects. It applies to reality-style videos, such as short dramas. - basic: Basic Edition. - advanced: Advanced Edition.
AutoAreas	Array of EraseArea	No	Custom area for automatic erasing. For the specified area, AI models are used to automatically detect and erase the target objects. Note: When the erasing method is set to custom, this parameter is invalid. Input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.
CustomAreas	Array of EraseTimeArea	No	Specify a custom region for erasure. For the specified area, erase the target objects directly without detection and recognition within a selected time period. Note: Input [] for the erasing area; if this parameter is unspecified, the template area information will remain unchanged.

UrlInputInfo

Media processing URL object information.

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

Name	Type	Required	Description
Url	String	Yes	URL of the video.

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

Media processing VOD object information.

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

Name	Type	Required	Description
Bucket	String	No	Bucket ID where the media processing object file resides
Region	String	No	Region of the Bucket where the media processing object file resides
Object	String	No	Input path of the media processing object file
SubAppId	Integer	No	VOD application ID.
VodBasic	Integer	No	Whether to use VOD Standard Edition. Attention: If left empty, VOD Pro Edition is used. Enumeration values: Use VOD Pro Edition Use VOD Standard Edition, allowing tasks to be initiated with FileId Default value: 0
FileId	String	No	VOD Standard Edition FileId

VODOutputStorage

Media processing VOD output object information.

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

Name	Type	Required	Description
Bucket	String	No	Target Bucket ID for the output file generated by media processing
Region	String	No	Region of the target Bucket for the output file generated by media processing
SubAppId	Integer	No	VOD application ID
VodBasic	Integer	No	Whether to use VOD Standard Edition. Attention: If left empty, VOD Pro Edition is used. Enumeration values: 0: Do not use VOD Standard Edition 1: Use VOD Standard Edition

VideoComprehensionResultItem

Video storyboard recognition result.

Used by actions: DescribeTaskDetail, ParseNotification.

Name	Type	Description
StartTime	Float	Start time of the storyboard segment, in seconds.
EndTime	Float	Segment end time (unit: second)
Title	String	Segment title.
Description	String	Description of the storyboard segment information
Keywords	Array of String	Segment keywords.

VideoDenoiseConfig

Video noise reduction 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	Type. Valid values: weak strong Default value: weak.

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	Frame rate configuration (old) for the frame interpolation. New users are recommended to use FrameRateWithDen for configuring the frame rate of frame interpolation, which supports fractions and provides better results. Note that FrameRate and FrameRateWithDen are mutually exclusive; configuring both simultaneously may cause task failures. The configuration does not take effect if the source frame rate is greater than or equal to the target frame rate.
SuperResolution	SuperResolutionConfig	No	Super-resolution configuration. The video is not processed when the source resolution is higher than the target resolution. Note that it cannot be enabled simultaneously with LLM enhancement.
Hdr	HdrConfig	No	HDR configuration.
Denoise	VideoDenoiseConfig	No	Video noise reduction configuration. Note that it cannot be enabled simultaneously with LLM enhancement.
ImageQualityEnhance	ImageQualityEnhanceConfig	No	Comprehensive enhancement configuration. Note that only one of the three items, large model, comprehensive enhancement, and artifacts removal, can be configured.
ColorEnhance	ColorEnhanceConfig	No	Color enhancement configuration.
LowLightEnhance	LowLightEnhanceConfig	No	Low-light enhancement configuration.
ScratchRepair	ScratchRepairConfig	No	Scratch removal configuration.
ArtifactRepair	ArtifactRepairConfig	No	Artifacts removal configuration. Note that only one of the three items, large model, comprehensive enhancement, and artifacts removal, can be configured.
EnhanceSceneType	String	No	Enhancement scenario configuration. Available values: common: general enhancement parameters, basic optimization parameters suitable for various video types, improving overall video quality. AIGC: overall resolution enhancement, using AI technology to improve the overall video resolution and enhance image clarity. short_play (mini-drama & AI virtual human drama): enhances face and subtitle details, highlights facial expression details and subtitle clarity, improving the viewing experience. AI_comic (AI comic drama): enhances comic-style image details. short_video: optimizes complex and diverse video quality issues, optimizes video quality for complex short video scenarios, and resolves various visual issues. game (game video): repairs motion blur and enhances details, focusing on enhancing the clarity of game details, restoring motion blur areas, and making the game screen content clearer and richer. HD_movie_series (UHD TV shows and movies): obtains UHD smooth effects, generates 4K 60fps HDR UHD standard videos for broadcasting/OTT UHD video demands. Supports broadcasting scenario format standards. LQ_material (low-quality material/classic film restoration): overall resolution enhancement, specially optimized for issues in old videos such as insufficient resolution, blur distortion, scratch damage, and color temperature due to their age. lecture (live show/e-commerce/conference/lecture): beautifies and enhances face effects, specially optimized for face region, noise reduction, and burr processing in scenarios where people explain, such as live shows/e-commerce/conferences/lectures. An empty string indicates non-use of enhancement scenarios.
DiffusionEnhance	DiffusionEnhanceConfig	No	Large model enhancement configuration. Note that only one of the three items, large model, comprehensive enhancement, and artifacts removal, can be configured. It cannot be enabled simultaneously with super resolution and noise reduction.
FrameRateWithDen	FrameRateWithDenConfig	No	New frame interpolation frame rate configuration, supporting fractions. Note that you can only choose one between this and FrameRate. The capacity will not take effect when the source frame rate is equal to or greater than the target frame rate.
AiRestoration	AiRestorationConfig	No	Large model repair configuration. Note that at most one of large model, comprehensive enhancement, and jitter removal can be configured. It cannot be enabled simultaneously with super resolution or noise reduction.
DiffusionEnhanceV2	DiffusionEnhanceV2Config	No	Configuration of the large model enhancement pro edition. Note that at most one of the large model, comprehensive enhancement, and artifacts removal can be configured. It cannot intersect with super resolution and noise reduction.

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 containers currently only support 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	Video stream bitrate, in kbps. Value range: 0 and [128, 100000]. 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 height (or short side) of the video stream. 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	Gop value unit. Value range: frame: indicates frame second: indicates second Default value: frame
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	Control factor for constant video bitrate. Value range: [0, 51]. If not specified, it means "auto". If there are no special requirements, it is advisable not to specify this parameter. If Mode is set to VBR and Vcrf is configured, MPS processes video in VBR mode, taking into account both Vcrf and Bitrate parameter settings to balance video quality, bitrate, transcoding efficiency, and file size. When Mode is set to CRF, the Bitrate setting will become invalid, and encoding will be performed based on the Vcrf value. If Mode is set to ABR or CBR, the Vcrf value does not need to be configured.
HlsTime	Integer	No	Average segment duration. Value range: (0-10], unit: second. If not specified, it means auto. The appropriate segment duration will be automatically selected based on video features such as GOP.
SegmentType	Integer	No	hls fragment type. Available values: 0: HLS+TS segment. 2:HLS+TS byte range 7: HLS+MP4 segment. 5:HLS+MP4 byte range Default value: 0 Note: This field is used for ordinary/TSC transcoding settings and does not take effect for adaptive bitrate streams. To configure the shard type for an adaptive bitrate stream, use the outer field.
FpsDenominator	Integer	No	Denominator of the frame rate. Note: The value must be greater than 0.
Stereo3dType	String	No	3D video splicing mode. It takes effect only for mv-hevc and 3D videos. Available values: side_by_side: left-right layout arrangement of the original video content. top_bottom: top-bottom layout arrangement of the original video content. Billing will be based on the segmented resolution size to report usage and charges. Default value: side_by_side.
VideoProfile	String	No	Profile, suitable for different scenarios. baseline: It only supports I/P-frames and non-interlaced scenarios, and is suitable for scenarios such as video calls and mobile videos. Main: Mainstream Profile, provides I-frames, P-frames, and B-frames, and supports both interlaced and non-interlaced modes. It is mainly used in mainstream audio and video consumption products such as video players and streaming media transmission devices. high: Highest encoding level. It adds 8X8 prediction to Main Profile and supports custom quantization. It is widely used in Blu-ray storage, HDTV, and other scenarios. default: automatic filling along with the original video. This configuration appears only when the encoding standard is set to H264. baseline/main/high is supported. Default value: default
VideoLevel	String	No	Encoder level. Default value: auto ("") If the encoding standard is set to H264, the following options are supported: "", 1, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, and 5.1. If the encoding standard is set to H265, the following options are supported: "", 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2, and 8.5.
Bframes	Integer	No	Number of B-frames between reference frames. The default is auto, and a range of 0 - 16 is supported. Note: Leaving it blank means using the auto option.
Mode	String	No	Bitrate control mode. Available values: VBR (Variable Bit Rate): adjust the output bitrate based on the complexity of the video image to ensure higher image quality. It is suitable for storage scenarios and applications with high image quality requirements. ABR (Average Bit Rate): Try to keep the average bitrate of the output video stable as much as possible, but allow short-term bitrate fluctuation. It is suitable for scenarios where the overall bitrate needs to be minimized while maintaining a certain image quality. CBR (Constant Bit Rate): maintains a constant output bitrate during video encoding, regardless of image complexity changes. It is suitable for scenarios with strict network bandwidth requirements, such as live streaming. VCRF (Constant Rate Factor): A constant quality factor. It controls video quality by setting a quality factor to achieve constant quality encoding of videos. The bitrate is automatically adjusted based on content complexity, making it suitable for scenarios where maintaining a certain quality is desired. VBR is selected by default.
Sar	String	No	Display aspect ratio. Optional values: [1:1, 2:1, default] Default value: default
NoScenecut	Integer	No	Adaptive I-frame decision. When it is enabled, Media Processing Service will automatically identify transition points between different scenarios in the video (usually they are visually distinct frames, such as those of switching from one shot to another) and adaptively insert keyframes (I-frames) at these points to improve the random accessibility and encoding efficiency of the video. Available values: 0: Disable adaptive I-frame decision 1: Enable the adaptive I-frame decision Default value: 0
BitDepth	Integer	No	Bit: 8/10 is supported. Default value: 8
RawPts	Integer	No	Preserve original timestamp. Optional values: 0: Disabled 1: Indicates open Default value: Disabled
Compress	Integer	No	Proportional compression bitrate. When enabled, the output video's bitrate is adjusted according to the proportion. After the compression ratio is entered, the system automatically calculates the target output bitrate based on the source video bitrate. Compression ratio range: 0-100 Leaving this value blank means it is not enabled by default.
SegmentSpecificInfo	SegmentSpecificInfo	No	Segment duration at startup
ScenarioBased	Integer	No	Whether to enable scenario-based settings for the template 0: disable 1: enable Default value: 0 Note: The values of the SceneType and CompressType fields are effective only when the value of this field is 1.
SceneType	String	No	Video scenario. Optional values: normal: General transcoding scenario: General transcoding and compression scenario. pgc: PGC HD TV shows and movies: At the time of compression, focus is placed on the viewing experience of TV shows and movies and ROI encoding is performed according to their characteristics, while high-quality contents of videos and audio are retained. materials_video: HD materials: Scenario involving material resources, where requirements for image quality are extremely high and there are many transparent images, with almost no visual loss during compression. ugc: UGC content: It is suitable for a wide range of UGC/short video scenarios, with an optimized encoding bitrate for short video characteristics, improved image quality, and enhanced business QOS/QOE metrics. e-commerce_video: Fashion show/e-commerce: During compression, emphasis is placed on detail clarity and ROI enhancement, with a particular focus on maintaining the image quality of the face region. educational_video: Education: At the time of compression, emphasis is placed on the clarity and readability of text and images to help students better understand the content, ensuring that the teaching content is clearly conveyed. Default value: normal. Note: To use this value, the value of ScenarioBased must be 1. Otherwise, this value does not take effect.
CompressType	String	No	Transcoding policy. Optional values: ultra_compress: Extreme compression: Compared to standard compression, this policy can maximize bitrate compression while ensuring a certain level of image quality, thus greatly saving bandwidth and storage costs. standard_compress: Comprehensively optimal: The compression ratio and image quality are balanced, and files are compressed as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy. high_compress: Bitrate priority: Priority is given to reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy. low_compress: Image quality priority: Priority is given to ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy. Default value: standard_compress. Note: The ultra_compress policy is not recommended for use if you need to watch videos on TV. The billing standard for the ultra_compress policy is TSC transcoding + audio/video enhancement-artifacts removal. Note: To use this value, the value of ScenarioBased must be 1. Otherwise, this value does not take effect.

VideoTemplateInfoForUpdate

Video stream configuration parameters

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

Name	Type	Required	Description
Codec	String	No	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: The 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	No	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	No	Bitrate of 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. 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. 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. 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]. When set to 0, the system will automatically set the gop length.
GopUnit	String	No	Gop value unit. Value range: frame: indicates frame second: indicates second Default value: frame
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: Stretch 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	Control factor for constant video bitrate. Value range: [0, 51]. If not specified, it means "auto". If there are no special requirements, it is advisable not to specify this parameter. If Mode is set to VBR and Vcrf is configured, MPS processes video in VBR mode, taking into account both Vcrf and Bitrate parameter settings to balance video quality, bitrate, transcoding efficiency, and file size. If Mode is set to CRF, the Bitrate setting will become invalid, and encoding will be performed based on the Vcrf value. When Mode is set to ABR or CBR, the Vcrf value does not need to be configured. Note: To change it to automatic, fill in 100.
ContentAdaptStream	Integer	No	Content adaptive encoding. Available values: 0: disable 1: Turn on Default value: 0. When this parameter is enabled, multiple streams with different resolutions and bitrates will be generated automatically. The width and height in VideoTemplate are the maximum resolution among the multiple streams, the bitrate in VideoTemplate is the highest bitrate among the multiple streams, and the vcrf in VideoTemplate is the highest quality among the multiple streams. When resolution, bitrate, and vcrf are not set, the highest resolution generated by the ContentAdaptStream parameter is the resolution of the video source, and the video quality is close to a vmaf score of 95. To enable this parameter or learn about billing details, contact your Tencent Cloud business.
HlsTime	Integer	No	Average segment duration. Value range: (0-10], unit: second Default value: 10 Note: It is used only in the HLS format.
SegmentType	Integer	No	hls fragment type. Available values: 0: HLS+TS segment. 2:HLS+TS byte range 7: HLS+MP4 segment. 5:HLS+MP4 byte range Default value: 0 Note: This field is used for ordinary/TSC transcoding settings and does not take effect for adaptive bitrate streams. To configure the sharding type for adaptive bitrate streams, use the outer field.
FpsDenominator	Integer	No	Denominator of the frame rate. Note: The value must be greater than 0.
Stereo3dType	String	No	3D video splicing mode. It takes effect only for mv-hevc and 3D videos. Available values: side_by_side: left-right layout arrangement of the original video content. top_bottom: top-bottom layout arrangement of the original video content. Billing will be based on the segmented resolution dimensions to report usage and fees. Default value: side_by_side
VideoProfile	String	No	Profile, suitable for different scenarios. baseline: It only supports I/P-frames and non-interlaced scenarios, and is suitable for scenarios such as video calls and mobile videos. Main Profile, which provides I-frames, P-frames, and B-frames, and supports both interlaced and non-interlaced modes. It is mainly used in mainstream audio and video consumption products such as video players and streaming media transmission devices. high: Highest encoding level. It adds 8X8 prediction to Main Profile and supports custom quantification. It is widely used in Blu-ray storage and HDTV scenarios. default: automatic filling along with the original video This configuration appears only when the encoding standard is set to H264. Default value: default
VideoLevel	String	No	Encoder level. Default value: auto ("") If the encoding standard is set to H264, the following options are supported: "", 1, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, and 5.1. If the encoding standard is set to H265, the following options are supported: "", 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2, and 8.5.
Bframes	Integer	No	Maximum number of consecutive B-frames. The default is auto, and 0 - 16 and -1 are supported. Note: -1 indicates auto.
Mode	String	No	Bitrate control mode. Available values: VBR (Variable Bit Rate): A dynamic bitrate that adjusts the output bitrate based on the complexity of the video image to ensure higher image quality. It is suitable for storage scenarios and applications with high image quality requirements. ABR (Average Bit Rate): It tries to stabilize the average bitrate of the output video as much as possible, but allows short-term bitrate fluctuation. It is suitable for scenarios where the overall bitrate needs to be minimized while maintaining a certain image quality. CBR (Constant Bit Rate): The output bitrate remains constant during video encoding, regardless of image complexity changes. It is suitable for scenarios with strict network bandwidth requirements, such as live streaming. VCRF (Constant Rate Factor): A constant quality factor. It controls video quality by setting a Quality Factor to achieve constant quality encoding of videos. Bitrate adjustment based on content complexity makes it suitable for scenarios where maintaining a certain quality is desired. VBR is selected by default.
Sar	String	No	Display aspect ratio. Optional values: [1:1, 2:1, default] Default value: default
NoScenecut	Integer	No	Adaptive I-frame decision. When it is enabled, Media Processing Service will automatically identify transition points between different scenarios in the video (usually they are visually distinct frames, such as those of switching from one shot to another) and adaptively insert keyframes (I-frames) at these points to improve the random accessibility and encoding efficiency of the video. Available values: 0: Disable adaptive I-frame decision 1: Enable the adaptive I-frame decision Default value: 0
BitDepth	Integer	No	Bit: 8/10 is supported. Default value: 8
RawPts	Integer	No	Preserve original timestamp. Available values: 0: Disabled 1: Enabled Default value: Disabled
Compress	Integer	No	Proportional compression bitrate. When it is enabled, the bitrate of the output video will be adjusted according to the proportion. After the compression ratio is entered, the system will automatically calculate the target output bitrate based on the source video bitrate. Compression ratio range: 0-100, optional values: [0-100] and -1. Note: -1 indicates auto.
SegmentSpecificInfo	SegmentSpecificInfo	No	Segment duration at startup
ScenarioBased	Integer	No	Whether to enable scenario-based settings for the template 0: disable 1: enable Default value: 0 Note: The values of SceneType and CompressType take effect only when this field is set to 1.
SceneType	String	No	Video scenario. Optional values: normal: General transcoding scenario: general transcoding and compression scenario. pgc: PGC HD TV shows and movies: At the time of compression, focus is placed on the viewing experience of TV shows and movies and ROI encoding is performed according to their characteristics, while high-quality video and audio content is retained. materials_video: HD materials: Scenario involving material resources, where requirements for image quality are extremely high and there are many transparent images, with almost no visual loss during compression. ugc: UGC content: It is suitable for a wide range of UGC/short video scenarios, with an optimized encoding bitrate for short video characteristics, improved image quality, and enhanced business QOS/QOE metrics. e-commerce_video: Fashion show/e-commerce: During compression, emphasis is placed on detail clarity and ROI enhancement, with a particular focus on maintaining the image quality of the face region. educational_video: Education: At the time of compression, emphasis is placed on the clarity and readability of text and images to help students better understand the content, ensuring that the teaching content is clearly conveyed. Default value: normal. Note: To use this value, the value of ScenarioBased must be 1. Otherwise, this value does not take effect.
CompressType	String	No	Transcoding policy. Optional values: ultra_compress: Ultimate compression: Compared to standard compression, this policy can maximize bitrate compression while ensuring a certain level of image quality, thus greatly saving bandwidth and storage costs. standard_compress: Comprehensively optimal: The compression ratio and image quality are balanced, and files are compressed as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy. high_compress: Bitrate priority: Priority is given to reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy. low_compress: Image quality priority: Priority is given to ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy. Default value: standard_compress. Note: The ultra_compress policy is not recommended for use if you need to watch videos on TV. The billing standard for the ultra_compress policy is TSC transcoding + audio/video enhancement-artifacts removal. Note: To use this value, the value of ScenarioBased must be 1. Otherwise, this value does not take effect.

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

Voice attribute.

Used by actions: CloneVoice, DesignVoiceAsync, SyncDubbing.

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. Supported languages: zh Chinese en English ja Japanese de German fr French ko Korean ru Russian uk Ukrainian pt Portuguese it Italian es Spanish id Indonesian nl Dutch tr Turkish fil Filipino ms Malay el Greek fi Finnish hr Croatian sk Slovak pl Polish sv Swedish hi Hindi bg Bulgarian ro Romanian ar Arabic cs Czech da Danish ta Tamil hun Hungarian vi Vietnamese no Norwegian yue Cantonese th Thai he Hebrew ca Catalan nn Nynorsk af Afrikaans fa Persian sl Slovenian
Labels	Array of String	No	Tag.
Scenes	Array of String	No	Scenario.

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	Type. Valid values: loudNorm: loudness normalization gainControl: reduce abrupt change Default value: loudNorm.

WatermarkInput

Watermark parameter type in the MPS 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 custom scenarios. We recommend you prioritize using Definition to specify watermark parameters. Watermark custom parameters do not support watermarking screenshots.
TextContent	String	No	Text content, not exceeding 100 characters in length. 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), a watermark appears at second n after a video starts; If the value is less than 0 (assuming -n), a watermark appears n seconds before the end of a video. Note: This parameter only applies to video scenes. Screenshots do not support it.
EndTimeOffset	Float	No	End time offset of a watermark. Unit: second. If not specified or set to 0, the watermark lasts until the end of the video. If the value is greater than 0 (assuming n), the watermark disappears at second n. If the value is less than 0 (assuming -n), the watermark disappears n seconds before the end of the video. Note: Only used for video scenes. Screenshots do not support it.

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 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	Returns a non-zero error code when a source error occurs. If 0 is returned, use the ErrCode of each specific task.
Message	String	Returns the corresponding error Message when a source error occurs. Otherwise, use the Message of each specific task.
InputInfo	MediaInputInfo	Target file information of media processing.
MetaData	MediaMetaData	Metadata of the original video.
MediaProcessResultSet	Array of MediaProcessTaskResult	Execution status and result of the media processing task.
AiContentReviewResultSet	Array of AiContentReviewResult	Execution status and results of the video content review task.
AiAnalysisResultSet	Array of AiAnalysisResult	Execution status and results of the video content analysis task.
AiRecognitionResultSet	Array of AiRecognitionResult	Execution status and results of the video content recognition task.
AiQualityControlTaskResult	ScheduleQualityControlTaskResult	Execution status and results of a media quality inspection task.
SmartSubtitlesTaskResult	Array of SmartSubtitlesResult	Execution result of the smart subtitle task
SmartEraseTaskResult	SmartEraseTaskResult	Outcome of the intelligent erasure task
AiDubbingTaskResult	AIDubbingTaskResult	Outcome of the AI dubbing task.

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.