Data types - API Reference| Alibaba Cloud Documentation Center

AliyunProperties

Attribute type

Name	Type	Description
Format	AliyunFormatInfo	Format information
Streams	AliyunStreamsInfo	Stream information

AliyunFormatInfo

Format information type

Name	Type	Description
NumStreams	String	Total number of media streams
NumPrograms	String	Total number of program streams
FormatName	String	Brief name of the container/encapsulation format
FormatName	String	Long name of the container/encapsulation format
StartTime	String	Start time
Duration	String	Total time
Size	String	File size
Bitrate	String	Total bit rate

AliyunStreamsInfo

Stream information type

Name	Type	Description
VideoStreamList	AliyunVideoStream[]	Video stream list
VideoStreamList	AliyunVideoStream[]	Audio stream list
SubtitleStreamList	AliyunSubtitleStream[]	Subtitle stream list

AliyunVideoStream

Video stream information type

Name	Type	Description
Index	String	Video stream number, used to identify the position of the video stream in the whole media streams
CodecName	String	Brief name of the encoding format
CodecLongName	String	Long name of the encoding format
Profile	String	Encoding preset
CodecTimeBase	String	Encoding time base
CodecTagString	String	Mark text of the encoding format
CodecTag	String	Encoding format mark
Width	String	Video resolution width
Height	String	Video resolution height
HasBFrames	String	Whether the video has B frames
Sar	String	Encoding signal resolution ratio
Dar	String	Encoding display resolution ratio
PixFmt	String	Pixel format
Level	String	Encoding level
Fps	String	Frame rate
AvgFPS	String	Average frame rate
Timebase	String	Time base
StartTime	String	Start time
Duration	String	Length
Bitrate	String	Bit rate
NumFrames	String	Total number of frames
Lang	String	Language. For more information, see FFmpeg language definition and ISO-639.
Rotate	String	Video rotation angle

AliyunAudioStream

Audio stream information type

Name	Type	Description
Index	String	Audio stream number, used to identify the position of the audio stream in the whole media streams
CodecName	String	Brief name of the encoding format
CodecLongName	String	Long name of the encoding format
CodecTimeBase	String	Encoding time base
CodecTagString	String	Mark text of the encoding format
CodecTag	String	Encoding format mark
SampleFmt	String	Sample format
Samplerate	String	Sampling rate
Channels	String	Number of audio channels
ChannelLayout	String	Audio channel output layout
Timebase	String	Time base
StartTime	String	Start time
Duration	String	Length
Bitrate	String	Bit rate
NumFrames	String	Total number of frames
Lang	String	Language. For more information, see FFmpeg language definition and ISO-639.

AliyunSubtitleStream

Subtitle stream information type

Name	Type	Description
Index	String	Subtitle stream number, used to identify the position of the subtitle stream in the whole media streams
Lang	String	Language. For more information, see FFmpeg language definition and ISO-639.

AliyunTemplate

Transcoding template type

Name	Type	Description
Id	String	Transcoding template ID
Name	String	Template name
Container	AliyunContainer	Container
Audio	AliyunAudioCodec	Audio codec configurations
Video	AliyunVideoCodec	Video codec configurations
TransConfig	AliyunTransConfig	General transcoding configurations
MuxConfig	AliyunMuxConfig	Transcoding encapsulation configurations
State	String	Template status, which has the following options: Normal and Deleted.

AliyunContainer

Container type

Name	Type	Description
Format	String	Container format. Supported formats are FLV, MP4, TS, M3U8, GIF, MP3, OGG, and FLAC.

AliyunAudioCodec

Audio codec configuration type

Name	Type	Description
Codec	String	Audio codec format. Supported formats are AAC, MP3, Vorbis, and FLAC. The default value is ACC.
Profile	String	Audio encoding preset. If Codec is set to aac, Profile has the following options: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld
Samplerate	String	Sampling rate, which has the following options: 22050, 32000, 44100, 48000, and 96000. The default value is 44100, and the unit is Hz.
Bitrate	String	Audio bit rate of the output file. The value ranges from 8 to 1000, and the default value is 128. The unit is Kbit/s.
Channels	String	Number of audio channels, which has the following options: 1, 2. 3, 4, 5, 6, 7, and 8. The default value is 2.

AliyunVideoCodec

Video codec configuration type

Name	Type	Description
Codec	String	Codec format, which has the following options: H.264 and H.265. The default value is H.264.
Profile	String	Encoding level, which has the following options: baseline, main, and high. The default value is high. baseline: applicable to mobile devices main: applicable to SD devices high: applicable to HD devices
Bitrate	String	Average video bit rate. The value ranges from 10 to 50000. The unit is Kbit/s.
Crf	String	Bit rate, which is a quality control factor. The value ranges from 0 to 51, and the default value is 26. If CRF is set, the setting of Bitrate becomes invalid.
Width	String	Width. The value ranges from 128 to 4096, and the unit is pixel. The default value is the original video width.
Height	String	Height. The value ranges from 128 to 4096, and the unit is pixel. The default value is the original video height.
Fps	String	Frame rate. The default value is the frame rate of the input file. If the frame rate of the input file is greater than 60, 60 is used. The value must be greater than 0 and smaller than or equal to 60.
Gop	String	Maximum number of frames between two key frames. The value ranges from 1 to 1080000, and the default value is 250.
Preset	String	Video algorithm preset, which has the following options: veryfast, fast, medium, slow, and slower. The default value is medium.
ScanMode	String	Scan mode, which has the following options: interlaced and progressive.
Bufsize	String	Size of the buffer area. The value ranges from 1000 to 128000, and the default value is 6000. The unit is KB.
Maxrate	String	Peak video bit rate. The value ranges from 10 to 50000. The unit is Kbit/s.
BitrateBnd	AliyunBitrateBnd	Range of the average video bit rate
PixFmt	String	Video color format. The value options are standard color formats, such as yuv420p and yuvj420p

AliyunTransConfig

General transcoding configuration type

Name	Type	Description
TransMode	String	Transcoding mode, which has the following options: onepass, twopass, and CBR. The default value is onepass.

AliyunBitrateBnd

Range of the average bit rate

Name	Type	Description
Max	String	Maximum total bit rate. The value ranges from 10 to 50000, and the unit is Kbit/s.
Min	String	Minimum total bit rate. The value ranges from 10 to 50000, and the unit is Kbit/s.

AliyunOSSFile

OSS file type

Name	Type	Description
Bucket	String	OSS bucket, which can contain 3 to 63 bytes
Location	String	OSS service region, up to 64 bytes
Object	String	OSS object, up to 1024 bytes

AliyunJob

Task

Name	Type	Description
JobId	String	Task ID
Input	AliyunJobInput	Task input
Output	AliyunOutput	Task output
State	String	Task status, which has the following options: Submitted indicates that the task is submitted, Transcoding indicates that the task is being transcoded, TranscodeSuccess indicates that the transcoding is successful, TranscodeFail indicates that the transcoding fails, and TranscodeCancelled indicates that transcoding is canceled.
Code	String	Error code of transcoding failure
Message	String	Message of transcoding failure
Percent	String	Transcoding progress. The value range from 0 to 100.
UserData	String	Custom data
PipelineId	String	ID of the Media Transcoding queue
CreationTime	String	Time of adding the task
MNSMessageResult	AliyunMNSMessageResult	Message result sent by Message Service to notify the user of task completion

AliyunJobInput

Transcoding task input type

Name	Type	Description
Bucket	String	OSS bucket of the input task, which can contain 3 to 63 bytes
Location	String	OSS service region, up to 64 bytes
Object	String	OSS object of the of the input task, up to 1024 bytes
Audio	AliyunInputAudio	Configurations of the audio in the source transcoding media
Container	AliyunInputContainer	Configurations of the transcoding source media container

AliyunInputContainer

Source media container configuration type. If the input file is in ADPCM or PCM format, this parameter is required.

Name	Type	Description
Format	String	Source media audio format, which has the following options: alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le,s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, and u8

AliyunInputAudio

Source media audio configuration type. If the input file is in ADPCM or PCM format, this parameter is required.

Name	Type	Description
Channels	String	Number of source media audio channels. The value ranges from 1 to 8.
Samplerate	String	Source media audio sampling rate. The value ranges from 0 to 320000. The unit is Hz.

AliyunOutput

Task output type

Name	Type	Description
OutputFile	AliyunOSSFile	Output file
TemplateId	String	Template ID
WaterMarkList	AliyunWaterMark[ ]	Watermark list
Clip	AliyunClip	Video clip
Rotate	String	Video rotation angle. The value ranges from 0 to 360.
Properties	AliyunProperties	Media attribute
Priority	String	Task priority in the Media Transcoding queue. The value ranges from 1 to 10. The default value is 6, and 10 indicates the highest priority.
Container	AliyunContainer	Container. If this parameter is set, the parameter setting replaces the AliyunContainer setting of the template specified by the TemplateId.
Video	AliyunVideoCodec	Video configurations. If this parameter is set, the parameter setting replaces the AliyunVideoCodec setting of the template specified by the TemplateId.
Audio	AliyunAudioCodec	Audio configurations. If this parameter is set, the parameter setting replaces the AliyunAudioCodec setting of the template specified by the TemplateId.
TransConfig	AliyunTransConfig	General transcoding configurations. If this parameter is set, the parameter setting replaces the AliyunTransConfig setting of the template specified by the TemplateId.
MuxConfig	AliyunMuxConfig	Transcoding encapsulation configurations. If this parameter is set, the parameter setting replaces the AliyunMuxConfig setting of the template specified by the TemplateId.
UserData	String	Custom data

AliyunClip

Editing type

Name	Type	Description
TimeSpan	AliyunTimeSpan	Edited time period

AliyunTimeSpan

Edited time period type

Name	Type	Description
Seek	String	Start time
Duration	String	Duration
End	String	Truncation time at the end. For example, 5.23 indicates that the 5.23 seconds at the end will be cut. If this parameter is set, the Duration parameter becomes invalid.

AliyunMuxConfig

Encapsulation configuration type

Name	Type	Description
Segment	AliyunSegment	Slice configurations

AliyunSegment

Slice configuration type

Name	Type	Description
Duration	String	Slice length. The value ranges from 1 to 60, and the unit is second.

AliyunJobResult

Task result submission type

Name	Type	Description
Success	String	Whether the task is successfully submitted. The following options are available: true or false
Code	String	Error code displayed when the task fails to be created
Message	String	Error message displayed when the task fails to be created
Job	AliyunJob	Task. If the task fails to be submitted, the task ID is not generated.

AliyunWaterMark

Task output type

Name	Type	Description
InputFile	AliyunOSSFile	Watermark output file
WaterMarkTemplateId	String	Watermark template ID

AliyunWaterMarkTemplate

Watermark template type

Name	Type	Description
Id	String	Watermark template ID
Name	String	Watermark template name
Width	Number	Width. The value ranges from 8 to 4096, and the unit is pixel.
Height	Number	Height. The value ranges from 8 to 4096, and the unit is pixel.
Dx	Number	Horizontal offset. The value ranges from -4096 to 4096, and the unit is pixel.
Dy	Number	Vertical offset. The value ranges from -4096 to 4096, and the unit is pixel.
ReferPos	String	Watermark position, which has the following options: TopRight, TopLeft, BottomRight, and BottomLeft.
Type	String	Watermark type, which has the following options: Image and Text. Currently, only the Image type is supported.
State	String	Watermark template status, which has the following options: Normal and Deleted.

AliyunPipeline

Media Transcoding queue type

Name	Type	Description
Id	String	ID of the Media Transcoding queue
Name	String	Name of the Media Transcoding queue
Speed	String	Type of the Media Transcoding queue, which has the following options: Boost, Standard, NarrowBandHDV2, AIVideoCover, AIVideoRecogni, AIVideoSummary, AIVideoPorn, AIAudioKWS, and AIAudioASR. The default value is Standard.
State	String	Status of the Media Transcoding queue, which has the following options: Active and Paused. Active: Tasks in the Media Transcoding queue will be scheduled, transcoded, and run by Media Transcoding. Paused: The Media Transcoding queue is paused, and tasks in the Media Transcoding queue will not be scheduled, transcoded, and run by Media Transcoding. The status of all tasks in the Media Transcoding queue is Submitted. Ongoing transcoding tasks are not paused.
NotifyConfig	String	Message Service notification configurations

AliyunMediaInfoJob

Media information analysis task type

Name	Type	Description
Id	String	Metadata analysis task ID
Input	AliyunOSSFile	Task input
State	String	Job status, which has the following options: Analyzing, Success, and Fail
Code	String	Error code displayed when the metadata analysis fails
Message	String	Error message displayed when the metadata analysis fails
Properties	AliyunProperties	Attribute
UserData	String	Custom data
CreationTime	String	Time of adding the task

AliyunAnalysisJob

Template analysis task type

Name	Type	Description
Id	String	Template analysis task ID
Input	AliyunOSSFile	Task input
AnalysisConfig	AliyunAnalysisConfig	Task configurations
TemplateList	AliyunTemplate[ ]	List of preset task output templates
State	String	Task status, which has the following options: Submitted, Analyzing, Success, and Fail
Code	String	Error code displayed when the analysis fails
Message	String	Error message displayed when the analysis fails
Percent	String	Transcoding progress. The value range from 0 to 100.
Priority	String	Task priority in the Media Transcoding queue. The value ranges from 1 to 10. The default value is 6, and 10 indicates the highest priority.
UserData	String	Custom data
PipelineId	String	ID of the Media Transcoding queue
CreationTime	String	Time of adding the task
MNSMessageResult	AliyunMNSMessageResult	Result sent by Message Service to notify the user of task completion

AliyunSnapshotJob

Screenshot task type

Name	Type	Description
Id	String	Screenshot task ID
Input	AliyunOSSFile	Task input
SnapshotConfig	AliyunSnapshotConfig	Screenshot configurations
Count	String	Number of screenshots
State	String	Screenshot status, which has the following options: Snapshoting, Success, and Fail
Code	String	Error code displayed when the analysis fails
Message	String	Error message displayed when the analysis fails
UserData	String	Custom data
MNSMessageResult	AliyunMNSMessageResult	Result sent by Message Service to notify the user of task completion

AliyunSnapshotConfig

Screenshot configurations

Name	Type	Description
OutputFile	String	Screenshot output OSS configurations
Time	String	Screenshot start time, in ms
Interval	String	Screenshot interval. If this parameter is set, screenshots are taken at intervals. The value must be greater than 0. The default value is 10, and the unit is second.
Num	String	Number of screenshots. If this parameter is set, screenshots are taken at intervals.
Width	String	Width of the screenshot output image. The value ranges from 8 to 4096.
Height	String	Width of the screenshot output image. The value ranges from 8 to 4096.
FrameType	String	Screenshot type, which has the following options: normal: indicates normal frames; intra: indicates I frames. The default value is intra.

AliyunFailReason

Failure cause type

Name	Type	Description
Code	String	Error code displayed upon failure
Message	String	Error message displayed upon failure

AliyunMNSMessageResult

Type of Message Service notifications of user’s task completion result

Name	Type	Description
ErrorCode	String	Error code displayed upon failure
ErrorMessage	String	Error message displayed upon failure
MessageId	String	ID of the success message

Activity

Media workflow activity

Name	Type	Description
Name	String	Media workflow activity name, which is unique in the same workflow
Type	String	Media workflow activity type, which has the following options: Start, Snapshot, Transcode, Analysis, and Report
JobId	String	Task ID (for example, analysis task ID, transcoding task ID, and screenshot task ID) that is generated when the activity is run
State	String	Status, which has the following options: Running, Success, Fail, and Skipped. Skipped indicates that the activity is skipped. For example, HD or SD transcoding activity is run after the analysis activity. The system determines to run which activity based on the actual conditions. If the resolution of the original video is low, the HD transcoding activity may be skipped.
StartTime	String	Start time of running the activity
EndTime	String	End time of running the activity
Code	String	Error code. An error code is returned if the activity status is Fail.
Message	String	Error message. An error message is returned if the activity status is Fail.

MediaWorkflow

Media workflow

Name	Type	Description
MediaWorkflowId	String	ID of a media workflow
Name	String	Media workflow name
Topology	String	Topology of the media workflow
State	String	Status, which has the following options: Inactive, Active, and Deleted
CreationTime	String	Creation time

InputFile

Input file

Name	Type	Description
Bucket	String	OSS Bucket
Location	String	OSS Location
Object	String	OSS Object

MediaWorkflowExecutionInput

Input of a media workflow execution instance

Name	Type	Description
InputFile	InputFile	Input file of the media workflow
UserData	String	Custom data

MediaWorkflowExecution

Media workflow execution instance

Name	Type	Description
RunId	String	Execution instance ID
Input	MediaWorkflowExecutionInput	Input of the media workflow
MediaWorkflowId	String	ID of a media workflow
Name	String	Media workflow name
MediaId	String	Media ID. All information generated by the media workflow all belongs to this media ID.
ActivityList	Activity	List of media workflow activities
State	String	Status, which has the following options: Running, Completed, and Fail. Completed only indicates that the execution of workflow completes. Whether each activity (such as Transcode or Screenshot) is successful depends on the specific status value of each activity.
CreationTime	String	Creation time

MediaInfo