tencent cloud

AIAnalysisTemplateItem

AI-based intelligent analysis template details

Used by actions: DescribeAIAnalysisTemplates.

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

AIRecognitionTemplateItem

Video content recognition template details

Used by actions: DescribeAIRecognitionTemplates.

Name	Type	Description
Definition	Integer	Unique ID of video content recognition template.
Name	String	Video content recognition template name.
Comment	String	Video content recognition template description.
HeadTailConfigure	HeadTailConfigureInfo	Control parameter of opening and closing credits recognition. Note: this field may return null, indicating that no valid values can be obtained.
SegmentConfigure	SegmentConfigureInfo	Control parameter of splitting recognition. Note: this field may return null, indicating that no valid values can be obtained.
FaceConfigure	FaceConfigureInfo	Face recognition control parameter. Note: this field may return null, indicating that no valid values can be obtained.
OcrFullTextConfigure	OcrFullTextConfigureInfo	Full text recognition control parameter. Note: this field may return null, indicating that no valid values can be obtained.
OcrWordsConfigure	OcrWordsConfigureInfo	Text keyword recognition control parameter. Note: this field may return null, indicating that no valid values can be obtained.
AsrFullTextConfigure	AsrFullTextConfigureInfo	Full speech recognition control parameter. Note: this field may return null, indicating that no valid values can be obtained.
AsrWordsConfigure	AsrWordsConfigureInfo	Speech keyword recognition control parameter. Note: this field may return null, indicating that no valid values can be obtained.
ObjectConfigure	ObjectConfigureInfo	Control parameter of object recognition. Note: this field may return null, indicating that no valid values can be obtained.
ScreenshotInterval	Float	Screencapturing interval in seconds.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

AccelerateAreaInfo

Acceleration region information of the domain name

Used by actions: DescribeVodDomains.

Name	Type	Description
Area	String	Acceleration region. Valid values: Chinese Mainland Outside Chinese Mainland
TencentDisableReason	String	Reason why acceleration is disabled by Tencent Cloud. Valid values: ForLegalReasons: legal reasons ForOverdueBills: overdue payment
TencentEdgeDomain	String	CNAME of the acceleration domain name

AdaptiveDynamicStreamingInfoItem

Adaptive bitrate streaming information

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Required	Description
Definition	Integer	Yes	Adaptive bitrate streaming specification.
Package	String	Yes	Container format. Valid values: hls, dash.
DrmType	String	Yes	Encryption type.
Url	String	Yes	Playback address.
Size	Integer	No	File size (bytes) If the file is an HLS file, the value of this parameter is the sum of the size of the M3U8 and TS files. If the file is a DASH file, the value of this parameter is the sum of the size of the MPD and segment files. Note: For adaptive bitrate streaming files generated before 2022-01-10T16:00:00Z, the value of this parameter is 0.

AdaptiveDynamicStreamingTaskInput

Input parameter type of adaptive bitrate streaming

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Adaptive bitrate streaming template ID.
WatermarkSet	Array of WatermarkInput	No	List of up to 10 image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
SubtitleSet	Array of String	No	List of subtitle IDs (maximum: 16)

AdaptiveDynamicStreamingTemplate

Details of a transcoding to adaptive bitrate streaming template

Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a transcoding to adaptive bitrate streaming template.
Type	String	Template type. Valid values: Preset: preset template; Custom: custom template.
Name	String	Name of a transcoding to adaptive bitrate streaming template.
Comment	String	Description of a transcoding to adaptive bitrate streaming template.
Format	String	Adaptive bitstream format. Valid value: HLS.
DrmType	String	DRM type. Valid values: FairPlay; SimpleAES; Widevine. If this field is a blank string, DRM will not be performed on the video.
StreamInfos	Array of AdaptiveStreamTemplate	Parameter information of input stream for adaptive bitrate streaming. Up to 10 streams can be input.
DisableHigherVideoBitrate	Integer	Whether to prohibit transcoding from low bitrate to high bitrate. Valid values: 0: no, 1: yes.
DisableHigherVideoResolution	Integer	Whether to prohibit transcoding from low resolution to high resolution. Valid values: 0: no, 1: yes.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

AdaptiveStreamTemplate

Adaptive bitrate streaming parameter template

Used by actions: CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name	Type	Required	Description
Video	VideoTemplateInfo	Yes	Video parameter information.
Audio	AudioTemplateInfo	Yes	Audio parameter information.
RemoveAudio	Integer	No	Whether to remove audio stream. Valid values: 0: no, 1: yes.
RemoveVideo	Integer	No	Whether to remove a video stream. Valid values: 0: no 1: yes
TEHDConfig	TEHDConfig	No	TESHD transcoding parameters Note: This field may return null, indicating that no valid value was found.

AiAnalysisResult

Intelligent analysis result

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Type	String	Task type. Valid values: Classification: intelligent categorization Cover: intelligent cover generating Tag: intelligent tagging FrameTag: intelligent frame tagging Highlight: intelligent highlight generating
ClassificationTask	AiAnalysisTaskClassificationResult	Query result of intelligent categorization task in video content analysis, which is valid if task type is Classification. Note: this field may return null, indicating that no valid values can be obtained.
CoverTask	AiAnalysisTaskCoverResult	Query result of intelligent cover generating task in video content analysis, which is valid if task type is Cover. Note: this field may return null, indicating that no valid values can be obtained.
TagTask	AiAnalysisTaskTagResult	Query result of intelligent tagging task in video content analysis, which is valid if task type is Tag. Note: this field may return null, indicating that no valid values can be obtained.
FrameTagTask	AiAnalysisTaskFrameTagResult	Query result of intelligent frame-specific tagging task in video content analysis, which is valid if task type is FrameTag. Note: this field may return null, indicating that no valid values can be obtained.
HighlightTask	AiAnalysisTaskHighlightResult	Query result of an intelligent highlight generating task in video content analysis, which is valid when task type is Highlight. Note: this field may return null, indicating that no valid values can be obtained.

AiAnalysisTaskClassificationInput

Input type of intelligent categorization task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Intelligent video categorization template ID.

AiAnalysisTaskClassificationOutput

Result information of intelligent categorization

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ClassificationSet	Array of MediaAiAnalysisClassificationItem	List of intelligently generated video categories Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by ClassificationSetFileUrl.
ClassificationSetFileUrl	String	URL to the file for intelligently generated video categories. The file is in JSON format and has the same data structure as ClassificationSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by ClassificationSetFileUrlExpireTime.
ClassificationSetFileUrlExpireTime	String	Expiration time of the URL to the file for intelligently generated video categories, in ISO date format

AiAnalysisTaskClassificationResult

Result type of intelligent categorization task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiAnalysisTaskClassificationInput	Input of intelligent categorization task.
Output	AiAnalysisTaskClassificationOutput	Output of intelligent categorization task. Note: this field may return null, indicating that no valid values can be obtained.

AiAnalysisTaskCoverInput

Input type of intelligent categorization task

Used by actions: DescribeTaskDetail, PullEvents.

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

AiAnalysisTaskCoverOutput

Result information of intelligent cover generating

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
CoverSet	Array of MediaAiAnalysisCoverItem	List of intelligently generated thumbnails Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by CoverSetFileUrl.
CoverSetFileUrl	String	URL to the file for intelligently generated thumbnails. The file is in JSON format and has the same data structure as CoverSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by CoverSetFileUrlExpireTime.
CoverSetFileUrlExpireTime	String	Expiration time of the URL to the file for intelligently generated thumbnails, in ISO date format

AiAnalysisTaskCoverResult

Result type of intelligent cover generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiAnalysisTaskCoverInput	Input of intelligent cover generating task.
Output	AiAnalysisTaskCoverOutput	Output of intelligent cover generating task. Note: this field may return null, indicating that no valid values can be obtained.

AiAnalysisTaskFrameTagInput

Input type of intelligent frame-specific tagging task

Used by actions: DescribeTaskDetail, PullEvents.

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

AiAnalysisTaskFrameTagOutput

Result information of intelligent frame-specific tagging

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
SegmentSet	Array of MediaAiAnalysisFrameTagSegmentItem	List of frame-specific video tags Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for frame-specific video tags. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for frame-specific video tags, in ISO date format

AiAnalysisTaskFrameTagResult

Result type of intelligent frame-specific tagging

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiAnalysisTaskFrameTagInput	Input of intelligent frame-specific tagging task.
Output	AiAnalysisTaskFrameTagOutput	Output of intelligent frame-specific tagging task. Note: this field may return null, indicating that no valid values can be obtained.

AiAnalysisTaskHighlightInput

Input type of an intelligent highlight generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of an intelligent highlight generating template.

AiAnalysisTaskHighlightOutput

Information of the intelligent highlight generating result

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
HighlightSet	Array of MediaAiAnalysisHighlightItem	List of intelligently generated highlights Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by HighlightSetFileUrl.
HighlightSetFileUrl	String	URL to the file for intelligently generated highlights. The file is in JSON format and has the same data structure as HighlightSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by HighlightSetFileUrlExpireTime.
HighlightSetFileUrlExpireTime	String	Expiration time of the URL to the file for intelligently generated highlights, in ISO date format

AiAnalysisTaskHighlightResult

Result type of an intelligent highlight generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiAnalysisTaskHighlightInput	Input for an intelligent highlight generating task.
Output	AiAnalysisTaskHighlightOutput	Output of an intelligent highlight generating task. Note: This field may return null, indicating that no valid values can be obtained.

AiAnalysisTaskInput

Input parameter type of AI-based intelligent video analysis

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

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

AiAnalysisTaskTagInput

Input type of intelligent tagging task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Intelligent video tagging template ID.

AiAnalysisTaskTagOutput

Result information of intelligent tagging

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TagSet	Array of MediaAiAnalysisTagItem	List of intelligently generated video tags Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by TagSetFileUrl.
TagSetFileUrl	String	URL to the file for intelligently generated video tags. The file is in JSON format and has the same data structure as TagSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by TagSetFileUrlExpireTime.
TagSetFileUrlExpireTime	String	Expiration time of the URL to the file for intelligently generated video tags, in ISO date format

AiAnalysisTaskTagResult

Result type of intelligent tagging task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiAnalysisTaskTagInput	Input of intelligent tagging task.
Output	AiAnalysisTaskTagOutput	Output of intelligent tagging task. Note: this field may return null, indicating that no valid values can be obtained.

AiContentReviewResult

Intelligent recognition result

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Type	String	Task type. Valid values: Porn: porn information recognition in images Terrorism: terrorism information recognition in images Political: politically sensitive information recognition in images Porn.Asr: ASR-based porn information recognition in speech Porn.Ocr: OCR-based porn information recognition in text Political.Asr: ASR-based politically sensitive information recognition in speech Political.Ocr: OCR-based politically sensitive information recognition in text Terrorism.Ocr: OCR-based terrorism information recognition in text Prohibited.Asr: ASR-based prohibited information recognition in speech Prohibited.Ocr: OCR-based prohibited information recognition in text
PornTask	AiReviewTaskPornResult	Result for intelligent recognition of pornographic content in images. This parameter is valid when Type is Porn. Note: This field may return null, indicating that no valid value can be found.
TerrorismTask	AiReviewTaskTerrorismResult	Result for intelligent recognition of terrorism content in images. This parameter is valid when Type is Terrorism. Note: This field may return null, indicating that no valid value can be found.
PoliticalTask	AiReviewTaskPoliticalResult	Result for intelligent recognition of politically sensitive content in images. This parameter is valid when Type is Political. Note: This field may return null, indicating that no valid value can be found.
PornAsrTask	AiReviewTaskPornAsrResult	Result for ASR-based recognition of pornographic content. This parameter is valid when Type is Porn.Asr. Note: This field may return null, indicating that no valid value can be found.
PornOcrTask	AiReviewTaskPornOcrResult	Result for OCR-based recognition of pornographic content. This parameter is valid when Type is Porn.Ocr. Note: This field may return null, indicating that no valid value can be found.
PoliticalAsrTask	AiReviewTaskPoliticalAsrResult	Result for ASR-based recognition of politically sensitive content. This parameter is valid when Type is Political.Asr. Note: This field may return null, indicating that no valid value can be found.
PoliticalOcrTask	AiReviewTaskPoliticalOcrResult	Result for OCR-based recognition of politically sensitive content. This parameter is valid when Type is Political.Ocr. Note: This field may return null, indicating that no valid value can be found.
TerrorismOcrTask	AiReviewTaskTerrorismOcrResult	Result for OCR-based recognition of terrorism content. This parameter is valid when Type is Terrorism.Ocr. Note: This field may return null, indicating that no valid value can be found.
ProhibitedOcrTask	AiReviewTaskProhibitedOcrResult	Result for OCR-based recognition of banned content. This parameter is valid when Type is Prohibited.Ocr. Note: This field may return null, indicating that no valid value can be found.
ProhibitedAsrTask	AiReviewTaskProhibitedAsrResult	Result for ASR-based recognition of banned content. This parameter is valid when Type is Prohibited.Asr. Note: This field may return null, indicating that no valid value can be found.

AiContentReviewTaskInput

Type of intelligent recognition task

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

Name	Type	Required	Description
Definition	Integer	Yes	Intelligent recognition template ID

AiRecognitionResult

Intelligent recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Type	String	Task type. Valid values: FaceRecognition: face recognition, AsrWordsRecognition: speech keyword recognition, OcrWordsRecognition: text keyword recognition, AsrFullTextRecognition: full speech recognition, OcrFullTextRecognition: full text recognition, HeadTailRecognition: video opening and ending credits recognition, ObjectRecognition: object recognition.
HeadTailTask	AiRecognitionTaskHeadTailResult	Video opening and ending credits recognition result, which is valid when Type is HeadTailRecognition. Note: this field may return null, indicating that no valid values can be obtained.
SegmentTask	AiRecognitionTaskSegmentResult	Video splitting recognition result, which is valid when Type is SegmentRecognition. Note: this field may return null, indicating that no valid values can be obtained.
FaceTask	AiRecognitionTaskFaceResult	Face recognition result, which is valid when Type is FaceRecognition. Note: this field may return null, indicating that no valid values can be obtained.
AsrWordsTask	AiRecognitionTaskAsrWordsResult	Speech keyword recognition result, which is valid when Type is AsrWordsRecognition. Note: this field may return null, indicating that no valid values can be obtained.
AsrFullTextTask	AiRecognitionTaskAsrFullTextResult	Full speech recognition result, which is valid when Type is AsrFullTextRecognition. Note: this field may return null, indicating that no valid values can be obtained.
OcrWordsTask	AiRecognitionTaskOcrWordsResult	Text keyword recognition result, which is valid when Type is OcrWordsRecognition. Note: this field may return null, indicating that no valid values can be obtained.
OcrFullTextTask	AiRecognitionTaskOcrFullTextResult	Full text recognition result, which is valid when Type is OcrFullTextRecognition. Note: this field may return null, indicating that no valid values can be obtained.
ObjectTask	AiRecognitionTaskObjectResult	Object recognition result, which is valid when Type is ObjectRecognition. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskAsrFullTextResult

Full speech recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskAsrFullTextResultInput	Input information of full speech recognition task.
Output	AiRecognitionTaskAsrFullTextResultOutput	Output information of full speech recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskAsrFullTextResultInput

Input of full speech recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Full speech recognition template ID.

AiRecognitionTaskAsrFullTextResultOutput

Full speech recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
SegmentSet	Array of AiRecognitionTaskAsrFullTextSegmentItem	List of full-text speech recognition segments Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file of the list for full-text speech recognition segments. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file of the list for full-text speech recognition segments, in ISO date format
SubtitleUrl	String	Subtitles file URL.

AiRecognitionTaskAsrFullTextSegmentItem

Full speech recognition segment.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskAsrWordsResult

Speech keyword recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskAsrWordsResultInput	Input information of speech keyword recognition task.
Output	AiRecognitionTaskAsrWordsResultOutput	Output information of speech keyword recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskAsrWordsResultInput

Input of speech keyword recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Speech keyword recognition template ID.

AiRecognitionTaskAsrWordsResultItem

Speech keyword recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Word	String	Speech keyword.
SegmentSet	Array of AiRecognitionTaskAsrWordsSegmentItem	List of time segments that contain the speech keyword.

AiRecognitionTaskAsrWordsResultOutput

Output of speech keyword recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ResultSet	Array of AiRecognitionTaskAsrWordsResultItem	Speech keyword recognition result set Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
ResultSetFileUrl	String	URL to the file of the speech keyword recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
ResultSetFileUrlExpireTime	String	Expiration time of the URL to the file of the speech keyword recognition result set, in ISO date format

AiRecognitionTaskAsrWordsSegmentItem

Speech recognition segment.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskFaceResult

Face recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskFaceResultInput	Input information of face recognition task.
Output	AiRecognitionTaskFaceResultOutput	Output information of face recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskFaceResultInput

Face recognition input.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Face recognition template ID.

AiRecognitionTaskFaceResultItem

Face recognition result

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Id	String	Unique ID of figure.
Type	String	Figure library type, indicating to which figure library the recognized figure belongs: Default: default figure library; UserDefine: custom figure library.
Name	String	Figure name.
SegmentSet	Array of AiRecognitionTaskFaceSegmentItem	Result set of segments that contain a figure.

AiRecognitionTaskFaceResultOutput

Output of intelligent face recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ResultSet	Array of AiRecognitionTaskFaceResultItem	Intelligent face recognition result set Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
ResultSetFileUrl	String	URL to the file of the intelligent face recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
ResultSetFileUrlExpireTime	String	Expiration time of the URL to the file of the intelligent face recognition result set, in ISO date format

AiRecognitionTaskFaceSegmentItem

Face recognition result segment

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskHeadTailResult

Video opening and ending credits recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskHeadTailResultInput	Input information of video opening and ending credits recognition task.
Output	AiRecognitionTaskHeadTailResultOutput	Output information of video opening and ending credits recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskHeadTailResultInput

Input of video opening and ending credits recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Video opening and ending credits recognition template ID.

AiRecognitionTaskHeadTailResultOutput

Output of video opening and ending credits recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
HeadConfidence	Float	Confidence of recognized opening credits. Value range: 0-100.
HeadTimeOffset	Float	End time point of video opening credits in seconds.
TailConfidence	Float	Confidence of recognized closing credits. Value range: 0-100.
TailTimeOffset	Float	Start time point of video closing credits in seconds.

AiRecognitionTaskInput

Input parameter type of video content recognition

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

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

AiRecognitionTaskObjectResult

Object recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskObjectResultInput	Input information of object recognition task.
Output	AiRecognitionTaskObjectResultOutput	Output information of object recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskObjectResultInput

Input type of object recognition task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Object recognition template ID.

AiRecognitionTaskObjectResultItem

Single-object recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskObjectResultOutput

Output of intelligent object recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ResultSet	Array of AiRecognitionTaskObjectResultItem	Intelligent object recognition result set Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
ResultSetFileUrl	String	URL to the file of the object recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
ResultSetFileUrlExpireTime	String	Expiration time of the URL to the object recognition result set, in ISO date format

AiRecognitionTaskObjectSeqmentItem

Object recognition result segment.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskOcrFullTextResult

Full text recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskOcrFullTextResultInput	Input information of full text recognition task.
Output	AiRecognitionTaskOcrFullTextResultOutput	Output information of full text recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskOcrFullTextResultInput

Input of full text recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Full text recognition template ID.

AiRecognitionTaskOcrFullTextResultOutput

Output of full text recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
SegmentSet	Array of AiRecognitionTaskOcrFullTextSegmentItem	Full-text recognition result set Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file of the full-text recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file of the full-text recognition result set, in ISO date format

AiRecognitionTaskOcrFullTextSegmentItem

Full text recognition segment.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskOcrFullTextSegmentTextItem

Full text recognition segment.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence of recognized segment. Value range: 0-100.
AreaCoordSet	Array of Integer	Zone coordinates of recognition result. The array contains four elements: [x1,y1,x2,y2], i.e., the horizontal and vertical coordinates of the top-left and bottom-right corners.
Text	String	Recognized text.

AiRecognitionTaskOcrWordsResult

Text keyword recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskOcrWordsResultInput	Input information of text keyword recognition task.
Output	AiRecognitionTaskOcrWordsResultOutput	Output information of text keyword recognition task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskOcrWordsResultInput

Input of text keyword recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Text keyword recognition template ID.

AiRecognitionTaskOcrWordsResultItem

Text keyword recognition result.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Word	String	Text keyword.
SegmentSet	Array of AiRecognitionTaskOcrWordsSegmentItem	List of segments that contain a text keyword.

AiRecognitionTaskOcrWordsResultOutput

Output of text keyword recognition.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ResultSet	Array of AiRecognitionTaskOcrWordsResultItem	Text keyword recognition result set Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
ResultSetFileUrl	String	URL to the file of the text keyword recognition result set. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
ResultSetFileUrlExpireTime	String	Expiration time of the URL to the file of the text keyword recognition result set, in ISO date format

AiRecognitionTaskOcrWordsSegmentItem

Text recognition segment.

Used by actions: DescribeTaskDetail, PullEvents.

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

AiRecognitionTaskSegmentResult

Video splitting results.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiRecognitionTaskSegmentResultInput	Input information of video splitting task. Note: this field may return null, indicating that no valid values can be obtained.
Output	AiRecognitionTaskSegmentResultOutput	Output information of video splitting task. Note: this field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskSegmentResultInput

Input of video splitting.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Video splitting template ID.

AiRecognitionTaskSegmentResultOutput

Output of video splitting.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
SegmentSet	Array of AiRecognitionTaskSegmentSegmentItem	List of split video segments Note: this list displays up to the first 100 results. You can get all the results from the file whose URL is SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file of the list for split video segments. The file format is JSON, and the data structure is the same as SegmentSet. The file will be deleted upon the expiration time SegmentSetFileUrlExpireTime, instead of being stored permanently.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file of the list for split video segments, in ISO date format

AiRecognitionTaskSegmentSegmentItem

Split video segment.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
FileId	String	File ID, which is valid only when a VOD file is processed and the subsegments generated through segmentation are also VOD files.
SegmentUrl	String	Split video segment URL.
Confidence	Float	Confidence of split segment. Value range: 0-100.
StartTimeOffset	Float	Start time offset of split segment in seconds.
EndTimeOffset	Float	End time offset of split segment in seconds.
CovImgUrl	String	Split cover image URL.
SpecialInfo	String	Special field, which should be ignored.

AiReviewPoliticalAsrTaskInput

Input parameters for ASR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of politically sensitive content

AiReviewPoliticalAsrTaskOutput

Output for ASR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the ASR-detected politically sensitive content. Value range: 0-100
Suggestion	String	Processing suggestion for the ASR-detected politically sensitive content. Valid values: pass review block
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments that contain ASR-detected politically sensitive content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain ASR-detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain ASR-detected politically sensitive content, in ISO date format

AiReviewPoliticalOcrTaskInput

Input parameters for OCR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of politically sensitive content

AiReviewPoliticalOcrTaskOutput

Output for OCR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the OCR-detected politically sensitive content. Value range: 0-100
Suggestion	String	Processing suggestion for the OCR-detected politically sensitive content. Valid values: pass review block
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments that contain OCR-detected politically sensitive content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain OCR-detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain OCR-detected politically sensitive content, in ISO date format

AiReviewPoliticalTaskInput

Input parameters for intelligent recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of politically sensitive content

AiReviewPoliticalTaskOutput

Output for intelligent recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the detected politically sensitive content. Value range: 0-100
Suggestion	String	Processing suggestion for the detected politically sensitive content pass review block
Label	String	Labels for the detected politically sensitive content. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows: violation_photo: violation_photo: banned images Other values (politician/entertainment/sport/entrepreneur/scholar/celebrity/military): politician: politically sensitive people
SegmentSet	Array of MediaContentReviewPoliticalSegmentItem	List of video segments that contain detected politically sensitive content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain detected politically sensitive content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain politically sensitive content, in ISO date format

AiReviewPornAsrTaskInput

Input parameters for ASR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of pornographic content

AiReviewPornAsrTaskOutput

Output for ASR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the ASR-detected pornographic content
Suggestion	String	Processing suggestion for the ASR-detected pornographic content pass review block
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments that contain ASR-detected pornographic content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain ASR-detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain ASR-detected pornographic content, in ISO date format

AiReviewPornOcrTaskInput

Input parameters for OCR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of pornographic content

AiReviewPornOcrTaskOutput

Output for OCR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the OCR-detected pornographic content
Suggestion	String	Processing suggestion for the OCR-detected pornographic content pass review block
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments that contain OCR-detected pornographic content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain OCR-detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain OCR-detected pornographic content, in ISO date format

AiReviewPornTaskInput

Input parameters for intelligent recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
Definition	Integer	Yes	ID of the template for recognition of pornographic content

AiReviewPornTaskOutput

Output for intelligent recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the detected pornographic content. Value range: 0-100
Suggestion	String	Processing suggestion for the detected pornographic content. Valid values: pass review block
Label	String	Labels for the detected pornographic content. Valid values: porn sexy vulgar intimacy
SegmentSet	Array of MediaContentReviewSegmentItem	List of video segments that contain detected pornographic content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain detected pornographic content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain detected pornographic content, in ISO date format

AiReviewProhibitedAsrTaskInput

Input parameters for ASR-based recognition of banned content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Prohibited information detection template ID.

AiReviewProhibitedAsrTaskOutput

ASR-detected prohibited information in speech

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Score of ASR-detected prohibited information in speech between 0 and 100.
Suggestion	String	Suggestion for ASR-detected prohibited information in speech. Valid values: pass. review. block.
SegmentSet	Array of MediaContentReviewAsrTextSegmentItem	List of video segments that contain ASR-detected prohibited information Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain ASR-detected prohibited information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain ASR-detected prohibited information, in ISO date format

AiReviewProhibitedOcrTaskInput

Input parameters for OCR-based recognition of banned content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	Prohibited information detection template ID.

AiReviewProhibitedOcrTaskOutput

OCR-detected prohibited information in text

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Score of OCR-detected prohibited information in text between 0 and 100.
Suggestion	String	Suggestion for OCR-detected prohibited information in text. Valid values: pass. review. block.
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments that contain OCR-detected prohibited information Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain OCR-detected prohibited information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL for video segments that contain OCR-detected prohibited information, in ISO date format

AiReviewTaskPoliticalAsrResult

Result for ASR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPoliticalAsrTaskInput	Input for ASR-based recognition of politically sensitive content
Output	AiReviewPoliticalAsrTaskOutput	Output for ASR-based recognition of politically sensitive content

AiReviewTaskPoliticalOcrResult

Result for OCR-based recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPoliticalOcrTaskInput	Input for OCR-based recognition of politically sensitive content
Output	AiReviewPoliticalOcrTaskOutput	Output for OCR-based recognition of politically sensitive content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskPoliticalResult

Result for intelligent recognition of politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPoliticalTaskInput	Input for intelligent recognition of politically sensitive content
Output	AiReviewPoliticalTaskOutput	Output for intelligent recognition of politically sensitive content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskPornAsrResult

Result for ASR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPornAsrTaskInput	Input for ASR-based recognition of pornographic content
Output	AiReviewPornAsrTaskOutput	Output for ASR-based recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskPornOcrResult

Result for OCR-based recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPornOcrTaskInput	Input for OCR-based recognition of pornographic content
Output	AiReviewPornOcrTaskOutput	Output for OCR-based recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskPornResult

Result for intelligent recognition of pornographic content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewPornTaskInput	Input for intelligent recognition of pornographic content
Output	AiReviewPornTaskOutput	Output for intelligent recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskProhibitedAsrResult

Result for ASR-based recognition of banned content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiReviewProhibitedAsrTaskInput	Input for ASR-based recognition of banned content
Output	AiReviewProhibitedAsrTaskOutput	Output for ASR-based recognition of banned content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskProhibitedOcrResult

Result for OCR-based recognition of banned content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiReviewProhibitedOcrTaskInput	Input for OCR-based recognition of banned content
Output	AiReviewProhibitedOcrTaskOutput	Output for OCR-based recognition of banned content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskTerrorismOcrResult

Result for OCR-based recognition of terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AiReviewTerrorismOcrTaskInput	Input for OCR-based recognition of terrorism content
Output	AiReviewTerrorismOcrTaskOutput	Output for OCR-based recognition of terrorism content Note: This field may return null, indicating that no valid value can be found.

AiReviewTaskTerrorismResult

Result for intelligent recognition of terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AiReviewTerrorismTaskInput	Input for intelligent recognition of terrorism content
Output	AiReviewTerrorismTaskOutput	Output for intelligent recognition of terrorism content Note: This field may return null, indicating that no valid value can be found.

AiReviewTerrorismOcrTaskInput

Input parameters for OCR-based recognition of terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of terrorism content

AiReviewTerrorismOcrTaskOutput

Output for OCR-based recognition of terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence score for the OCR-detected terrorism content. Value range: 0-100
Suggestion	String	Processing suggestion for the OCR-detected terrorism content pass review block
SegmentSet	Array of MediaContentReviewOcrTextSegmentItem	List of video segments that contain OCR-detected terrorism content Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain OCR-detected terrorism content. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain OCR-detected terrorism content, in ISO date format

AiReviewTerrorismTaskInput

Input parameters for intelligent recognition of terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Definition	Integer	ID of the template for recognition of terrorism content

AiReviewTerrorismTaskOutput

Terrorism information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Score of detected terrorism information in a video between 0 and 100. Note: this field may return null, indicating that no valid values can be obtained.
Suggestion	String	Suggestion for detected terrorism information. Valid values: pass. review. block. Note: this field may return null, indicating that no valid values can be obtained.
Label	String	Tag of the detected terrorism information in a video. Valid values: guns: weapons and guns crowd: crowds police: police forces bloody: bloody images banners: terrorism flags militant: militants explosion: explosions and fires terrorists: terrorists scenario: terrorism images
SegmentSet	Array of MediaContentReviewSegmentItem	List of video segments that contain terrorism information Note: This list displays the first 100 results at most. You can get all the results from the file at the URL specified by SegmentSetFileUrl.
SegmentSetFileUrl	String	URL to the file for video segments that contain terrorism information. The file is in JSON format and has the same data structure as SegmentSet. Instead of being saved permanently, the file is deleted upon the expiration time specified by SegmentSetFileUrlExpireTime.
SegmentSetFileUrlExpireTime	String	Expiration time of the URL to the file for video segments that contain terrorism information, in ISO date format

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, which is required if Type is delete.
FaceContents	Array of String	No	String set generated by Base64-encoding the face image. This field is required if 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 failed to be processed.

Used by actions: CreatePersonSample, ModifyPersonSample.

Name	Type	Description
Index	Integer	It corresponds to incorrect image subscripts in the FaceContents input parameter, starting from 0.
ErrCode	Integer	Error code. Valid values: 0: success; Other values: failure.
Message	String	Error message.

AiSamplePerson

AI-based sample management - figure information.

Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

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

AiSampleTagOperation

AI-based sample management - tag operation.

Used by actions: ModifyPersonSample, ModifyWordSample.

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

AiSampleWord

AI-based sample management - keyword output information.

Used by actions: DescribeWordSamples.

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

AiSampleWordInfo

AI-based sample management - keyword input information.

Used by actions: CreateWordSamples.

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

AnimatedGraphicTaskInput

Animated image generating task type

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Animated image generating template ID
StartTimeOffset	Float	Yes	Start time offset of an animated image in the video, in seconds. If this parameter is left empty or set to 0, the animated image will start at the same time as the video. If this parameter is set to a positive number (n for example), the animated image will start at the nth second of the video. If this parameter is set to a negative number (-n for example), the animated image will start at the nth second before the end of the video.
EndTimeOffset	Float	Yes	End time offset of an animated image in the video, in seconds. If this parameter is left empty or set to 0, the animated image will end at the same time as the video. If this parameter is set to a positive number (n for example), the animated image will end at the nth second of the video. If this parameter is set to a negative number (-n for example), the animated image will end at the nth second before the end of the video.

AnimatedGraphicsTemplate

Details of an animated image generating template.

Used by actions: DescribeAnimatedGraphicsTemplates.

Name	Type	Description
Definition	Integer	Unique ID of an animated image generating template.
Type	String	Template type. Valid values: Preset: preset template; Custom: custom template.
Name	String	Name of an animated image generating template.
Comment	String	Description of an animated image generating template.
Width	Integer	Maximum value of the width (or long side) of an animated image in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
Height	Integer	Maximum value of the height (or short side) of an animated image in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
ResolutionAdaptive	String	Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height. Default value: open.
Format	String	Animated image format.
Fps	Integer	Frame rate.
Quality	Float	Image quality.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

AsrFullTextConfigureInfo

Control parameter of full speech recognition task.

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

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

AsrFullTextConfigureInfoForUpdate

Control parameter of full speech recognition task.

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of full speech recognition task. Valid values: ON: enables intelligent full speech recognition task; OFF: disables intelligent full speech recognition task.
SubtitleFormat	String	No	Format of generated subtitles file. If an empty string is entered, no subtitles files will be generated. Valid values: vtt: generates a WebVTT subtitles file.

AsrWordsConfigureInfo

Speech keyword recognition control parameter.

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

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

AsrWordsConfigureInfoForUpdate

Control parameter of speech keyword recognition.

Used by actions: ModifyAIRecognitionTemplate.

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

AudioTemplateInfo

Audio stream configuration parameter

Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name	Type	Required	Description
Codec	String	Yes	Audio stream encoder. When the outer Container parameter is mp3, the valid value is: libmp3lame. When the outer Container parameter is ogg or flac, the valid value is: flac. When the outer Container parameter is m4a, the valid values include: libfdk_aac; libmp3lame; ac3. When the outer Container parameter is mp4 or flv, the valid values include: libfdk_aac: more suitable for mp4; libmp3lame: More suitable for flv; mp2. When the outer Container parameter is hls, the valid values include: libfdk_aac; libmp3lame.
Bitrate	Integer	Yes	Audio stream bitrate in Kbps. Value range: 0 and [26, 256]. If the value is 0, the bitrate of the audio stream will be the same as that of the original audio.
SampleRate	Integer	Yes	Audio stream sample rate. Valid values: 32,000 44,100 48,000 In Hz.
AudioChannel	Integer	No	Audio channel system. Valid values: 1: mono-channel 2: dual-channel 6: stereo You cannot set the sound channel as stereo for media files in container formats for audios (FLAC, OGG, MP3, M4A). Default value: 2

AudioTemplateInfoForUpdate

Audio stream configuration parameter

Used by actions: ModifyTranscodeTemplate.

Name	Type	Required	Description
Codec	String	No	Audio stream encoder. When the outer Container parameter is mp3, the valid value is: libmp3lame. When the outer Container parameter is ogg or flac, the valid value is: flac. When the outer Container parameter is m4a, the valid values include: libfdk_aac; libmp3lame; ac3. When the outer Container parameter is mp4 or flv, the valid values include: libfdk_aac: more suitable for mp4; libmp3lame: More suitable for flv; mp2. When the outer Container parameter is hls, the valid values include: libfdk_aac; libmp3lame.
Bitrate	Integer	No	Audio stream bitrate in Kbps. Value range: 0 and [26, 256]. If the value is 0, the bitrate of the audio stream will be the same as that of the original audio.
SampleRate	Integer	No	Audio stream sample rate. Valid values: 32,000 44,100 48,000 In Hz.
AudioChannel	Integer	No	Audio channel system. Valid values: 1: mono-channel 2: dual-channel 6: stereo You cannot set the sound channel as stereo for media files in container formats for audios (FLAC, OGG, MP3, M4A).

AudioTrackItem

Audio segment information of audio track.

Used by actions: ComposeMedia.

Name	Type	Required	Description
SourceMedia	String	Yes	Source of media material for audio segment, which can be: ID of VOD media files Download URL of other media files Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
SourceMediaStartTime	Float	No	Start time of audio segment in material file in seconds. Default value: 0, which means to start capturing from the beginning position of the material.
Duration	Float	No	Audio segment duration in seconds. By default, the length of the material will be used, which means that the entire material will be captured.
AudioOperations	Array of AudioTransform	No	Operation on audio segment, such as volume adjustment. Note: this field may return null, indicating that no valid values can be obtained.

AudioTransform

Audio operation

Used by actions: ComposeMedia.

Name	Type	Required	Description
Type	String	Yes	Audio operation type. Valid values: Volume: volume adjustment.
VolumeParam	AudioVolumeParam	No	Volume adjustment parameter, which is valid if Type is Volume. Note: this field may return null, indicating that no valid values can be obtained.

AudioVolumeParam

Audio gain adjustment parameter

Used by actions: ComposeMedia.

Name	Type	Required	Description
Mute	Integer	No	Whether to mute. Valid values: 0, 1. 0: not muted. 1: muted. Default value: 0.
Gain	Float	No	Audio gain. Value range: 0-10. If the value is greater than 1, the volume will be increased. If the value is smaller than 1, the volume will be decreased. 0 and 1: no change. Default value: 0.

Canvas

Canvas information. When a video is composed, if the source material (video or image) cannot fill the output video window, the background will be drawn with the set canvas.

Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
Color	String	No	Background color. Valid values: Black: black background White: white background Default value: Black.
Width	Integer	No	Canvas width, which is the width of the output video. Value range: 0-4096 px. Default value: 0, which means that the value is the same as the video width of the first video segment in the first video track.
Height	Integer	No	Canvas height, which is the height (or long side) of the output video. Value range: 0-4096 px. Default value: 0, which means that the value is the same as the video height of the first video segment in the first video track.

CdnLogInfo

CDN log information

Used by actions: DescribeCdnLogs.

Name	Type	Description
Date	String	Log date in the format of yyyy-MM-dd, such as 2018-03-01.
Name	String	Log name in the format of date and time-domain name, such as 2018120101-test.vod2.mqcloud.com.
Url	String	Log download link, which is valid for 24 hours.
StartTime	String	Log start time in ISO date format
EndTime	String	Log end time in ISO date format

ClassificationConfigureInfo

Control parameter of intelligent categorization task

Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

ClassificationConfigureInfoForUpdate

Control parameter of intelligent categorization task

Used by actions: ModifyAIAnalysisTemplate.

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

ClipFileInfo2017

Information of file generated by video clipping (v2017)

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error description. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	Output target file ID. Note: this field may return null, indicating that no valid values can be obtained.
FileUrl	String	Output target file address. Note: this field may return null, indicating that no valid values can be obtained.
FileType	String	Output target file type. Note: this field may return null, indicating that no valid values can be obtained.

ClipTask2017

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

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Video clipping task ID.
SrcFileId	String	ID of source file for video clipping task.
FileInfo	ClipFileInfo2017	Information of file output by video clipping.

ComposeMediaOutput

Information of output media file.

Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
FileName	String	Yes	Filename of up to 64 characters.
Description	String	No	Description, which can contain up to 128 characters.
ClassId	Integer	No	Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API. Default value: 0, which means "Other".
ExpireTime	String	No	Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format.
Container	String	No	Container. Valid values: mp4, mp3. mp3 is for audio files.
VideoStream	OutputVideoStream	No	Information of output video. Note: this field may return null, indicating that no valid values can be obtained.
AudioStream	OutputAudioStream	No	Information of output audio. Note: this field may return null, indicating that no valid values can be obtained.
RemoveVideo	Integer	No	Whether to remove video data. Valid values: 0: retain 1: remove Default value: 0.
RemoveAudio	Integer	No	Whether to remove audio data. Valid values: 0: retain 1: remove Default value: 0.

ComposeMediaTask

Media file composing task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task flow status. Valid values: PROCESSING: processing; FINISH: completed. Note: this field may return null, indicating that no valid values can be obtained.
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Progress	Integer	Progress of a media file composing task. Value range: [0, 100]
Input	ComposeMediaTaskInput	Input of media file composing task. Note: this field may return null, indicating that no valid values can be obtained.
Output	ComposeMediaTaskOutput	Output of media file composing task. Note: this field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	The metadata of the output video. Note: This field may return null, indicating that no valid value was found.
SessionId	String	ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is not carried or is left empty, no deduplication will be performed.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this parameter. It can contain up to 1000 characters.

ComposeMediaTaskInput

Input of media file composing task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Tracks	Array of MediaTrack	List of input media tracks, i.e., information of multiple tracks composed of video, audio, image, and other materials.
Canvas	Canvas	Canvas used for composing video file. Note: this field may return null, indicating that no valid values can be obtained.
Output	ComposeMediaOutput	Information of output media file.

ComposeMediaTaskOutput

Output of media file composing task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
FileType	String	File type, such as mp4 and mp3.
FileId	String	Media file ID.
FileUrl	String	Media file playback address.
MediaName	String	Filename of up to 64 characters.
ClassId	Integer	Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API. Default value: 0, which means "Other".
ExpireTime	String	Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format.

ConcatFileInfo2017

Information of source file for video splicing (v2017)

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	ID of source file for video splicing. Note: this field may return null, indicating that no valid values can be obtained.
FileUrl	String	Address of source file for video splicing. Note: this field may return null, indicating that no valid values can be obtained.
FileType	String	Format of source file for video splicing. Note: this field may return null, indicating that no valid values can be obtained.

ConcatTask2017

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

Used by actions: DescribeTaskDetail, PullEvents.

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

ContentReviewOcrResult

The result for OCR-based image recognition.

Used by actions: ProcessImage.

Name	Type	Description
Confidence	Float	The confidence score for the OCR-based recognition result. Value range: 0-100.
Suggestion	String	The suggestion for handling the suspicious content detected based on OCR. Valid values: pass/li> review block
KeywordSet	Array of String	The list of suspicious keywords detected based on OCR.
AreaCoordSet	Array of Integer	The coordinates (pixel) of the top-left and bottom-right corners of the frame where a suspicious keyword appears. Format: [x1, y1, x2, y2].

ContentReviewResult

The result for intelligent image recognition.

Used by actions: ProcessImage.

Name	Type	Description
Type	String	The result type. Valid values: Porn.Image: Recognition of pornographic content in the image Terrorism.Image: Recognition of terrorism content in the image Political.Image: Recognition of politically sensitive content in the image Porn.Ocr: OCR-based recognition of pornographic content in the image Terrorism.Ocr: OCR-based recognition of terrorism content in the image Political.Ocr: OCR-based recognition of politically sensitive content in the image
PornImageResult	PornImageResult	The pornographic content detected in the image. This parameter is valid if Type is Porn.Image. Note: This field may return null, indicating that no valid value was found.
TerrorismImageResult	TerrorismImageResult	The terrorism content detected in the image. This parameter is valid if Type is Terrorism.Image. Note: This field may return null, indicating that no valid value was found.
PoliticalImageResult	PoliticalImageResult	The politically sensitive content detected in the image. This parameter is valid if Type is Political.Image. Note: This field may return null, indicating that no valid value was found.
PornOcrResult	ContentReviewOcrResult	The pornographic content detected in the image based on OCR. This parameter is valid if Type is Porn.Ocr. Note: This field may return null, indicating that no valid value was found.
TerrorismOcrResult	ContentReviewOcrResult	The terrorism content detected in the image based on OCR. This parameter is valid if Type is Terrorism.Ocr. Note: This field may return null, indicating that no valid value was found.
PoliticalOcrResult	ContentReviewOcrResult	The politically sensitive content detected in the image based on OCR. This parameter is valid if Type is Political.Ocr. Note: This field may return null, indicating that no valid value was found.

ContentReviewTemplateItem

Intelligent recognition template details

Used by actions: DescribeContentReviewTemplates.

Name	Type	Description
Definition	Integer	Unique ID of an intelligent recognition template
Name	String	Name of an intelligent recognition template. Max 64 characters
Comment	String	Description of an intelligent recognition template. Max 256 characters
PornConfigure	PornConfigureInfo	Parameters for recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.
TerrorismConfigure	TerrorismConfigureInfo	Parameters for recognition of terrorism content Note: This field may return null, indicating that no valid value can be found.
PoliticalConfigure	PoliticalConfigureInfo	Parameters for recognition of politically sensitive content Note: This field may return null, indicating that no valid value can be found.
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 recognition parameters Note: This field may return null, indicating that no valid value can be found.
ReviewWallSwitch	String	Whether to subject the recognition result to human review ON OFF
ScreenshotInterval	Float	Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

CoverBySnapshotTaskInput

Input parameter type of cover generating task

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Time point screencapturing template ID.
PositionType	String	Yes	Screencapturing mode. Valid values: Time: screencaptures by time point Percent: screencaptures by percentage
PositionValue	Float	Yes	Screenshot position: For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
WatermarkSet	Array of WatermarkInput	No	List of up to 10 image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.

CoverBySnapshotTaskOutput

Output type of cover generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
CoverUrl	String	Cover URL.

CoverConfigureInfo

Control parameter of intelligent cover generating task

Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

CoverConfigureInfoForUpdate

Control parameter of intelligent cover generating task

Used by actions: ModifyAIAnalysisTemplate.

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

CreateImageSpriteTask2017

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

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Image sprite generating task ID.
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	ID of generated image sprite file. Note: this field may return null, indicating that no valid values can be obtained.
Definition	Integer	Image sprite specification. For more information, please see Image Sprite Generating Template. Note: this field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of subimages in image sprite. Note: this field may return null, indicating that no valid values can be obtained.
ImageSpriteUrlSet	Array of String	Address of output image sprite. Note: this field may return null, indicating that no valid values can be obtained.
WebVttUrl	String	Address of WebVtt file for the position-time relationship among subimages in an image sprite. Note: this field may return null, indicating that no valid values can be obtained.

DomainDetailInfo

Domain name information

Used by actions: DescribeVodDomains.

Name	Type	Description
Domain	String	Domain name
AccelerateAreaInfos	Array of AccelerateAreaInfo	Acceleration region information Note: this field may return null, indicating that no valid value is obtained.
DeployStatus	String	Deployment status. Valid values: Online Deploying Locked: you cannot change the deployment status of locked domain names
HTTPSConfig	DomainHTTPSConfig	HTTPS configuration information Note: this field may return null, indicating that no valid value is obtained.
UrlSignatureAuthPolicy	UrlSignatureAuthPolicy	Key hotlink protection configuration Note: this field may return null, indicating that no valid value is obtained.
RefererAuthPolicy	RefererAuthPolicy	Referer hotlink protection configuration Note: this field may return null, indicating that no valid value is obtained.
CreateTime	String	The time when the domain name was added in the VOD system The time is in ISO 8601 date format.

DomainHTTPSConfig

HTTPS configuration information of the domain name

Used by actions: DescribeVodDomains.

Name	Type	Required	Description
CertExpireTime	String	Yes	Time when the certificate expires The time is in ISO 8601 date format.

DrmStreamingsInfo

DRM-protected adaptive bitstream playback information

Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs.

Name	Type	Required	Description
SimpleAesDefinition	Integer	No	ID of the adaptive bitrate streaming template whose protection type is SimpleAES.
WidevineDefinition	Integer	No	The ID of the adaptive bitrate streaming template that encrypts the streams by Widewine.
FairPlayDefinition	Integer	No	The ID of the adaptive bitrate streaming template that encrypts the streams by FairPlay.

DrmStreamingsInfoForUpdate

Modification object of DRM-protected adaptive bitstream playback information

Used by actions: ModifySuperPlayerConfig.

Name	Type	Required	Description
SimpleAesDefinition	Integer	No	ID of the adaptive bitrate streaming template whose protection type is SimpleAES.
WidevineDefinition	Integer	No	The ID of the adaptive bitrate streaming template that encrypts the streams by Widewine.
FairPlayDefinition	Integer	No	The ID of the adaptive bitrate streaming template that encrypts the streams by FairPlay.

EditMediaFileInfo

VOD video file editing information

Used by actions: DescribeTaskDetail, PullEvents.

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

EditMediaStreamInfo

Video stream editing information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
StreamId	String	Yes	ID of recorded stream
StartTime	String	No	Start time of stream clipping in ISO date format. Note: this field may return null, indicating that no valid values can be obtained.
EndTime	String	No	End time of stream clipping in ISO date format. Note: this field may return null, indicating that no valid values can be obtained.

EditMediaTask

Video editing task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task flow status. Valid values: PROCESSING: processing; FINISH: completed. Note: this field may return null, indicating that no valid values can be obtained.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: invalid input parameter. Please check it; 60000: invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: internal service error. Please try again. Note: this field may return null, indicating that no valid values can be obtained.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Progress	Integer	Progress of a video editing task. Value range: [0, 100]
Input	EditMediaTaskInput	Input of video editing task. Note: this field may return null, indicating that no valid values can be obtained.
Output	EditMediaTaskOutput	Output of video editing task. Note: this field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	The metadata of the output video.
ProcedureTaskId	String	If a video processing flow is specified when a video editing task is initiated, this field will be the ID of the task flow. Note: this field may return null, indicating that no valid values can be obtained.
SessionId	String	The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed. Note: this field may return null, indicating that no valid values can be obtained.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters. Note: this field may return null, indicating that no valid values can be obtained.

EditMediaTaskInput

Input of video editing task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
InputType	String	Input video source type. Valid values: File, Stream.
FileInfoSet	Array of EditMediaFileInfo	Information of input video file. This field has a value only when InputType is File. Note: this field may return null, indicating that no valid values can be obtained.
StreamInfoSet	Array of EditMediaStreamInfo	Input stream information. This field has a value only when InputType is Stream. Note: this field may return null, indicating that no valid values can be obtained.

EditMediaTaskOutput

Output of video editing task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
FileType	String	File type, such as mp4 and flv. Note: this field may return null, indicating that no valid values can be obtained.
FileUrl	String	Media file playback address. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	Media file ID. Note: this field may return null, indicating that no valid values can be obtained.
MediaName	String	Output filename of up to 64 characters, which is generated by the system by default. Note: this field may return null, indicating that no valid values can be obtained.
ClassId	Integer	Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API. Default value: 0, which means "Other". Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime	String	Expiration time of output media file in ISO 8601 format, after which the file will be deleted. Files will never expire by default. For more information, please see Notes on ISO Date Format. Note: this field may return null, indicating that no valid values can be obtained.

EmptyTrackItem

Empty track segment used as placeholder on time axis. If you want a period of silence between two audio segments, you can use EmptyTrackItem to hold the place.

Used by actions: ComposeMedia.

Name	Type	Required	Description
Duration	Float	Yes	Duration in seconds.

EventContent

Event notification content, where TranscodeCompleteEvent, ConcatCompleteEvent, ClipCompleteEvent, CreateImageSpriteCompleteEvent, and SnapshotByTimeOffsetCompleteEvent are event notifications for tasks that are initiated by v2017-compatible APIs.

Used by actions: PullEvents.

Name	Type	Description
EventHandle	String	Event handler. The caller must call ConfirmEvents to confirm that the message has been received, and the confirmation is valid for 30 seconds. After the confirmation expires, the event can be obtained again.
EventType	String	Supported event types: NewFileUpload: finished video upload ProcedureStateChanged: task flow status changed FileDeleted: finished video deletion PullComplete: finished pulling for upload EditMediaComplete: finished video editing SplitMediaComplete: finished video splitting WechatPublishComplete: finished publishing on WeChat ComposeMediaComplete: finished producing the media file WechatMiniProgramPublishComplete: finished publishing on WeChat Mini Program Support v2017 task types: TranscodeComplete: finished video transcoding ConcatComplete: finished video splicing ClipComplete: finished video clipping CreateImageSpriteComplete: finished image sprite generation CreateSnapshotByTimeOffsetComplete: finished point-in-time screencapturing
FileUploadEvent	FileUploadTask	Video upload completion event, which is valid if the event type is NewFileUpload. Note: this field may return null, indicating that no valid values can be obtained.
ProcedureStateChangeEvent	ProcedureTask	Task flow status change event, which is valid if the event type is ProcedureStateChanged. Note: this field may return null, indicating that no valid values can be obtained.
FileDeleteEvent	FileDeleteTask	File deletion event, which is valid if the event type is FileDeleted. Note: this field may return null, indicating that no valid values can be obtained.
PullCompleteEvent	PullUploadTask	Video pull for upload completion event, which is valid if the event type is PullComplete. Note: this field may return null, indicating that no valid values can be obtained.
EditMediaCompleteEvent	EditMediaTask	Video editing completion event, which is valid if the event type is EditMediaComplete. Note: this field may return null, indicating that no valid values can be obtained.
SplitMediaCompleteEvent	SplitMediaTask	Video splitting completion event, which is valid if the event type is EditMediaComplete. Note: this field may return null, indicating that no valid values can be obtained.
ComposeMediaCompleteEvent	ComposeMediaTask	Media file composing task completion event, which is valid when the event type is ComposeMediaComplete. Note: this field may return null, indicating that no valid values can be obtained.
ClipCompleteEvent	ClipTask2017	Video clipping completion event, which is valid if the event type is ClipComplete. Note: this field may return null, indicating that no valid values can be obtained.
TranscodeCompleteEvent	TranscodeTask2017	Video transcoding completion event, which is valid if the event type is TranscodeComplete. Note: this field may return null, indicating that no valid values can be obtained.
CreateImageSpriteCompleteEvent	CreateImageSpriteTask2017	Image sprite generating completion event, which is valid if the event type is CreateImageSpriteComplete. Note: this field may return null, indicating that no valid values can be obtained.
ConcatCompleteEvent	ConcatTask2017	Video splicing completion event, which is valid if the event type is ConcatComplete. Note: this field may return null, indicating that no valid values can be obtained.
SnapshotByTimeOffsetCompleteEvent	SnapshotByTimeOffsetTask2017	Time point screencapturing completion event, which is valid when the event type is CreateSnapshotByTimeOffsetComplete. Note: this field may return null, indicating that no valid values can be obtained.
WechatPublishCompleteEvent	WechatPublishTask	Release on WeChat completion event, which is valid if the event type is WechatPublishComplete. Note: this field may return null, indicating that no valid values can be obtained.
WechatMiniProgramPublishCompleteEvent	WechatMiniProgramPublishTask	Release on WeChat Mini Program task completion event, which is valid if the event type is WechatMiniProgramPublishComplete. Note: this field may return null, indicating that no valid values can be obtained.
RestoreMediaCompleteEvent	RestoreMediaTask	Callback for video retrieval. This parameter is valid when the event type is RestoreMediaComplete. Note: this field may return null, indicating that no valid values can be obtained.

FaceConfigureInfo

Control parameter of face recognition task

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of face recognition task. Valid values: ON: enables intelligent face recognition task; OFF: disables intelligent face recognition task.
Score	Float	No	Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100. Default value: 95.
DefaultLibraryLabelSet	Array of String	No	Default face filter labels, which specify the types of faces to return. If this parameter is left empty, the recognition results for all labels are returned. Valid values: entertainment: people in the entertainment industry sport: sports celebrities politician: politically sensitive people
UserDefineLibraryLabelSet	Array of String	No	Custom face labels for filtering. After you specify a label, callbacks of face images without this label will be returned. If this parameter is not specified or left empty, callbacks of all face images will be returned. You can specify up to 100 labels, with each containing up to 16 characters.
FaceLibrary	String	No	Figure library. Valid values: Default: default figure library; UserDefine: custom figure library. All: both default and custom figure libraries will be used. Default value: All (both default and custom figure libraries will be used.)

FaceConfigureInfoForUpdate

Control parameter of face recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of face recognition task. Valid values: ON: enables intelligent face recognition task; OFF: disables intelligent face recognition task.
Score	Float	No	Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100.
DefaultLibraryLabelSet	Array of String	No	Default face filter labels, which specify the types of faces to return. If this parameter is left empty or an empty value is entered, the recognition results for all labels are returned. Valid values: entertainment: people in the entertainment industry sport: sports celebrities politician: politically sensitive people
UserDefineLibraryLabelSet	Array of String	No	Custom face labels for filtering. After you specify a label, callbacks of face images without this label will be returned. If this parameter is not specified or left empty, callbacks of all face images will be returned. You can specify up to 100 labels, with each containing up to 16 characters.
FaceLibrary	String	No	Figure library. Valid values: Default: default figure library; UserDefine: custom figure library. All: both default and custom figure libraries will be used.

FileDeleteTask

File deleting task

Used by actions: PullEvents.

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

FileUploadTask

File upload task information

Used by actions: PullEvents.

Name	Type	Description
FileId	String	Unique file ID.
MediaBasicInfo	MediaBasicInfo	Basic information of media file generated after upload is completed.
ProcedureTaskId	String	If a video processing flow is specified when a video is uploaded, this field will be the ID of the task flow. Note: this field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	Metadata, such as size, duration, video stream information, audio stream information, etc. Note: this field may return null, indicating that no valid values can be obtained.

FrameTagConfigureInfo

Control parameter of intelligent frame-specific tagging task

Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of intelligent frame-specific tagging task. Valid values: ON: enables intelligent frame-specific tagging task; OFF: disables intelligent frame-specific tagging task.
ScreenshotInterval	Float	No	Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds.

FrameTagConfigureInfoForUpdate

Control parameter of intelligent frame-specific tagging task

Used by actions: ModifyAIAnalysisTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of intelligent frame-specific tagging task. Valid values: ON: enables intelligent frame-specific tagging task; OFF: disables intelligent frame-specific tagging task.
ScreenshotInterval	Float	No	Frame capturing interval in seconds. Minimum value: 0.5 seconds.

HeadTailConfigureInfo

Control parameter of video opening and ending credits recognition task.

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of video opening and ending credits recognition task. Valid values: ON: enables video opening and ending credits recognition task; OFF: disables video opening and ending credits recognition task.

HeadTailConfigureInfoForUpdate

Control parameter of video opening and ending credits recognition task.

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of video opening and ending credits recognition task. Valid values: ON: enables video opening and ending credits recognition task; OFF: disables video opening and ending credits recognition task.

HeadTailTaskInput

Input parameters for a video opening/closing credits generation task

Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Video opening/closing credits configuration template ID

HighlightSegmentItem

List of intelligently generated highlights.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Confidence	Float	Confidence.
StartTimeOffset	Float	Start time offset of a segment.
EndTimeOffset	Float	End time offset of a segment.

HighlightsConfigureInfo

Control parameter of an intelligent highlight generating task

Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of an intelligent highlight generating task. Valid values: ON: enable an intelligent highlight generating task; OFF: disable an intelligent highlight generating task.

HighlightsConfigureInfoForUpdate

Control parameter of an intelligent highlight generating task

Used by actions: ModifyAIAnalysisTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of an intelligent highlight generating task. Valid values: ON: enable an intelligent highlight generating task; OFF: disable an intelligent highlight generating task.

ImageContentReviewInput

The request parameters for an image recognition task.

Used by actions: ProcessImage.

Name	Type	Required	Description
Definition	Integer	Yes	The ID of the image recognition template to use. Valid values: 10: All recognition types enabled

ImageSpriteTaskInput

Input parameter type of image sprite generating task

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Image sprite generating template ID.

ImageSpriteTemplate

Details of an image sprite generating template

Used by actions: DescribeImageSpriteTemplates.

Name	Type	Description
Definition	Integer	Unique ID of an image sprite generating template.
Type	String	Template type. Valid values: Preset: preset template; Custom: custom template.
Name	String	Name of an image sprite generating template.
Width	Integer	Maximum value of the width (or long side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
Height	Integer	Maximum value of the height (or short side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
ResolutionAdaptive	String	Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height. Default value: open.
SampleType	String	Sampling type.
SampleInterval	Integer	Sampling interval.
RowCount	Integer	Subimage row count of an image sprite.
ColumnCount	Integer	Subimage column count of an image sprite.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.
FillType	String	Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer"; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
Comment	String	Template description.

ImageTransform

Operation such as image rotation and flipping

Used by actions: ComposeMedia.

Name	Type	Required	Description
Type	String	Yes	Type. Valid values: Rotate: image rotation. Flip: image flipping.
RotateAngle	Float	No	Rotation angle of image with its center point as origin. Value range: 0-360. This parameter is valid if Type is Rotate.
Flip	String	No	Image flipping action. Valid values: Horizental: horizontal flipping, i.e., horizontally mirrored. Vertical: vertical flipping, i.e., vertically mirrored. This is valid if Type is Flip.

ImageWatermarkInput

Input parameter of image watermarking template

Used by actions: CreateWatermarkTemplate.

Name	Type	Required	Description
ImageContent	String	Yes	The Base64 encoded string of a watermark image. Only JPEG, PNG, and GIF images are supported.
Width	String	No	Watermark width. % and px formats are supported: If the string ends in %, the Width of the watermark will be the specified percentage of the video width. For example, 10% means that Width is 10% of the video width; If the string ends in px, the Width of the watermark will be in pixels. For example, 100px means that Width is 100 pixels. Value range: [8, 4096]. Default value: 10%.
Height	String	No	Watermark height. % and px formats are supported: If the string ends in %, the Height of the watermark will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height; If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px. Valid values: 0 or [8,4096]. Default value: 0 px, 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 image watermarking template

Used by actions: ModifyWatermarkTemplate.

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

MediaAdaptiveDynamicStreamingInfo

Adaptive bitrate streaming information

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
AdaptiveDynamicStreamingSet	Array of AdaptiveDynamicStreamingInfoItem	Information array of adaptive bitrate streaming. Note: this field may return null, indicating that no valid values can be obtained.

MediaAiAnalysisClassificationItem

Intelligent categorization result

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Classification	String	Name of intelligently generated category.
Confidence	Float	Confidence of intelligently generated category between 0 and 100.

MediaAiAnalysisCoverItem

Information of intelligently generated cover

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
CoverUrl	String	Address of intelligently generated cover.
Confidence	Float	Confidence of intelligently generated cover between 0 and 100.

MediaAiAnalysisFrameTagItem

Result information of intelligent frame-specific tagging

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Tag	String	Frame-specific tag name.
CategorySet	Array of String	Category list of frame-specific tag names. CategorySet.N indicates the N+1-level category. For example, if the Tag is "tower", and CategorySet contains two elements (CategorySet.0 is "scene", and CategorySet.1 is "architecture"), then the frame-specific tag is "tower", the first-level category is "scene", and the second-level category is "architecture".
Confidence	Float	Confidence of intelligently generated frame-specific tag between 0 and 100.

MediaAiAnalysisFrameTagSegmentItem

List of frame-specific tag segments

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
StartTimeOffset	Float	Start time offset of frame-specific tag.
EndTimeOffset	Float	End time offset of frame-specific tag.
TagSet	Array of MediaAiAnalysisFrameTagItem	List of tags in time period.

MediaAiAnalysisHighlightItem

Information of an intelligently generated highlight

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
HighlightUrl	String	Address of an intelligently generated highlight.
CovImgUrl	String	Address of an intelligently generated highlight cover.
Confidence	Float	Confidence of an intelligently generated highlight between 0 and 100.
Duration	Float	Duration of an intelligently generated highlight.
SegmentSet	Array of HighlightSegmentItem	List of intelligently generated highlight subsegments, which together form a highlight.

MediaAiAnalysisTagItem

Result information of intelligent tagging

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Tag	String	Tag name.
Confidence	Float	Confidence of tag between 0 and 100.

MediaAnimatedGraphicsInfo

Result information of animated image generating in VOD file

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
AnimatedGraphicsSet	Array of MediaAnimatedGraphicsItem	Result information of animated image generating task Note: this field may return null, indicating that no valid values can be obtained.

MediaAnimatedGraphicsItem

Result information of animated image generating task

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Url	String	Address of generated animated image. Note: this field may return null, indicating that no valid values can be obtained.
Definition	Integer	Animated image generating template ID. For more information, please see Animated Image Generating Parameter Template. Note: this field may return null, indicating that no valid values can be obtained.
Container	String	Animated image format, such as gif. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	Height of animated image in px. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	Width of animated image in px. Note: this field may return null, indicating that no valid values can be obtained.
Bitrate	Integer	Bitrate of animated image in bps. Note: this field may return null, indicating that no valid values can be obtained.
Size	Integer	Size of animated image in bytes. Note: this field may return null, indicating that no valid values can be obtained.
Md5	String	MD5 value of an animated image. Note: this field may return null, indicating that no valid values can be obtained.
StartTimeOffset	Float	Start time offset of animated image in video in seconds. Note: this field may return null, indicating that no valid values can be obtained.
EndTimeOffset	Float	End time offset of animated image in video in seconds. Note: this field may return null, indicating that no valid values can be obtained.

MediaAudioStreamItem

Information of audio stream in VOD file

Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

Name	Type	Description
Bitrate	Integer	Bitrate of audio stream in bps. Note: this field may return null, indicating that no valid values can be obtained.
SamplingRate	Integer	Sample rate of audio stream in Hz. Note: this field may return null, indicating that no valid values can be obtained.
Codec	String	Audio stream encoder, such as aac. Note: this field may return null, indicating that no valid values can be obtained.

MediaBasicInfo

Basic information of VOD media file

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Name	String	Media filename. Note: this field may return null, indicating that no valid values can be obtained.
Description	String	Media file description. Note: this field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time of media file in ISO date format. Note: this field may return null, indicating that no valid values can be obtained.
UpdateTime	String	Last update time of media file (by an operation that triggers updating of media file information such as modifying video attributes or initiating video processing) in ISO date format. Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime	String	Expiration time of media file in ISO date format. After the expiration, the media file and its related resources (such as transcoding results and image sprites) will be permanently deleted. 9999-12-31T23:59:59Z means "never expire". Note: this field may return null, indicating that no valid values can be obtained.
ClassId	Integer	Category ID of media file. Note: this field may return null, indicating that no valid values can be obtained.
ClassName	String	Category name of media file. Note: this field may return null, indicating that no valid values can be obtained.
ClassPath	String	Category path to media file separated by "-", such as "new first-level category - new second-level category". Note: this field may return null, indicating that no valid values can be obtained.
CoverUrl	String	Cover image address of media file. Note: this field may return null, indicating that no valid values can be obtained.
Type	String	Media file container, such as mp4 and flv. Note: this field may return null, indicating that no valid values can be obtained.
MediaUrl	String	URL of source media file. Note: this field may return null, indicating that no valid values can be obtained.
SourceInfo	MediaSourceData	Source information of media file. Note: this field may return null, indicating that no valid values can be obtained.
StorageRegion	String	Regions where media files are stored, such as ap-chongqing. For more regions, see Storage Region.
TagSet	Array of String	Tag information of media file. Note: this field may return null, indicating that no valid values can be obtained.
Vid	String	Unique ID of an LVB recording file.
Category	String	File type: Video: video file Audio: audio file Image: image file
Status	String	File status. Valid values: Normal, Forbidden. *Note: this field is not supported yet.
StorageClass	String	Storage class of a media file: STANDARD STANDARD_IA ARCHIVE DEEP_ARCHIVE

MediaClassInfo

Category information description

Used by actions: DescribeAllClass.

Name	Type	Description
ClassId	Integer	Category ID
ParentId	Integer	Parent category ID, which is -1 for a first-level category.
ClassName	String	Category name
Level	Integer	Category level. 0 for first-level category, up to 3, i.e., up to 4 levels of categories are allowed.
SubClassIdSet	Array of Integer	Set of IDs of the immediate subcategories in current category

MediaContentReviewAsrTextSegmentItem

Video segment containing ASR-detected suspicious content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
StartTimeOffset	Float	Start time offset of suspected segment in seconds. Note: this field may return null, indicating that no valid values can be obtained.
EndTimeOffset	Float	End time offset of suspected segment in seconds. Note: this field may return null, indicating that no valid values can be obtained.
Confidence	Float	Confidence of suspected segment. Note: this field may return null, indicating that no valid values can be obtained.
Suggestion	String	Processing suggestion for the detected suspicious content. Valid values: pass review block
KeywordSet	Array of String	List of suspected keywords. Note: this field may return null, indicating that no valid values can be obtained.

MediaContentReviewOcrTextSegmentItem

Video segment containing OCR-detected suspicious content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
StartTimeOffset	Float	Start time offset of suspected segment in seconds. Note: this field may return null, indicating that no valid values can be obtained.
EndTimeOffset	Float	End time offset of suspected segment in seconds. Note: this field may return null, indicating that no valid values can be obtained.
Confidence	Float	Confidence of suspected segment. Note: this field may return null, indicating that no valid values can be obtained.
Suggestion	String	Processing suggestion for the detected suspicious content. Valid values: pass review block
KeywordSet	Array of String	List of suspected keywords. Note: this field may return null, indicating that no valid values can be obtained.
AreaCoordSet	Array of Integer	Zone coordinates (at the pixel level) of suspected text: [x1, y1, x2, y2], i.e., the coordinates of the top-left and bottom-right corners. Note: this field may return null, indicating that no valid values can be obtained.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTime	String	Expiration time of suspected image URL in ISO date format.

MediaContentReviewPoliticalSegmentItem

Video segment containing detected politically sensitive content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Confidence score for the detected politically sensitive content
Suggestion	String	Processing suggestion for the detected politically sensitive content. Valid values: pass review block
Name	String	Name of the politically sensitive content or banned images
Label	String	Labels for the detected politically sensitive content. The relationship between the values of this parameter and those of the LabelSet parameter in PoliticalImgReviewTemplateInfo is as follows: violation_photo: violation_photo: banned images politician: nation_politician: state leader of China province_politician: provincial officials bureau_politician: bureau-level officials county_politician: county-level officials rural_politician: township-level officials sensitive_politician: politically sensitive people foreign_politician: state leaders of other countries entertainment: sensitive_entertainment: banned people in the entertainment industry sport: sensitive_sport: banned sports celebrities entrepreneur: sensitive_entrepreneur: banned businesspeople scholar: sensitive_scholar: banned scholars celebrity: sensitive_celebrity: banned celebrities historical_celebrity: banned historical figures military: sensitive_military: banned people in military
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
AreaCoordSet	Array of Integer	Coordinates (pixel) of the detected politically sensitive content or banned icons. The format is [x1, y1, x2, y2], which indicates the coordinates of the top-left and bottom-right corners.
PicUrlExpireTimeStamp	Integer	This field has been disused. Please use PicUrlExpireTime.
PicUrlExpireTime	String	Expiration time of suspected image URL in ISO date format.

MediaContentReviewSegmentItem

Video segment containing detected pornographic or terrorism content

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Confidence score for the detected pornographic content
Label	String	Label for the detected pornographic content
Suggestion	String	Processing suggestion for the detected pornographic content. Valid values: pass review block
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTimeStamp	Integer	This field has been disused. Please use PicUrlExpireTime.
PicUrlExpireTime	String	Expiration time of suspected image URL in ISO date format.

MediaDeleteItem

Content to be deleted when a VOD video is deleted

Used by actions: DeleteMedia.

Name	Type	Required	Description
Type	String	Yes	Type of files to delete. If this parameter is left empty, it will be invalid. Valid values: OriginalFiles: original files. You cannot initiate transcoding, publishing on WeChat, or other video processing operations after deleting the original files. TranscodeFiles: transcoded files WechatPublishFiles: files for publishing on WeChat
Definition	Integer	No	ID of the template for which to delete the videos of the type specified by the Type parameter. For the template definition, please see Transcoding Template. Default value: 0, which indicates to delete all videos of the type specified by the Type parameter.

MediaImageSpriteInfo

Image sprite information of VOD file

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
ImageSpriteSet	Array of MediaImageSpriteItem	Information set of image sprites with specified specifications. Each element represents a set of image sprites with the same specification. Note: this field may return null, indicating that no valid values can be obtained.

MediaImageSpriteItem

Image sprite information

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Definition	Integer	Image sprite specification. For more information, please see Image Sprite Parameter Template. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	Subimage height of image sprite. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	Subimage width of image sprite. Note: this field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of subimages in each image sprite. Note: this field may return null, indicating that no valid values can be obtained.
ImageUrlSet	Array of String	Address of each image sprite. Note: this field may return null, indicating that no valid values can be obtained.
WebVttUrl	String	Address of WebVtt file for the position-time relationship among subimages in an image sprite. The WebVtt file indicates the corresponding time points of each subimage and their coordinates in the image sprite, which is typically used by the player for implementing preview. Note: this field may return null, indicating that no valid values can be obtained.

MediaInfo

VOD file information

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
BasicInfo	MediaBasicInfo	Basic information, such as video name, category, playback address, and cover image. Note: this field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	Metadata, such as size, duration, video stream information, and audio stream information. Note: this field may return null, indicating that no valid values can be obtained.
TranscodeInfo	MediaTranscodeInfo	Result information of transcoding, such as address, specification, bitrate, and resolution of the videos in various bitrates generated by transcoding a video. Note: this field may return null, indicating that no valid values can be obtained.
AnimatedGraphicsInfo	MediaAnimatedGraphicsInfo	Result information of animated image generating, i.e., relevant information of an animated image (such as .gif) generated from a video. Note: this field may return null, indicating that no valid values can be obtained.
SampleSnapshotInfo	MediaSampleSnapshotInfo	Sampled screenshot information, i.e., relevant information of a sampled screenshot generated from a video. Note: this field may return null, indicating that no valid values can be obtained.
ImageSpriteInfo	MediaImageSpriteInfo	Image sprite information, i.e., relevant information of image sprite generated from video. Note: this field may return null, indicating that no valid values can be obtained.
SnapshotByTimeOffsetInfo	MediaSnapshotByTimeOffsetInfo	Time point screenshot information, i.e., information of each time point screenshot generated from a video. Note: this field may return null, indicating that no valid values can be obtained.
KeyFrameDescInfo	MediaKeyFrameDescInfo	Timestamp information, i.e., information of each timestamp set for a video. Note: this field may return null, indicating that no valid values can be obtained.
AdaptiveDynamicStreamingInfo	MediaAdaptiveDynamicStreamingInfo	Adaptive bitrate streaming information, such as specification, encryption type, and container format. Note: this field may return null, indicating that no valid values can be obtained.
MiniProgramReviewInfo	MediaMiniProgramReviewInfo	WeChat Mini Program audit information. Note: this field may return null, indicating that no valid values can be obtained.
SubtitleInfo	MediaSubtitleInfo	Subtitle information Note: this field may return null, indicating that no valid value is obtained.
FileId	String	Unique ID of media file.

MediaInputInfo

Information, name, and customer ID of the source video to be processed

Used by actions: ProcessMediaByUrl.

Name	Type	Required	Description
Url	String	Yes	Video URL.
Name	String	No	Video name.
Id	String	No	Custom video ID.

MediaKeyFrameDescInfo

Video timestamp information

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
KeyFrameDescSet	Array of MediaKeyFrameDescItem	Information array of video timestamps. Note: this field may return null, indicating that no valid values can be obtained.

MediaKeyFrameDescItem

Video timestamp information

Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

Name	Type	Required	Description
TimeOffset	Float	Yes	Offset time of video timestamp in seconds.
Content	String	Yes	Content string of timestamp containing 1-128 characters.

MediaMetaData

VOD media file metadata

Used by actions: DescribeMediaInfos, DescribeTaskDetail, LiveRealTimeClip, PullEvents, SearchMedia, SimpleHlsClip.

Name	Type	Description
Size	Integer	Size of uploaded media file in bytes (which is the sum of size of m3u8 and ts files if the video is in HLS format). Note: this field may return null, indicating that no valid values can be obtained.
Container	String	Container, such as m4a and mp4. Note: this field may return null, indicating that no valid values can be obtained.
Bitrate	Integer	Sum of the average bitrate of a video stream and that of an audio stream in bps. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	Maximum value of the height of a video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	Maximum value of the width of a video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Duration	Float	Video duration in seconds. Note: this field may return null, indicating that no valid values can be obtained.
Rotate	Integer	Selected angle during video recording in degrees. Note: this field may return null, indicating that no valid values can be obtained.
VideoStreamSet	Array of MediaVideoStreamItem	Video stream information. Note: this field may return null, indicating that no valid values can be obtained.
AudioStreamSet	Array of MediaAudioStreamItem	Audio stream information. Note: this field may return null, indicating that no valid values can be obtained.
VideoDuration	Float	Video duration in seconds. Note: this field may return null, indicating that no valid values can be obtained.
AudioDuration	Float	Audio duration in seconds. Note: this field may return null, indicating that no valid values can be obtained.

MediaMiniProgramReviewElem

Used by actions: DescribeMediaInfos, SearchMedia.

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

MediaMiniProgramReviewInfo

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
MiniProgramReviewList	Array of MediaMiniProgramReviewInfoItem	Audit information list.

MediaMiniProgramReviewInfoItem

Used by actions: DescribeMediaInfos, SearchMedia.

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

MediaOutputInfo

Information parameter of file output by video processing

Used by actions: ProcessMediaByUrl.

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

MediaProcessTaskAdaptiveDynamicStreamingResult

Result type of adaptive bitrate streaming task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message.
Input	AdaptiveDynamicStreamingTaskInput	Input of adaptive bitrate streaming task.
Output	AdaptiveDynamicStreamingInfoItem	Output of adaptive bitrate streaming task.

MediaProcessTaskAnimatedGraphicResult

Result type of animated image generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	AnimatedGraphicTaskInput	Input of animated image generating task.
Output	MediaAnimatedGraphicsItem	Output of animated image generating task. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskCoverBySnapshotResult

Result type of cover generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	CoverBySnapshotTaskInput	Input of cover generating task.
Output	CoverBySnapshotTaskOutput	Output of cover generating task.

MediaProcessTaskImageSpriteResult

Result type of image sprite generating task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	ImageSpriteTaskInput	Input of image sprite generating task.
Output	MediaImageSpriteItem	Output of image sprite generating task. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskInput

Video processing task type

Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ResetProcedureTemplate.

Name	Type	Required	Description
TranscodeTaskSet	Array of TranscodeTaskInput	No	List of transcoding tasks. Note: this field may return null, indicating that no valid values can be obtained.
AnimatedGraphicTaskSet	Array of AnimatedGraphicTaskInput	No	List of animated image generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
SnapshotByTimeOffsetTaskSet	Array of SnapshotByTimeOffsetTaskInput	No	List of time point screencapturing tasks. Note: this field may return null, indicating that no valid values can be obtained.
SampleSnapshotTaskSet	Array of SampleSnapshotTaskInput	No	List of sampled screencapturing tasks. Note: this field may return null, indicating that no valid values can be obtained.
ImageSpriteTaskSet	Array of ImageSpriteTaskInput	No	List of image sprite generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
CoverBySnapshotTaskSet	Array of CoverBySnapshotTaskInput	No	List of cover generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
AdaptiveDynamicStreamingTaskSet	Array of AdaptiveDynamicStreamingTaskInput	No	List of adaptive bitrate streaming tasks. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskResult

Query result type of task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Type	String	Task type. Valid values: Transcode: transcoding AnimatedGraphics: animated image generating SnapshotByTimeOffset: time point screencapturing SampleSnapshot: sampled screencapturing ImageSprites: image sprite generating CoverBySnapshot: Screencapturing for cover image AdaptiveDynamicStreaming: adaptive bitrate streaming
TranscodeTask	MediaProcessTaskTranscodeResult	Query result of transcoding task, which is valid when task type is Transcode. Note: this field may return null, indicating that no valid values can be obtained.
AnimatedGraphicTask	MediaProcessTaskAnimatedGraphicResult	Query result of animated image generating task, which is valid when task type is AnimatedGraphics. Note: this field may return null, indicating that no valid values can be obtained.
SnapshotByTimeOffsetTask	MediaProcessTaskSnapshotByTimeOffsetResult	Query result of time point screencapturing task, which is valid when task type is SnapshotByTimeOffset. Note: this field may return null, indicating that no valid values can be obtained.
SampleSnapshotTask	MediaProcessTaskSampleSnapshotResult	Query result of sampled screencapturing task, which is valid when task type is SampleSnapshot. Note: this field may return null, indicating that no valid values can be obtained.
ImageSpriteTask	MediaProcessTaskImageSpriteResult	Query result of image sprite generating task, which is valid when task type is ImageSprite. Note: this field may return null, indicating that no valid values can be obtained.
CoverBySnapshotTask	MediaProcessTaskCoverBySnapshotResult	Query result of cover generating task, which is valid if task type is CoverBySnapshot. Note: this field may return null, indicating that no valid values can be obtained.
AdaptiveDynamicStreamingTask	MediaProcessTaskAdaptiveDynamicStreamingResult	Query result of adaptive bitrate streaming, which is valid if task type is AdaptiveDynamicStreaming. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskSampleSnapshotResult

Result type of sampled screencapturing task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	SampleSnapshotTaskInput	Input of sampled screencapturing task.
Output	MediaSampleSnapshotItem	Output of sampled screencapturing task. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskSnapshotByTimeOffsetResult

Result type of time point screencapturing task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	SnapshotByTimeOffsetTaskInput	Input of time point screencapturing task.
Output	MediaSnapshotByTimeOffsetItem	Output of time point screencapturing task. Note: this field may return null, indicating that no valid values can be obtained.

MediaProcessTaskTranscodeResult

Result type of transcoding task

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You’re not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
Input	TranscodeTaskInput	Input of transcoding task.
Output	MediaTranscodeItem	Output of transcoding task. Note: this field may return null, indicating that no valid values can be obtained.
Progress	Integer	Transcoding progress. Value range: 0-100.
BeginProcessTime	String	Transcoding task start time in ISO date format
FinishTime	String	Transcoding task end time in ISO date format

MediaSampleSnapshotInfo

Information of sampled screenshot of VOD file

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
SampleSnapshotSet	Array of MediaSampleSnapshotItem	Information set of sampled screenshots with the specified specifications. Each element represents a set of sampled screenshots with the same specification. Note: this field may return null, indicating that no valid values can be obtained.

MediaSampleSnapshotItem

Sampled screenshot information

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Definition	Integer	Sampled screenshot specification ID. For more information, please see Sampled Screencapturing Parameter Template. Note: this field may return null, indicating that no valid values can be obtained.
SampleType	String	Sample type. Valid values: Percent: samples at a specified percentage interval. Time: samples at a specified time interval. Note: this field may return null, indicating that no valid values can be obtained.
Interval	Integer	Sampling interval If SampleType is Percent, this value means taking a screenshot at an interval of the specified percentage. If SampleType is Time, this value means taking a screenshot at an interval of the specified time (in seconds). The first screenshot is always the first video frame. Note: this field may return null, indicating that no valid values can be obtained.
ImageUrlSet	Array of String	List of URLs of generated screenshots. Note: this field may return null, indicating that no valid values can be obtained.
WaterMarkDefinition	Array of Integer	List of watermarking template IDs if the screenshots are watermarked. Note: this field may return null, indicating that no valid values can be obtained.

MediaSnapshotByTimeOffsetInfo

Information of time point screenshot in VOD file

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
SnapshotByTimeOffsetSet	Array of MediaSnapshotByTimeOffsetItem	Information set of time point screenshots with a specified specification. Currently, there can be only one set of screenshots for each specification. Note: this field may return null, indicating that no valid values can be obtained.

MediaSnapshotByTimeOffsetItem

Information of time point screenshot in VOD file

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Definition	Integer	Specification of a time point screenshot. For more information, please see Parameter Template for Time Point Screencapturing. Note: this field may return null, indicating that no valid values can be obtained.
PicInfoSet	Array of MediaSnapshotByTimePicInfoItem	Information set of screenshots of the same specification. Each element represents a screenshot. Note: this field may return null, indicating that no valid values can be obtained.

MediaSnapshotByTimePicInfoItem

Time point screenshot information

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
TimeOffset	Float	Time offset corresponding to the screenshot in the video in milliseconds. Note: this field may return null, indicating that no valid values can be obtained.
Url	String	Screenshot URL. Note: this field may return null, indicating that no valid values can be obtained.
WaterMarkDefinition	Array of Integer	List of watermarking template IDs if the screenshots are watermarked. Note: this field may return null, indicating that no valid values can be obtained.

MediaSourceData

Source file information

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
SourceType	String	Source of a media file: Record: recording, such as live or time-shift recording Upload: upload, such as pull for upload, upload from server, and UGC upload from client VideoProcessing: video processing, such as video splicing and video clipping WebPageRecord: panoramic recording Unknown: unknown source
SourceContext	String	Field passed through when a file is created. Note: this field may return null, indicating that no valid values can be obtained.

MediaSubtitleInfo

Subtitle information

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
SubtitleSet	Array of MediaSubtitleItem	Subtitle information list

MediaSubtitleInput

Input parameters of subtile information

Used by actions: ModifyMediaInfo.

Name	Type	Required	Description
Name	String	Yes	Subtitle name. Length limit: 64 characters
Language	String	Yes	Subtitle language. Common values: cn: Chinese ja: Japanese en-US: English For other valid values, see RFC 5646.
Format	String	Yes	Subtitle format. Valid value: vtt
Content	String	Yes	Subtitle content, which is Base64-encoded strings
Id	String	No	Subtitle ID. Its length cannot exceed 16 characters. Uppercase and lowercase letters, numbers, underscores (_), and hyphens (-) are supported. It cannot be the same as the IDs of the existing subtitles in the media file.

MediaSubtitleItem

Subtitle information

Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

Name	Type	Description
Id	String	Unique subtitle ID
Name	String	Subtitle name
Language	String	Subtitle language. Common values: cn: Chinese ja: Japanese en-US: English For other values, see RFC 5646.
Format	String	Subtitle format. Valid value: vtt
Url	String	Subtitle URL

MediaTrack

Track information

Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
Type	String	Yes	Track type. Valid values: Video: video track, which is composed of the following items: VideoTrackItem MediaTransitionItem EmptyTrackItem Audio: audio track, which is composed of the following items: AudioTrackItem MediaTransitionItem EmptyTrackItem Sticker: sticker track, which is composed of the following items: StickerTrackItem EmptyTrackItem
TrackItems	Array of MediaTrackItem	Yes	List of media segments on track. Note: this field may return null, indicating that no valid values can be obtained.

MediaTrackItem

Segment information of media track

Used by actions: ComposeMedia.

Name	Type	Required	Description
Type	String	Yes	Segment type. Valid values: Video: video segment. Audio: audio segment. Sticker: sticker segment. Transition: transition. Empty: empty segment.
VideoItem	VideoTrackItem	No	Video segment, which is valid if Type is Video. Note: this field may return null, indicating that no valid values can be obtained.
AudioItem	AudioTrackItem	No	Audio segment, which is valid if Type is Audio. Note: this field may return null, indicating that no valid values can be obtained.
StickerItem	StickerTrackItem	No	Sticker segment, which is valid if Type is Sticker. Note: this field may return null, indicating that no valid values can be obtained.
TransitionItem	MediaTransitionItem	No	Transition, which is valid if Type is Transition. Note: this field may return null, indicating that no valid values can be obtained.
EmptyItem	EmptyTrackItem	No	Empty segment, which is valid if Type is Empty. It is used as placeholder on time axis. If you want a period of silence between two audio segments, you can use EmptyTrackItem to hold the place. Use EmptyTrackItem as a placeholder to locate an item. Note: this field may return null, indicating that no valid values can be obtained.

MediaTranscodeInfo

Transcoding information of VOD file

Used by actions: DescribeMediaInfos, SearchMedia.

Name	Type	Description
TranscodeSet	Array of MediaTranscodeItem	Information set of transcoding with each specification. Each element represents a result of transcoding with a specification. Note: this field may return null, indicating that no valid values can be obtained.

MediaTranscodeItem

Transcoding information

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name	Type	Description
Url	String	Address of output video file. Note: this field may return null, indicating that no valid values can be obtained.
Definition	Integer	Transcoding specification ID. For more information, please see Transcoding Parameter Template. Note: this field may return null, indicating that no valid values can be obtained.
Bitrate	Integer	Sum of the average bitrate of a video stream and that of an audio stream in bps. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	Maximum value of the height of a video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	Maximum value of the width of a video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Size	Integer	Total size of a media file in bytes (which is the sum of size of m3u8 and ts files if the video is in HLS format). Note: this field may return null, indicating that no valid values can be obtained.
Duration	Float	Video duration in seconds. Note: this field may return null, indicating that no valid values can be obtained.
Container	String	Container, such as m4a and mp4. Note: this field may return null, indicating that no valid values can be obtained.
Md5	String	MD5 value of video. Note: this field may return null, indicating that no valid values can be obtained.
AudioStreamSet	Array of MediaAudioStreamItem	Audio stream information. Note: this field may return null, indicating that no valid values can be obtained.
VideoStreamSet	Array of MediaVideoStreamItem	Video stream information. Note: this field may return null, indicating that no valid values can be obtained.

MediaTransitionItem

Transition information

Used by actions: ComposeMedia.

Name	Type	Required	Description
Duration	Float	Yes	Transition duration in seconds. For two media segments that use a transition, the start time of the second segment on the track will be automatically set to the end time of the first segment minus the transition duration.
Transitions	Array of TransitionOpertion	No	List of transition operations. Up to one video image or audio transition operation is supported. Note: this field may return null, indicating that no valid values can be obtained.

MediaVideoStreamItem

Information of video stream in VOD file

Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

Name	Type	Description
Bitrate	Integer	Bitrate of video stream in bps. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	Height of video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	Width of video stream in px. Note: this field may return null, indicating that no valid values can be obtained.
Codec	String	Video stream encoder, such as h264. Note: this field may return null, indicating that no valid values can be obtained.
Fps	Integer	Frame rate in Hz. Note: this field may return null, indicating that no valid values can be obtained.

MosaicInput

Blur parameter type of video processing task

Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

Name	Type	Required	Description
CoordinateOrigin	String	No	Origin position, which currently can only be: TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text. Default value: TopLeft.
XPos	String	No	The horizontal position of the origin of the blur relative to the origin of coordinates of the video. % and px formats are supported: If the string ends in %, the XPos of the blur will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width; If the string ends in px, the XPos of the blur will be the specified px; for example, 100px means that XPos is 100 px. Default value: 0 px.
YPos	String	No	Vertical position of the origin of blur relative to the origin of coordinates of video. % and px formats are supported: If the string ends in %, the YPos of the blur will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height; If the string ends in px, the YPos of the blur will be the specified px; for example, 100px means that YPos is 100 px. Default value: 0 px.
Width	String	No	Blur width. % and px formats are supported: If the string ends in %, the Width of the blur will be the specified percentage of the video width; for example, 10% means that Width is 10% of the video width; If the string ends in px, the Width of the blur will be in px; for example, 100px means that Width is 100 px. Default value: 10%.
Height	String	No	Blur height. % and px formats are supported: If the string ends in %, the Height of the blur will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height; If the string ends in px, the Height of the blur will be in px; for example, 100px means that Height is 100 px. Default value: 10%.
StartTimeOffset	Float	No	Start time offset of blur in seconds. If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame. If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame; If this value is greater than 0 (e.g., n), the blur will appear at second n after the first video frame; If this value is smaller than 0 (e.g., -n), the blur will appear at second n before the last video frame.
EndTimeOffset	Float	No	End time offset of blur in seconds. If this parameter is left empty or 0 is entered, the blur will exist till the last video frame; If this value is greater than 0 (e.g., n), the blur will exist till second n; If this value is smaller than 0 (e.g., -n), the blur will exist till second n before the last video frame.

ObjectConfigureInfo

Control parameter of object recognition task

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of object recognition task. Valid values: ON: enables intelligent object recognition task; OFF: disables intelligent object recognition task.
ObjectLibrary	String	No	Object library. Valid values: Default: default object library; UserDefine: custom object library. All: both default and custom object libraries will be used. Default value: All, i.e., both default and custom object libraries will be used.

ObjectConfigureInfoForUpdate

Control parameter of object recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of object recognition task. Valid values: ON: enables intelligent object recognition task; OFF: disables intelligent object recognition task.
ObjectLibrary	String	No	Object library. Valid values: Default: default object library; UserDefine: custom object library. All: both default and custom object libraries will be used.

OcrFullTextConfigureInfo

Control parameter of full text recognition task

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of full text recognition task. Valid values: ON: enables intelligent full text recognition task; OFF: disables intelligent full text recognition task.

OcrFullTextConfigureInfoForUpdate

Control parameter of full text recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of full text recognition task. Valid values: ON: enables intelligent full text recognition task; OFF: disables intelligent full text recognition task.

OcrWordsConfigureInfo

Text keyword recognition control parameter.

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

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

OcrWordsConfigureInfoForUpdate

Control parameter of text keyword recognition.

Used by actions: ModifyAIRecognitionTemplate.

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

OutputAudioStream

Information of output audio stream

Used by actions: ComposeMedia.

Name	Type	Required	Description
Codec	String	No	Audio stream encoder. Valid values: libfdk_aac: suitable for mp4 files. Default value: libfdk_aac.
SampleRate	Integer	No	Audio stream sample rate. Valid values: 16,000 32,000 44,100 48,000 In Hz. Default value: 16,000.
AudioChannel	Integer	No	Number of sound channels. Valid values: 1: mono. 2: dual Default value: 2.

OutputVideoStream

Information of output video stream

Used by actions: ComposeMedia.

Name	Type	Required	Description
Codec	String	No	Video stream encoder. Valid values: libx264: H.264 Default value: libx264.
Fps	Integer	No	Video frame rate in Hz. Value range: [0, 60]. Default value: 0, which means that the value is the same as the video frame rate of the first video segment in the first video track.

PlayStatFileInfo

Information of a playback statistics file

Used by actions: DescribeDailyPlayStatFileList.

Name	Type	Description
Date	String	Date of playback statistics in ISO date format.
Url	String	URL of a playback statistics file, including the following contents: date: playback date file_id: video file ID ip_count: number of client IPs after deduplication flux: playback traffic in bytes play_times: total playback times pc_play_times: playback times on PC clients mobile_play_times: playback times on mobile clients iphone_play_times: playback times on iPhone android_play_times: playback times on Android host_name: domain name

PlayStatInfo

The playback statistics.

Used by actions: DescribeMediaPlayStatDetails.

Name	Type	Description
Time	String	The start time (in ISO date format) of the data returned. For example, if the granularity is a day, 2018-12-01T00:00:00+08:00 indicates that the data is for the period between December 1, 2018 (inclusive) and December 2, 2018 (exclusive). If the granularity is an hour, 2019-08-22T00:00:00+08:00 indicates the data is for the period between 00:00 and 01:00 AM on August 22, 2019. If the granularity is a day, 2019-08-22T00:00:00+08:00 indicates the data is for August 22, 2019.
FileId	String	The ID of the media file.
PlayTimes	Integer	The playback times.
Traffic	Integer	The traffic (in bytes) consumed for playback.

PlayerConfig

Player configuration details

Used by actions: DescribeSuperPlayerConfigs.

Name	Type	Description
Name	String	Player configuration name.
Type	String	Player configuration type. Valid values: Preset: preset configuration; Custom: custom configuration.
DrmSwitch	String	Switch of DRM-protected adaptive bitstream playback: ON: enabled, indicating to play back only output adaptive bitstreams protected by DRM; OFF: disabled, indicating to play back unencrypted output adaptive bitstreams.
AdaptiveDynamicStreamingDefinition	Integer	ID of the unencrypted adaptive bitrate streaming template that allows output.
DrmStreamingsInfo	DrmStreamingsInfo	Content of the DRM-protected adaptive bitrate streaming template that allows output.
ImageSpriteDefinition	Integer	ID of the image sprite generating template that allows output.
ResolutionNameSet	Array of ResolutionNameInfo	Display name of player for substreams with different resolutions.
CreateTime	String	Creation time of player configuration in ISO date format.
UpdateTime	String	Last modified time of player configuration in ISO date format.
Domain	String	Domain name used for playback. If its value is Default, the domain name configured in Default Distribution Configuration will be used.
Scheme	String	Scheme used for playback. Valid values: Default: the scheme configured in Default Distribution Configuration will be used; HTTP; HTTPS.
Comment	String	Template description.

PoliticalAsrReviewTemplateInfo

Parameters for ASR-based recognition of politically sensitive content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable ASR-based recognition of politically sensitive content. Valid values: ON OFF
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100

PoliticalAsrReviewTemplateInfoForUpdate

Parameters for ASR-based recognition of politically sensitive content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable ASR-based recognition of politically sensitive content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

PoliticalConfigureInfo

Parameters for recognition of politically sensitive content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
ImgReviewInfo	PoliticalImgReviewTemplateInfo	No	Parameters for recognition of politically sensitive content in images Note: This field may return null, indicating that no valid value can be found.
AsrReviewInfo	PoliticalAsrReviewTemplateInfo	No	Parameters for ASR-based recognition of politically sensitive content Note: This field may return null, indicating that no valid value can be found.
OcrReviewInfo	PoliticalOcrReviewTemplateInfo	No	Parameters for OCR-based recognition of politically sensitive content Note: This field may return null, indicating that no valid value can be found.

PoliticalConfigureInfoForUpdate

Parameters for recognition of politically sensitive content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
ImgReviewInfo	PoliticalImgReviewTemplateInfoForUpdate	No	Parameters for recognition of politically sensitive content in images
AsrReviewInfo	PoliticalAsrReviewTemplateInfoForUpdate	No	Parameters for ASR-based recognition of politically sensitive content
OcrReviewInfo	PoliticalOcrReviewTemplateInfoForUpdate	No	Parameters for OCR-based recognition of politically sensitive content

PoliticalImageResult

The result for the recognition of politically sensitive content in the image.

Used by actions: ProcessImage.

Name	Type	Description
Confidence	Float	The confidence score for the politically sensitive content recognition result. Value range: 0-100.
Suggestion	String	The suggestion for handling the detected politically sensitive content. Valid values: pass/li> review block
Name	String	The name of the politically sensitive content or banned icon detected.
AreaCoordSet	Array of Integer	The coordinates (pixel) of the top-left and bottom-right corners of the frame where politically sensitive content or a banned icon appears. Format: [x1, y1, x2, y2].

PoliticalImgReviewTemplateInfo

Parameters for recognition of politically sensitive content in images

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable recognition of politically sensitive content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of politically sensitive content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: violation_photo: banned images politician: politically sensitive people entertainment: people in the entertainment industry sport: sportspeople entrepreneur: businesspeople scholar: scholars celebrity: celebrities military: people in military
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 97 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 95 will be used by default. Value range: 0-100

PoliticalImgReviewTemplateInfoForUpdate

Parameters for recognition of politically sensitive content in images

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable recognition of politically sensitive content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of politically sensitive content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: violation_photo: banned images politician: politically sensitive people entertainment: people in the entertainment industry sport: sportspeople entrepreneur: businesspeople scholar: scholars celebrity: celebrities military: people in military
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

PoliticalOcrReviewTemplateInfo

Parameters for OCR-based recognition of politically sensitive content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable OCR-based recognition of politically sensitive content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

PoliticalOcrReviewTemplateInfoForUpdate

Parameters for OCR-based recognition of politically sensitive content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable OCR-based recognition of politically sensitive content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

PornAsrReviewTemplateInfo

Parameters for ASR-based recognition of pornographic content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable ASR-based recognition of pornographic content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

PornAsrReviewTemplateInfoForUpdate

Parameters for ASR-based recognition of pornographic content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable ASR-based recognition of pornographic content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

PornConfigureInfo

Parameters for recognition of pornographic content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
ImgReviewInfo	PornImgReviewTemplateInfo	No	Parameters for recognition of pornographic content in images Note: This field may return null, indicating that no valid value can be found.
AsrReviewInfo	PornAsrReviewTemplateInfo	No	Parameters for ASR-based recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.
OcrReviewInfo	PornOcrReviewTemplateInfo	No	Parameters for OCR-based recognition of pornographic content Note: This field may return null, indicating that no valid value can be found.

PornConfigureInfoForUpdate

Parameters for recognition of pornographic content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
ImgReviewInfo	PornImgReviewTemplateInfoForUpdate	No	Parameters for recognition of pornographic content in images
AsrReviewInfo	PornAsrReviewTemplateInfoForUpdate	No	Parameters for ASR-based recognition of pornographic content
OcrReviewInfo	PornOcrReviewTemplateInfoForUpdate	No	Parameters for OCR-based recognition of pornographic content

PornImageResult

The result for the recognition of pornographic content in the image.

Used by actions: ProcessImage.

Name	Type	Description
Confidence	Float	The confidence score for the pornographic content recognition result. Value range: 0-100.
Suggestion	String	The suggestion for handling the detected pornographic content. Valid values: pass/li> review block
Label	String	The label for the detected pornographic content. Valid values: porn sexy vulgar intimacy

PornImgReviewTemplateInfo

Parameters for recognition of pornographic content in images

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable recognition of pornographic content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of pornographic content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: porn vulgar intimacy sexy
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 90 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 0 will be used by default. Value range: 0-100

PornImgReviewTemplateInfoForUpdate

Parameters for recognition of pornographic content in images

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable recognition of pornographic content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of pornographic content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: porn vulgar intimacy sexy
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

PornOcrReviewTemplateInfo

Parameters for OCR-based recognition of pornographic content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable OCR-based recognition of pornographic content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

PornOcrReviewTemplateInfoForUpdate

Parameters for OCR-based recognition of pornographic content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable OCR-based recognition of pornographic content. 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.

ProcedureTask

Video processing task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Video processing task ID.
Status	String	Task flow status. Valid values: PROCESSING: processing; FINISH: completed.
ErrCode	Integer	Disused. Please use ErrCode of each specific task. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Disused. Please use Message of each specific task. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	Media file ID. If the task flow is initiated by ProcessMedia, this field means the FileId in MediaInfo; If the task flow is initiated by ProcessMediaByUrl, this field means the Id in MediaInputInfo. Note: this field may return null, indicating that no valid values can be obtained.
FileName	String	Media filename If the task flow is initiated by ProcessMedia, this field means the BasicInfo.Name in MediaInfo; If the task flow is initiated by ProcessMediaByUrl, this field means the Name in MediaInputInfo. Note: this field may return null, indicating that no valid values can be obtained.
FileUrl	String	Media file address If the task flow is initiated by ProcessMedia, this field means the BasicInfo.MediaUrl in MediaInfo; If the task flow is initiated by ProcessMediaByUrl, this field means the Url in MediaInputInfo.
MetaData	MediaMetaData	Source video metadata.
MediaProcessResultSet	Array of MediaProcessTaskResult	Execution status and result of video processing task. Note: this field may return null, indicating that no valid values can be obtained.
AiContentReviewResultSet	Array of AiContentReviewResult	Status and result of an intelligent recognition task
AiAnalysisResultSet	Array of AiAnalysisResult	Execution status and result of video content analysis task. Note: this field may return null, indicating that no valid values can be obtained.
AiRecognitionResultSet	Array of AiRecognitionResult	Execution status and result of video content recognition task. Note: this field may return null, indicating that no valid values can be obtained.
TasksPriority	Integer	Task flow priority. Value range: [-10, 10]. Note: this field may return null, indicating that no valid values can be obtained.
TasksNotifyMode	String	Notification mode for change in task flow status. Finish: an event notification will be initiated only after the task flow is completely executed; Change: an event notification will be initiated as soon as the status of a subtask in the task flow changes; None: no callback for the task flow will be accepted. Note: this field may return null, indicating that no valid values can be obtained.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters. Note: this field may return null, indicating that no valid values can be obtained.
SessionId	String	The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed. Note: this field may return null, indicating that no valid values can be obtained.

ProcedureTemplate

Task flow template details

Used by actions: DescribeProcedureTemplates.

Name	Type	Description
Name	String	Task flow name.
Type	String	Type of a task flow template. Valid values: Preset: preset task flow template; Custom: custom task flow template.
Comment	String	Template description. Length limit: 256 characters.
MediaProcessTask	MediaProcessTaskInput	Parameter of video processing task. Note: this field may return null, indicating that no valid values can be obtained.
AiContentReviewTask	AiContentReviewTaskInput	Intelligent recognition task Note: This field may return null, indicating that no valid value can be found.
AiAnalysisTask	AiAnalysisTaskInput	Parameter of AI-based content analysis task. Note: this field may return null, indicating that no valid values can be obtained.
AiRecognitionTask	AiRecognitionTaskInput	Type parameter of AI-based content recognition task. Note: this field may return null, indicating that no valid values can be obtained.
MiniProgramPublishTask	WechatMiniProgramPublishTaskInput	Parameter of a release on WeChat Mini Program task. Note: this field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

ProhibitedAsrReviewTemplateInfo

Control parameter of prohibited information detection in speech task

Used by actions: 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	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. 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	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. 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. Note: this field may return null, indicating that no valid values can be obtained.
OcrReviewInfo	ProhibitedOcrReviewTemplateInfo	No	Control parameter of prohibited information detection in text. Note: this field may return null, indicating that no valid values can be obtained.

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	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. 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	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

PullUploadTask

Video pull for upload task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Pull for upload task ID.
Status	String	Task flow status. Valid values: PROCESSING: processing; FINISH: completed.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: invalid input parameter. Please check it; 60000: invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: internal service error. Please try again.
Message	String	Error message.
FileId	String	ID of video generated after pull for upload is completed.
MediaBasicInfo	MediaBasicInfo	Basic information of media file generated after pull for upload is completed. Note: this field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	The metadata of the output video.
FileUrl	String	Playback address generated after pull for upload is completed.
ProcedureTaskId	String	If a video processing flow is specified when a video is pulled for upload, this parameter will be the ID of the task flow.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
SessionId	String	The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.

RefererAuthPolicy

Referer hotlink protection configuration

Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

Name	Type	Required	Description
Status	String	Yes	Referer hotlink protection status. Valid values: Enabled Disabled
AuthType	String	No	Referer authentication method. Valid values: Black: blocklist. Any HTTP request carrying a referer in the Referers list will be rejected. White: allowlist. Only HTTP requests carrying referers in the Referers list will be accepted. When Status is set to Enabled, AuthType must be specified.
Referers	Array of String	No	The list of referers (up to 20). When Status is set to Enabled, Referers cannot be empty. Enter domain names as referers.
BlankRefererAllowed	String	No	Whether to allow requests with empty referer to access this domain name. Valid values: Yes No When Status is set to Enabled, BlankRefererAllowed must be specified.

ResolutionNameInfo

Player substream name information

Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs, ModifySuperPlayerConfig.

Name	Type	Required	Description
MinEdgeLength	Integer	Yes	Length of video short side in px.
Name	String	Yes	Display name.

ResourceTag

Tag key value. For details, see Tags.

Used by actions: DescribeSubAppIds.

Name	Type	Required	Description
TagKey	String	Yes	Tag key.
TagValue	String	Yes	Tag value.

RestoreMediaTask

Video retrieval task information

Used by actions: PullEvents.

Name	Type	Description
FileId	String	File ID
OriginalStorageClass	String	Original storage class
TargetStorageClass	String	Target storage class. For temporary retrieval, the target storage class is the same as the original.
RestoreTier	String	Retrieval mode. Valid values: Expedited Standard Bulk
RestoreDay	Integer	Validity period (days) for a temporary copy. 0 indicates permanent retrieval.
Status	Integer	This field has been disused.
Message	String	This field has been disused.

SampleSnapshotTaskInput

Input parameter type of sampling screencapturing task

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Sampled screencapturing template ID.
WatermarkSet	Array of WatermarkInput	No	List of up to 10 image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.

SampleSnapshotTemplate

Details of a sampled screencapturing template

Used by actions: DescribeSampleSnapshotTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a sampled screencapturing template.
Type	String	Template type. Valid values: Preset: preset template; Custom: custom template.
Name	String	Name of a sampled screencapturing template.
Comment	String	Template description.
Width	Integer	Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
Height	Integer	Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
ResolutionAdaptive	String	Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height. Default value: open.
Format	String	Image format.
SampleType	String	Sampled screencapturing type.
SampleInterval	Integer	Sampling interval.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.
FillType	String	The fill mode, or the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values: stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding. black: Keep the image's original aspect ratio and fill the blank space with black bars. white: Keep the image’s original aspect ratio and fill the blank space with white bars. gauss: Keep the image’s original aspect ratio and apply Gaussian blur to the blank space. Default value: black.

SegmentConfigureInfo

Control parameter of video splitting recognition task

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of video splitting recognition task. Valid values: ON: enables intelligent video splitting recognition task; OFF: disables intelligent video splitting recognition task.

SegmentConfigureInfoForUpdate

Control parameter of video splitting recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of video splitting recognition task. Valid values: ON: enables intelligent video splitting recognition task; OFF: disables intelligent video splitting recognition task.

SnapshotByTimeOffset2017

Screencapturing output information (v2017)

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
TimeOffset	Integer	Specific time point of screenshot in milliseconds. Note: this field may return null, indicating that no valid values can be obtained.
Url	String	Address of output screenshot file. Note: this field may return null, indicating that no valid values can be obtained.

SnapshotByTimeOffsetTask2017

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

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Screencapturing task ID.
FileId	String	Screenshot file ID.
Definition	Integer	screenshot specification. For more information, please see Parameter Template for Time Point Screencapturing.
SnapshotInfoSet	Array of SnapshotByTimeOffset2017	Result information of screencapturing.

SnapshotByTimeOffsetTaskInput

Input parameter type of time point screencapturing task

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Time point screencapturing template ID.
ExtTimeOffsetSet	Array of String	No	The list of screenshot time points. “s” and “%” formats are supported: When a time point string ends with “s”, its unit is second. For example, “3.5s” means the 3.5th second of the video. When a time point string ends with “%”, it represents the percentage of the video’s duration. For example, “10%” means that the time point is at the 10% of the video’s entire duration.
TimeOffsetSet	Array of Float	No	List of time points for screencapturing in milliseconds. Note: this field may return null, indicating that no valid values can be obtained.
WatermarkSet	Array of WatermarkInput	No	List of up to 10 image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.

SnapshotByTimeOffsetTemplate

Details of a specified time point screencapturing template

Used by actions: DescribeSnapshotByTimeOffsetTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a specified time point screencapturing template.
Type	String	Template type. Valid values: Preset: preset template; Custom: custom template.
Name	String	Name of a specified time point screencapturing template.
Comment	String	Template description.
Width	Integer	Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
Height	Integer	Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0.
ResolutionAdaptive	String	Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height. Default value: open.
Format	String	Image format.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.
FillType	String	The fill mode, or the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values: stretch: Stretch the image frame by frame to fill the entire screen. The video image may become "squashed" or "stretched" after transcoding. black: Keep the image's original aspect ratio and fill the blank space with black bars. white: Keep the image’s original aspect ratio and fill the blank space with white bars. gauss: Keep the image’s original aspect ratio and apply Gaussian blur to the blank space. Default value: black.

SortBy

Sort by criterion

Used by actions: DescribeTasks, SearchMedia.

Name	Type	Description
Field	String	Sort by field
Order	String	Sorting order. Valid values: Asc (ascending), Desc (descending)

SpecificationDataItem

Statistics of task with specified specification.

Used by actions: DescribeMediaProcessUsageData.

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

SplitMediaOutputConfig

Information of video splitting output files.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Required	Description
MediaName	String	No	Name of an output file. This parameter can contain up to 64 characters, and will be generated by the system if it is left empty.
Type	String	No	Output file format. Valid values: mp4 (default), hls.
ClassId	Integer	No	Category ID, which is used to categorize the media file for management. You can use CreateClass API to create a category and get the category ID. Default value: 0, which means other categories.
ExpireTime	String	No	Expiration time of an output file. After passing the expiration time, the file will be deleted. There is no expiration time set for a file by default. The time is in ISO date format.

SplitMediaTask

Video splitting task information. This field has a value only when TaskType is SplitMedia.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task flow status. Valid values: PROCESSING: processing FINISH: finished
ErrCodeExt	String	Error code. An empty string indicates the task is successful; other values indicate failure. For details, see Video Processing Error Codes.
ErrCode	Integer	Error code. 0 indicates the task is successful; other values indicate failure. You're not recommended to use this parameter, but to use the new parameter ErrCodeExt.
Message	String	Error information.
FileInfoSet	Array of SplitMediaTaskSegmentInfo	List of video splitting task details.
SessionContext	String	The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1000 characters.
SessionId	String	ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or set to an empty string, no deduplication will be performed.

SplitMediaTaskInput

Input information of a video splitting task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
FileId	String	Video ID.
StartTimeOffset	Float	Offset of the video splitting start time in seconds. If this parameter is left empty or set to 0, the transcoded video will start at the same time as the original video. If this parameter is set to a positive number (n for example), the transcoded video will start at the nth second of the original video. If this parameter is set to a negative number (-n for example), the transcoded video will start at the nth second before the end of the original video.
EndTimeOffset	Float	Offset of the video splitting end time in seconds. If this parameter is left empty or set to 0, the transcoded video will end at the same time as the original video. If this parameter is set to a positive number (n for example), the transcoded video will end at the nth second of the original video. If this parameter is set to a negative number (-n for example), the transcoded video will end at the nth second before the end of the original video.
ProcedureName	String	Task flow template name, which should be entered if you want to perform a task flow on the generated new video.
OutputConfig	SplitMediaOutputConfig	Output information of a video splitting task.

SplitMediaTaskSegmentInfo

Information of a video splitting task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Input	SplitMediaTaskInput	Input information of a video splitting task.
Output	TaskOutputMediaInfo	Output information of a video splitting task. Note: this field may return null, indicating that no valid values can be obtained.
ProcedureTaskId	String	If a video processing flow is specified when a video splitting task is initiated, this field will be the task flow ID.

StatDataItem

Statistics

Used by actions: DescribeCDNStatDetails, DescribeCDNUsageData, DescribeReviewDetails, DescribeStorageDetails.

Name	Type	Description
Time	String	Start time of data time range in ISO date format. For example, if the time granularity is 1-day, 2018-12-01T00:00:00+08:00 represents the time range between December 1, 2018 (inclusive) and December 2, 2018 (not inclusive). For data at hourly level, 2019-08-22T00:00:00+08:00 indicates the statistics between 00:00 and 01:00 AM on August 22, 2019. For data at daily level, 2019-08-22T00:00:00+08:00 indicates statistics on August 22, 2019.
Value	Integer	Data size. Storage capacity in bytes. Transcoding duration in seconds. Traffic in bytes. Bandwidth in bps.

StickerTrackItem

Information of sticker on sticker track.

Used by actions: ComposeMedia.

Name	Type	Required	Description
SourceMedia	String	Yes	Source of media material for sticker segment, which can be: ID of VOD media files Download URL of other media files Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
Duration	Float	Yes	Sticker duration in seconds.
StartTime	Float	No	Start time of sticker on track in seconds.
CoordinateOrigin	String	No	Origin position. Valid values: Center: the origin of coordinates is the center position, such as the center of canvas. Default value: Center.
XPos	String	No	The horizontal position of the origin of the sticker relative to the origin of the canvas. % and px formats are supported: If the string ends in %, the XPos of the sticker will be at the position of the specified percentage of the canvas width; for example, 10% means that XPos is 10% of the canvas width. If the string ends in px, the XPos of the sticker will be in px; for example, 100px means that XPos is 100 px. Default value: 0 px.
YPos	String	No	The vertical position of the origin of the sticker relative to the origin of the canvas. % and px formats are supported: If the string ends in %, the YPos of the sticker will be at the position of the specified percentage of the canvas height; for example, 10% means that YPos is 10% of the canvas height. If the string ends in px, the YPos of the sticker will be in px; for example, 100px means that YPos is 100 px. Default value: 0 px.
Width	String	No	Sticker width. % and px formats are supported: If the string ends in %, the Width of the sticker will be the specified percentage of the canvas width; for example, 10% means that Width is 10% of the canvas width. If the string ends in px, the Width of the sticker will be in px; for example, 100px means that Width is 100 px. If both Width and Height are empty, then they will be the Width and Height of the sticker material, respectively. If Width is empty (0), but Height is not empty, Width will be proportionally scaled. If Width is not empty, but Height is empty, Height will be proportionally scaled.
Height	String	No	Sticker height. % and px formats are supported: If the string ends in %, the Height of the sticker will be the specified percentage of the canvas height; for example, 10% means that Height is 10% of the canvas height. If the string ends in px, the Height of the sticker will be in px; for example, 100px means that Height is 100 px. If both Width and Height are empty, then they will be the Width and Height of the sticker material, respectively. If Width is empty, but Height is not empty, Width will be proportionally scaled. If Width is not empty, but Height is empty, Height will be proportionally scaled.
ImageOperations	Array of ImageTransform	No	Operation on sticker such as image rotation. Note: this field may return null, indicating that no valid values can be obtained.

StorageRegionInfo

The information of a storage region.

Used by actions: DescribeStorageRegions.

Name	Type	Description
Region	String	Storage region.
Description	String	Description of the storage region.
Status	String	Whether storage is enabled in the region. Valid values: opened: Enabled unopened: Not enabled
IsDefault	Boolean	Whether the region is the default storage region. Valid values: true, false.

StorageStatData

VOD storage usage by region.

Used by actions: DescribeStorageData.

Name	Type	Description
Area	String	VOD storage billing region. Valid values: Chinese Mainland Outside Chinese Mainland
TotalStorage	Integer	Current total storage capacity in bytes.
InfrequentStorage	Integer	Current STANDARD_IA storage capacity in bytes.
StandardStorage	Integer	Current STANDARD storage capacity in bytes.
ArchiveStorage	Integer	Current ARCHIVE storage usage in bytes
DeepArchiveStorage	Integer	Current DEEP ARCHIVE storage usage in bytes

SubAppIdInfo

Subapplication information.

Used by actions: DescribeSubAppIds.

Name	Type	Description
SubAppId	Integer	Subapplication ID.
Name	String	Subapplication name.
Description	String	Subapplication overview.
CreateTime	String	Subapplication creation time of task in ISO date format.
Status	String	Subapplication status. Valid values: On: enabled Off: disabled Destroying: terminating Destroyed: terminated

SvgWatermarkInput

Input parameter of SVG watermarking template

Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

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

SvgWatermarkInputForUpdate

Input parameter of SVG watermarking template

Used by actions: ModifyWatermarkTemplate.

Name	Type	Required	Description
Width	String	No	Watermark width, which supports six formats of px, %, W%, H%, S%, and L%: If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px; if 0px is entered and Height is not 0px, the watermark width will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark width will be the width of the source SVG image; If the string ends in W%, the Width of the watermark will be the specified percentage of the video width; for example, 10W% means that Width is 10% of the video width; If the string ends in H%, the Width of the watermark will be the specified percentage of the video height; for example, 10H% means that Width is 10% of the video height; If the string ends in S%, the Width of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Width is 10% of the short side of the video; If the string ends in L%, the Width of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Width is 10% of the long side of the video; If the string ends in %, the meaning is the same as W%. Default value: 10W%.
Height	String	No	Watermark height, which supports six formats of px, %, W%, H%, S%, and L%: If the string ends in px, the Height of the watermark will be in px; for example, 100px means that Height is 100 px; if 0px is entered and Width is not 0px, the watermark height will be proportionally scaled based on the source SVG image; if 0px is entered for both Width and Height, the watermark height will be the height of the source SVG image; If the string ends in W%, the Height of the watermark will be the specified percentage of the video width; for example, 10W% means that Height is 10% of the video width; If the string ends in H%, the Height of the watermark will be the specified percentage of the video height; for example, 10H% means that Height is 10% of the video height; If the string ends in S%, the Height of the watermark will be the specified percentage of the short side of the video; for example, 10S% means that Height is 10% of the short side of the video; If the string ends in L%, the Height of the watermark will be the specified percentage of the long side of the video; for example, 10L% means that Height is 10% of the long side of the video; If the string ends in %, the meaning is the same as H%. Default value: 0 px.
CycleConfig	WatermarkCycleConfigForUpdate	No	Watermark cycle configuration, which is used to configure watermarks so that they will be displayed and hidden periodically. Primary use case: watermarks can be added at various positions in a video, which are displayed and hidden periodically to prevent them from being covered. For example, watermarks A, B, C, and D are set in the top-left corner, top-right corner, bottom-right corner, and bottom-left corner of a video, respectively. After the first video frame, { A will be displayed for 5s -> B for 5s -> C for 5s -> D for 5s } -> A for 5s -> B for 5s -> ... Only one watermark will be visible at any time. Within the braces ({}) is a major cycle composed of four watermarks, namely, A, B, C, and D, which lasts for 20 seconds in a cycle. Watermarks A, B, C, and D are displayed periodically for 5 seconds and hidden for 15 seconds each in a fixed order. This configuration item is used to describe the cycle configuration of a single watermark.

TEHDConfig

TESHD parameter configuration.

Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name	Type	Required	Description
Type	String	Yes	TESHD transcoding type. Valid values: TEHD-100 OFF (default)
MaxVideoBitrate	Integer	No	Maximum bitrate, which is valid when Type is TESHD. If this parameter is left blank or 0 is entered, there will be no upper limit for bitrate.

TEHDConfigForUpdate

TESHD parameter configuration.

Used by actions: ModifyTranscodeTemplate.

Name	Type	Required	Description
Type	String	No	TESHD transcoding type. Valid values: TEHD-100 OFF (default)
MaxVideoBitrate	Integer	No	Maximum bitrate. If this parameter is left blank, no modification will be made.

TagConfigureInfo

Control parameter of intelligent tagging task

Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

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

TagConfigureInfoForUpdate

Control parameter of intelligent tagging task

Used by actions: ModifyAIAnalysisTemplate.

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

TaskOutputMediaInfo

Output media file information of a video processing task.

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
FileId	String	Media file ID.
MediaBasicInfo	MediaBasicInfo

TaskSimpleInfo

Task overview information

Used by actions: DescribeTasks.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task status. Valid values: WAITING (waiting), PROCESSING (processing), FINISH (completed)
FileId	String	Video ID
TaskType	String	Task type. Valid values: Procedure: video processing task; EditMedia: video editing task WechatDistribute: release on WeChat task. Task types compatible with v2017: Transcode: transcoding task; SnapshotByTimeOffset: video screencapturing task Concat: video splicing task; Clip: video clipping task; ImageSprites: image sprite generating task.
CreateTime	String	Creation time of 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 empty.
FinishTime	String	End time of task in ISO date format. If the task has not been completed yet, this field will be empty.
SessionId	String	ID used for deduplication if there was a request with the same ID in the last seven days.
SessionContext	String	Source context, which is used to pass through the user request information.

TaskStatData

Video processing task statistics.

Used by actions: DescribeMediaProcessUsageData.

Name	Type	Description
TaskType	String	Task type Transcoding: basic transcoding Transcoding-TESHD: TESHD transcoding Editing: video editing AdaptiveBitrateStreaming: adaptive bitrate streaming ContentAudit: content moderation RemoveWatermark: watermark removal Transcode: transcoding, including basic transcoding, TESHD transcoding, and video editing. This value is not recommended.
Summary	Array of TaskStatDataItem	Task statistics overview (usage unit: second).
Details	Array of SpecificationDataItem	Detailed statistics of different tasks Transcoding statistics: Remuxing Audio Standard.H264.SD Standard.H264.HD Standard.H264.FHD Standard.H264.2K Standard.H264.4K Standard.H265.SD Standard.H265.HD Standard.H265.FHD Standard.H265.2K Standard.H265.4K TESHD-10.H264.SD TESHD-10.H264.HD TESHD-10.H264.FHD TESHD-10.H264.2K TESHD-10.H264.4K TESHD-10.H265.SD TESHD-10.H265.HD TESHD-10.H265.FHD TESHD-10.H265.2K TESHD-10.H265.4K Edit.Audio Edit.H264.SD Edit.H264.HD Edit.H264.FHD Edit.H264.2K Edit.H264.4K Edit.H265.SD Edit.H265.HD Edit.H265.FHD Edit.H265.2K Edit.H265.4K Watermark removal: 480P: 640 × 480 and below 720P: 1280 × 720 and below 1080P: 1920 × 1080 and below 2K: 2560 × 1440 and below 4K: 3840 × 2160 and below 8K: 7680 × 4320 and below

TaskStatDataItem

Task statistics, including number of tasks and usage.

Used by actions: DescribeMediaProcessUsageData.

Name	Type	Description
Time	String	Start time of data time range in ISO date format. For example, if the time granularity is 1-day, 2018-12-01T00:00:00+08:00 represents the time range between December 1, 2018 (inclusive) and December 2, 2018 (not inclusive).
Count	Integer	Number of tasks.
Usage	Integer	Task usage.

TempCertificate

Temporary credential

Used by actions: ApplyUpload.

Name	Type	Description
SecretId	String	Temporary security certificate ID.
SecretKey	String	Temporary security certificate Key.
Token	String	Token value.
ExpiredTime	Integer	Certificate expiration time. A Unix timestamp will be returned which is accurate down to the second.

TerrorismConfigureInfo

Parameters for recognition of terrorism content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Description
ImgReviewInfo	TerrorismImgReviewTemplateInfo	Parameters for recognition of terrorism content in images Note: This field may return null, indicating that no valid value can be found.
OcrReviewInfo	TerrorismOcrReviewTemplateInfo	Parameters for OCR-based recognition of terrorism content Note: This field may return null, indicating that no valid value can be found.

TerrorismConfigureInfoForUpdate

Parameters for recognition of terrorism content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
ImgReviewInfo	TerrorismImgReviewTemplateInfoForUpdate	No	Parameters for recognition of terrorism content in images
OcrReviewInfo	TerrorismOcrReviewTemplateInfoForUpdate	No	Parameters for OCR-based recognition of terrorism content

TerrorismImageResult

The result for the recognition of terrorism content in the image.

Used by actions: ProcessImage.

Name	Type	Description
Confidence	Float	The confidence score for the terrorism content recognition result. Value range: 0-100.
Suggestion	String	The suggestion for handling the detected terrorism content. Valid values: pass/li> review block
Label	String	The label for the detected terrorism content. Valid values: guns crowd police bloody banners explosion scenario (terrorist scenes)

TerrorismImgReviewTemplateInfo

Parameters for recognition of terrorism content in images

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable recognition of terrorism content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of terrorism content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: guns: weapons and guns crowd: crowd bloody: bloody scenes police: police force banners: terrorism flags militant: militants explosion: explosions and fires terrorists: terrorists scenario: terrorism images
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 90 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 80 will be used by default. Value range: 0-100

TerrorismImgReviewTemplateInfoForUpdate

Parameters for recognition of terrorism content in images

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable recognition of terrorism content in images. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for recognition of terrorism content in images. Results containing the specified labels are returned. If no labels are specified, all results are returned. Valid values: guns: weapons and guns crowd: crowd bloody: bloody scenes police: police force banners: terrorism flags militant: militants explosion: explosions and fires terrorists: terrorists scenario: terrorism images
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

TerrorismOcrReviewTemplateInfo

Parameters for OCR-based recognition of terrorism content

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable OCR-based recognition of terrorism content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

TerrorismOcrReviewTemplateInfoForUpdate

Parameters for OCR-based recognition of terrorism content

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable OCR-based recognition of terrorism content. Valid values: ON OFF
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. 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 Npx format where N is a numeric value.
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.

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 Npx format where N is a numeric value.
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

TimeRange

General data type used to describe a time period.

Used by actions: DescribeTasks, SearchMedia.

Name	Type	Required	Description
After	String	No	After or at this time (start time). In ISO 8601 format. For more information, please see ISO Date Format.
Before	String	No	Earlier than this time (end time). In ISO 8601 format. For more information, please see ISO date format.

TranscodePlayInfo2017

Video transcoding playback information (v2017)

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
Url	String	Playback address.
Definition	Integer	Transcoding specification ID. For more information, please see Transcoding Parameter Template.
Bitrate	Integer	Sum of the average bitrate of a video stream and that of an audio stream in bps.
Height	Integer	Maximum value of the height of a video stream in px.
Width	Integer	Maximum value of the width of a video stream in px.

TranscodeTask2017

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

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Transcoding task ID.
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	ID of transcoded file. Note: this field may return null, indicating that no valid values can be obtained.
FileName	String	Name of transcoded file. Note: this field may return null, indicating that no valid values can be obtained.
Duration	Integer	Video duration in seconds. Note: this field may return null, indicating that no valid values can be obtained.
CoverUrl	String	Cover address. Note: this field may return null, indicating that no valid values can be obtained.
PlayInfoSet	Array of TranscodePlayInfo2017	Playback information generated after video transcoding. Note: this field may return null, indicating that no valid values can be obtained.

TranscodeTaskInput

Input parameter type of transcoding task

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Video transcoding template ID.
WatermarkSet	Array of WatermarkInput	No	List of up to 10 image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
MosaicSet	Array of MosaicInput	No	List of blurs. Up to 10 ones can be supported.
HeadTailSet	Array of HeadTailTaskInput	No	List of video opening/closing credits configuration template IDs. You can enter up to 10 IDs.
StartTimeOffset	Float	No	Start time offset of a transcoded video, in seconds. If this parameter is left empty or set to 0, the transcoded video will start at the same time as the original video. If this parameter is set to a positive number (n for example), the transcoded video will start at the nth second of the original video. If this parameter is set to a negative number (-n for example), the transcoded video will start at the nth second before the end of the original video.
EndTimeOffset	Float	No	End time offset of a transcoded video, in seconds. If this parameter is left empty or set to 0, the transcoded video will end at the same time as the original video. If this parameter is set to a positive number (n for example), the transcoded video will end at the nth second of the original video. If this parameter is set to a negative number (-n for example), the transcoded video will end at the nth second before the end of the original video.

TranscodeTemplate

Transcoding template details

Used by actions: DescribeTranscodeTemplates.

Name	Type	Description
Definition	String	Unique ID of transcoding template.
Container	String	Container. Valid values: mp4, flv, hls, mp3, flac, ogg.
Name	String	Transcoding 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: 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. Note: this field may return null, indicating that no valid values can be obtained.
ContainerType	String	Container filter. Valid values: Video: video container that can contain both video stream and audio stream; PureAudio: audio container that can contain only audio stream.
CreateTime	String	Creation time of template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.

TransitionOpertion

Transition operation

Used by actions: ComposeMedia.

Name	Type	Required	Description
Type	String	Yes	Transition type. Valid values: Video image transition operation, which is used for transition with video image between two video segments: ImageFadeInFadeOut: video image fade-in/fade-out. BowTieHorizontal: horizontal bow. BowTieVertical: vertical bow. ButterflyWaveScrawler: waggling. Cannabisleaf: maple leaf. Circle: curved circling. CircleCrop: circle gathering. Circleopen: elliptic gathering. Crosswarp: horizontal warping. Cube: cube. DoomScreenTransition: curtain. Doorway: doorway. Dreamy: wave. DreamyZoom: horizontal gathering. FilmBurn: evening glow. GlitchMemories: joggling. Heart: heart. InvertedPageCurl: page turning. Luma: corroding. Mosaic: grid. Pinwheel: pinwheel. PolarFunction: elliptic diffusing. PolkaDotsCurtain: curved diffusing. Radial: radar scan. RotateScaleFade: vertical rotating. Squeeze: vertical gathering. Swap: zooming in. Swirl: swirling. UndulatingBurnOutSwirl: water spreading. Windowblinds: blinds. WipeDown: collapsing down. WipeLeft: collapsing to the left. WipeRight: collapsing to the right. WipeUp: collapsing up. ZoomInCircles: ripples. Audio transition operation, which is used for transition between two audio segments: AudioFadeInFadeOut: audio fade-in/fade-out.

UrlSignatureAuthPolicy

Key hotlink protection information for generating the signature

Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

Name	Type	Required	Description
Status	String	Yes	Whether to enable or disable key hotlink protection. Valid values: Enabled: enable Disabled: disable
EncryptedKey	String	No	The key for generating the signature of key hotlink protection. EncryptedKey can contain 8-40 bytes, and cannot contain non-printable characters.

UserDefineAsrTextReviewTemplateInfo

Parameters for custom ASR-based recognition

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable custom ASR-based recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom ASR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom ASR-based recognition. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

UserDefineAsrTextReviewTemplateInfoForUpdate

Parameters for custom ASR-based recognition

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable custom ASR-based recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom ASR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom ASR-based recognition. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

UserDefineConfigureInfo

Parameters for custom recognition

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
FaceReviewInfo	UserDefineFaceReviewTemplateInfo	No	Parameters for custom facial recognition Note: This field may return null, indicating that no valid value can be found.
AsrReviewInfo	UserDefineAsrTextReviewTemplateInfo	No	Parameters for custom ASR-based recognition Note: This field may return null, indicating that no valid value can be found.
OcrReviewInfo	UserDefineOcrTextReviewTemplateInfo	No	Parameters for custom OCR-based recognition Note: This field may return null, indicating that no valid value can be found.

UserDefineConfigureInfoForUpdate

Parameters for custom recognition

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
FaceReviewInfo	UserDefineFaceReviewTemplateInfoForUpdate	No	Parameters for custom facial recognition
AsrReviewInfo	UserDefineAsrTextReviewTemplateInfoForUpdate	No	Parameters for custom ASR-based recognition
OcrReviewInfo	UserDefineOcrTextReviewTemplateInfoForUpdate	No	Parameters for custom OCR-based recognition

UserDefineFaceReviewTemplateInfo

Parameters for custom facial recognition

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable custom facial recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom facial recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding custom facial libraries. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 97 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 95 will be used by default. Value range: 0-100

UserDefineFaceReviewTemplateInfoForUpdate

Parameters for custom facial recognition

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable custom facial recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom facial recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding custom facial libraries. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

UserDefineOcrTextReviewTemplateInfo

Parameters for custom OCR-based recognition

Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable custom OCR-based recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom OCR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom OCR-based recognition. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. If this parameter is left empty, 100 will be used by default. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. If this parameter is left empty, 75 will be used by default. Value range: 0-100

UserDefineOcrTextReviewTemplateInfoForUpdate

Parameters for custom OCR-based recognition

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Whether to enable custom OCR-based recognition. Valid values: ON OFF
LabelSet	Array of String	No	Filter labels for custom OCR-based recognition. Results containing the specified labels are returned. If no labels are specified, all results are returned. To filter by labels, specify the labels when adding keywords for custom OCR-based recognition. Up to 10 labels are allowed, each containing no more than 16 characters.
BlockConfidence	Integer	No	Confidence score threshold for determining that something should be blocked. If this threshold is reached, VOD will suggest that the content be blocked. Value range: 0-100
ReviewConfidence	Integer	No	Confidence score threshold for human review. If this threshold is reached, human review is needed. Value range: 0-100

VideoTemplateInfo

Video stream configuration parameter

Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name	Type	Required	Description
Codec	String	Yes	Video stream encoder. Valid values: libx264: H.264 libx265: H.265 av1: AOMedia Video 1 Currently, a resolution within 640x480 must be specified for H.265. and the av1 container only supports mp4.
Fps	Integer	Yes	Video frame rate in Hz. Value range: [0,100]. If the value is 0, the frame rate will be the same as that of the source video.
Bitrate	Integer	Yes	Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000]. If the value is 0, the bitrate of the video will be the same as that of the source video.
ResolutionAdaptive	String	No	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. Note: this field may return null, indicating that no valid values can be obtained.
Width	Integer	No	Maximum value of the width (or long side) of a video stream in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0. Note: this field may return null, indicating that no valid values can be obtained.
Height	Integer	No	Maximum value of the height (or short side) of a video stream in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used. Default value: 0. Note: this field may return null, indicating that no valid values can be obtained.
FillType	String	No	Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values: stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding. black: fills the uncovered area with black color, without changing the image's aspect ratio. white: fills the uncovered area with white color, without changing the image's aspect ratio. gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio. Default value: black
Vcrf	Integer	No	Video Constant Rate Factor (CRF). Value range: 1-51. If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used. We don’t recommend specifying this parameter unless you have special requirements.
Gop	Integer	No	I-frame interval in frames. Valid values: 0 and 1-100000. When this parameter is set to 0 or left empty, Gop will be automatically set.

VideoTemplateInfoForUpdate

Video stream configuration parameter

Used by actions: ModifyTranscodeTemplate.

Name	Type	Required	Description
Codec	String	No	Video stream encoder. Valid values: libx264: H.264 libx265: H.265 av1: AOMedia Video 1 Currently, a resolution within 640x480 must be specified for H.265. and the av1 container only supports mp4.
Fps	Integer	No	Video frame rate in Hz. Value range: [0,100]. If the value is 0, the frame rate will be the same as that of the source video.
Bitrate	Integer	No	Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000]. If the value is 0, the bitrate of the video will be the same as that of the source video.
ResolutionAdaptive	String	No	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.
Width	Integer	No	Maximum value of the width (or long side) of a video stream in px. Value range: 0 and [128, 4,096]. If both Width and Height are 0, the resolution will be the same as that of the source video; If Width is 0, but Height is not 0, Width will be proportionally scaled; If Width is not 0, but Height is 0, Height will be proportionally scaled; If both Width and Height are not 0, the custom resolution will be used.
Height	Integer	No	Maximum value of the height (or short side) of a video stream in px. Value range: 0 and [128, 4,096].
FillType	String	No	Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. Valid values: stretch: stretches video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding. black: fills the uncovered area with black color, without changing the image's aspect ratio. white: fills the uncovered area with white color, without changing the image's aspect ratio. gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Vcrf	Integer	No	Video Constant Rate Factor (CRF). Value range: 0-51. This parameter will be disabled if you enter 0. We don’t recommend specifying this parameter unless you have special requirements.
Gop	Integer	No	I-frame interval in frames. Valid values: 0 and 1-100000. When this parameter is set to 0 or left empty, Gop will be automatically set.

VideoTrackItem

Video segment information of video track.

Used by actions: ComposeMedia.

Name	Type	Required	Description
SourceMedia	String	Yes	Source of media material for video segment, which can be: ID of VOD media files Download URL of other media files. Note: when a download URL of other media files is used as the material source and access control (such as hotlink protection) is enabled, the URL needs to carry access control parameters (such as hotlink protection signature).
SourceMediaStartTime	Float	No	Start time of video segment in material file in seconds. Default value: 0.
Duration	Float	No	Video segment duration in seconds. By default, the length of the video material will be used, which means that the entire material will be captured. If the source file is an image, Duration needs to be greater than 0.
CoordinateOrigin	String	No	Video origin position. Valid values: Center: the origin of coordinates is the center position, such as the center of canvas. Default value: Center.
XPos	String	No	The horizontal position of the origin of the video segment relative to the origin of the canvas. % and px formats are supported: If the string ends in %, the XPos of the video segment will be at the position of the specified percentage of the canvas width; for example, 10% means that XPos is 10% of the canvas width. If the string ends in px, the XPos of the video segment will be in px; for example, 100px means that XPos is 100 px. Default value: 0 px.
YPos	String	No	The vertical position of the origin of the video segment relative to the origin of the canvas. % and px formats are supported: If the string ends in %, the YPos of the video segment will be at the position of the specified percentage of the canvas height; for example, 10% means that YPos is 10% of the canvas height. If the string ends in px, the YPos of the video segment will be in px; for example, 100px means that YPos is 100 px. Default value: 0 px.
Width	String	No	Video segment width. % and px formats are supported: If the string ends in %, the Width of the video segment will be the specified percentage of the canvas width; for example, 10% means that Width is 10% of the canvas width. If the string ends in px, the Width of the video segment will be in px; for example, 100px means that Width is 100 px. If both Width and Height are empty, then they will be the Width and Height of the video material, respectively. If Width is empty, but Height is not empty, Width will be proportionally scaled. If Width is not empty, but Height is empty, Height will be proportionally scaled.
Height	String	No	Video segment height. % and px formats are supported: If the string ends in %, the Height of the video segment will be the specified percentage of the canvas height; for example, 10% means that Height is 10% of the canvas height; If the string ends in px, the Height of the video segment will be in px; for example, 100px means that Height is 100 px. If both Width and Height are empty, then they will be the Width and Height of the video material, respectively. If Width is empty, but Height is not empty, Width will be proportionally scaled. If Width is not empty, but Height is empty, Height will be proportionally scaled.
ImageOperations	Array of ImageTransform	No	Operation on video image such as image rotation. Note: this field may return null, indicating that no valid values can be obtained.
AudioOperations	Array of AudioTransform	No	Operation on audio such as muting. Note: this field may return null, indicating that no valid values can be obtained.

WatermarkCycleConfigForUpdate

Watermark cycle configuration.

Used by actions: ModifyWatermarkTemplate.

Name	Type	Required	Description
StartTime	Float	No	Playback time point in seconds when a watermark appears in a video for the first time.
DisplayDuration	Float	No	Display duration of a watermark in a watermark cycle in seconds.
CycleDuration	Float	No	Duration of a watermark cycle in seconds. If 0 is entered, a watermark will last for only one cycle (i.e., visible for DisplayDuration seconds throughout the video).

WatermarkInput

Watermark parameter type of video processing task

Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

Name	Type	Required	Description
Definition	Integer	Yes	Watermarking template ID.
TextContent	String	No	Text content, which contains up to 100 characters. Set this parameter only when the watermark type is text. VOD does not support adding text watermarks on screenshots.
SvgContent	String	No	SVG content, which contains up to 2,000,000 characters. Set this parameter only when the watermark type is SVG. VOD does not support adding SVG watermarks on screenshots.
StartTimeOffset	Float	No	Start time offset of a watermark in seconds. If this parameter is left blank or 0 is entered, the watermark will appear upon the first video frame. If this parameter is left blank or 0 is entered, the watermark will appear upon the first video frame; If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame; If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame.
EndTimeOffset	Float	No	End time offset of a watermark in seconds. If this parameter is left blank or 0 is entered, the watermark will exist till the last video frame; If this value is greater than 0 (e.g., n), the watermark will exist till second n; If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame.

WatermarkTemplate

Watermarking template details

Used by actions: DescribeWatermarkTemplates.

Name	Type	Description
Definition	Integer	Unique ID of watermarking template.
Type	String	Watermark type. Valid values: image: image watermark; text: text watermark.
Name	String	Watermarking template name. Note: this field may return null, indicating that no valid values can be obtained.
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 template in ISO date format.
UpdateTime	String	Last modified time of template in ISO date format.
CoordinateOrigin	String	Origin position. Valid values: topLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text; topRight: the origin of coordinates is in the top-right corner of the video, and the origin of the watermark is in the top-right corner of the image or text; bottomLeft: the origin of coordinates is in the bottom-left corner of the video, and the origin of the watermark is in the bottom-left corner of the image or text; bottomRight: the origin of coordinates is in the bottom-right corner of the video, and the origin of the watermark is in the bottom-right corner of the image or text.

WechatMiniProgramPublishTask

Release on WeChat Mini Program task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task status. Valid values: WAITING: waiting; PROCESSING: processing; FINISH: completed.
ErrCode	Integer	Error code 0: success; Other values: failure.
Message	String	Error message.
FileId	String	ID of published video file.
SourceDefinition	Integer	ID of the transcoding template corresponding to the published video. 0 represents the source video.
PublishResult	String	Status of video release on WeChat Mini Program. Valid values: Pass: successfully published; Failed: failed to publish; Rejected: rejected.

WechatMiniProgramPublishTaskInput

Type of a release on WeChat Mini Program task

Used by actions: DescribeProcedureTemplates.

Name	Type	Required	Description
SourceDefinition	Integer	Yes	ID of the transcoding template corresponding to the published video. 0 represents the source video.

WechatPublishTask

Release on WeChat task information

Used by actions: DescribeTaskDetail, PullEvents.

Name	Type	Description
TaskId	String	Task ID.
Status	String	Task status. Valid values: WAITING: waiting; PROCESSING: processing; FINISH: completed.
ErrCode	Integer	Error code 0: success; Other values: failure. Note: this field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: this field may return null, indicating that no valid values can be obtained.
FileId	String	ID of published video file. Note: this field may return null, indicating that no valid values can be obtained.
Definition	Integer	Release on WeChat template ID. Note: this field may return null, indicating that no valid values can be obtained.
SourceDefinition	Integer	ID of the transcoding template corresponding to the published video. 0 represents the source video. Note: this field may return null, indicating that no valid values can be obtained.
WechatStatus	String	Release on WeChat status. Valid values: FAIL: failure; SUCCESS: success; AUDITNOTPASS: rejected NOTTRIGGERED: release on WeChat not initiated yet. Note: this field may return null, indicating that no valid values can be obtained.
WechatVid	String	WeChat Vid. Note: this field may return null, indicating that no valid values can be obtained.
WechatUrl	String	WeChat address. Note: this field may return null, indicating that no valid values can be obtained.