You can view the following data types.
AliyunProperties
Attribute type
Name | Type | Description |
---|---|---|
Format | AliyunFormatInfo | Format information. |
Streams | AliyunStreamsInfo | Streaming 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 |
FormatLongName | 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 |
AudioStreamList | AliyunAudioStream[] | 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 baseEncoding time base. |
CodecTagString | String | Mark text of the encoding format |
CodecTag | String | Encoding format mark |
Width | String | Video resolution width, numbers. |
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, number. |
AvgFPS | String | Average frame rate |
Timebase | String | Time base |
StartTime | String | Start time |
Duration | String | Time 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 | Time 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.
|
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,
|
Bitrate | String | Audio bit rate of the output file.
|
Channels | String | Number of audio channels,
|
AliyunVideoCodec
Video codec configuration type
Name | Type | Description |
---|---|---|
Codec | String | Codec format,
|
Profile | String | Encoding level,
which has the following options: baseline, main, and high.
|
Bitrate | String | Average video bit rate.
|
Crf | String | Bit rate, which is a quality control factor.
|
Width | String | Width.
|
Height | String | Height.
|
Fps | String | Frame rate.
|
Gop | String | Maximum number of frames between two key frames.
|
Preset | String | Video algorithm preset,
|
ScanMode | String | Scan mode, which has the following options: interlaced and progressive. |
Bufsize | String | Size of the buffer area.
|
Maxrate | String | Peak video bit rate.
|
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,
|
AliyunBitrateBnd
Range of the average bit rate
Name | Type | Description |
---|---|---|
Max | String | Maximum total bit rate.
|
Min | String | Minimum total bit rate.
|
AliyunOSSFile
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
Name | Type | Description |
---|---|---|
JobId | String | Task ID |
Input | AliyunJobInput | Task input. |
Output | AliyunOutput | Task output. |
State | String | Task status,
|
Code | String | Error code of transcoding failure. |
Message | String | Message of transcoding failure. |
Percent | String | Transcoding progress. Value range: [0, 100]. |
UserData | String | Custom data. |
PipelineId | String | MPS queue ID. |
CreationTime | String | Time of adding the task. |
MNSMessageResult | AliyunMNSMessageResult | Message result sent by Message Service to notify the user of task completion. |
AliyunJobInput
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
Name | Type | Description |
---|---|---|
Format | String | Source media audio format,
|
AliyunInputAudio
Name | Type | Description |
---|---|---|
Channels | String | Number of source media audio channels. Value range: [1,8] |
Samplerate | String | Source media audio sampling rate.
|
AliyunOutput
Name | Type | Description |
---|---|---|
OutputFile | AliyunOSSFile | Output file. |
TemplateId | String | Template ID. |
WaterMarkList | AliyunWaterMark[ ] | Watermark list. |
Clip | AliyunClip | Video clip |
Rotate | String | Video rotation angle. Value range: [0,360) |
Properties | AliyunProperties | Media properties. |
Priority | String | Task priority in the MPS queue.
|
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 configuration. If this parameter is set, the parameter setting replaces the AliyunVideoCodec setting of the template specified by the TemplateId. |
Audio | AliyunAudioCodec | Audio configuration. If this parameter is set, the parameter setting replaces the AliyunAudioCodec setting of the template specified by the TemplateId. |
TransConfig | AliyunTransConfig | General transcoding configuration. 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
Name | Type | Description |
---|---|---|
TimeSpan | AliyunTimeSpan | Edited time period. |
AliyunTimeSpan
Name | Type | Description |
---|---|---|
Seek | String | Start time. |
Duration | String | Duration. |
End | String | Truncation time at the end.
|
AliyunMuxConfig
Name | Type | Description |
---|---|---|
Segment | AliyunSegment | Slice configurations. |
AliyunSegment
Name | Type | Description |
---|---|---|
Duration | String | Slice length.
|
AliyunJobResult
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
Name | Type | Description |
---|---|---|
InputFile | AliyunOSSFile | Watermark input file. |
WaterMarkTemplateId | String | Watermark template ID. |
AliyunWaterMarkTemplate
Name | Type | Description |
---|---|---|
Id | String | Watermark template ID. |
Name | String | Watermark template name. |
Width | Number | Width.
|
Height | Number | Height.
|
DX | Number | Horizontal offset.
|
Dy | Number | Vertical offset.
|
ReferPos | String | Watermark position,
|
Type | String | Watermark type,
which has the following options: Image and Text.
Note Currently, only the Image type is supported.
|
State | String | Watermark template status, which has the following options: Normal and Deleted. |
AliyunPipeline
Name | Type | Description |
---|---|---|
Id | String | MPS queue ID. |
Name | String | MPS queue name. |
Speed | String | MPS queue type,
|
State | String | MPS queue status,
which has the following options: Active and Paused.
|
NotifyConfig | String | Message Service notification configurations. |
AliyunMediaInfoJob
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 | Properties. |
UserData | String | Custom data. |
CreationTime | String | Time of adding the task. |
AliyunAnalysisJob
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. Value range: [0, 100]. |
Priority | String | Task priority in the MPS queue.
|
UserData | String | Custom data. |
PipelineId | String | MPS queue ID. |
CreationTime | String | Time of adding the task. |
MNSMessageResult | AliyunMNSMessageResult | Result sent by Message Service to notify the user of task completion. |
AliyunSnapshotJob
Screenshot task typeName | Type | Description |
---|---|---|
Id | String | Screenshot task ID. |
Input | AliyunOSSFile | Task input. |
SnapshotConfig | AliyunSnapshotConfig | Screenshot configuration. |
Count | String | Number of screenshots. |
State | String | Screenshot status, which has the following options: Analyzing, 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
Name | Type | Description |
---|---|---|
OutputFile | String | Screenshot output OSS configurations. |
TileOutputFile | String | Output OSS configurations of tile task. |
Time | String | Screenshots start time. Unit: milliseconds. |
Interval | String | Time interval of screenshots.
|
Num | String | Number of screenshots. If this parameter is set, screenshots are taken at intervals. |
Width | String | Width of the screenshot output image. Value range: [8,4096] |
Height | String | Width of the screenshot output image. Value range: [8,4096] |
FrameType | String | Type of screenshots, which has the following options:
Default value: intra |
TileOut | String | Tile configuration. |
AliyunFailReason
Name | Type | Description |
---|---|---|
Code | String | Error code displayed upon failure. |
Message | String | Error message displayed upon failure. |
AliyunMNSMessageResult
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
Name | Type | Description |
---|---|---|
Name | String | Media workflow activity name,
Note 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.
|
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
Name | Type | Description |
---|---|---|
MediaWorkflowId | String | Media workflow ID. |
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
Name | Type | Description |
---|---|---|
Bucket | String | OSS Bucket |
Location | String | OSS Location |
Object | String | OSS Object |
MediaWorkflowExecutionInput
Name | Type | Description |
---|---|---|
InputFile | InputFile | Input file of the media workflow. |
UserData | String | Custom data. |
MediaWorkflowExecution
Name | Type | Description |
---|---|---|
RunId | String | Execution instance ID. |
Input | MediaWorkflowExecutionInput | Input of the media workflow. |
MediaWorkflowId | String | Media workflow ID. |
Name | String | Media workflow name. |
MediaId | String | Media ID. All information generated by the media workflow belongs to this media ID. |
ActivityList | Activity | List of media workflow activities. |
State | String | Status,
|
CreationTime | String | Creation time. |
MediaInfo
Name | Type | Description |
---|---|---|
Format | FormatInfo | Format information. |
Streams | StreamsInfo | Streaming information. |
Formatinfo
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. |
FormatLongName | String | Long name of the container/encapsulation format |
StartTime | String | The start time. |
Duration | String | Total time. |
Size | String | File size. |
Bitrate | String | Total bit rate. |
StreamsInfo
Name | Type | Description |
---|---|---|
VideoStreamList | VideoStream[] | Video stream list, containing up to four video streams. |
AudioStreamList | AudioStream[] | Audio stream list, containing up to four audio streams. |
SubtitleStreamList | SubtitleStream[] | Subtitle stream list, containing up to four subtitle streams. |
VideoStream
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, numbers. |
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 | Target frame rate. |
AvgFPS | String | Average frame rate. |
Timebase | String | Time base. |
StartTime | String | The start time. |
Duration | String | Time length. |
NumFrames | String | Total number of frames. |
Lang | String | Language. |
NetworkCost | NetworkCost | Network bandwidth consumption. |
NetworkCost
Name | Type | Description |
---|---|---|
PreloadTime | String | Preload time. |
CostBandwidth | String | Maximum bandwidth consumption. |
AvgBitrate | String | Average bit rate. |
AudioStream
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 | The start time. |
Duration | String | Time length. |
Bitrate | String | Bit rate. |
NumFrames | String | Total number of frames. |
Lang | String | Language. |
SubtitleStream
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. |
Media
Name | Type | Description |
---|---|---|
MediaId | String | Media ID. |
File | File | Original file. |
Title | String | Title. |
Description | String | Description. |
CateId | String | Category ID. |
CateName | String | Category name. |
Tags | String[] | Tag list. |
RiskFactor | String | Risk factors.
|
CoverURL | String | Cover URL. |
PublishState | String | Media publishing status, indicating whether to publish the media.
The options are as follows:
|
RunIdList | String[] | Media task stream list. |
CreationTime | String | Creation time. |
Duration | String | Time length. |
Format | String | Format . |
Size | String | Size. |
Bitrate | String | Bit rate. |
Fps | String | Frame rate. |
Width | String | Width. |
Height | String | Height. |
PlayList | Play[] | Playlist. |
SnapshotList | Snapshot[] | Screenshot list |
MediaInfo | MediaInfo | Media information. |
Category
Name | Type | Description |
---|---|---|
CateId | String | Category ID. |
ParentId | String | Parent node ID. The value of the top-level node is -1. |
CateName | String | Category name. |
Level | String | Level. The top-level node value is 0. |
File
Name | Type | Description |
---|---|---|
URL | String | File URL. |
State | String | File status, which has the following options: Normal and Deleted. |
Play
Name | Type | Description |
---|---|---|
MediaWorkflowId | String | ID of the workflow that generates the playback file. |
MediaWorkflowName | String | Workflow that generates the playback file. |
ActivityName | String | Media workflow activity name. |
Duration | String | Time length. |
Format | String | Format. |
Size | String | Size. |
Bitrate | String | Bit rate. |
Fps | String | Frame rate. |
Width | String | Width. |
Height | String | Height. |
File | File | Playback file. |
Snapshot
Name | Type | Description |
---|---|---|
MediaWorkflowId | String | ID of the workflow that generates the screenshot file. |
MediaWorkflowName | String | Workflow that generates the screenshot file |
ActivityName | String | The name of the workflow activity that generated the screenshot file. |
File | File | Screenshot files. |
Type | String | Snapshot type, which has the following options: Single and Sequence. |
Count | Number | Number of screenshots. This parameter is valid only when Type is set to Sequence. |
MediaBucket
Name | Type | Description |
---|---|---|
Bucket | String | The bucket name. |
Type | String | Media bucket type, which has the following options: Input, and Output. |