API reference for data structures and parameters - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

The following data types are available.

AliyunProperties

Property type

Name	Type	Description
Format	AliyunFormatInfo	The format information.
Streams	AliyunStreamsInfo	The stream information.

AliyunFormatInfo

Format Type

Name	Type	Description
NumStreams	String	The total number of media streams.
NumPrograms	String	The total number of program streams.
FormatName	String	The short name of the container format.
FormatLongName	String	The full name of the container format.
StartTime	String	The start time.
Duration	String	The total duration.
Size	String	The size of the file.
Bitrate	String	The total bitrate.

AliyunStreamsInfo

Stream type

Name	Type	Description
VideoStreamList	AliyunVideoStream[]	The list of video streams.
AudioStreamList	AliyunAudioStream[]	The list of audio streams.
SubtitleStreamList	AliyunSubtitleStream[]	The list of subtitle streams.

AliyunVideoStream

Video stream type

Name	Type	Description
Index	String	The sequence number of the video stream. The value indicates the position of the video stream in all video streams.
CodecName	String	The short name of the encoding format.
CodecLongName	String	The full name of the encoding format.
Profile	String	Codec profile
CodecTimeBase	String	The codec time base.
CodecTagString	String	The tag string of the encoding format.
CodecTag	String	The tag of the encoding format.
Width	String	The width of the video resolution in pixels.
Height	String	The video height.
HasBFrames	String	Specifies whether the video stream contains B-frames.
Sar	String	The resolution of the encoded signal.
Dar	String	The display aspect ratio (DAR).
PixFmt	String	The pixel format.
Level	String	The encoding level.
Fps	String	Frame rate. Data type: Number.
AvgFPS	String	The average frame rate.
Timebase	String	The time base.
StartTime	String	The start time.
Duration	String	The duration.
Bitrate	String	The bitrate.
NumFrames	String	The total number of frames.
Lang	String	The language. For more information, see FFmpeg language definitions and ISO-639.
Rotate	String	The video rotation angle.

AliyunAudioStream

Type of audio stream information

Name	Type	Description
Index	String	The ordinal number of the audio stream, which specifies its position within the media stream.
CodecName	String	The short name of the encoding format.
CodecLongName	String	The full name of the encoding format.
CodecTimeBase	String	The codec time base.
CodecTagString	String	The tag string of the encoding format.
CodecTag	String	The tag of the encoding format.
SampleFmt	String	The sampling format.
Samplerate	String	The sample rate.
Channels	String	The number of sound channels.
ChannelLayout	String	The output layout of the sound channels.
Timebase	String	The time base.
StartTime	String	The start time.
Duration	String	The duration.
Bitrate	String	The bitrate.
NumFrames	String	The total number of frames.
Lang	String	The language. For more information, see FFmpeg language definitions and ISO-639.

AliyunSubtitleStream

Caption stream type

Name	Type	Description
Index	String	The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.
Lang	String	The language. For more information, see FFmpeg language definitions and ISO-639.

AliyunTemplate

Transcoding Template Type

Name	Type	Description
Id	String	The transcoding template ID.
Name	String	The name of the template.
Container	AliyunContainer	The container.
Audio	AliyunAudioCodec	The audio encoding configuration.
Video	AliyunVideoCodec	The video encoding configuration.
TransConfig	AliyunTransConfig	The general transcoding configuration.
MuxConfig	AliyunMuxConfig	The transmuxing configuration.
State	String	The status of the template. Valid values: Normal and Deleted.

AliyunContainer

Container type

Name	Type	Description
Format	String	The container format. Valid values: flv, mp4, ts, m3u8, gif, mp3, ogg, and flac.

AliyunAudioCodec

Audio codec configuration

Name	Type	Description
Codec	String	The audio encoding format. Supported formats include aac, mp3, vorbis, and flac. Default value: aac.
Profile	String	The audio codec profile. If you set Codec to aac, you can set this parameter to one of the following values: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.
Samplerate	String	The sample rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Unit: Hz. Default value: 44100.
Bitrate	String	The audio bitrate of the output file. The value ranges from 8 to 1000. Unit: Kbit/s. Default value: 128.
Channels	String	The number of sound channels. Valid values: 1, 2, 3, 4, 5, 6, 7, and 8. Default value: 2.

AliyunVideoCodec

Video Codec Configuration

Name	Type	Description
Codec	String	The encoding format. Support for H.264 and H.265. Default value: H.264.
Profile	String	The encoding profile. Valid values: baseline, main, and high. baseline: for mobile devices. main: for standard definition devices. high: for high resolution devices. Default value: high.
Bitrate	String	The average video bitrate. The value ranges from 10 to 50000. Unit: Kbit/s.
Crf	String	The constant rate factor for quality control. The value ranges from 0 to 51. If you set Codec to H264, the default value is 23. If you set Codec to H265, the default value is 26. If you set Crf, the Bitrate setting is ignored.
Width	String	The width. The value ranges from 128 to 4096. Unit: px. Default value: The width of the source video.
Height	String	The height. The value ranges from 128 to 4096. Unit: px. Default value: The height of the source video.
Fps	String	The frame rate. The value must be greater than 0 and less than or equal to 60. If the frame rate of the input file is greater than 60, the frame rate is 60. Default value: The frame rate of the input file.
Gop	String	The maximum number of frames between two keyframes. The value ranges from 1 to 1080000. Default value: 250.
Preset	String	The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.
ScanMode	String	The scan mode. Both interlaced and progressive scanning are supported.
Bufsize	String	The buffer size. The value ranges from 1000 to 128000. Unit: KB. Default value: 6000.
Maxrate	String	The maximum video bitrate. The value ranges from 10 to 50000. Unit: Kbit/s.
BitrateBnd	AliyunBitrateBnd	The average video bitrate range.
PixFmt	String	The video color format. Valid values: standard color formats such as yuv420p and yuvj420p.

AliyunTransConfig

Parameters for general transcoding.

Name	Type	Description
TransMode	String	The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.

AliyunBitrateBnd

Average bitrate range

Name	Type	Description
Max	String	The upper limit of the total bitrate. The value ranges from 10 to 50000. Unit: Kbit/s.
Min	String	The lower limit of the total bitrate. The value ranges from 10 to 50000. Unit: Kbit/s.

AliyunOSSFile

Parameters for an OSS file.

Name	Type	Description
Bucket	String	The OSS bucket. The value must be 3 to 63 bytes in length.
Location	String	The area where the OSS endpoint is deployed. The value can be up to 64 bytes in length.
Object	String	The OSS object. The value can be up to 1,024 bytes in length.

AliyunJob

Parameters for a job.

Name	Type	Description
JobId	String	The job ID.
Input	AliyunJobInput	The job input.
Output	AliyunOutput	The job output.
State	String	The job status. Submitted: The job is submitted. Transcoding: The job is in progress. TranscodeSuccess: The job is successful. TranscodeFail: The job failed. TranscodeCancelled: The job is canceled.
Code	String	The error code returned if the transcoding job fails.
Message	String	The error message returned if the transcoding job fails.
Percent	String	The transcoding progress. The value ranges from 0 to 100.
UserData	String	The custom data.
PipelineId	String	Pipeline ID
CreationTime	String	The time when the job was created.
MNSMessageResult	AliyunMNSMessageResult	The message sent by MNS to notify you of the job result.

AliyunJobInput

Parameters for the input of a transcoding job.

Name	Type	Description
Bucket	String	The OSS bucket of the job input. The value must be 3 to 63 bytes in length.
Location	String	The area where the OSS endpoint for the job input is deployed. The value can be up to 64 bytes in length.
Object	String	The OSS object of the job input. The value can be up to 1,024 bytes in length.
Audio	AliyunInputAudio	The audio configuration of the source media file.
Container	AliyunInputContainer	The container configuration of the source media file.

AliyunInputContainer

Parameters for the container configuration of the source media file.

Note This parameter is required if the input file is in the ADPCM or PCM format.

Name	Type	Description
Format	String	The audio format of the source media file. Valid values: alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le, s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, and u8.

AliyunInputAudio

Parameters for the audio configuration of the source media file.

Note This parameter is required if the input file is in the ADPCM or PCM format.

Name	Type	Description
Channels	String	The number of sound channels of the source media file. The value ranges from 1 to 8.
Samplerate	String	The audio sample rate of the source media file. The value ranges from 0 to 320000. Unit: Hz.

AliyunOutput

Parameters for the job output.

Name	Type	Description
OutputFile	AliyunOSSFile	The output file.
TemplateId	String	The template ID.
WaterMarkList	AliyunWaterMark[ ]	The list of watermarks.
Clip	AliyunClip	The video editing clip.
Rotate	String	The video rotation angle. The value must be greater than or equal to 0 and less than 360.
Properties	AliyunProperties	The media properties.
Priority	String	The priority of the job in its MPS queue. The value ranges from 1 to 10. A value of 10 indicates the highest priority. Default value: 6.
Container	AliyunContainer	The container. If you specify this parameter, it overwrites the AliyunContainer setting of the template specified by TemplateId.
Video	AliyunVideoCodec	The video configuration. If you specify this parameter, it overwrites the AliyunVideoCodec setting of the template specified by TemplateId.
Audio	AliyunAudioCodec	The audio configuration. If you specify this parameter, it overwrites the AliyunAudioCodec setting of the template specified by TemplateId.
TransConfig	AliyunTransConfig	The general transcoding configuration. If you specify this parameter, it overwrites the AliyunTransConfig setting of the template specified by TemplateId.
MuxConfig	AliyunMuxConfig	The transmuxing configuration. If you specify this parameter, it overwrites the AliyunMuxConfig setting of the template specified by TemplateId.
UserData	String	The custom data.

AliyunClip

Parameters for a clip.

Name	Type	Description
TimeSpan	AliyunTimeSpan	The time span of the clip.

AliyunTimeSpan

Parameters for the time span of a clip.

Name	Type	Description
Seek	String	The start time.
Duration	String	The duration.
End	String	The end time. For example, a value of 5.23 indicates that the last 5.23 seconds are cut off. If you set this parameter, the Duration parameter is ignored.

AliyunMuxConfig

Parameters for transmuxing.

Name	Type	Description
Segment	AliyunSegment	The segment configuration.

AliyunSegment

Parameters for segment configuration.

Name	Type	Description
Duration	String	The segment duration. The value ranges from 1 to 60. Unit: seconds.

AliyunJobResult

Parameters for the result of a job submission.

Name	Type	Description
Success	String	Indicates whether the job was successfully submitted. Valid values: true and false.
Code	String	The error code returned if the job fails to be created.
Message	String	The error message returned if the job fails to be created.
Job	AliyunJob	The job. If the job fails to be submitted, no job ID is generated.

AliyunWaterMark

Parameters for a watermark.

Name	Type	Description
InputFile	AliyunOSSFile	The watermark input file.
WaterMarkTemplateId	String	The watermark template ID.

AliyunWaterMarkTemplate

Parameters for a watermark template.

Name	Type	Description
Id	String	The watermark template ID.
Name	String	The name of the watermark template.
Width	Number	The width. The value ranges from 8 to 4096. Unit: px.
Height	Number	The height. The value ranges from 8 to 4096. Unit: px.
Dx	Number	The horizontal offset. The value ranges from -4096 to 4096. Unit: px.
Dy	Number	The vertical offset. The value ranges from -4096 to 4096. Unit: px.
ReferPos	String	The position of the watermark. Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.
Type	String	The type of the watermark. Valid values: Image and Text. Note Only Image is supported.
State	String	The status of the watermark template. Valid values: Normal and Deleted.

AliyunPipeline

Parameters for an MPS queue.

Name	Type	Description
Id	String	Pipeline ID
Name	String	Pipeline name
Speed	String	The type of the MPS queue. Valid values: Boost, Standard, NarrowBandHDV2, AIVideoCover, AIVideoRecogni, AIVideoSummary, AIVideoPorn, AIAudioKWS, and AIAudioASR. Default value: Standard.
State	String	The status of the MPS queue. Valid values: Active and Paused. Active: Jobs in the MPS queue are scheduled for transcoding. Paused: The MPS queue is paused. Jobs are no longer scheduled for transcoding. All jobs in the MPS queue remain in the Submitted state. Ongoing jobs are not affected.
NotifyConfig	String	The MNS notification configuration.

AliyunMediaInfoJob

Parameters for a media information analysis job.

Name	Type	Description
Id	String	The ID of the metadata analysis job.
Input	AliyunOSSFile	The job input.
State	String	The job status. Valid values: Analyzing, Success, and Fail.
Code	String	The error code returned if the metadata analysis job fails.
Message	String	The error message returned if the metadata analysis job fails.
Properties	AliyunProperties	Property
UserData	String	The custom data.
CreationTime	String	The time when the job was created.

AliyunAnalysisJob

Parameters for a template analysis job.

Name	Type	Description
Id	String	The ID of the template analysis job.
Input	AliyunOSSFile	The job input.
AnalysisConfig	AliyunAnalysisConfig	The job configuration.
TemplateList	AliyunTemplate[ ]	The list of preset templates in the job output.
State	String	The job status. Valid values: Submitted, Analyzing, Success, and Fail.
Code	String	The error code returned if the analysis fails.
Message	String	The error message returned if the analysis fails.
Percent	String	The transcoding progress. The value ranges from 0 to 100.
Priority	String	The priority of the job in its MPS queue. The value ranges from 1 to 10. A value of 10 indicates the highest priority. Default value: 10.
UserData	String	The custom data.
PipelineId	String	Pipeline ID
CreationTime	String	The time when the job was created.
MNSMessageResult	AliyunMNSMessageResult	MNS notifies users when a job is complete.

AliyunSnapshotJob

Parameters for a snapshot job.

Name	Type	Description
Id	String	The ID of the snapshot job.
Input	AliyunOSSFile	The job input.
SnapshotConfig	AliyunSnapshotConfig	The snapshot configuration.
Count	String	The number of snapshots captured.
State	String	The status of the snapshot job. Valid values: Snapshoting, Success, and Fail.
Code	String	The error code returned if the analysis fails.
Message	String	The error message returned if the analysis fails.
UserData	String	The custom data.
MNSMessageResult	AliyunMNSMessageResult	MNS notifies users when the job is complete.

AliyunSnapshotConfig

Parameters for snapshot configuration. AliyunSnapshotConfig

Name	Type	Description
OutputFile	String	The OSS configuration for the snapshot output.
TileOutputFile	String	The OSS configuration for the output of the large tiled image.
Time	String	The start time for capturing snapshots. Unit: milliseconds.
Interval	String	The interval for capturing snapshots. If you specify this parameter, a sequence of snapshots is captured. The value must be greater than 0. Unit: seconds. Default value: 10.
Num	String	The number of snapshots to capture. If you specify this parameter, a sequence of snapshots is captured.
Width	String	The width of the output snapshot. The value ranges from 8 to 4096.
Height	String	The height of the output snapshot. The value ranges from 8 to 4096.
FrameType	String	The snapshot type. Normal frame intra: An I-frame. Default value: normal.
TileOut	String	Puzzle configuration

AliyunFailReason

Parameters that describe the cause of a failure.

Name	Type	Description
Code	String	The error code returned if the job fails.
Message	String	The error message returned if the job fails.

AliyunMNSMessageResult

Parameters in the message that MNS sends to notify you of the job result.

Name	Type	Description
ErrorCode	String	The error code returned if the job fails.
ErrorMessage	String	The error message returned if the job fails.
MessageId	String	The ID of the success message.

Activity

Parameters for a media workflow activity.

Name	Type	Description
Name	String	The name of the media workflow activity. Note Activity names must be unique within a workflow.
Type	String	The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report.
JobId	String	The job ID generated when the activity is executed, such as an analysis job ID, transcoding job ID, or snapshot job ID.
State	String	The status. Valid values: Running, Success, Fail, and Skipped. Skipped: The activity is skipped. For example, after an analysis activity, there are two transcoding activities: one for high definition and one for standard definition. The system decides which activity to run based on the analysis result. If the source video has a low definition, the high-definition transcoding activity might be skipped.
StartTime	String	The time when the activity started.
EndTime	String	The time when the activity ended.
Code	String	The error code. If the activity status is Fail, a specific error code is provided.
Message	String	The error message. If the activity status is Fail, a detailed error description is provided.

MediaWorkflow

Parameters for a media workflow.

Name	Type	Description
MediaWorkflowId	String	The media workflow ID.
Name	String	The name of the media workflow.
Topology	String	The topology of the media workflow.
State	String	The status. Valid values: Inactive, Active, and Deleted.
CreationTime	String	The creation time.

InputFile

Parameters for an input file.

Name	Type	Description
Bucket	String	The OSS bucket.
Location	String	The OSS location.
Object	String	The OSS object.

MediaWorkflowExecutionInput

The input for a media workflow execution instance.

Name	Type	Description
InputFile	InputFile	The input file of the media workflow.
UserData	String	User-defined data.

MediaWorkflowExecution

A media workflow execution instance.

Name	Type	Description
RunId	String	The ID of the execution instance.
Input	MediaWorkflowExecutionInput	The input of the media workflow.
MediaWorkflowId	String	The media workflow ID.
Name	String	The name of the media workflow.
MediaId	String	The media ID. All information generated by the media workflow belongs to this media ID.
ActivityList	Activity	The list of media workflow activities.
State	String	The status. Valid values: Running, Completed, and Fail. Completed only indicates that the workflow execution is complete. To check if an activity such as transcoding or snapshotting was successful, check the status of that specific activity.
CreationTime	String	The creation time.

MediaInfo

Parameters for media information.

Name	Type	Description
Format	FormatInfo	The format information.
Streams	StreamsInfo	The stream information.

FormatInfo

Parameters for container and general information.

Name	Type	Description
NumStreams	String	The total number of media streams.
NumPrograms	String	The total number of program streams.
FormatName	String	The short name of the container format.
FormatLongName	String	The full name of the container format.
StartTime	String	The start time.
Duration	String	The total duration.
Size	String	The size of the file.
Bitrate	String	The total bitrate.

StreamsInfo

Parameters for stream information.

Name	Type	Description
VideoStreamList	VideoStream[]	The list of video streams. The list can contain up to four elements.
AudioStreamList	AudioStream[]	The list of audio streams. The list can contain up to four elements.
SubtitleStreamList	SubtitleStream[]	The list of subtitle streams. The list can contain up to four elements.

VideoStream

Parameters for video stream information.

Name	Type	Description
Index	String	The sequence number of the video stream. This indicates the position of the video stream in the entire media stream.
CodecName	String	The short name of the encoding format.
CodecLongName	String	The full name of the encoding format.
Profile	String	Codec profile
CodecTimeBase	String	The codec time base.
CodecTagString	String	The tag string of the encoding format.
CodecTag	String	The tag of the encoding format.
Width	String	The video width.
Height	String	The video height.
HasBFrames	String	Specifies whether the video stream contains B-frames.
Sar	String	The resolution of the encoded signal.
Dar	String	The DAR.
PixFmt	String	The pixel format.
Level	String	The encoding level.
Fps	String	The target frame rate.
AvgFPS	String	The average frame rate.
Timebase	String	The time base.
StartTime	String	The start time.
Duration	String	The duration.
NumFrames	String	The total number of frames.
Lang	String	The language.
NetworkCost	NetworkCost	The network bandwidth consumption.

NetworkCost

Parameters for video network bandwidth consumption.

Name	Type	Description
PreloadTime	String	The preload time.
CostBandwidth	String	The maximum bandwidth consumed.
AvgBitrate	String	The average bitrate.

AudioStream

Parameters for audio stream information.

Name	Type	Description
Index	String	The sequence number of the audio stream. This indicates the position of the audio stream in the entire media stream.
CodecName	String	The short name of the encoding format.
CodecLongName	String	The full name of the encoding format.
CodecTimeBase	String	The codec time base.
CodecTagString	String	The tag string of the encoding format.
CodecTag	String	The tag of the encoding format.
SampleFmt	String	The sampling format.
Samplerate	String	The sample rate.
Channels	String	The number of sound channels.
ChannelLayout	String	The output layout of the sound channels.
Timebase	String	The time base.
StartTime	String	The start time.
Duration	String	The duration.
Bitrate	String	The bitrate.
NumFrames	String	The total number of frames.
Lang	String	The language.

SubtitleStream

Parameters for subtitle stream information.

Name	Type	Description
Index	String	The sequence number of the subtitle stream. This indicates the position of the subtitle stream in the entire media stream.
Lang	String	The language.

Media

Parameters for media.

Name	Type	Description
MediaId	String	The media ID.
File	File	The source file.
Title	String	The title.
Description	String	The description.
CateId	String	The category ID.
CateName	String	The category name.
Tags	String[]	The list of tags.
RiskFactor	String	The risk factor. The value ranges from 0 to 1. A higher risk factor indicates a higher possibility of pornographic or violent content. The detection accuracy is 80%.
CoverURL	String	The URL of the thumbnail.
PublishState	String	The publishing status of the media, which indicates whether the media is publicly accessible. Valid values: Initiated: Initial state. UnPublish: Not published. The permission on the OSS playback file is Private. Published: Published. The permission on the OSS playback file is Default. Deleted: Deleted.
RunIdList	String[]	The list of media workflows.
CreationTime	String	The creation time.
Duration	String	The duration.
Format	String	The format.
Size	String	The size.
Bitrate	String	The bitrate.
Fps	String	The frame rate.
Width	String	The width.
Height	String	High
PlayList	Play[]	The playlist.
SnapshotList	Snapshot[]	The snapshot list.
MediaInfo	MediaInfo	The media information.

File

Parameters for a file.

Name	Type	Description
URL	String	The file URL.
State	String	The file status. Valid values: Normal and Deleted.

Play

Playback information.

Name	Type	Description
MediaWorkflowId	String	The ID of the workflow that generates the playback file.
MediaWorkflowName	String	The workflow that generates the playback file.
ActivityName	String	The name of the media workflow activity.
Duration	String	The duration.
Format	String	The format.
Size	String	The size.
Bitrate	String	The bitrate.
Fps	String	The frame rate.
Width	String	The width.
Height	String	High
File	File	The playback file.

Snapshot

Snapshot information.

Name	Type	Description
MediaWorkflowId	String	The ID of the workflow that generates the snapshot file.
MediaWorkflowName	String	The workflow that generates the snapshot file.
ActivityName	String	The name of the workflow activity that generates the snapshot file.
File	File	The snapshot file.
Type	String	The snapshot type. Valid values: Single and Sequence.
Count	Number	The number of snapshots. This parameter is valid only if Type is set to Sequence.

MediaBucket

Parameters for a media bucket.

Name	Type	Description
Bucket	String	The name of the media bucket.
Type	String	The type of the media bucket. Valid values: Input and Output.