Data Types

AIRecognitionTemplateItem

Details of a video content recognition template

Used by actions: DescribeAIRecognitionTemplates.

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

AiAnalysisResult

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description

AiAnalysisTaskInput

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

Name	Type	Required	Description

AiContentReviewResult

Content audit result

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Type	String	Task type. Valid values: Porn: Porn information detection in image Terrorism: Terrorism information detection in image Political: Politically sensitive information detection in image Porn.Asr: ASR-based porn information detection in text Porn.Ocr: OCR-based porn information detection in text Porn.Voice: Porn information detection in speech Political.Asr: ASR-based politically sensitive information detection in text Political.Ocr: OCR-based politically sensitive information detection in text
SampleRate	Float
Duration	Float
PornTask	AiReviewTaskPornResult	Query result of an intelligent porn information detection in image task in video content audit, which is valid when task type is Porn. Note: This field may return null, indicating that no valid values can be obtained.
TerrorismTask	AiReviewTaskTerrorismResult	Query result of an intelligent terrorism information detection in image task in video content audit, which is valid when task type is Terrorism. Note: This field may return null, indicating that no valid values can be obtained.
PoliticalTask	AiReviewTaskPoliticalResult	Query result of an intelligent politically sensitive information detection in image task in video content audit, which is valid when task type is Political. Note: This field may return null, indicating that no valid values can be obtained.
PornAsrTask	AiReviewTaskPornAsrResult	Query result of an ASR-based porn information detection in text task in video content audit, which is valid when task type is Porn.Asr. Note: This field may return null, indicating that no valid values can be obtained.
PornOcrTask	AiReviewTaskPornOcrResult	Query result of an OCR-based porn information detection in text task in video content audit, which is valid when task type is Porn.Ocr. Note: This field may return null, indicating that no valid values can be obtained.
PoliticalAsrTask	AiReviewTaskPoliticalAsrResult	Query result of an ASR-based politically sensitive information detection in text task in video content audit, which is valid when task type is Political.Asr. Note: This field may return null, indicating that no valid values can be obtained.
PoliticalOcrTask	AiReviewTaskPoliticalOcrResult	Query result of an OCR-based politically sensitive information detection in text task in video content audit, which is valid when task type is Political.Ocr. Note: This field may return null, indicating that no valid values can be obtained.

AiContentReviewTaskInput

Task type of intelligent content audit

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

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

AiRecognitionResult

Intelligent recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskAsrFullTextResult

Full speech recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiRecognitionTaskAsrFullTextResultInput	Input information of a full speech recognition task.
Output	AiRecognitionTaskAsrFullTextResultOutput	Output information of a full speech recognition task. Note: This field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskAsrFullTextResultInput

Input for full speech recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Full speech recognition template ID.

AiRecognitionTaskAsrFullTextResultOutput

Full speech recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskAsrFullTextSegmentItem

Full speech recognition segment.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskAsrWordsResult

Speech keyword recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiRecognitionTaskAsrWordsResultInput	Input information of a speech keyword recognition task.
Output	AiRecognitionTaskAsrWordsResultOutput	Output information of a speech keyword recognition task. Note: This field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskAsrWordsResultInput

Input for speech keyword recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Speech keyword recognition template ID.

AiRecognitionTaskAsrWordsResultItem

Speech keyword recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskAsrWordsResultOutput

Output of speech keyword recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskAsrWordsSegmentItem

Speech recognition segment.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskFaceResult

Face recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiRecognitionTaskFaceResultInput	Input information of a face recognition task.
Output	AiRecognitionTaskFaceResultOutput	Output information of a face recognition task. Note: This field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskFaceResultInput

Face recognition input.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Face recognition template ID.

AiRecognitionTaskFaceResultItem

Face recognition result

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskFaceResultOutput

Output of intelligent face recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskFaceSegmentItem

Face recognition result segment

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskInput

Input parameter type of video content recognition

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

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

AiRecognitionTaskOcrFullTextResult

Full text recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiRecognitionTaskOcrFullTextResultInput	Input information of a full text recognition task.
Output	AiRecognitionTaskOcrFullTextResultOutput	Output information of a full text recognition task. Note: This field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskOcrFullTextResultInput

Input for full text recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Full text recognition template ID.

AiRecognitionTaskOcrFullTextResultOutput

Output of full text recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskOcrFullTextSegmentItem

Full text recognition segment.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskOcrFullTextSegmentTextItem

Full text recognition segment.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskOcrWordsResult

Text keyword recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiRecognitionTaskOcrWordsResultInput	Input information of a text keyword recognition task.
Output	AiRecognitionTaskOcrWordsResultOutput	Output information of a text keyword recognition task. Note: This field may return null, indicating that no valid values can be obtained.

AiRecognitionTaskOcrWordsResultInput

Input for text keyword recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Text keyword recognition template ID.

AiRecognitionTaskOcrWordsResultItem

Text keyword recognition result.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskOcrWordsResultOutput

Output of text keyword recognition.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiRecognitionTaskOcrWordsSegmentItem

Text recognition segment.

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalAsrTaskInput

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

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalAsrTaskOutput

ASR-detected politically sensitive information in text

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalOcrTaskInput

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

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalOcrTaskOutput

OCR-detected politically sensitive information in text

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalTaskInput

Input parameter type of a politically sensitive information detection task during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPoliticalTaskOutput

Politically sensitive information

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Confidence	Float	Score of the detected politically sensitive information in video from 0 to 100.
Suggestion	String	Suggestion for the detected politically sensitive information. Valid values: pass. review. block.
Label	String	Tag of the detected politically sensitive information in video. Valid values: politician: Politically sensitive figure. violation_photo: Violating photo.
SegmentSet	Array of MediaContentReviewPoliticalSegmentItem	List of video segments that contain the detected politically sensitive information.

AiReviewPornAsrTaskInput

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

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPornAsrTaskOutput

ASR-detected porn information in text

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPornOcrTaskInput

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

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPornOcrTaskOutput

OCR-detected porn information in text

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPornTaskInput

Input parameter type of a porn information detection task during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewPornTaskOutput

Porn information detection result

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewTaskPoliticalAsrResult

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiReviewPoliticalAsrTaskInput	Input for an ASR-based politically sensitive information detection in text task during content audit.
Output	AiReviewPoliticalAsrTaskOutput	Output of an ASR-based politically sensitive information detection in text task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskPoliticalOcrResult

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. Note: This field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: This field may return null, indicating that no valid values can be obtained.
Input	AiReviewPoliticalOcrTaskInput	Input for an OCR-based politically sensitive information detection in text task during content audit.
Output	AiReviewPoliticalOcrTaskOutput	Output of an OCR-based politically sensitive information detection in text task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskPoliticalResult

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiReviewPoliticalTaskInput	Input for a politically sensitive information detection task during content audit.
Output	AiReviewPoliticalTaskOutput	Output of a politically sensitive information detection task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskPornAsrResult

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiReviewPornAsrTaskInput	Input for an ASR-based porn information detection in text task during content audit.
Output	AiReviewPornAsrTaskOutput	Output of an ASR-based porn information detection in text task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskPornOcrResult

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiReviewPornOcrTaskInput	Input for an OCR-based porn information detection in text task during content audit.
Output	AiReviewPornOcrTaskOutput	Output of an OCR-based porn information detection in text task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskPornResult

Result type of a porn information detection task during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. Note: This field may return null, indicating that no valid values can be obtained.
Message	String	Error message. Note: This field may return null, indicating that no valid values can be obtained.
Input	AiReviewPornTaskInput	Input for a porn information detection task during content audit.
Output	AiReviewPornTaskOutput	Output of a porn information detection task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTaskTerrorismResult

Result type of a terrorism information detection task during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure.
Message	String	Error message.
Input	AiReviewTerrorismTaskInput	Input for a terrorism information detection task during content audit.
Output	AiReviewTerrorismTaskOutput	Output of a terrorism information detection task during content audit. Note: This field may return null, indicating that no valid values can be obtained.

AiReviewTerrorismTaskInput

Input parameter type of a terrorism information detection task during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

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

AiReviewTerrorismTaskOutput

Terrorism information

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Confidence	Float	Score of the detected terrorism information in a video from 0 to 100.
Suggestion	String	Suggestion for the detected terrorism information. Valid values: pass. review. block.
Label	String	Tag of the detected terrorism information in a video. Valid values: guns: Weapons and guns. crowd: Crowd. police: Police force. bloody: Bloody scenes. banners: Terrorism flags. militant: Militants. explosion: Explosions and fires. terrorists: Terrorists.
SegmentSet	Array of MediaContentReviewSegmentItem	List of video segments that contain the detected terrorism information.

AiSampleFaceInfo

AI-based sample management - face information.

Used by actions: CreatePersonSample、DescribePersonSamples、ModifyPersonSample.

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

AiSampleFaceOperation

AI-based sample management - face data operation.

Used by actions: ModifyPersonSample.

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

AiSampleFailFaceInfo

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

Used by actions: CreatePersonSample、ModifyPersonSample.

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

AiSamplePerson

AI-based sample management - figure information.

Used by actions: CreatePersonSample、DescribePersonSamples、ModifyPersonSample.

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

AiSampleTagOperation

AI-based sample management - tag operation.

Used by actions: ModifyPersonSample、ModifyWordSample.

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

AiSampleWord

AI-based sample management - keyword output information.

Used by actions: DescribeWordSamples.

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

AiSampleWordInfo

AI-based sample management - keyword input information.

Used by actions: CreateWordSamples.

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

AnimatedGraphicTaskInput

Type of an animated image generating task.

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

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

AnimatedGraphicsTemplate

Details of an animated image generating template.

Used by actions: DescribeAnimatedGraphicsTemplates.

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

AsrFullTextConfigureInfo

Control parameter of a full speech recognition task.

Used by actions: CreateAIRecognitionTemplate、DescribeAIRecognitionTemplates.

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

AsrFullTextConfigureInfoForUpdate

Control parameter of a full speech recognition task.

Used by actions: ModifyAIRecognitionTemplate.

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

AsrWordsConfigureInfo

Speech keyword recognition control parameter.

Used by actions: CreateAIRecognitionTemplate、DescribeAIRecognitionTemplates.

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

AsrWordsConfigureInfoForUpdate

Speech keyword recognition control parameter.

Used by actions: ModifyAIRecognitionTemplate.

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

AudioTemplateInfo

Audio stream configuration parameter

Used by actions: CreateTranscodeTemplate、DescribeTranscodeTemplates.

Name	Type	Required	Description
Codec	String	Yes	Audio stream codec. When the outer Container parameter is mp3, the valid value is: libmp3lame. When the outer Container parameter is ogg or flac, the valid value is: flac. When the outer Container parameter is m4a, the valid values include: libfdk_aac; libmp3lame; ac3. When the outer Container parameter is mp4 or flv, the valid values include: libfdk_aac: More suitable for mp4; libmp3lame: More suitable for flv; 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 2: Dual 6: Stereo Default value: 2.

AudioTemplateInfoForUpdate

Audio stream configuration parameter

Used by actions: ModifyTranscodeTemplate.

Name	Type	Required	Description
Codec	String	No	Audio stream codec. When the outer Container parameter is mp3, the valid value is: libmp3lame. When the outer Container parameter is ogg or flac, the valid value is: flac. When the outer Container parameter is m4a, the valid values include: libfdk_aac; libmp3lame; ac3. When the outer Container parameter is mp4 or flv, the valid values include: libfdk_aac: More suitable for mp4; libmp3lame: More suitable for flv; mp2. When the outer Container parameter is hls, the valid values include: libfdk_aac; libmp3lame.
Bitrate	Integer	No	Audio stream bitrate in Kbps. Value range: 0 and [26, 256]. If the value is 0, the bitrate of the audio stream will be the same as that of the original audio.
SampleRate	Integer	No	Audio stream sample rate. Valid values: 32,000 44,100 48,000 In Hz.
AudioChannel	Integer	No	Audio channel system. Valid values: 1: Mono 2: Dual 6: Stereo

ContentReviewTemplateItem

Details of a content audit template

Used by actions: DescribeContentReviewTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a content audit template.
Name	String	Name of a content audit template. Length limit: 64 characters.
Comment	String	Description of a content audit template. Length limit: 256 characters.
PornConfigure	PornConfigureInfo	Porn information detection control parameter. Note: This field may return null, indicating that no valid values can be obtained.
TerrorismConfigure	TerrorismConfigureInfo	Terrorism information detection control parameter. Note: This field may return null, indicating that no valid values can be obtained.
PoliticalConfigure	PoliticalConfigureInfo	Politically sensitive information detection control parameter. Note: This field may return null, indicating that no valid values can be obtained.
UserDefineConfigure	UserDefineConfigureInfo	Custom content audit control parameter. Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time of a template in ISO date format.
UpdateTime	String	Last modified time of a template in ISO date format.

CosFileUploadTrigger

Input rule bound to COS.

Used by actions: CreateWorkflow、DescribeWorkflows、ResetWorkflow.

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

CosInputInfo

Information of the COS object for video processing.

Used by actions: DescribeTaskDetail、ParseNotification、ProcessMedia.

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

CosOutputStorage

Information of a COS output object generated from video processing.

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

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

FaceConfigureInfo

Control parameter of a face recognition task

Used by actions: CreateAIRecognitionTemplate、DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a face recognition task. Valid values: ON: Enables an intelligent face recognition task; OFF: Disables an intelligent face recognition task.
Score	Float	No	Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100. Default value: 95.
DefaultLibraryLabelSet	Array of String	No	Default figure filter tag, which specifies the default figure tag that needs to be returned. If this parameter is left empty or an empty value is entered, all results of the default figures will be returned. Valid values: entertainment: Entertainment celebrity; sport: Sports celebrity; politician: Politically sensitive figure.
UserDefineLibraryLabelSet	Array of String	No	Custom figure filter tag, which specifies the custom figure tag that needs to be returned. If this parameter is left empty or an empty value is entered, all results of the custom figures will be returned. Valid values: There can be up to 10 tags, each with a length limit of 16 characters.
FaceLibrary	String	No	Figure library. Valid values: Default: Default figure library; UserDefine: Custom figure library. All: Both default and custom figure libraries will be used. Default value: All (both default and custom figure libraries will be used.)

FaceConfigureInfoForUpdate

Control parameter of a face recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a face recognition task. Valid values: ON: Enables an intelligent face recognition task; OFF: Disables an intelligent face recognition task.
Score	Float	No	Face recognition filter score. If this score is reached or exceeded, a recognition result will be returned. Value range: 0–100.
DefaultLibraryLabelSet	Array of String	No	Default figure filter tag, which specifies the default figure tag that needs to be returned. If this parameter is left empty or an empty value is entered, all results of the default figures will be returned. Valid values: entertainment: Entertainment celebrity; sport: Sports celebrity; politician: Politically sensitive figure.
UserDefineLibraryLabelSet	Array of String	No	Custom figure filter tag, which specifies the custom figure tag that needs to be returned. If this parameter is left empty or an empty value is entered, all results of the custom figures will be returned. Valid values: There can be up to 10 tags, each with a length limit of 16 characters.
FaceLibrary	String	No	Figure library. Valid values: Default: Default figure library; UserDefine: Custom figure library. All: Both default and custom figure libraries will be used.

ImageSpriteTaskInput

Input parameter type of an image sprite generating task

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

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

ImageSpriteTemplate

Details of an image sprite generating template

Used by actions: DescribeImageSpriteTemplates.

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

ImageWatermarkInput

Input parameter of an image watermarking template

Used by actions: CreateWatermarkTemplate.

Name	Type	Required	Description
ImageContent	String	Yes	String generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
Width	String	No	Watermark width. % and px formats are supported: If the string ends in %, the Width of the watermark will be the specified percentage of the video width; for example, 10% means that Width is 10% of the video width; If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px. 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 Width of the watermark will be in px; for example, 100px means that Width is 100 px. Default value: 0 px, which means that Height will be proportionally scaled according to the aspect ratio of the original watermark image.

ImageWatermarkInputForUpdate

Input parameter of an image watermarking template

Used by actions: ModifyWatermarkTemplate.

Name	Type	Required	Description
ImageContent	String	No	String generated by Base64-encoding a watermark image. JPEG and PNG images are supported.
Width	String	No	Watermark width. % and px formats are supported: If the string ends in %, the Width of the watermark will be the specified percentage of the video width; for example, 10% means that Width is 10% of the video width; If the string ends in px, the Width of the watermark will be in px; for example, 100px means that Width is 100 px.
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 Width of the watermark will be in px; for example, 100px means that Width is 100 px. 0px means that Height will be proportionally scaled according to the video width.

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 Width of the watermark will be in px; for example, 100px means that Width is 100 px; 0px means that Height will be proportionally scaled according to the video width.

LiveStreamAiRecognitionResultInfo

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description

LiveStreamAiReviewImagePoliticalResult

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

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
StartPtsTime	Float	Start PTS time of a suspected segment in seconds.
EndPtsTime	Float	End PTS time of a suspected segment in seconds.
Confidence	Float	Score of a suspected politically sensitive segment.
Suggestion	String	Suggestion for porn information detection of a suspected segment. Valid values: pass review block
Label	String	Tag of the detected politically sensitive information in video. Valid values: politician: Politically sensitive figure. violation_photo: Violating photo.
Name	String	Name of a politically sensitive figure or violating photo.
AreaCoordSet	Array of Integer	Zone coordinates (at the pixel level) of a politically sensitive figure or violating photo: [x1, y1, x2, y2], i.e., the coordinates of the top-left and bottom-right corners.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTime	String	Expiration time of a suspected image URL in ISO date format.

LiveStreamAiReviewImagePornResult

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

Used by actions: ParseLiveStreamProcessNotification.

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

LiveStreamAiReviewImageTerrorismResult

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

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
StartPtsTime	Float	Start PTS time of a suspected segment in seconds.
EndPtsTime	Float	End PTS time of a suspected segment in seconds.
Confidence	Float	Score of a suspected terrorism segment.
Suggestion	String	Suggestion for terrorism information detection of a suspected segment. Valid values: pass review block
Label	String	Tag of the detected terrorism information in a video. Valid values: guns: Weapons and guns. crowd: Crowd. police: Police force. bloody: Bloody scenes. banners: Terrorism flags. militant: Militants. explosion: Explosions and fires. terrorists: Terrorists.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTime	String	Expiration time of a suspected image URL in ISO date format.

LiveStreamAiReviewResultInfo

Result of AI-based live stream audit

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
ResultSet	Array of LiveStreamAiReviewResultItem	List of content audit results.

LiveStreamAiReviewResultItem

Result of AI-based live stream audit

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
Type	String	Content audit type. Valid values: ImagePorn: Porn information detection in image ImageTerrorism: Terrorism information detection in image ImagePolitical: Politically sensitive information detection in image PornVoice: Porn information detection in speech
ImagePornResultSet	Array of LiveStreamAiReviewImagePornResult	Result of porn information detection in image, which is valid when Type is ImagePorn.
ImageTerrorismResultSet	Array of LiveStreamAiReviewImageTerrorismResult	Result of terrorism information detection in image, which is valid when Type is ImageTerrorism.
ImagePoliticalResultSet	Array of LiveStreamAiReviewImagePoliticalResult	Result of politically sensitive information detection in image, which is valid when Type is ImagePolitical.
VoicePornResultSet	Array of LiveStreamAiReviewVoicePornResult	Result of porn information detection in speech, which is valid when Type is PornVoice.

LiveStreamAiReviewVoicePornResult

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

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
StartPtsTime	Float	Start PTS time of a suspected segment in seconds.
EndPtsTime	Float	End PTS time of a suspected segment in seconds.
Confidence	Float	Score of a suspected porn segment.
Suggestion	String	Suggestion for porn information detection of a suspected segment. Valid values: pass review block
Label	String	Tag of the detected porn information in video. Valid values: sexual_moan: Sexual moans.

LiveStreamProcessErrorInfo

Information of a live stream processing error

Used by actions: ParseLiveStreamProcessNotification.

Name	Type	Description
ErrCode	Integer	Error code: 0: No error; If this parameter is not 0, an error has occurred. Please see the error message (Message).
Message	String	Error message.

LiveStreamProcessTask

Information of a live stream processing task

Used by actions: DescribeTaskDetail.

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

LiveStreamTaskNotifyConfig

Event notification configuration of a task.

Used by actions: ProcessLiveStream.

Name	Type	Required	Description
CmqModel	String	Yes	CMQ model. There are two types: Queue and Topic. Currently, only Queue is supported.
CmqRegion	String	Yes	CMQ region, such as sh and bj.
QueueName	String	No	This parameter is valid when the model is Queue, indicating the name of the CMQ queue for receiving event notifications.
TopicName	String	No	This parameter is valid when the model is Topic, indicating the name of the CMQ topic for receiving event notifications.

MediaAnimatedGraphicsItem

Result information of an animated image generating task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Storage	TaskOutputStorage	Storage location of a generated animated image file.
Path	String	Path to a generated animated image file.
Definition	Integer	ID of an animated image generating template. For more information, please see Animated Image Generating Parameter Template.
Container	String	Animated image format, such as gif.
Height	Integer	Height of an animated image in px.
Width	Integer	Width of an animated image in px.
Bitrate	Integer	Bitrate of an animated image in bps.
Size	Integer	Size of an animated image in bytes.
Md5	String	MD5 value of an animated image.
StartTimeOffset	Float	Start time offset of an animated image in the video in seconds.
EndTimeOffset	Float	End time offset of an animated image in the video in seconds.

MediaAudioStreamItem

Information of the audio stream in a VOD file

Used by actions: DescribeTaskDetail、ParseNotification.

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

MediaContentReviewAsrTextSegmentItem

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Confidence of a suspected segment.
Suggestion	String	Suggestion for suspected segment audit. Valid values: pass. review. block.
KeywordSet	Array of String	List of suspected keywords.

MediaContentReviewOcrTextSegmentItem

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

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Confidence of a suspected segment.
Suggestion	String	Suggestion for suspected segment audit. Valid values: pass. review. block.
KeywordSet	Array of String	List of suspected keywords.
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.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTime	String	Expiration time of a suspected image URL in ISO date format.

MediaContentReviewPoliticalSegmentItem

Suspected politically sensitive segment identified during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Score of a suspected politically sensitive segment.
Suggestion	String	Suggestion for politically sensitive information detection of a suspected segment. Valid values: pass. review. block.
Name	String	Name of a politically sensitive figure or violating photo.
Label	String	Tag of politically sensitive information detection result of a suspected segment.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
AreaCoordSet	Array of Integer	Zone coordinates (at the pixel level) of a politically sensitive figure or violating photo: [x1, y1, x2, y2], i.e., the coordinates of the top-left and bottom-right corners.
PicUrlExpireTime	String	Expiration time of a suspected image URL in ISO date format.

MediaContentReviewSegmentItem

Suspected porn/terrorism segment identified during content audit

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
StartTimeOffset	Float	Start time offset of a suspected segment in seconds.
EndTimeOffset	Float	End time offset of a suspected segment in seconds.
Confidence	Float	Score of a suspected porn segment.
Label	String	Tag of porn information detection result of a suspected segment.
Suggestion	String	Suggestion for porn information detection of a suspected segment. Valid values: pass. review. block.
Url	String	URL of a suspected image (which will not be permanently stored and will be deleted after PicUrlExpireTime).
PicUrlExpireTime	String	Expiration time of a suspected image URL in ISO date format.

MediaImageSpriteItem

Image sprite information

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Image sprite specification. For more information, please see Image Sprite Parameter Template.
Height	Integer	Subimage height of an image sprite.
Width	Integer	Subimage width of an image sprite.
TotalCount	Integer	Total number of subimages in each image sprite.
ImagePathSet	Array of String	Path to each image sprite.
WebVttPath	String	Path to a WebVtt file for the position-time relationship among subimages in an image sprite. The WebVtt file indicates the corresponding time points of each subimage and their coordinates in the image sprite, which is typically used by the player for implementing preview.
Storage	TaskOutputStorage	Storage location of an image sprite file.

MediaInputInfo

Information of a video processing input object.

Used by actions: DescribeTaskDetail、ParseNotification、ProcessMedia.

Name	Type	Required	Description
Type	String	Yes	Video processing object type. Only COS is supported currently.
CosInputInfo	CosInputInfo	No	This parameter is required and valid when Type is COS, indicating the information of a COS object for video processing.

MediaMetaData

Metadata of a VOD media file

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Size	Integer	Size of an uploaded media file in bytes (which is the sum of size of m3u8 and ts files if the video is in HLS format). Note: This field may return null, indicating that no valid values can be obtained.
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.

MediaProcessTaskAnimatedGraphicResult

Result type of an animated image generating task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: Invalid input parameter. Please check it; 60000: Invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: Internal service error. Please try again.
Message	String	Error message.
Input	AnimatedGraphicTaskInput	Input for an animated image generating task.
Output	MediaAnimatedGraphicsItem	Output of an animated image generating task. Note: This field may return null, indicating that no valid values can be obtained.

MediaProcessTaskImageSpriteResult

Result type of an image sprite generating task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: Invalid input parameter. Please check it; 60000: Invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: Internal service error. Please try again.
Message	String	Error message.
Input	ImageSpriteTaskInput	Input for an image sprite generating task.
Output	MediaImageSpriteItem	Output of an image sprite generating task. Note: This field may return null, indicating that no valid values can be obtained.

MediaProcessTaskInput

Type of a video processing task

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

Name	Type	Required	Description
TranscodeTaskSet	Array of TranscodeTaskInput	No	List of transcoding tasks.
AnimatedGraphicTaskSet	Array of AnimatedGraphicTaskInput	No	List of animated image generating tasks.
SnapshotByTimeOffsetTaskSet	Array of SnapshotByTimeOffsetTaskInput	No	List of time point screencapturing tasks.
SampleSnapshotTaskSet	Array of SampleSnapshotTaskInput	No	List of sampled screencapturing tasks.
ImageSpriteTaskSet	Array of ImageSpriteTaskInput	No	List of image sprite generating tasks.

MediaProcessTaskResult

Query result type of a task

Used by actions: DescribeTaskDetail、ParseNotification.

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 a transcoding task, which is valid when task type is Transcode. Note: This field may return null, indicating that no valid values can be obtained.
AnimatedGraphicTask	MediaProcessTaskAnimatedGraphicResult	Query result of an animated image generating task, which is valid when task type is AnimatedGraphics. Note: This field may return null, indicating that no valid values can be obtained.
SnapshotByTimeOffsetTask	MediaProcessTaskSnapshotByTimeOffsetResult	Query result of a time point screencapturing task, which is valid when task type is SnapshotByTimeOffset. Note: This field may return null, indicating that no valid values can be obtained.
SampleSnapshotTask	MediaProcessTaskSampleSnapshotResult	Query result of a sampled screencapturing task, which is valid when task type is SampleSnapshot. Note: This field may return null, indicating that no valid values can be obtained.
ImageSpriteTask	MediaProcessTaskImageSpriteResult	Query result of an image sprite generating task, which is valid when task type is ImageSprite. Note: This field may return null, indicating that no valid values can be obtained.

MediaProcessTaskSampleSnapshotResult

Result type of a sampled screencapturing task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. 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.
Message	String	Error message. Note: This field may return null, indicating that no valid values can be obtained.
Input	SampleSnapshotTaskInput	Input for a sampled screencapturing task.
Output	MediaSampleSnapshotItem	Output of a sampled screencapturing task. Note: This field may return null, indicating that no valid values can be obtained.

MediaProcessTaskSnapshotByTimeOffsetResult

Result type of a time point screencapturing task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: Invalid input parameter. Please check it; 60000: Invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: Internal service error. Please try again.
Message	String	Error message.
Input	SnapshotByTimeOffsetTaskInput	Input for a time point screencapturing task.
Output	MediaSnapshotByTimeOffsetItem	Output of a time point screencapturing task. Note: This field may return null, indicating that no valid values can be obtained.

MediaProcessTaskTranscodeResult

Result type of a transcoding task

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Status	String	Task status. Valid values: PROCESSING, SUCCESS, FAIL.
ErrCode	Integer	Error code. 0: success; other values: failure. 40000: Invalid input parameter. Please check it; 60000: Invalid source file (e.g., video data is corrupted). Please check whether the source file is normal; 70000: Internal service error. Please try again.
Message	String	Error message.
Input	TranscodeTaskInput	Input for a transcoding task.
Output	MediaTranscodeItem	Output of a transcoding task. Note: This field may return null, indicating that no valid values can be obtained.

MediaSampleSnapshotItem

Information of a sampled screenshot

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Sampled screenshot specification ID. For more information, please see Sampled Screencapturing Parameter Template.
SampleType	String	Sample type. Valid values: Percent: Samples at the specified percentage interval. Time: Samples at the specified time interval.
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.
Storage	TaskOutputStorage	Storage location of a generated screenshot file.
ImagePathSet	Array of String	List of paths to generated screenshots.
WaterMarkDefinition	Array of Integer	List of watermarking template IDs if the screenshots are watermarked.

MediaSnapshotByTimeOffsetItem

Information of the time point screenshots in a VOD file

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Definition	Integer	Specification of a time point screenshot. For more information, please see Parameter Template for Time Point Screencapturing.
PicInfoSet	Array of MediaSnapshotByTimePicInfoItem	Information set of screenshots of the same specification. Each element represents a screenshot.
Storage	TaskOutputStorage	Location of a time point screenshot file.

MediaSnapshotByTimePicInfoItem

Information of a time point screenshot

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
TimeOffset	Float	Time offset corresponding to the screenshot in the video in milliseconds.
Path	String	Path to the screenshot.
WaterMarkDefinition	Array of Integer	List of watermarking template IDs if the screenshots are watermarked.

MediaTranscodeItem

Transcoding information

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
OutputStorage	TaskOutputStorage	Target bucket of an output file.
Path	String	Path to an output video file.
Definition	Integer	Transcoding specification ID. For more information, please see Transcoding Parameter.
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.
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).
Duration	Float	Video duration in seconds.
Container	String	Container, such as m4a and mp4.
Md5	String	MD5 value of a video.
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.

MediaVideoStreamItem

Information of the video stream in a VOD file

Used by actions: DescribeTaskDetail、ParseNotification.

Name	Type	Description
Bitrate	Integer	Bitrate of a video stream in bps. Note: This field may return null, indicating that no valid values can be obtained.
Height	Integer	Height of a video stream in px. Note: This field may return null, indicating that no valid values can be obtained.
Width	Integer	Width of a video stream in px. Note: This field may return null, indicating that no valid values can be obtained.
Codec	String	Video stream codec, 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.

NumberFormat

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

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

Name	Type	Required	Description
InitialValue	Integer	No	Start value of the {number} variable. Default value: 0.
Increment	Integer	No	Increment of the {number} variable. Default value: 1.
MinLength	Integer	No	Minimum length of the {number} variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1.
PlaceHolder	String	No	Placeholder used when the {number} variable length is below the minimum requirement. Default value: 0.

OcrFullTextConfigureInfo

Control parameter of a full text recognition task

Used by actions: CreateAIRecognitionTemplate、DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a full text recognition task. Valid values: ON: Enables an intelligent full text recognition task; OFF: Disables an intelligent full text recognition task.

OcrFullTextConfigureInfoForUpdate

Control parameter of a full text recognition task

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a full text recognition task. Valid values: ON: Enables an intelligent full text recognition task; OFF: Disables an intelligent full text recognition task.

OcrWordsConfigureInfo

Text keyword recognition control parameter.

Used by actions: CreateAIRecognitionTemplate、DescribeAIRecognitionTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a text keyword recognition task. Valid values: ON: Enables a text keyword recognition task; OFF: Disables a 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

Text keyword recognition control parameter.

Used by actions: ModifyAIRecognitionTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a text keyword recognition task. Valid values: ON: Enables a text keyword recognition task; OFF: Disables a 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.

PoliticalAsrReviewTemplateInfo

Control parameter of a politically sensitive information detection in speech task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

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

PoliticalAsrReviewTemplateInfoForUpdate

Control parameter of a politically sensitive information detection in speech task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a politically sensitive information detection in speech task. Valid values: ON: Enables a politically sensitive information detection in speech task; OFF: Disables a politically sensitive information detection in speech task.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

PoliticalConfigureInfo

Control parameter of a politically sensitive information detection task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
ImgReviewInfo	PoliticalImgReviewTemplateInfo	No	Control parameter of politically sensitive information detection in image. Note: This field may return null, indicating that no valid values can be obtained.
AsrReviewInfo	PoliticalAsrReviewTemplateInfo	No	Control parameter of politically sensitive information detection in speech. Note: This field may return null, indicating that no valid values can be obtained.
OcrReviewInfo	PoliticalOcrReviewTemplateInfo	No	Control parameter of politically sensitive information detection in text. Note: This field may return null, indicating that no valid values can be obtained.

PoliticalConfigureInfoForUpdate

Control parameter of a politically sensitive information detection task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
ImgReviewInfo	PoliticalImgReviewTemplateInfoForUpdate	No	Control parameter of politically sensitive information detection in image.
AsrReviewInfo	PoliticalAsrReviewTemplateInfoForUpdate	No	Control parameter of politically sensitive information detection in speech.
OcrReviewInfo	PoliticalOcrReviewTemplateInfoForUpdate	No	Control parameter of politically sensitive information detection in text.

PoliticalImgReviewTemplateInfo

Control parameter of a politically sensitive information detection in image task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a politically sensitive information detection in image task. Valid values: ON: Enables a politically sensitive information detection in image task; OFF: Disables a politically sensitive information detection in image task.
LabelSet	Array of String	No	Filter tag for politically sensitive information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: violation_photo: Violating photo; politician: Politically sensitive figure; entertainment: Entertainment celebrity; sport: Sports celebrity.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 97 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 95 will be used by default. Value range: 0–100.

PoliticalImgReviewTemplateInfoForUpdate

Control parameter of a politically sensitive information detection in image task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a politically sensitive information detection in image task. Valid values: ON: Enables a politically sensitive information detection in image task; OFF: Disables a politically sensitive information detection in image task.
LabelSet	Array of String	No	Filter tag for politically sensitive information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: violation_photo: Violating photo; politician: Politically sensitive figure; entertainment: Entertainment celebrity; sport: Sports celebrity.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

PoliticalOcrReviewTemplateInfo

Control parameter of a politically sensitive information detection in text task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

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

PoliticalOcrReviewTemplateInfoForUpdate

Control parameter of a politically sensitive information detection in text task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a politically sensitive information detection in text task. Valid values: ON: Enables a politically sensitive information detection in text task; OFF: Disables a politically sensitive information detection in text task.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

PornAsrReviewTemplateInfo

Control parameter of a porn information detection in speech task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

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

PornAsrReviewTemplateInfoForUpdate

Control parameter of a porn information detection in speech task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a porn information detection in speech task. Valid values: ON: Enables a porn information detection in speech task; OFF: Disables a porn information detection in speech task.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

PornConfigureInfo

Control parameter of a porn information detection task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

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

PornConfigureInfoForUpdate

Control parameter of a porn information detection task.

Used by actions: ModifyContentReviewTemplate.

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

PornImgReviewTemplateInfo

Control parameter of a porn information detection in image task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a porn information detection in image task. Valid values: ON: Enables a porn information detection in image task; OFF: Disables a porn information detection in image task.
LabelSet	Array of String	No	Filter tag for porn information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: porn: Porn; vulgar: Vulgarity; intimacy: Intimacy; sexy: Sexiness.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 90 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 0 will be used by default. Value range: 0–100.

PornImgReviewTemplateInfoForUpdate

Control parameter of a porn information detection in image task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a porn information detection in image task. Valid values: ON: Enables a porn information detection in image task; OFF: Disables a porn information detection in image task.
LabelSet	Array of String	No	Filter tag for porn information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: porn: Porn; vulgar: Vulgarity; intimacy: Intimacy; sexy: Sexiness.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

PornOcrReviewTemplateInfo

Control parameter of a porn information detection in text task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

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

PornOcrReviewTemplateInfoForUpdate

Control parameter of a porn information detection in text task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a porn information detection in text task. Valid values: ON: Enables a porn information detection in text task; OFF: Disables a porn information detection in text task.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

RawTranscodeParameter

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

Name	Type	Required	Description

RawWatermarkParameter

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

Name	Type	Required	Description

SampleSnapshotTaskInput

Input parameter type of a sampled screencapturing task.

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

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.
OutputStorage	TaskOutputStorage	No	Target bucket of a sampled screenshot. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.
OutputObjectPath	String	No	Output path to a generated sampled screenshot, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: {inputName}_sampleSnapshot_{definition}_{number}.{format}.
ObjectNumberFormat	NumberFormat	No	Rule of the {number} variable in the sampled screenshot output path. Note: This field may return null, indicating that no valid values can be obtained.

SampleSnapshotTemplate

Details of a sampled screencapturing template

Used by actions: DescribeSampleSnapshotTemplates.

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

SnapshotByTimeOffsetTaskInput

Input parameter type of a time point screencapturing task

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

Name	Type	Required	Description
Definition	Integer	Yes	ID of a time point screencapturing template.
TimeOffsetSet	Array of Float	Yes	List of time points of screenshots in seconds.
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.
OutputStorage	TaskOutputStorage	No	Target bucket of a generated time point screenshot file. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.
OutputObjectPath	String	No	Output path to a generated time point screenshot, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: {inputName}_snapshotByTimeOffset_{definition}_{number}.{format}.
ObjectNumberFormat	NumberFormat	No	Rule of the {number} variable in the time point screenshot output path. Note: This field may return null, indicating that no valid values can be obtained.

SnapshotByTimeOffsetTemplate

Details of a time point screencapturing template.

Used by actions: DescribeSnapshotByTimeOffsetTemplates.

Name	Type	Description
Definition	Integer	Unique ID of a time point screencapturing template.
Type	String	Template type. Valid values: Preset: Preset template; Custom: Custom template.
Name	String	Name of a 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 a template in ISO date format.
UpdateTime	String	Last modified time of a template in ISO date format.
FillType	String	Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: Stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer"; black: Fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. white: Fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: Fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur. Default value: black.

SvgWatermarkInput

Input parameter of an SVG watermarking template

Used by actions: CreateWatermarkTemplate、DescribeWatermarkTemplates.

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

SvgWatermarkInputForUpdate

Input parameter of an SVG watermarking template

Used by actions: ModifyWatermarkTemplate.

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

TEHDConfig

TESHD parameter configuration.

Used by actions: CreateTranscodeTemplate、DescribeTranscodeTemplates.

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

TEHDConfigForUpdate

TESHD parameter configuration.

Used by actions: ModifyTranscodeTemplate.

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

TaskNotifyConfig

Event notification configuration of a task.

Used by actions: CreateWorkflow、DescribeTaskDetail、DescribeWorkflows、ProcessMedia、ResetWorkflow.

Name	Type	Required	Description
CmqModel	String	Yes	CMQ model. There are two types: Queue and Topic. Currently, only Queue is supported.
CmqRegion	String	Yes	CMQ region, such as sh and bj.
QueueName	String	No	This parameter is valid when the model is Queue, indicating the name of the CMQ queue for receiving event notifications.
TopicName	String	No	This parameter is valid when the model is Topic, indicating the name of the CMQ topic for receiving event notifications.
NotifyMode	String	No	Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, Finish will be used.

TaskOutputStorage

Information of a video processing output object.

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

Name	Type	Required	Description
Type	String	Yes	Storage location type of a video processing output object. Only COS is supported currently.
CosOutputStorage	CosOutputStorage	No	This parameter is valid and required when Type is COS, indicating the location of an output COS object after video processing. Note: This field may return null, indicating that no valid values can be obtained.

TaskSimpleInfo

Task overview information

Used by actions: DescribeTasks.

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

TerrorismConfigureInfo

Control parameter of a terrorism information detection task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Description
ImgReviewInfo	TerrorismImgReviewTemplateInfo	Control parameter of a terrorism information detection in image task. Note: This field may return null, indicating that no valid values can be obtained.

TerrorismConfigureInfoForUpdate

Control parameter of a terrorism information detection task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
ImgReviewInfo	TerrorismImgReviewTemplateInfoForUpdate	No	Control parameter of a terrorism information detection in image task.

TerrorismImgReviewTemplateInfo

Control parameter of a terrorism information detection in image task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a terrorism information detection in image task. Valid values: ON: Enables a terrorism information detection in image task; OFF: Disables a terrorism information detection in image task.
LabelSet	Array of String	No	Filter tag for terrorism information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: guns: Weapons and guns; crowd: Crowd; bloody: Bloody scenes; police: Police force; banners: Terrorism flags; militant: Militants; explosion: Explosions and fires; terrorists: Terrorists.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 90 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 80 will be used by default. Value range: 0–100.

TerrorismImgReviewTemplateInfoForUpdate

Control parameter of a terrorism information detection in image task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a terrorism information detection in image task. Valid values: ON: Enables a terrorism information detection in image task; OFF: Disables a terrorism information detection in image task.
LabelSet	Array of String	No	Filter tag for terrorism information detection in image. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. Valid values: guns: Weapons and guns; crowd: Crowd; bloody: Bloody scenes; police: Police force; banners: Terrorism flags; militant: Militants; explosion: Explosions and fires; terrorists: Terrorists.
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.

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

TranscodeTaskInput

Input parameter type of a transcoding task

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

Name	Type	Required	Description
Definition	Integer	Yes	ID of a video transcoding template.
RawParameter	RawTranscodeParameter	No
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.
OutputStorage	TaskOutputStorage	No	Target bucket of an output file. If this parameter is left empty, the OutputStorage value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.
OutputObjectPath	String	No	Path to a master output file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: {inputName}_transcode_{definition}.{format}.
SegmentObjectName	String	No	Path to an output file part (the path to ts during transcoding to HLS), which can only be a relative path. If this parameter is left empty, the following relative path will be used by default: {inputName}_transcode_{definition}_{number}.{format}.
ObjectNumberFormat	NumberFormat	No	Rule of the {number} variable in the output path after transcoding. Note: This field may return null, indicating that no valid values can be obtained.

TranscodeTemplate

Details of a transcoding template

Used by actions: DescribeTranscodeTemplates.

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

UserDefineAsrTextReviewTemplateInfo

Control parameter of a custom speech audit task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a custom speech audit task. Valid values: ON: Enables a custom speech audit task; OFF: Disables a custom speech audit task.
LabelSet	Array of String	No	Custom speech filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom speech keywords. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

UserDefineAsrTextReviewTemplateInfoForUpdate

Control parameter of a custom speech audit task

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a custom speech audit task. Valid values: ON: Enables a custom speech audit task; OFF: Disables a custom speech audit task.
LabelSet	Array of String	No	Custom speech filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom speech keywords. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

UserDefineConfigureInfo

Control parameter of a custom audit task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
FaceReviewInfo	UserDefineFaceReviewTemplateInfo	No	Control parameter of custom figure audit. Note: This field may return null, indicating that no valid values can be obtained.
AsrReviewInfo	UserDefineAsrTextReviewTemplateInfo	No	Control parameter of custom speech audit. Note: This field may return null, indicating that no valid values can be obtained.
OcrReviewInfo	UserDefineOcrTextReviewTemplateInfo	No	Control parameter of custom text audit. Note: This field may return null, indicating that no valid values can be obtained.

UserDefineConfigureInfoForUpdate

Control parameter of a custom audit task.

Used by actions: ModifyContentReviewTemplate.

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

UserDefineFaceReviewTemplateInfo

Control parameter of a custom figure audit task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a custom figure audit task. Valid values: ON: Enables a custom figure audit task; OFF: Disables a custom figure audit task.
LabelSet	Array of String	No	Custom figure filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for the custom figure library. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 97 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 95 will be used by default. Value range: 0–100.

UserDefineFaceReviewTemplateInfoForUpdate

Control parameter of a custom figure audit task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a custom figure audit task. Valid values: ON: Enables a custom figure audit task; OFF: Disables a custom figure audit task.
LabelSet	Array of String	No	Custom figure filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for the custom figure library. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

UserDefineOcrTextReviewTemplateInfo

Control parameter of a custom text audit task

Used by actions: CreateContentReviewTemplate、DescribeContentReviewTemplates.

Name	Type	Required	Description
Switch	String	Yes	Switch of a custom text audit task. Valid values: ON: Enables a custom text audit task; OFF: Disables a custom text audit task.
LabelSet	Array of String	No	Custom text filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom text keywords. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. If this parameter is left empty, 100 will be used by default. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. If this parameter is left empty, 75 will be used by default. Value range: 0–100.

UserDefineOcrTextReviewTemplateInfoForUpdate

Control parameter of a custom text audit task.

Used by actions: ModifyContentReviewTemplate.

Name	Type	Required	Description
Switch	String	No	Switch of a custom text audit task. Valid values: ON: Enables a custom text audit task; OFF: Disables a custom text audit task.
LabelSet	String	No	Custom text filter tag. If an audit result contains the selected tag, it will be returned; if the filter tag is empty, all audit results will be returned. To use the tag filtering feature, you need to add the corresponding tag when adding materials for custom text keywords. There can be up to 10 tags, each with a length limit of 16 characters.
BlockConfidence	Integer	No	Threshold score for violation. If this score is reached or exceeded during intelligent audit, it will be deemed that a suspected violation has occurred. Value range: 0–100.
ReviewConfidence	Integer	No	Threshold score for human audit. If this score is reached or exceeded during intelligent audit, human audit will be considered necessary. Value range: 0–100.

VideoTemplateInfo

Video stream configuration parameter

Used by actions: CreateTranscodeTemplate、DescribeTranscodeTemplates.

Name	Type	Required	Description
Codec	String	Yes	Video stream codec. Valid values: libx264: H.264 libx265: H.265 Currently, a resolution within 640*480p must be specified for H.265.
Fps	Integer	Yes	Video frame rate in Hz. Value range: [0, 60]. If the value is 0, the frame rate will be the same as that of the source video.
Bitrate	Integer	Yes	Bitrate of a video stream in Kbps. Value range: 0 and [128, 35,000]. If the value is 0, the bitrate of the video will be the same as that of the source video.
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.
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.
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.
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. 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.

VideoTemplateInfoForUpdate

Video stream configuration parameter

Used by actions: ModifyTranscodeTemplate.

Name	Type	Required	Description
Codec	String	No	Video stream codec. Valid values: libx264: H.264 libx265: H.265 Currently, a resolution within 640*480p must be specified for H.265.
Fps	Integer	No	Video frame rate in Hz. Value range: [0, 60]. If the value is 0, the frame rate will be the same as that of the source video.
Bitrate	Integer	No	Bitrate of a video stream in Kbps. Value range: 0 and [128, 35,000]. If the value is 0, the bitrate of the video will be the same as that of the source video.
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. 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.

WatermarkInput

Watermark parameter type of a video processing task

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

Name	Type	Required	Description
Definition	Integer	Yes	ID of a watermarking template.
RawParameter	RawWatermarkParameter	No
TextContent	String	No	Text content of up to 100 characters. This field is required only when the watermark type is text.
SvgContent	String	No	SVG content of up to 2,000,000 characters. This field is required only when the watermark type is SVG.
StartTimeOffset	Float	No	Start time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame; If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame; If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame.
EndTimeOffset	Float	No	End time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame; If this value is greater than 0 (e.g., n), the watermark will exist till second n; If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame.

WatermarkTemplate

Details of a watermarking template

Used by actions: DescribeWatermarkTemplates.

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

WorkflowInfo

Workflow information details.

Used by actions: DescribeWorkflows.

Name	Type	Description
WorkflowId	Integer	Workflow ID.
WorkflowName	String	Workflow name.
Status	String	Workflow status. Valid values: Enabled: Enabled, Disabled: Disabled.
Trigger	WorkflowTrigger	Input rule bound to a workflow. If an uploaded video hits the rule for the object, the workflow will be triggered.
OutputStorage	TaskOutputStorage	Target storage of a video processing output file. Note: This field may return null, indicating that no valid values can be obtained.
MediaProcessTask	MediaProcessTaskInput	Parameter of a video processing task. Note: This field may return null, indicating that no valid values can be obtained.
AiContentReviewTask	AiContentReviewTaskInput	Type parameter of a video content audit task. Note: This field may return null, indicating that no valid values can be obtained.
AiAnalysisTask	AiAnalysisTaskInput
AiRecognitionTask	AiRecognitionTaskInput	Type parameter of a video content recognition task. Note: This field may return null, indicating that no valid values can be obtained.
TaskNotifyConfig	TaskNotifyConfig	Event notification information of a task. If this parameter is left empty, no event notifications will be obtained. Note: This field may return null, indicating that no valid values can be obtained.
TaskPriority	Integer	Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
OutputDir	String	Target directory of a video processing output file, such as /movie/201907/.
CreateTime	String	Creation time of a workflow in ISO date format.
UpdateTime	String	Last modified time of a workflow in ISO date format.

WorkflowTask

Information of a video processing task

Used by actions: DescribeTaskDetail、ParseNotification.

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.
Message	String	Disused. Please use Message of each specific task.
InputInfo	MediaInputInfo	Information of a target file of video processing. Note: This field may return null, indicating that no valid values can be obtained.
MetaData	MediaMetaData	Metadata of a source video. Note: This field may return null, indicating that no valid values can be obtained.
MediaProcessResultSet	Array of MediaProcessTaskResult	Execution status and result of a video processing task.
AiContentReviewResultSet	Array of AiContentReviewResult	Execution status and result of a video content audit task.
AiAnalysisResultSet	Array of AiAnalysisResult
AiRecognitionResultSet	Array of AiRecognitionResult	Execution status and result of a video content recognition task.

WorkflowTrigger

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

Used by actions: CreateWorkflow、DescribeWorkflows、ResetWorkflow.

Name	Type	Required	Description
Type	String	Yes	Trigger type. Only CosFileUpload is supported currently.
CosFileUploadTrigger	CosFileUploadTrigger	No	This parameter is required and valid when Type is CosFileUpload, indicating the COS trigger rule. Note: This field may return null, indicating that no valid values can be obtained.