API全部資料類型參考-ApsaraVideo for Media Processing-阿里雲

您可以查看以下資料類型。

AliyunProperties

屬性類型

名稱	類型	描述
Format	AliyunFormatInfo	格式資訊。
Streams	AliyunStreamsInfo	流資訊。

AliyunFormatInfo

格式資訊類型

名稱	類型	描述
NumStreams	String	媒體流總數。
NumPrograms	String	節目流總數。
FormatName	String	容器、封裝格式簡述名。
FormatLongName	String	容器、封裝格式長述名。
StartTime	String	起始時間。
Duration	String	總時間長度。
Size	String	檔案大小。
Bitrate	String	總碼率。

AliyunStreamsInfo

流資訊類型

名稱	類型	描述
VideoStreamList	AliyunVideoStream[]	視頻流列表。
AudioStreamList	AliyunAudioStream[]	音頻流列表。
SubtitleStreamList	AliyunSubtitleStream[]	字幕流列表。

AliyunVideoStream

視頻流資訊類型

名稱	類型	描述
Index	String	視頻流序號，標識視頻流在整個媒體流中的位置。
CodecName	String	編碼格式簡述名。
CodecLongName	String	編碼格式長述名。
Profile	String	編碼預置。
CodecTimeBase	String	編碼時基。
CodecTagString	String	編碼格式標記文本。
CodecTag	String	編碼格式標記。
Width	String	視頻解析度寬，數字。
Height	String	視頻解析度長。
HasBFrames	String	是否有B幀。
Sar	String	編碼訊號解析度比。
Dar	String	編碼顯示解析度比。
PixFmt	String	像素格式。
Level	String	編碼等級。
Fps	String	幀率，數字。
AvgFPS	String	平均幀率。
Timebase	String	時基。
StartTime	String	起始時間。
Duration	String	時間長度。
Bitrate	String	碼率。
NumFrames	String	總幀數。
Lang	String	語言。參考FFmpeg語言定義，ISO-639。
Rotate	String	視頻旋轉角度。

AliyunAudioStream

音頻流資訊類型

名稱	類型	描述
Index	String	音頻流序號，標識音頻流在整個媒體流中的位置。
CodecName	String	編碼格式簡述名。
CodecLongName	String	編碼格式長述名。
CodecTimeBase	String	編碼時基。
CodecTagString	String	編碼格式標記文本。
CodecTag	String	編碼格式標記。
SampleFmt	String	採樣格式。
Samplerate	String	採樣率。
Channels	String	聲道數。
ChannelLayout	String	聲道輸出樣式。
Timebase	String	時基。
StartTime	String	起始時間。
Duration	String	時間長度。
Bitrate	String	碼率。
NumFrames	String	總幀數。
Lang	String	語言。參考FFmpeg語言定義，ISO-639。

AliyunSubtitleStream

字幕流資訊類型

名稱	類型	描述
Index	String	字幕流序號，標識字幕流在整個媒體流中的位置。
Lang	String	語言。參考FFmpeg語言定義，ISO-639。

AliyunTemplate

轉碼模板類型

名稱	類型	描述
Id	String	轉碼模板ID。
Name	String	模板名稱。
Container	AliyunContainer	容器。
Audio	AliyunAudioCodec	音頻編解碼配置。
Video	AliyunVideoCodec	視頻編解碼配置。
TransConfig	AliyunTransConfig	轉碼通用配置。
MuxConfig	AliyunMuxConfig	轉碼封包配置。
State	String	模板的狀態，分為Normal、Deleted。

AliyunContainer

容器類型

名稱	類型	描述
Format	String	容器格式。可選範圍flv、mp4、ts、m3u8、gif、mp3、ogg、flac。

AliyunAudioCodec

音頻編解碼配置類型

名稱	類型	描述
Codec	String	音頻編解碼格式。支援aac、mp3、vorbis、flac。預設值：aac。
Profile	String	音頻編碼預置。當Codec為aac時可以設定如下範圍中的值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。
Samplerate	String	採樣率。支援22050、32000、44100、48000、96000。單位：Hz。預設值：44100。
Bitrate	String	輸出檔案的音頻碼率。取值範圍：[8，1000]。單位：Kbps。預設值：128。
Channels	String	聲道數。支援1、2、3、4、5、6、7、8。預設值：2。

AliyunVideoCodec

視頻編解碼配置類型

名稱	類型	描述
Codec	String	編解碼格式。支援H.264、H.265。預設值：H.264。
Profile	String	編碼層級。支援baseline、main、high。 baseline：針對行動裝置。 main：針對標準解析度裝置。 high：針對高解析度裝置。預設值：high。
Bitrate	String	視頻平均碼率。取值範圍：[10,50000]。單位：Kbps。
Crf	String	碼率-品質控制因子。取值範圍：[0,51]。預設值：編碼格式為H264，預設值為23。編碼格式為H265，預設值為26。如果設定了Crf，則Bitrate的設定失效。
Width	String	寬。取值範圍：[128,4096]。單位：px。預設值：視頻原始寬度。
Height	String	高。取值範圍：[128,4096]。單位：px。預設值：視頻原始高度。
Fps	String	幀率。取值範圍：(0,60]。當輸入檔案幀率超過60時取60。預設值：取輸入檔案幀率。
Gop	String	主要畫面格間最大幀數。取值範圍：[1,1080000]。預設值：250。
Preset	String	視頻演算法器預置。支援veryfast、fast、medium、slow、slower。預設值：medium。
ScanMode	String	掃描模式。支援interlaced、progressive。
Bufsize	String	緩衝區大小。取值範圍：[1000,128000]。單位：Kb。預設值：6000。
Maxrate	String	視頻碼率峰值。取值範圍：[10,50000]。單位：Kbps。
BitrateBnd	AliyunBitrateBnd	視頻平均碼率範圍。
PixFmt	String	視頻顏色格式。範圍：yuv420p，yuvj420p等標準顏色格式。

AliyunTransConfig

轉碼通用配置類型

名稱	類型	描述
TransMode	String	轉碼模式。可選範圍onepass、twopass、CBR。預設值：onepass。

AliyunBitrateBnd

平均碼率範圍

名稱	類型	描述
Max	String	總碼率上限。取值範圍：[10,50000]。單位：Kbps。
Min	String	總碼率下限。取值範圍：[10,50000]。單位：Kbps。

AliyunOSSFile

OSS檔案類型

名稱	類型	描述
Bucket	String	OSS的Bucket。3～63位元組。
Location	String	OSS的服務地區。最大64位元組。
Object	String	OSS的Object。最大1024位元組。

AliyunJob

作業

名稱	類型	描述
JobId	String	任務ID。
Input	AliyunJobInput	作業輸入。
Output	AliyunOutput	作業輸出。
State	String	作業狀態： Submitted表示作業已提交。 Transcoding表示轉碼中。 TranscodeSuccess表示轉碼成功。 TranscodeFail表示轉碼失敗。 TranscodeCancelled表示轉碼取消。
Code	String	轉碼失敗時的錯誤碼。
Message	String	轉碼失敗時的訊息。
Percent	String	轉碼進度。取值範圍：[0,100]。
UserData	String	使用者自訂資料。
PipelineId	String	管道ID。
CreationTime	String	作業添加時間。
MNSMessageResult	AliyunMNSMessageResult	MNS通知使用者作業完成的訊息結果。

AliyunJobInput

轉碼作業輸入類型

名稱	類型	描述
Bucket	String	作業輸入OSS的Bucket。3～63位元組。
Location	String	作業輸入OSS的服務地區。最大64位元組。
Object	String	作業輸入OSS的Object。最大1024位元組。
Audio	AliyunInputAudio	轉碼源媒體音頻配置。
Container	AliyunInputContainer	轉碼源媒體容器配置。

AliyunInputContainer

源媒體容器配置類型。

說明當輸入檔案為ADPCM、PCM格式時此參數為必填項。

名稱	類型	描述
Format	String	源媒體音頻格式。取值：alaw、 f32be、f32le、f64be、f64le、mulaw、s16be、s16le、s24be、s24le、s32be、s32le、s8、u16be、u16le、u24be、u24le、u32be、u32le、u8。

AliyunInputAudio

源媒體音頻配置類型。

說明當輸入檔案為ADPCM、PCM格式時此參數為必填項。

名稱	類型	描述
Channels	String	源媒體音頻聲道數。取值範圍：[1,8]。
Samplerate	String	源媒體音頻採樣率。取值範圍：[0,320000]。單位：Hz。

AliyunOutput

作業輸出類型

名稱	類型	描述
OutputFile	AliyunOSSFile	輸出檔案。
TemplateId	String	模板ID。
WaterMarkList	AliyunWaterMark[ ]	浮水印列表。
Clip	AliyunClip	剪輯片段。
Rotate	String	視頻旋轉角度。取值範圍：[0,360)
Properties	AliyunProperties	媒體屬性。
Priority	String	任務在其對應管道內的優先順序。取值範圍：[1,10]。最高優先順序：10。預設值：6。
Container	AliyunContainer	容器。指定則替換TemplateId所指定模版的AliyunContainer設定。
Video	AliyunVideoCodec	視頻配置。指定則替換TemplateId所指定模版的AliyunVideoCodec設定。
Audio	AliyunAudioCodec	音頻配置。指定則替換TemplateId所指定模版的AliyunAudioCodec設定。
TransConfig	AliyunTransConfig	轉碼通用配置。指定則替換TemplateId所指定模版的AliyunTransConfig設定。
MuxConfig	AliyunMuxConfig	轉碼封包配置。指定則替換TemplateId所指定模版的AliyunMuxConfig設定。
UserData	String	使用者自訂資料。

AliyunClip

剪輯類型

名稱	類型	描述
TimeSpan	AliyunTimeSpan	剪輯時間段。

AliyunTimeSpan

剪輯時間段類型

名稱	類型	描述
Seek	String	開始時間。
Duration	String	延續時間。
End	String	截尾時間。如5.23，表示尾部的5.23秒會被截掉。設定此參數會導致Duration參數失效。

AliyunMuxConfig

封包配置類型

名稱	類型	描述
Segment	AliyunSegment	切片配置。

AliyunSegment

切片配置類型

名稱	類型	描述
Duration	String	分區時間長度。取值範圍：[1,60]。單位：秒。

AliyunJobResult

提交作業結果類型

名稱	類型	描述
Success	String	是否成功。取值為true或者false。
Code	String	建立作業失敗時錯誤碼。
Message	String	建立作業失敗時錯誤訊息。
Job	AliyunJob	作業。如果提交失敗則不會產生作業ID。

AliyunWaterMark

作業輸出類型

名稱	類型	描述
InputFile	AliyunOSSFile	浮水印輸入檔案。
WaterMarkTemplateId	String	浮水印模板ID。

AliyunWaterMarkTemplate

浮水印模板類型

名稱	類型	描述
Id	String	浮水印模板ID。
Name	String	浮水印模板名稱。
Width	Number	寬。取值範圍：[8,4096]。單位：px。
Height	Number	高。取值範圍：[8,4096]。單位：px。
Dx	Number	水平位移量。取值範圍：[-4096,4096]。單位：px。
Dy	Number	垂直位移量。取值範圍：[-4096,4096]。單位：px。
ReferPos	String	浮水印的位置。可取值：TopRight、TopLeft、BottomRight、BottomLeft。
Type	String	浮水印類型。可取值：Image、Text 。說明目前僅支援 Image。
State	String	浮水印模板的狀態。可取值：Normal、Deleted。

AliyunPipeline

管道類型

名稱	類型	描述
Id	String	管道ID。
Name	String	管道名稱。
Speed	String	管道類型。取值：Boost、Standard、NarrowBandHDV2、AIVideoCover、AIVideoRecogni、AIVideoSummary、AIVideoPorn、AIAudioKWS、AIAudioASR。預設值：Standard。
State	String	管道狀態。可取值：Active、Paused 。 Active：表示管道內的作業會被調度給轉碼系統轉碼， Paused：表示管道暫停，作業不再會被調度到轉碼系統，管道內的所有作業狀態維持在已提交狀態，正在執行的作業不受影響，繼續進行。
NotifyConfig	String	MNS通知配置。

AliyunMediaInfoJob

媒體資訊分析作業類型

名稱	類型	描述
Id	String	元資訊分析作業ID。
Input	AliyunOSSFile	作業輸入。
State	String	作業狀態。分為Analyzing、Success、Fail。
Code	String	元資訊分析失敗時錯誤碼。
Message	String	元資訊分析失敗時錯誤資訊。
Properties	AliyunProperties	屬性。
UserData	String	使用者自訂資料。
CreationTime	String	作業添加時間。

AliyunAnalysisJob

模板分析作業類型

名稱	類型	描述
Id	String	模板分析作業ID。
Input	AliyunOSSFile	作業輸入。
AnalysisConfig	AliyunAnalysisConfig	作業配置。
TemplateList	AliyunTemplate[ ]	作業輸出的預置模板列表。
State	String	作業狀態。分為Submitted、Analyzing、Success、Fail。
Code	String	分析失敗時錯誤碼。
Message	String	分析失敗時錯誤資訊。
Percent	String	轉碼進度。取值範圍：[0,100]。
Priority	String	任務在其對應管道內的優先順序。取值範圍：[1,10]。最高優先順序：10。預設值：10。
UserData	String	使用者自訂資料。
PipelineId	String	管道ID。
CreationTime	String	作業添加時間。
MNSMessageResult	AliyunMNSMessageResult	MNS通知使用者作業完成的結果。

AliyunSnapshotJob

截圖作業類型

名稱	類型	描述
Id	String	截圖作業ID。
Input	AliyunOSSFile	作業輸入。
SnapshotConfig	AliyunSnapshotConfig	截圖配置。
Count	String	截取圖片的數量。
State	String	截圖狀態。分為Snapshoting、Success、Fail。
Code	String	分析失敗時錯誤碼。
Message	String	分析失敗時錯誤資訊。
UserData	String	使用者自訂資料。
MNSMessageResult	AliyunMNSMessageResult	MNS通知使用者作業完成的結果。

AliyunSnapshotConfig

截圖配置 AliyunSnapshotConfig

名稱	類型	描述
OutputFile	String	截圖輸出OSS配置。
TileOutputFile	String	拼圖任務大圖的輸出OSS配置。
Time	String	截圖開始時間。單位：毫秒
Interval	String	截圖間隔時間。若指定則表示序列截圖，且值必須大於0。單位：秒預設值：10
Num	String	截圖數量。若指定則表示序列截圖。
Width	String	截圖輸出圖片寬度。取值範圍：[8,4096]
Height	String	截圖輸出圖片高度。取值範圍：[8,4096]
FrameType	String	截圖類型。普通幀：normal。 I幀：intra。預設值：normal。
TileOut	String	拼圖配置。

AliyunFailReason

失敗原因類型

名稱	類型	描述
Code	String	失敗時錯誤碼。
Message	String	失敗時錯誤資訊。

AliyunMNSMessageResult

MNS通知使用者作業完成結果類型

名稱	類型	描述
ErrorCode	String	失敗時錯誤碼。
ErrorMessage	String	失敗時錯誤資訊。
MessageId	String	成功時訊息ID。

Activity

媒體工作流程活動

名稱	類型	描述
Name	String	媒體工作流程活動名稱。說明在同一個工作流程中活動的名字是唯一的。
Type	String	媒體工作流程活動類型。範圍：Start、Snapshot、Transcode、Analysis、Report。
JobId	String	活動執行時產生的作業ID（例如分析作業ID、轉碼作業ID、截圖作業ID）。
State	String	狀態。範圍：Running、Success、Fail、Skipped。 Skipped表示活動被跳過。例如分析活動之後有高清、標清兩個轉碼活動，會根據實際分析的結果來決策，如果原視頻內容清晰度不夠，高清的轉碼活動就可能被跳過。
StartTime	String	活動開始執行時間。
EndTime	String	活動結束執行時間。
Code	String	錯誤碼。如果活動狀態是Fail時，會給出具體的錯誤碼。
Message	String	錯誤資訊。如果活動狀態是Fail時，會給出詳細的錯誤描述資訊。

MediaWorkflow

媒體工作流程

名稱	類型	描述
MediaWorkflowId	String	媒體工作流程ID。
Name	String	媒體工作流程名稱。
Topology	String	媒體工作流程拓撲結構。
State	String	狀態。範圍Inactive、Active、Deleted
CreationTime	String	建立時間。

InputFile

輸入檔案

名稱	類型	描述
Bucket	String	OSS Bucket。
Location	String	OSS Location。
Object	String	OSS Object。

MediaWorkflowExecutionInput

媒體工作流程執行執行個體輸入

名稱	類型	描述
InputFile	InputFile	媒體工作流程的輸入檔案。
UserData	String	使用者自訂資料。

MediaWorkflowExecution

媒體工作流程執行執行個體

名稱	類型	描述
RunId	String	執行執行個體ID。
Input	MediaWorkflowExecutionInput	媒體工作流程的輸入。
MediaWorkflowId	String	媒體工作流程ID。
Name	String	媒體工作流程名稱。
MediaId	String	媒體ID。媒體工作流程產生的所有資訊都屬於這個媒體ID。
ActivityList	Activity	媒體工作流程活動列表。
State	String	狀態。範圍：Running、Completed、Fail。 Completed僅表示工作流程執行完成，每個活動的（轉碼、截圖等）是否成功要看每個活動具體的狀態值。
CreationTime	String	建立時間。

MediaInfo