This topic describes data types.

AliyunProperties

Property parameters

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

AliyunFormatInfo

Format information parameters

Parameter 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 information parameters

Parameter 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 information parameters

Parameter 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 The 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 former number in the video resolution. The number indicates the video width.
Height String The latter number in the video resolution. The number indicates the video height.
HasBFrames String Specifies whether the video stream contains bidirectional frames (B-frames).
Sar String The sample aspect ratio (SAR).
Dar String The display aspect ratio (DAR).
PixFmt String The pixel format.
Level String The codec level.
Fps String The frame rate, which is a 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 documentation and ISO-639.

Rotate String The video rotation angle.

AliyunAudioStream

Audio stream information parameters

Parameter Type Description
Index String The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.
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 sampling 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 documentation and ISO-639.

AliyunSubtitleStream

Subtitle stream information parameters

Parameter 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 documentation and ISO-639.

AliyunTemplate

Transcoding template parameters

Parameter Type Description
Id String The ID of the transcoding template.
Name String The name of the template.
Container AliyunContainer The container configuration.
Audio AliyunAudioCodec The audio codec configuration.
Video AliyunVideoCodec The video codec 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 parameter

Parameter Type Description
Format String The container format.

Valid values: flv, mp4, ts, m3u8, gif, mp3, ogg, and flac.

AliyunAudioCodec

Audio codec parameters

Parameter Type Description
Codec String The audio codec format.
  • Valid values: aac, mp3, vorbis, and flac.
  • Default value: aac.
Profile String The codec profile of the audio file.

Valid values when the Codec parameter is set to aac: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.

Samplerate String The sampling rate.
  • Valid values: 22050, 32000, 44100, 48000, and 96000.
  • Unit: Hz.
  • Default value: 44100.
Bitrate String The audio bitrate of the output file.
  • Valid values: [8,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 parameters

Parameter Type Description
Codec String The video codec format.
  • Valid values: H.264 and H.265.
  • Default value: H.264.
Profile String The codec profile.
Valid values: baseline, main, and high.
  • baseline: applicable to mobile devices.
  • main: applicable to standard-definition devices.
  • high: applicable to high-definition devices.
  • Default value: high.
Bitrate String The average bitrate of the video.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
Crf String The constant rate factor, which is the default quality control setting.
  • Valid values: [0,51].
  • Default value when the Codec parameter is set to H.264: 23. Default value when the Codec parameter is set to H.265: 26.
  • If this parameter is specified, the setting of the Bitrate parameter is invalid.
Width String The width.
  • Valid values: [128,4096].
  • Unit: pixel.
  • Default value: the original width of the video.
Height String The height.
  • Valid values: [128,4096].
  • Unit: pixel.
  • Default value: the original height of the video.
Fps String The frame rate.
  • Valid values: (0,60].
  • The value is 60 if the frame rate of the input file exceeds 60.
  • Default value: the frame rate of the input file.
Gop String The maximum number of frames between two keyframes.
  • Valid values: [1,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.

Valid values: interlaced and progressive.

Bufsize String The size of the buffer.
  • Valid values: [1000,128000].
  • Unit: KB.
  • Default value: 6000.
Maxrate String The maximum video bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
BitrateBnd AliyunBitrateBnd The average bitrate range of the video.
PixFmt String The pixel format for video color encoding.

Valid values: standard pixel formats such as yuv420p and yuvj420p.

AliyunTransConfig

General transcoding parameter

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

AliyunBitrateBnd

Average bitrate range parameters

Parameter Type Description
Max String The upper limit of the total bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.
Min String The lower limit of the total bitrate.
  • Valid values: [10,50000].
  • Unit: Kbit/s.

AliyunOSSFile

Object Storage Service (OSS) object parameters
Parameter Type Description
Bucket String The name of the OSS bucket.

The value must be 3 to 63 bytes in size.

Location String The ID of the OSS region.

The value can be up to 64 bytes in size.

Object String The name of the OSS object.

The value can be up to 1,024 bytes in size.

AliyunJob

Job parameters
Parameter Type Description
JobId String The ID of the job.
Input AliyunJobInput The information about the job input.
Output AliyunOutput The information about the job output.
State String The status of the job.
  • Submitted: The job has been submitted.
  • Transcoding: Transcoding is ongoing.
  • TranscodeSuccess: Transcoding succeeds.
  • TranscodeFail: Transcoding fails.
  • TranscodeCancelled: Transcoding is canceled.
Code String The error code returned when the transcoding job fails.
Message String The error message returned when the transcoding job fails.
Percent String The transcoding progress.

Valid values: [0,100].

UserData String The custom data.
PipelineId String The ID of the pipeline.
CreationTime String The time when the job was created.
MNSMessageResult AliyunMNSMessageResult The message sent by Message Service (MNS) to notify the user of the job result.

AliyunJobInput

Transcoding job input parameters
Parameter Type Description
Bucket String The name of the OSS bucket of the job input.

The value must be 3 to 63 bytes in size.

Location String The ID of the OSS region of the job input.

The value can be up to 64 bytes in size.

Object String The name of the OSS object of the job input.

The value can be up to 1,024 bytes in size.

Audio AliyunInputAudio The audio configuration of the input media file.
Container AliyunInputContainer The container configuration of the input media file.

AliyunInputContainer

Container configuration parameter for the input media file
Note This parameter is required when the input file is in the ADPCM or PCM format.
Parameter Type Description
Format String The audio format of the input 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

Audio configuration parameters for the input media file
Note This parameter is required when the input file is in the ADPCM or PCM format.
Parameter Type Description
Channels String The number of sound channels of the input media file.

Valid values: [1,8].

Samplerate String The audio sampling rate of the input media file.
  • Valid values: [0,320000].
  • Unit: Hz.

AliyunOutput

Job output parameters
Parameter Type Description
OutputFile AliyunOSSFile The information about the output file.
TemplateId String The ID of the template.
WaterMarkList AliyunWaterMark[ ] The list of watermarks.
Clip AliyunClip The information about the media clip.
Rotate String The video rotation angle.

Valid values: [0,360).
Properties AliyunProperties The media properties.
Priority String The priority of the job in the corresponding pipeline.
  • Valid values: [1,10].
  • A value of 10 indicates the highest priority.
  • Default value: 6.
Container AliyunContainer The container configuration.

If this parameter is specified, the parameter setting of the AliyunContainer parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

Video AliyunVideoCodec The video codec configuration.

If this parameter is specified, the parameter setting of the AliyunVideoCodec parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

Audio AliyunAudioCodec The audio codec configuration.

If this parameter is specified, the parameter setting of the AliyunAudioCodec parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

TransConfig AliyunTransConfig The general transcoding configuration.

If this parameter is specified, the parameter setting of the AliyunTransConfig parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

MuxConfig AliyunMuxConfig The transmuxing configuration.

If this parameter is specified, the parameter setting of the AliyunMuxConfig parameter for the template specified by the TemplateId parameter is replaced by this parameter setting.

UserData String The custom data.

AliyunClip

Clip parameter
Parameter Type Description
TimeSpan AliyunTimeSpan The time span of the clip.

AliyunTimeSpan

Clip time span parameters
Parameter Type Description
Seek String The start time.
Duration String The length of the clip.
End String The length of the ending part to cut off.
  • For example, a value of 5.23 indicates that the last 5.23 seconds of the media file are cut off.
  • If you specify this parameter, the Duration parameter is invalid.

AliyunMuxConfig

Transmuxing parameter
Parameter Type Description
Segment AliyunSegment The segment configuration.

AliyunSegment

Segment configuration parameter
Parameter Type Description
Duration String The length of the segment.
  • Valid values: [1,60].
  • Unit: seconds.

AliyunJobResult

Job submission result parameters
Parameter Type Description
Success String Indicates whether the job was successfully submitted.

Valid values: true and false.

Code String The error code returned when the job fails to be created.
Message String The error message returned when the job fails to be created.
Job AliyunJob The information about the job.

If the job fails to be submitted, no job ID is generated.

AliyunWaterMark

Job output parameters
Parameter Type Description
InputFile AliyunOSSFile The watermark input file.
WaterMarkTemplateId String The ID of the watermark template.

AliyunWaterMarkTemplate

Watermark template parameters
Parameter Type Description
Id String The ID of the watermark template.
Name String The name of the watermark template.
Width Number The width.
  • Valid values: [8,4096].
  • Unit: pixel.
Height Number The height.
  • Valid values: [8,4096].
  • Unit: pixel.
Dx Number The horizontal offset.
  • Valid values: [-4096,4096].
  • Unit: pixel.
Dy Number The vertical offset.
  • Valid values: [-4096,4096].
  • Unit: pixel.
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 Set the value to Image.
State String The status of the watermark template.

Valid values: Normal and Deleted.

AliyunPipeline

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

AliyunMediaInfoJob

Media information analysis job parameters
Parameter Type Description
Id String The ID of the metadata analysis job.
Input AliyunOSSFile The information about the job input.
State String The status of the job.

Valid values: Analyzing, Success, and Fail.

Code String The error code returned when the metadata analysis job fails.
Message String The error message returned when the metadata analysis job fails.
Properties AliyunProperties The media properties.
UserData String The custom data.
CreationTime String The time when the job was created.

AliyunAnalysisJob

Template analysis job parameters
Parameter Type Description
Id String The ID of the template analysis job.
Input AliyunOSSFile The information about the job input.
AnalysisConfig AliyunAnalysisConfig The job configuration.
TemplateList AliyunTemplate[ ] The list of matched preset templates.
State String The status of the job.

Valid values: Submitted, Analyzing, Success, and Fail.

Code String The error code returned when the template analysis job fails.
Message String The error message returned when the template analysis job fails.
Percent String The transcoding progress.

Valid values: [0,100].

Priority String The priority of the job in the corresponding pipeline.
  • Valid values: [1,10].
  • A value of 10 indicates the highest priority.
  • Default value: 10.
UserData String The custom data.
PipelineId String The ID of the pipeline.
CreationTime String The time when the job was created.
MNSMessageResult AliyunMNSMessageResult The message sent by MNS to notify the user of the job result.

AliyunSnapshotJob

Snapshot job parameters
Parameter Type Description
Id String The ID of the snapshot job.
Input AliyunOSSFile The information about the job input.
SnapshotConfig AliyunSnapshotConfig The snapshot configuration.
Count String The number of snapshots that were taken.
State String The status of the snapshot job.

Valid values: Snapshoting, Success, and Fail.

Code String The error code returned when the snapshot job fails.
Message String The error message returned when the snapshot job fails.
UserData String The custom data.
MNSMessageResult AliyunMNSMessageResult The message sent by MNS to notify the user of the job result.

AliyunSnapshotConfig

Snapshot configuration parameters
Parameter Type Description
OutputFile String The OSS output file of the snapshot job.
TileOutputFile String The OSS output file of the tiling job.
Time String The start time for taking snapshots.

Unit: milliseconds.
Interval String The interval for taking snapshots.
  • If this parameter is specified, snapshots are taken at intervals. The interval must be greater than 0.
  • Unit: seconds.
  • Default value: 10.
Num String The number of snapshots to take.

If this parameter is specified, snapshots are taken at intervals.

Width String The width of the output snapshot.

Valid values: [8,4096].
Height String The height of the output snapshot.

Valid values: [8,4096].
FrameType String The type of the snapshot. Valid values:
  • normal: normal frame
  • intra: I-frame

Default value: normal.

TileOut String The tiling configuration.

AliyunFailReason

Failure cause parameters
Parameter Type Description
Code String The error code returned when the job fails.
Message String The error message returned when the job fails.

AliyunMNSMessageResult

Parameters in the message sent by MNS to notify the user of the job result
Parameter Type Description
ErrorCode String The error code returned when the job fails.
ErrorMessage String The error message returned when the job fails.
MessageId String The ID of the success message.

Activity

Media workflow activity parameters
Parameter Type Description
Name String The name of the workflow activity.
Note The name of an activity in a media workflow is unique.
Type String The type of the media workflow activity.

Valid values: Start, Snapshot, Transcode, Analysis, and Report.

JobId String The job ID, such as the analysis job ID, transcoding job ID, or snapshot job ID, generated when the activity is executed.
State String The status of the activity.
Valid values: Running, Success, Fail, and Skipped.
  • A value of Skipped indicates that the activity is skipped.
  • For example, the high-definition and standard-definition transcoding activities are run after the analysis activity is complete. The system determines the activity to run based on the analysis result. If the definition of the input video content is insufficient, the high-definition transcoding activity may be skipped.
StartTime String The start time of the activity.
EndTime String The end time of the activity.
Code String The error code returned when the activity fails.

The specific error code appears if the activity status is Fail.

Message String The error message returned when the activity fails.

The detailed error message appears if the activity status is Fail.

MediaWorkflow

Media workflow parameters
Parameter Type Description
MediaWorkflowId String The ID of the media workflow.
Name String The name of the media workflow.
Topology String The topology of the media workflow.
State String The status of the media workflow.

Valid values: Inactive, Active, and Deleted.
CreationTime String The time when the media workflow was created.

InputFile

Input file parameters
Parameter Type Description
Bucket String The name of the OSS bucket.
Location String The ID of the OSS region.
Object String The name of the OSS object.

MediaWorkflowExecutionInput

Input file parameters for executing the media workflow
Parameter Type Description
InputFile InputFile The input file of the media workflow.
UserData String The custom data.

MediaWorkflowExecution

Media workflow execution instance parameters
Parameter Type Description
RunId String The ID of the execution instance.
Input MediaWorkflowExecutionInput The input file of the media workflow.
MediaWorkflowId String The ID of the media workflow.
Name String The name of the media workflow.
MediaId String The ID of the media file.

This media file ID is associated with all information generated by the media workflow.

ActivityList Activity The list of activities that are executed in the media workflow.
State String The status of the execution instance.
  • Valid values: Running, Completed, and Fail.
  • A value of Completed indicates that the execution instance is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity.
CreationTime String The time when the execution instance was created.

MediaInfo

Media information parameters
Parameter Type Description
Format FormatInfo The format information.
Streams StreamsInfo The stream information.

FormatInfo

Container and general information parameters
Parameter 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

Stream information parameters
Parameter Type Description
VideoStreamList VideoStream[] The list of video streams.

The list contains a maximum of four items.

AudioStreamList AudioStream[] The list of audio streams.

The list contains a maximum of four items.

SubtitleStreamList SubtitleStream[] The list of subtitle streams.

The list contains a maximum of four items.

VideoStream

Video stream information parameters
Parameter 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 The 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 former number in the video resolution. The number indicates the video width.
Height String The latter number in the video resolution. The number indicates the video height.
HasBFrames String Specifies whether the video stream contains B-frames.
Sar String The SAR.
Dar String The DAR.
PixFmt String The pixel format.
Level String The codec level.
Fps String The frame rate of the output file.
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

Video network bandwidth consumption parameters
Parameter Type Description
PreloadTime String The amount of preload time.
CostBandwidth String The maximum bandwidth that was consumed.
AvgBitrate String The average bitrate.

AudioStream

Audio stream information parameters
Parameter Type Description
Index String The sequence number of the audio stream.

The value indicates the position of the audio stream in all audio streams.

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 sampling 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

Subtitle stream information parameters
Parameter 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.

Media

Media parameters
Parameter Type Description
MediaId String The ID of the media file.
File File The input file.
Title String The title of the media file.
Description String The description of the media file.
CateId String The ID of the category to which the media file belongs.
CateName String The name of the category.
Tags String[] The tags of the media file.
RiskFactor String The risk factor.
  • Valid values: [0,1].
  • A higher risk factor indicates a higher possibility of pornography and violence involved in the media file.
  • The recognition accuracy is 80%.
CoverURL String The URL of the thumbnail.
PublishState String The publishing status of the media file.
Valid values:
  • Initiated: The media file is in the initial state.
  • UnPublish: The media file has not been published, and the playback permission on the OSS object is Private.
  • Published: The media file has been published, and the playback permission on the OSS object is Default.
  • Deleted: The media file has been deleted.
RunIdList String[] The list of media workflow execution instances.
CreationTime String The time when the media file was created.
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 The height.
PlayList Play[] The playlist.
SnapshotList Snapshot[] The snapshot list.
MediaInfo MediaInfo The media information.

Category

Category parameters
Parameter Type Description
CateId String The ID of the category.
ParentId String The ID of the parent category.

The value for the top-level category is -1.

CateName String The name of the category.
Level String The level of the category.

The value for the top-level category is 0.

File

File parameters
Parameter Type Description
URL String The URL of the file.
State String The status of the file.

Valid values: Normal and Deleted.

Play

Playback information parameters
Parameter Type Description
MediaWorkflowId String The ID of the workflow that generates the playback file.
MediaWorkflowName String The name of the workflow that generates the playback file.
ActivityName String The name of the 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 The height.
File File The playback file.

Snapshot

Snapshot information parameters
Parameter Type Description
MediaWorkflowId String The ID of the workflow that generates the snapshot.
MediaWorkflowName String The name of the workflow that generates the snapshot.
ActivityName String The name of the workflow activity that generates the snapshot.
File File The snapshot.
Type String The type of the snapshot.

Valid values: Single and Sequence.
Count Number The number of snapshots.

This parameter is valid only when the Type parameter is set to Sequence.

MediaBucket

Media bucket parameters
Parameter Type Description
Bucket String The name of the media bucket.
Type String The type of the media bucket.

Valid values: Input

and Output.