點播API的基礎資料型別 (Elementary Data Type) -

本文為您介紹點播API的基礎資料型別 (Elementary Data Type)。

媒資基本資料

Video：音視頻資訊

名稱	類型	描述
VideoId	String	音視頻ID。
Title	String	音視頻標題。
Description	String	音視頻描述。
Duration	Float	音視頻時間長度，單位：秒。
CoverURL	String	音視頻封面URL。
Status	String	音視頻狀態。具體的參數說明請參見Status：音視頻狀態。
CreationTime	String	音視頻建立時間。使用UTC時間。
Size	Long	音視頻源檔案大小，單位：位元組。
Snapshots	String[]	視頻截圖URL數組。
CateId	Long	音視頻分類ID。
CateName	String	音視頻分類名稱。
Tags	String	音視頻標籤，多個使用英文逗號（,）分隔。
TemplateGroupId	String	音視頻轉碼時使用的轉碼組ID。
StorageLocation	String	音視頻檔案的儲存地址。
AppId	String	應用ID。

Status：音視頻狀態

取值	描述	說明
Uploading	上傳中	音視頻的初始狀態，表示正在上傳。如果您的音視頻長時間處於上傳中，請參見為什麼我上傳的檔案一直處於上傳中？。處於該狀態下的音視頻僅可以刪除，無法進行其他動作，即無法對上傳中的音視頻發起轉碼處理、視頻截圖、媒資審核等其他動作。
UploadFail	上傳失敗	由於網路或源檔案損壞等原因可能導致上傳失敗，建議重試或更換源檔案上傳。當使用斷點續傳上傳時，由於無法判斷上傳是否失敗，因此斷點續傳的音視頻不會出現該狀態。處於該狀態下的音視頻僅可以刪除，無法進行其他動作，即無法對上傳失敗的音視頻發起轉碼處理、視頻截圖、媒資審核等其他動作。
UploadSucc	上傳完成	由於業務設計或其他原因，上傳時跳過了預設的轉碼處理環節，導致視頻未能產生有效播放流時，則視頻會被標記為上傳完成的狀態；當後續經過轉碼處理得到有效播放流後，該視頻會轉為正常狀態。處於該狀態下的音視頻可以正常發起轉碼處理、視頻截圖和媒資審核的操作。
Transcoding	轉碼中	表示音視頻進行中轉碼處理。處於初次轉碼中的視頻，無有效播放流，無法通過介面擷取到播放地址，您可以通過視頻轉碼完成的事件通知（單個清晰度轉碼完成或全部清晰度轉碼完成）來判斷轉碼狀態。
TranscodeFail	轉碼失敗	通常是由於您的視頻源檔案存在問題而導致轉碼失敗。您可以在視頻轉碼完成的事件通知（單個清晰度轉碼完成或全部清晰度轉碼完成）中擷取ErrorMessage失敗資訊，或參見轉碼常見問題排查轉碼失敗的原因。
Checking	審核中	如果在ApsaraVideo for VOD控制台 > 審核管理 > 審核設定中開啟了先審後發，則當音視頻上傳到ApsaraVideo for VOD中轉碼成功後，將預設進入審核流程，音視頻狀態將會被標記為審核中，後續，您必須要去發起人工審核，否則該音視頻將一直處於審核中狀態。處於該狀態下的音視頻，只能在ApsaraVideo for VOD控制台播放或通過審核安全IP進行播放，您將無法通過API或SDK擷取到音視頻的播放地址用於播放，但對於已經外泄的有效播放地址仍可以正常播放。處於該狀態下的音視頻可以正常發起轉碼處理、視頻截圖的操作。說明請注意此處審核中描述的為音視頻的狀態（在ApsaraVideo for VOD控制台 > 媒資庫 > 音/視頻中的狀態列查看），需要區別於機審狀態的審核中（在ApsaraVideo for VOD控制台 >審核管理 > 視頻審核中的機審狀態列查看）。機審狀態的審核中僅描述機器審核作業的狀態，而音視頻狀態的審核中描述了包含機器審核和人工審核作業的狀態。
Blocked	屏蔽	處於該狀態下的音視頻，只能在ApsaraVideo for VOD控制台播放或通過審核安全IP進行播放，您將無法通過API/SDK擷取到音/視頻的播放地址用於播放，但對於已經外泄的有效播放地址仍可以正常播放。處於該狀態下的音視頻僅可以刪除，無法進行其他動作，即無法對屏蔽的音視頻發起轉碼處理、視頻截圖、媒資審核等其他動作。
Normal	正常	當音視頻存在至少一路有效播放流時，該音視頻會處於正常狀態。處於該狀態下的音視頻可以進行所有操作，包括髮起轉碼處理、視頻截圖、媒資審核、播放等其他動作。
ProduceFail	合成失敗	表示視訊剪輯合成失敗。使用ApsaraVideo for VOD的雲剪輯進行剪輯合成時，請確保剪輯合成所使用的媒資都處於正常狀態，否則易導致視頻合成失敗。

ImageInfo：圖片資訊

名稱	類型	描述
ImageId	String	圖片ID。
URL	String	圖片URL（如果配置了CDN網域名稱則為CDN地址，否則為OSS地址）。
Title	String	圖片標題。
Tags	String	圖片標籤。
ImageType	String	圖片類型。
CateId	Long	分類ID。
CateName	String	分類名稱。
Description	String	描述。
StorageLocation	String	檔案儲存體地址。
Mezzanine	Mezzanine	圖片源資訊。
CreationTime	String	圖片建立時間。使用UTC時間。
Status	String	圖片狀態。具體的參數說明請參見Status：圖片狀態。
AppId	String	應用ID。

Status：圖片狀態

取值	描述	說明
Uploading	上傳中	圖片的初始狀態，表示正在上傳。如果您的圖片長時間處於上傳中，請參見為什麼我上傳的檔案一直處於上傳中？。
UploadFail	上傳失敗	由於網路或源檔案損壞等原因可能導致上傳失敗，建議重試或更換源檔案上傳。
Normal	正常	圖片上傳成功。

AttachedMediaInfo：輔助媒資資訊

名稱	類型	描述
MediaId	String	輔助媒資ID。
URL	String	輔助媒資URL（如果配置了CDN網域名稱則為CDN地址，否則為OSS地址）。
Title	String	標題。
Tags	String	標籤。
Type	String	輔助媒資類型。
Categories	Category[]	分類列表。
Description	String	描述。
StorageLocation	String	檔案儲存體地址。
CreationTime	String	輔助媒資建立時間。使用UTC時間。
ModificationTime	String	輔助媒資更新時間。使用UTC時間。
Status	String	輔助媒資狀態。具體的參數說明請參見Status：輔助媒資狀態。
AppId	String	應用ID。

Status：輔助媒資狀態

取值	描述	說明
Uploading	上傳中	初始狀態，表示輔助媒資正在上傳。
Normal	正常	輔助媒資上傳成功。
UploadFail	失敗	輔助媒資上傳失敗。

媒資源檔資訊

Mezzanine：音視頻源檔案資訊

名稱	類型	描述
VideoId	String	視頻ID。
FileName	String	檔案名稱。
Duration	String	檔案時間長度，單位：秒。
Status	String	源檔案狀態。具體的參數說明請參見Status：音視頻源檔案狀態。
CreationTime	String	檔案建立時間。使用UTC時間。
Height	Long	檔案高度，單位：Px。
Width	Long	檔案寬度，單位：Px。
Fps	String	檔案幀率，每秒多少幀。
FileURL	String	檔案地址。
Bitrate	String	檔案碼率，單位：Kbps。
Size	Long	檔案大小，單位：位元組。
OutputType	String	輸出檔案類型。取值： oss：來源站點地址。 cdn：加速地址。
VideoStreamList	VideoStream[]	視頻流資訊列表。
AudioStreamList	AudioStream[]	音頻流資訊列表。

VideoStream：視頻流資訊

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

AudioStream：音頻流資訊

名稱	類型	描述
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	語言。

Status：音視頻源檔案狀態

取值	描述	備忘
Uploading	上傳中	檔案的初始狀態，表示正在上傳。
Normal	正常	檔案上傳成功。
UploadFail	失敗	檔案上傳失敗。
Deleted	刪除	檔案被刪除。

Mezzanine：圖片源檔案資訊

名稱	類型	描述
FileURL	String	圖片OSS URL。
OriginalFileName	String	上傳檔案名稱。
FileSize	Long	檔案大小，單位：位元組。
Width	Integer	圖片寬度，單位：Px。
Height	Integer	圖片高度，單位：Px。

URL批量拉取上傳

URLUploadInfo：URL上傳資訊

名稱	類型	描述
JobId	String	Job ID。
UploadURL	String	上傳URL地址。
MediaId	String	上傳視頻ID。
FileSize	String	檔案大小。單位：位元組。
Status	String	URL上傳任務狀態。具體的參數說明請參見Status：URL上傳任務狀態。
CreationTime	String	建立時間。
CompleteTime	Long	完成時間。
UserData	String	使用者自訂欄位。
ErrorCode	String	錯誤碼。
ErrorMessage	String	錯誤資訊。

Status：URL上傳任務狀態

取值	描述
PENDING	提交任務成功，等待處理。
PROCESSING	開始處理任務。
DOWNLOADING	檔案下載中。
DOWNLOAD_SUCCESS	檔案下載完成。
DOWNLOAD_FAIL	檔案下載失敗。
UPLOADING	檔案上傳中。
UPLOAD_SUCCESS	上傳成功。
UPLOAD_FAIL	上傳失敗。
SUCCESS	任務成功，且回調完成。

音視頻播放

VideoBase：視頻基本資料

名稱	類型	描述
VideoId	String	視頻ID。
Title	String	視頻標題。
Duration	String	視頻時間長度，單位：秒。
CoverURL	String	視頻封面。
Status	String	視頻狀態。
CreationTime	String	視頻建立時間。使用UTC時間。
MediaType	MediaType	媒體檔案類型。取值： video：視頻。 audio：純音頻。

說明

播放介面預設返回CDN加速地址。未佈建網域名時，播放介面返回OSS來源站點地址，此時只有MP4格式地址可用於播放。

PlayInfo：視頻播放資訊

名稱	類型	描述
Bitrate	String	視頻流碼率，單位：Kbps。
Definition	String	視頻流清晰度定義。取值： FD：流暢。 LD：標清。 SD：高清。 HD：超清。 OD：原畫。 2K：2K。 4K：4K。
Specification	String	音視頻轉碼輸出規格，更多取值資訊，請參見輸出規格說明。
Duration	String	視頻流長度，單位：秒。
Encrypt	Long	視頻流是否加密流。取值： 0：否。 1：是。
EncryptType	String	視頻流加密類型。取值： AliyunVoDEncryption：阿里雲視頻加密（私人加密）。 HLSEncryption：HLS標準加密。
PlayURL	String	視頻流的播放地址。
Format	String	視頻流格式。若媒體檔案為視頻，取值： mp4 m3u8 若是純音頻，取值：mp3。
Fps	String	視頻流幀率，每秒多少幀。
Size	Long	視頻流大小，單位：位元組。
Width	Long	視頻流寬度，單位：Px。
Height	Long	視頻流高度，單位：Px。
StreamType	String	媒體流類型。若媒體流為視頻，取值：video。若是純音頻，取值：audio。
JobId	String	媒體流轉碼的作業ID，作為媒體流的唯一標識。
WatermarkId	String	當前媒體流關聯的浮水印ID。
Status	String	視頻流狀態，取值： Normal：正常狀態，標記的是每種清晰度和格式的一路最新轉碼完成的流的狀態。 Invisible：不可見狀態，當每種清晰度和格式有多路重複的轉碼流時，除了最新的一路流會被標記為正常狀態，其他流會被標記為不可見狀態。
NarrowBandType	String	窄帶高清類型。取值： 0：普通。 1.0：窄帶高清1.0。 2.0：窄帶高清2.0。僅當配置了窄帶高清1.0內建轉碼模板的清晰度時才會生效，更多資訊，請參見TranscodeTemplate：轉碼模板配置。
CreationTime	String	建立時間。使用UTC時間。
ModificationTime	String	更新時間。使用UTC時間。

VideoMeta：視頻Meta資訊

名稱	類型	描述
VideoId	String	視頻ID。
Title	String	視頻標題。
Duration	Float	視頻時間長度，單位：秒。
CoverURL	String	視頻封面。
Status	String	視頻狀態。

媒資搜尋

Media：媒體資訊

名稱	類型	描述
MediaId	String	媒體ID。
CreationTime	String	媒體建立時間。使用UTC時間。
MediaType	String	媒體檔案類型。取值： video：視頻。 audio：音頻。 image：圖片。 attached：輔助媒資。
Video	Video	視頻資訊。
Audio	Audio	音頻資訊。
Image	Image	圖片資訊。
AttachedMedia	AttachedMedia	輔助媒資資訊。

媒資分類

Category：媒資分類

名稱	類型	描述
CateId	Long	視頻分類ID。
CateName	String	分類名稱，最大64位元組，UTF8編碼。
ParentId	Long	父分類ID，一級分類父ID為-1。
Level	Long	分類層級，一級分類層級為0。

直播轉點播

LiveRecordVideo：直轉點錄製視頻資訊

名稱	類型	描述
StreamName	String	直播流名稱。
DomainName	String	網域名稱。
AppName	String	App名稱。
PlaylistId	String	播單ID。
RecordStartTime	String	錄製開始時間。
RecordEndTime	String	錄製結束時間。
Video	Video	視頻資訊。

雲剪輯-剪輯合成

EditingProject：雲剪輯工程

名稱	類型	描述
ProjectId	String	雲剪輯工程ID。
Title	String	雲剪輯工程標題。
CreationTime	String	雲剪輯工程建立時間。UTC時間，格式為：yyyy-MM-ddTHH:mm:ssZ。例如，2017-01-11T12:00:00Z（為北京時間2017年1月11日20點0分0秒）。
ModifiedTime	String	雲剪輯工程最新修改時間。UTC時間，格式為：yyyy-MM-ddTHH:mm:ssZ。例如，2017-01-11T12:00:00Z（為北京時間2017年1月11日20點0分0秒）。
Status	String	雲剪輯工程狀態。
Description	String	雲剪輯工程描述。
Timeline	String	雲剪輯工程時間軸。Json格式。
Duration	String	雲剪輯工程總時間長度，與Timeline的總時間長度一致。
CoverURL	String	雲剪輯工程封面URL。

ProjectStatus：雲剪輯工程狀態

取值	描述	說明
Normal	草稿	雲剪輯工程建立的初始狀態。
Producing	合成中	無。
Produced	合成成功	無。
ProduceFailed	合成失敗	無。

Material：雲剪輯工程素材資訊

說明

該類型指廣義的素材，既包括素材管理中的素材，也包括媒體庫中的視頻。

名稱	類型	描述
MaterialId	String	素材ID。
Title	String	素材標題。
Description	String	素材描述。
Duration	Float	素材時間長度，單位：秒，精確到小數點後4位。
CoverURL	String	素材封面URL。
Status	String	素材狀態。
CreationTime	String	素材建立時間，為UTC時間
Size	Long	素材源檔案大小，單位：位元組。
CateId	Long	素材分類ID。
CateName	String	素材分類名稱。
Tags	String	素材標籤，多個標籤使用英文逗號（,）分隔。
Snapshots	String[]	素材截圖URL數組。
Sprites	String[]	素材雪碧圖URL數組。

ProduceConfig：視頻合成配置

名稱	類型	描述
TemplateGroupId	String	視頻合成完畢之後，以合成的檔案為源檔案，啟動轉碼時所使用的轉碼模板組ID，類似上傳完成後的轉碼過程。該欄位為非必填項，當為空白時，則使用轉碼設定的預設範本組進行轉碼；當不為空白時，會使用該指定的模板組進行轉碼。可在控制台轉碼設定裡查看模板組ID。
TemplateId	String	視頻合成時使用的合成模板ID，用於產生媒體資源的源檔案。該欄位為非必填項。當取值為空白時，則使用雲剪輯內建的模板進行合成。如果合成目標為視頻檔案，內建模板的編碼格式為H.264，容器格式為MP4。如果有其他需求希望指定合成參數（如動圖合成、智能字幕合成、M3U8快剪、自訂合成參數支援等），可提交工單申請。
Width	Integer	合成輸出的視頻畫面的寬，單位：Px。該欄位為非必填項，預設值與Timeline所使用的素材源檔案解析度有關：取其最大寬高。例如：Timeline使用了3個素材，其源檔案解析度分別為：1280＊720，1920＊1080，720＊1280，則目標成片的解析度為1920＊1280。
Height	Integer	合成輸出的視頻畫面的高，單位：Px。該欄位為非必填項，預設值與Timeline所使用的素材源檔案解析度有關：取其最大寬高。例如：Timeline使用了3個素材，其源檔案解析度分別為：1280＊720，1920＊1080，720＊1280，則目標成片的解析度為1920＊1280。
Bitrate	Integer	合成輸出的視頻碼率，單位：Kbps。該欄位為非必填項，預設值與Timeline所使用的素材源檔案碼率有關：取其最大碼率。例如：Timeline使用了3個素材，其源檔案碼率分別為：400Kbps，600Kbps，800Kbps，則目標成片的碼率為800Kbps。
StorageLocation	String	檔案的儲存地址（除上海地區外的其他地區必填）。

MediaMetadata：合成視頻的媒資中繼資料

名稱	類型	描述
Title	String	合成視頻標題，長度不超過128個位元組，UTF8編碼。
Description	String	合成視頻描述，長度不超過1024個位元組，UTF8編碼。
CoverURL	String	合成視頻自訂封面URL地址。
CateId	String	合成視頻分類ID，請在ApsaraVideo for VOD控制台 > 組態管理 > 媒資管理配置 > 分類管理裡編輯或查看分類的ID。
Tags	String	合成視頻標籤，單個標籤不超過32位元組，最多不超過16個標籤。多個標籤使用英文逗號（,）分隔，UTF8編碼。

雲剪輯-Timeline（適用於新版編輯器）

說明

不同服務地區對雲剪輯能力的支援情況不同，使用前，請先確認您的服務地區是否支援，具體支援情況，請參見服務地區。舊版編輯器的雲剪輯資料類型相關參數解釋，請參見雲剪輯資料類型（適用於舊版編輯器）。

Timeline：時間軸資訊

時間軸是將素材按照視頻創意進行編排和特效設計的產物。時間軸主要包含軌道、素材、效果3種對象。

名稱	類型	是否必填	描述
VideoTracks	VideoTrack[]	否，視頻軌為空白時，音頻軌必須非空。	視頻軌列表。多個軌道的層疊順序與數組元素順序一致，如：數組的第一個元素圖層的t在最底層，第二個元素的圖層在其之上，以此類推。
AudioTracks	AudioTrack[]	否，音頻軌為空白時，視頻軌必須非空。	音頻軌列表。
SubtitleTracks	SubtitleTrack[]	否	字幕軌列表。
EffectTracks	EffectTrack[]	否	特效軌列表。

VideoTrack：視頻軌資訊

視頻軌VideoTrack用於編排映像素材，包括視頻素材和圖片素材。

名稱	類型	是否必填	描述
Type	String	否	預設為普通視頻軌。當Type=Effect時，當前軌道可當做特效軌使用，VideoTrackClips可填入EffectTrackItem。
MainTrack	Boolean	否	用於指定當前軌道是否為主軌道。預設為 False。
VideoTrackClips	VideoTrackClip[]	是	視頻軌素材片段列表。

AudioTrack：音頻軌資訊

音頻軌AudioTrack用於編排音頻素材，包括純音頻素材和帶音訊視頻素材。

名稱	類型	是否必填	描述
MainTrack	Boolean	否	用於指定當前軌道是否為主軌道。預設為 False。
AudioTrackClips	AudioTrackClip[]	是	音頻軌素材片段列表。

SubtitleTrack：字幕軌資訊

字幕軌SubtitleTrack用於編排字幕，包括橫幅文字和外掛字幕。

名稱	類型	是否必填	描述
SubtitleTrackClips	SubtitleTrackClip[]	是	字幕軌素材片段列表。

EffectTrack：特效軌資訊

特效軌EffectTrack用於為視頻整體添加特效，支援濾鏡、VFX。

名稱	類型	是否必填	描述
EffectTrackItems	EffectTrackItem[]	是	特效軌片段列表。

VideoTrackClip：視頻軌素材資訊

視頻軌素材VideoTrackClip的範圍包括視頻素材和圖片素材。

In、Out、TimelineIn、TimelineOut標記了對素材截取的位置以及素材在時間軸中的位置，如：想把一段視頻的5~10s放在時間軸15s~20s位置上，則：In=5, Out=10, TimelineIn=15, TimelineOut=20。

名稱	類型	是否必填	描述
MediaId	String	否	視頻軌素材片段對應的媒體ID。媒體ID在某些場合也叫音/視頻ID（VideoId）或圖片ID（ImageId）。
Type	String	否	素材片段類型，預設Video。取值： Video（視頻） Image（圖片） GlobalImage（全域圖片，預設按照最長視頻軌時間計算該圖片時間長度。）樣本：視頻軌道中使用全域圖片GlobalImage
X	Float	否	表示圖片或視頻左上方距離輸出視頻左上方的橫向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Y	Float	否	表示圖片或視頻左上方距離輸出視頻左上方的縱向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。
Width	Float	否	表示圖片在輸出視頻中的寬度。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Height	Float	否	表示圖片在輸出視頻中的高度。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。
AdaptMode	String	否	視頻尺寸自適應模式類型，預設為Fill，必須同時設定視頻軌道Width和Height，該模式才會生效，此時Width和Height為目的地區域寬高，視頻會在目的地區域內自適應縮放。 Contain：被替換的內容將被縮放，在填充目的地區域的同時保留其長寬比。 Cover：被替換的內容在保持其寬高比的同時填充整個目的地區域。如果對象的寬高比與內容框不相匹配，該對象將被剪裁以適應目的地區域。 Fill：預設邏輯，被替換的內容正好填充目標內容框。整個對象將完全填充此框。如果對象的寬高比與內容框不相匹配，那麼該對象將被展開以適應目的地區域。
In	Float	否	素材片段相對於素材的入點，在素材類型是音視頻時使用。單位：秒，精確到小數點後4位。如果In不填，預設為0。
Out	Float	否	素材片段相對於素材的出點，在素材類型是音視頻時使用。單位：秒，精確到小數點後4位。如果Out不填，預設為素材時間長度。
MaxOut	Float	否	素材片段相對於素材的最大出點值。如果設定該值，素材片段相對於素材的出點將會設定為素材時間長度與該值中的較小者。在素材為音視頻時使用。單位：秒，精確到小數點後4位。如果填入Out值，MaxOut值將失效。樣本：視頻軌中設定出點MaxOut
Duration	Float	否	素材片段的時間長度，一般在素材類型是圖片時使用。單位：秒，精確到小數點後4位。
DyncFrames	Int	否	動圖的幀率，在素材類型是圖片且為動圖時使用。樣本：使用GIF貼紙
TimelineIn	Float	否	素材片段相對於時間軸的入點。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會按照素材片段順序相接的方式自動計算TimelineIn。
TimelineOut	Float	否	素材片段相對於時間軸的出點。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會按照素材片段順序相接的方式自動計算TimelineOut。
Speed	Float	否	視頻素材速率，取值範圍為0.1~100，如：Speed=2，則將視頻做2倍速處理，Clip的Duration減半，併合成到成片中。樣本：音視頻變速
MaskVideoUrl	String	否	遮罩視頻地址。一般為帶Alpha通道的視頻，用於為原視頻添加透明通道效果。僅支援傳入OSS外網地址。
Effects	Effect[]	否	素材片段的效果列表。

AudioTrackClip：音頻軌素材資訊

音頻軌素材AudioTrackClip的範圍包括純音頻素材、有音頻流的視頻素材。

名稱	類型	是否必填	描述
MediaId	String	否	音頻軌素材片段對應的媒體ID。
In	Float	否	素材片段相對於素材的入點。單位：秒，精確到小數點後4位。如果In不填，預設為0。
Out	Float	否	素材片段相對於素材的出點。單位：秒，精確到小數點後4位。如果Out不填，預設為素材時間長度。
TimelineIn	Float	否	素材片段相對於時間軸的入點。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會按照素材片段順序相接的方式自動計算TimelineIn。
TimelineOut	Float	否	素材片段相對於時間軸的出點。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會按照素材片段順序相接的方式自動計算TimelineOut。
Speed	Float	否	音頻素材速率，取值範圍0.1~100，如：Speed=2，則將音頻做2倍速處理，Clip的Duration減半，併合成到成片中。樣本：音視頻變速
Effects	Effect[]	否	素材片段的效果列表。
LoopMode	Boolean	否	素材片段在時間軸中迴圈播放效果。True：迴圈播放；False（預設值）：正常不迴圈。樣本：音頻迴圈播放

SubtitleTrackClip：字幕軌素材資訊

字幕軌素材SubtitleTrackClip的範圍包括字幕素材。

名稱	類型	是否必填	描述
Type	String	是	字幕素材類型。取值： Subtitle：外掛字幕檔案 Text：橫幅文字
SubType	String	否	字幕素材子類型。取值： srt：外掛srt字幕 ass：外掛ass字幕字幕素材類型為橫幅文字時，可忽略該欄位。
FileURL	String	否	字幕檔案對應的OSS地址。當字幕類型為外掛字幕時必填。格式為： https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt 樣本：直接使用字幕檔案進行剪輯說明 FileURL僅支援OSS外網地址，不支援OSS加速地址、CDN地址或其他HTTP URL。
X	Float	否	當字幕類型為橫幅文字時，表示文字左上方距離輸出視頻左上方的橫向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻寬的佔比。當取值為>=2的整數時，表示絕對像素。
Y	Float	否	當字幕類型為橫幅文字時，表示文字左上方距離輸出視頻左上方的縱向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻高的佔比。當取值為>=2的整數時，表示絕對像素。
TimelineIn	Float	否	當字幕類型為橫幅文字時，表示文字出現在時間軸的起始位置。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會按照素材順序相接的方式自動計算TimelineIn。
TimelineOut	Float	否	當字幕類型為橫幅文字時，表示文字出現在時間軸的結束位置。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會按照素材順序相接的方式自動計算TimelineOut。
Content	String	否	當字幕類型為橫幅文字時必填，表示文字內容。
Font	String	否	當字幕類型為橫幅文字時，表示文字的字型。預設為SimSun，宋體。具體支援的字型列表參見：字型列表。
FontSize	Int	否	當字幕類型為橫幅文字時，表示文字的字型大小。
FontColor	String	否	當字幕類型為橫幅文字時，表示文字的顏色，格式為#後跟16進位值。例如：#ffffff。
FontColorOpacity	String	否	當字幕類型為橫幅文字時，表示文字的透明度，取值0-1，預設1。1為不透明，0為完全透明。
FontFace	FontFace	否	當字幕類型為橫幅文字時，表示文字的字型外觀。
Spacing	Int	否	當字幕類型為橫幅文字時，表示橫幅文字字間距。單位：像素值，預設為0。
Angle	Float	否	當字幕類型為橫幅文字時，表示橫幅文字逆時針旋轉角度。單位：度，預設為0。
BorderStyle	Int	否	設定橫幅文字邊框和陰影格式。取值1或3，1=邊框+陰影，3=不透明底框。預設為1。
Outline	Int	否	當字幕類型為橫幅文字時，表示橫幅文字描邊寬度。單位：像素值，預設為0。
OutlineColour	String	否	當字幕類型為橫幅文字時，表示橫幅文字描邊顏色，格式為#後跟16進位值。例如：#ffffff。
Shadow	Int	否	當字幕類型為橫幅文字時，表示橫幅文字投下陰影的深度，單位：像素值，預設為0。
BackColour	String	否	當字幕類型為橫幅文字時，表示橫幅文字陰影顏色，格式為#後跟16進位值。例如：#ffffff。
Alignment	String	否	當字幕類型為橫幅文字時，用於設定定位對齊，預設為TopLeft。取值： TopLeft：視頻左上方 TopCenter：視頻豎直中軸線上側 TopRight：視頻右上方 CenterLeft：視頻水平中軸線左側 CenterCenter：視頻中心位置 CenterRight：視頻水平中軸線右側 BottomLeft：視頻左下角 BottomCenter：視頻豎直中軸線下側 BottomRight：視頻右下角
AdaptMode	String	否	橫幅文字當超出視頻寬度或超出指定TextWidth時進行自動換行或縮放。取值： AutoWrap：自動換行 AutoScale：自動縮放 AutoWrapAtSpaces：只在空格位置自動換行（適用於純英文字幕自動換行情境）
TextWidth	Integer	否	字幕文字框寬度，當設定AdaptMode時生效。將按照該值設定文字框寬度進行自動換行或縮放。不填寫時，會按照視頻寬度進行自動換行或縮放。單位：像素值。
FontUrl	String	否	當字幕類型為橫幅文字時，支援使用使用者OSS的字型檔路徑來產生字幕，支援ttf、otf、woff三種格式的字型檔。例如：https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf
EffectColorStyle	String	否	當字幕類型為橫幅文字時，表示橫幅文字花字樣式類型。花字種類及效果請參見花字效果樣本。
AaiMotionInEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字入場特效類型。字幕入場特效種類及效果請參見入場特效。
AaiMotionIn	Float	否	當字幕類型為橫幅文字時，表示橫幅文字入場特效時間長度。單位：秒，精確到小數點後4位，如果AaiMotionIn不填，預設0.5s，如果文本時間長度小於0.5，則為總時間長度減去出場時間長度。
AaiMotionOutEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字出場特效類型。字幕出場特效種類及效果請參見出場特效。
AaiMotionOut	Float	否	當字幕類型為橫幅文字時，表示橫幅文字出場特效時間長度，單位秒，精確到小數點後4位，如果AaiMotionOut不填，預設0.5s，如果文本時間長度小於0.5，則為總文本時間長度。
AaiMotionLoopEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字迴圈特效類型，不可與字幕入場或者出場特效同時生效。迴圈特效種類以及效果請參見迴圈特效。
Ratio	Float	否	當字幕類型為橫幅文字時，表示橫幅文字迴圈特效播放速度，精確到小數點後4位。不填預設為1，大於1表示加速迴圈，小於1表示慢速迴圈。

EffectTrackItem：特效軌片段資訊

特效軌片段EffectTrackItem，類型包括VFX、濾鏡。

名稱	類型	是否必填	描述
Type	String	是	特效軌片段類型，支援：VFX、Filter。
SubType	String	是	特效軌片段子類型，支援的特效種類及效果請參見特效效果樣本及濾鏡效果樣本。
TimelineIn	Float	否	特效片段出現在時間軸的起始位置。單位：秒，精確到小數點後4位。如果TimelineIn不填，則預設為0。
TimelineOut	Float	否	特效片段出現在時間軸的結束位置。單位：秒，精確到小數點後4位。如果TimelineOut不填，則預設為視頻結束時間。
Duration	Float	否	特效片段出現在時間軸的持續時間長度。單位：秒，精確到小數點後4位。如果Duration不填，則預設為視頻時間長度。說明 Duration和TimelineOut僅有一個生效。
X	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區左上方距離輸出視頻左上方的橫向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Y	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區距離輸出視頻左上方的縱向距離。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。
Width	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區在輸出視頻中的寬度。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Height	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區在輸出視頻中的高度。註：支持度百分比和像素兩種形式。當取值為[0～0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。

FontFace：字型樣式

名稱	類型	是否必填	描述
Bold	Boolean	否	加粗。
Italic	Boolean	否	斜體。
Underline	Boolean	否	底線。

Effect：特效資訊

不同的效果類型，有不同的屬性可以設定，同時有一些共通的屬性。

各類Effect的獨立屬性描述，詳情請參見Effect配置說明。

Effect通用屬性如下：

名稱

類型

是否必填

描述

Type

String

是

效果類型。取值：

Text：橫幅文字，視頻軌素材。
DeWatermark：遮標，視頻軌素材。
Crop：裁剪，視頻軌素材。
Scale：縮放，視頻軌素材。
Pad：貼邊，視頻軌素材
Background：背景設定，視頻軌素材。
Transition：轉場，視頻軌素材。
VFX：特效，視頻軌素材。
Filter：濾鏡，視頻軌素材。
Volume：音量調整，音頻軌素材。
AFade：音頻淡入淡出，音頻軌素材。
Rotate：素材旋轉，視頻軌素材。
Clip：隨機截取。
Flip：翻轉。
KenBurns：鏡頭推拉。
Zoom：變焦。

SubType

String

否

效果子類型。

當Type為Transition時，會進一步描述轉場子類型。取值請參見轉場效果樣本。
當Type為VFX時，會進一步描述特效子類型。取值請參見特效效果樣本。
當Type為Filter時，會進一步描述濾鏡子類型。取值請參見濾鏡效果樣本。

視頻截圖/視頻動圖

SnapshotJob：截圖作業資訊

名稱	類型	描述
JobId	String	作業ID。

VodTemplateInfo：截圖模板資訊

名稱	類型	描述
Name	String	模板名稱。
VodTemplateId	String	模板ID。
TemplateType	String	模板類型，取值： Snapshot：截圖。 DynamicImage：動圖。
IsDefault	String	是否預設，取值： Default：預設浮水印。 NotDefault：非預設浮水印。
TemplateConfig	JSON	模板詳細配置，Json字串，取值： Snapshot配置請參見SnapshotTemplateConfig。 DynamicImage配置請參見DynamicImageTemplateConfig。
CreationTime	String	建立時間，UTC格式。
ModifyTime	String	修改時間，UTC格式。

MediaSnapshot：媒體截圖資料

名稱	類型	描述
JobId	String	截圖作業ID。
CreationTime	String	截圖作業建立時間，為UTC時間。
Total	Long	截圖總數。
Regular	String	截圖地址建置規則。
Snapshots	Snapshot[]	截圖資料。

Snapshot：截圖資訊

名稱	類型	描述
Index	String	截圖索引值。
Url	String	截圖地址。

DynamicImage：動圖資訊

名稱	類型	描述
VideoId	String	視頻ID。
DynamicImageId	String	動圖ID。
FileURL	String	動圖檔案地址。
Width	String	動圖寬。
Height	String	動圖高。
Duration	String	動圖時間長度。
Format	String	動圖格式，取值：gif或webp。
FileSize	String	動圖檔案大小。
Fps	String	動圖幀率。

視頻浮水印

WatermarkInfo：浮水印資訊

名稱	類型	是否必填	描述
CreationTime	String	是	浮水印建立時間。
Name	String	是	浮水印名稱。
IsDefault	String	是	是否是預設浮水印，取值： Default：預設浮水印。 NotDefault：非預設浮水印。
Type	String	是	浮水印類型，取值： Image：圖片。 Text：文字。
WatermarkId	String	是	浮水印ID。
FileUrl	String	否	浮水印檔案URL（OSS地址或CDN地址），文字浮水印沒有檔案地址資訊。
WatermarkConfig	WatermarkConfig	是	浮水印顯示位置、效果等配置資訊（JSON字串）：文字浮水印、圖片浮水印。

音視頻轉碼

TranscodeJob：轉碼作業資訊

名稱	類型	描述
JobId	String	作業ID。

TranscodeTemplateGroup：轉碼模板組

名稱	類型	是否必填	描述
Name	String	是	模板組的名稱。
TranscodeTemplateGroupId	String	是	轉碼模板組ID。
IsDefault	String	是	是否是預設範本組，取值： Default：預設範本組。 NotDefault：非預設範本組。
CreationTime	String	是	模板組的建立時間。
ModifyTime	String	是	模板組的修改時間。
TranscodeTemplateList	TranscodeTemplate[]	是	轉碼模板配置資訊列表。

TranscodeTemplate：轉碼模板配置

名稱	類型	是否必填	描述
Type	String	否	模板類型，取值： Normal：正常轉碼模板。該類型模板不能設定PackageSetting參數。 VideoPackage：視頻流打包模板。該類型模板會先轉碼,後構建自適應碼流，且必須要配置PackageSetting參數。 SubtitlePackage：字幕打包模板。該類型模板不會轉碼，僅將對應字幕資訊構建到自適應碼率輸出檔案中，且必須要設定PackageSetting參數。但該類型模板不能在模板組中單獨存在，需要與VideoPackage類型模板一同配置&一個模板組僅能配置一個該類型模板。預設值為Normal。
Video	Video	是	視頻流轉碼配置參數（JSON字串）。
Audio	Audio	是	音頻流轉碼配置參數（JSON字串）。
Definition	String	是	普通轉碼模板清晰度標記，取值： LD：流暢。 SD：標清。 HD：高清。 FHD：超清。 OD：原畫，即轉封裝。 2K 4K SQ：普通音質。 HQ：高音質。說明此處清晰度僅為轉碼模板資料標記，不代表視頻實際輸出規格（解析度範圍），視頻實際輸出規格關係，更多資訊請參見輸出規格：Specification。此處清晰度標記與實際轉碼計費沒有任何關係，轉碼計費規格（解析度範圍）。更多資訊，請參見ApsaraVideo for VOD轉碼時間長度包。窄帶高清1.0內建轉碼模板清晰度標記，取值： LD-NBV1：流暢。 SD-NBV1：標清。 HD-NBV1：高清。 FHD-NBV1：超清。 2K-NBV1 4K-NBV 說明所有轉碼模板不支援清晰度標記修改。窄帶高清1.0轉碼模板音視頻解析度、碼率等參數為系統內建，不支援修改，更多參數資訊，請參見窄帶高清轉碼。窄帶高清1.0轉碼模板建立只支援FLV、M3U8（HLS）、MP4格式。
Container	Container	是	封裝音視頻碼流的容器格式（JSON字串）。
MuxConfig	MuxConfig	否	轉碼的分區設定參數，HLS必傳（JSON字串）。
TransConfig	TransConfig	否	條件轉碼參數，如需要根據源片碼率、解析度進行基本邏輯判斷再輸出轉碼視頻，則可設定該參數（JSON字串）。
TranscodeFileRegular	String	否	自訂轉碼輸出路徑。說明支援萬用字元：{MediaId}（視頻ID）、{JobId}（轉碼任務ID）、{PlayDefinition}（ GetPlayInfo返回的清晰度標記）。只支援數字、英文字元、{、}、/、-、_，最大允許128個字元。自訂輸出路徑必須以{MediaId}開頭。配置樣本 {MediaId}/watermark-{PlayDefinition}，則轉碼時會將對應的視頻ID（例如：8ff5cc93f6da4079a47a77bf71d）替換掉{MediaId}，將清晰度標記（例如：fd）替換掉{PlayDefinition}。輸出樣本 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4（檔案尾碼名自動補齊，諸如：.mp4、.m3u8、.flv）。
Clip	Clip	否	視頻裁剪配置（JSON字串）。例如：需要截取視頻中的5s內容，用於產生一個新的視頻，則可設定該參數。
Rotate	String	否	視頻旋轉標參數，控制畫面的旋轉角度。取值範圍：[0,360]。例如：設定180，則視頻畫面將上下顛倒。
EncryptSetting	EncryptSetting	否	轉碼加密配置資訊。
PackageSetting	PackageSetting	否	打包配置，只支援HLS自適應碼流打包、DASH打包（JSON字串）。
SubtitleList	SubtitleConfig	否	字幕配置（JSON字串）。
WatermarkIds	String[]	否	關聯的浮水印ID，最大支援4個浮水印ID關聯。USER_DEFAULT_WATERMARK關鍵字代表設定的預設浮水印對應的ID。
TranscodeTemplateId	String	否	轉碼模板ID，修改操作時必傳。
TemplateName	String	否	轉碼模板名稱，添加操作時必傳。

TranscodeTemplate參數樣本

{
        "Type":"VideoPackage",
        "Video":{
                "Codec":"H.264",
                "Bitrate":"900",
                "Width":"960",
                "Remove":"false",
                "Fps":"30"
        },
        "Audio":{
                "Codec":"AAC",
                "Bitrate":"128",
                "Samplerate":"44100"
        },
        "Container":{
                "Format":"m3u8"
        },
        "MuxConfig":{
                "Segment":{
                        "Duration":"6"
                }
        },
        "EncryptSetting":{
                "EncryptType":"AliyunVoDEncryption"
        },
        "PackageSetting":{
                "PackageType":"HLSPackage"
                "PackageConfig":{
                        "BandWidth":"900000"
                }
        },
       "SubtitleUrl": "http://outin-40564284ef058b2163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****-cn.ass",
        "CharEncode": "UTF-8",
        "WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
        "Definition":"SD",
        "TemplateName":"test"
}

Video：轉碼視頻流配置

說明

無特殊需求，只需要設定Codec、Bitrate、Height、Width、Remove=false即可。
轉碼輸出視頻的Width（寬）、Height（高）建議只設定其中之一，這樣可保持轉碼輸出視頻畫面寬高比例與源片一致。

名稱	類型	是否必填	描述
Codec	String	是	視頻編碼格式：H.264、H.265。
Remove	String	是	是否刪除視頻流，取值： true：表示轉碼輸出檔案會刪除視頻流 false：表示轉碼輸出檔案保留視頻流預設值為false。
Bitrate	String	否	視頻輸出目標碼率，不傳遞則根據Crf產生碼率，單位：Kbps。取值範圍：[10，50000]。
Height	String	否	視頻輸出的畫面高（取值需為2的倍數），不傳則為源檔案高。單位：Px。取值範圍：[128，4096]。
Width	String	否	視頻輸出的畫面寬（取值需為2的倍數），不傳則為源片寬。單位：Px。取值範圍[128，4096]。
Fps	String	否	不傳則為源檔案幀率。單位：FPS。取值範圍：(0,60]。
Gop	String	否	相鄰主要畫面格的幀間距，單位：幀。取值範圍：[1-100000]。
LongShortMode	String	否	開啟橫豎屏自適應（即：長短邊模式），轉碼輸出的寬對應輸入片源的長邊（豎屏為片源的高），高對應輸入視頻的短邊（豎屏為片源的寬）。取值： true：開啟。 false：關閉。預設值為true，適用於豎屏視頻（推薦開啟）。
Crf	String	否	碼率品質控制因子，設定該參數則Bitrate參數無效，取值越大，轉碼視頻畫面品質越差，檔案Size越小，反之畫面品質越好，檔案Size越大，但轉碼時間越長。取值範圍：[0,51]。預設值為26（不推薦修改該參數）。
Profile	String	否	編碼層級。取值： baseline：適合行動裝置 main：適合標準解析度裝置 high：適合高解析度裝置預設值為high，目前僅H.264支援該參數。最佳實務如果您有多個清晰度，建議最低清晰度配成baseline，以保證最低端裝置可播放。其他清晰度配置為main或high。
Preset	String	否	視頻演算法器預置。取值：veryfast、fast、medium、slow、slower。預設值為medium。目前僅H.264支援該參數，不推薦修改該參數。
ScanMode	String	否	掃描模式。取值： interlaced：隔行掃描。 progressive：漸進式掃描。
Bufsize	String	否	緩衝區大小。單位：kb，取值範圍：[1000,128000]。預設值為6000。
Maxrate	String	否	視頻碼率峰值，單位：kbps。取值範圍：[1000,50000]。
PixFmt	String	否	視頻顏色格式。取值：yuv420p，yuvj420p等標準顏色格式。預設值：yuv420p或原始顏色格式。

Video參數樣本

{
        "Codec":"H.264",
        "Bitrate":"128",
        "Remove":"false",
        "Width":"640",
        "Fps":"30"
}

Audio：轉碼音頻流配置

說明

無特殊需求時，只需要設定Codec、Bitrate、Remove=false即可。

名稱	類型	是否必填	描述
Codec	String	是	音頻編碼格式：AAC、MP3。
Bitrate	String	是	音訊輸出目標碼率，單位：Kbps。取值範圍：[8，1000]。
Remove	String	是	是否刪除音頻流，取值： true：表示會刪除轉碼輸出檔案的音頻流。 false：表示會保留轉碼輸出檔案的音頻流。預設值為false。
Samplerate	String	是	採樣率單位為：Hz。取值：22050、32000、44100、48000、96000。預設值為44100。若視頻容器格式為flv，音頻編解碼格式選擇為mp3時，採樣率不支援32000、48000、96000。音頻編解碼格式為mp3時，採樣率不支援96000。
Channels	String	否	聲道數。預設值為2。當Codec設定為mp3時，聲道數只支援1、2。當Codec設定為aac時，聲道數只支援1、2、4、5、6、8。
Profile	String	否	音頻編碼預置。當Codec為AAC時，取值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。
Volume	Volume	否	音量參數。

Audio參數樣本

{
        "Codec":"AAC",
        "Bitrate":"128",
        "Remove":"false",
        "Samplerate":"44100"
}

Container：封裝格式

名稱

類型

是否必填

描述

Format

String

是

容器格式。

視頻轉碼支援：FLV、MP4、HLS（M3U8+TS）。
音頻轉碼支援：MP3、MP4。
容器格式為FLV時支援：Video Codec不能設定為H.265。

Container參數樣本

{
        "Format":"mp4"
}

MuxConfig：HLS分區配置

說明

Container格式設定為m3u8，則必傳該參數。

名稱	類型	是否必填	描述
Segment	Segment	是	JSON對象，切片配置欄位。

Segment：分區詳細配置

名稱

類型

是否必填

描述

Duration

String

是

TS分區時間長度，整數值，取值範圍：[1，60]，單位：秒。

樣本：{"Duration":"10"}。

MuxConfig參數樣本

{
        "Segment":{
                "Duration":"10"
        }
}

TransConfig：條件轉碼配置

名稱	類型	是否必填	描述
TransMode	String	否	轉碼模式。取值： onepass：通常用於ABR（Average Bitrate），比twopass的編碼速度更快。是阿里雲預設的編碼方式。 twopass：通常用於VBR（Variable Bitrate），編碼器執行兩次來精準分配碼率，以擷取體積更小品質更高的編碼結果。twopass模式相比onepass模式需要花費更多時間，所以無法使用在直播、即時通訊等對轉碼時效性要求高的情境。以及若輸入視頻的壓縮率已經很高，也不適合使用twopass，會出現塊效應。 CBR：固定碼率模式，指檔案從頭到尾都是一種碼率。相對於VBR和ABR來講，它壓縮出來的檔案體積較大，而且視頻品質相對於VBR和ABR不會有明顯的提高。預設值為onepass。
IsCheckReso	String	否	檢查源片解析度，判斷是否按原片解析度轉碼。取值： true：表示檢查，如果輸出解析度大於輸入解析度（判斷條件是寬或高），則輸出解析度等於輸入解析度。 false：表示不檢查。預設值為false。
IsCheckResoFail	String	否	檢查源片解析度，判斷是否為轉碼失敗。取值： true：表示檢查，如果輸出解析度大於輸入解析度（判斷條件是寬或高），則返迴轉碼失敗。 false：表示不檢查。預設值為false。
IsCheckVideoBitrate	String	否	檢查源片視頻流碼率，判斷是否按照源片視頻流碼率轉碼。取值： true：表示檢查，如果視頻輸出碼率大於視頻輸入碼率，則視頻輸出碼率等於視頻輸入碼率。 false：表示不檢查。預設值為false。
IsCheckVideoBitrateFail	String	否	檢查源片視頻流碼率，判斷是否為轉碼失敗。取值： true：表示檢查，當輸出視頻碼率大於媒體源視頻碼率時，不進行轉碼。 false：表示不檢查。預設值為false，此值優先順序大於IsCheckVideoBitrate。
IsCheckAudioBitrate	String	否	檢查源片音頻流碼率，判斷是否為按照源片音頻流碼率轉碼。取值： true：表示檢查，如果音訊輸出碼率大於音頻輸入碼率，則音訊輸出碼率等於音頻輸入碼率。 false：表示不檢查。預設值為false。
IsCheckAudioBitrateFail	String	否	檢查源片音頻流碼率，判斷是否為轉碼失敗。取值： true：表示檢查，當輸出音頻碼率大於媒體源音頻碼率時，不進行轉碼。 false：表示不檢查。預設值為false，此值優先順序大於IsCheckAudioBitrate。

TransConfig參數樣本

{
        "IsCheckReso":"true",
        "IsCheckResoFail":"false",
        "IsCheckVideoBitrate":"false",
        "IsCheckVideoBitrateFail":"false",
        "IsCheckAudioBitrate":"false",
        "IsCheckAudioBitrateFail":"false"
}

Clip：視頻裁剪設定

名稱	類型	是否必填	描述
TimeSpan	TimeSpan	是	視頻裁剪範圍相關時間參數配置。

TimeSpan：視頻裁剪設定

名稱	類型	是否必填	描述
Seek	String	是	視頻裁剪的開始時間。格式1：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：12000.55。格式2：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:05.003。推薦使用格式1。
Duration	String	否	視頻裁剪的持續時間長度。格式1：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：12000.55。格式2：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:05.003。推薦使用格式1。說明 Duration與End參數必須設定一個，二者同時設定時，按設定的End參數處理。
End	String	否	視頻裁剪需要丟棄的尾部時間長度。格式1：sssss[.SSS]，取值範圍：[0.000，86399.999]。樣本：12000.55。格式2：hh:mm:ss[.SSS]，取值範圍：[00:00:00.000,23:59:59.999]。樣本：00:00:05.003。推薦使用格式1。說明 Duration與End參數必須設定一個，二者同時設定時，按設定的End參數處理。開始時間和結束時間之間的時間長度，不能大於視頻的總時間長度。

EncryptSetting：轉碼加密設定

說明

HLS標準加密需要先設定轉碼模板的EncryptType為AliyunVoDEncryption後，然後通過SubmitTranscodeJobs - 提交媒體轉碼作業介面發起標準加密轉碼時配置EncryptConfig。

名稱

類型

是否必填

描述

EncryptType

String

是

加密類型，取值：

AliyunVoDEncryption：適用於HLS協議（M3U8格式）的私人加密類型、HLS標準加密類型。
AliyunVoDLicenseEncryption：適用於MP4格式的私人加密類型。

EncryptSetting參數樣本

{
        "EncryptType":"AliyunVoDEncryption"
}

PackageSetting：轉碼打包設定

說明

暫不支援音視頻流抽取後打包。
目前僅支援HLS自適應碼率打包。

名稱	類型	是否必填	描述
PackageType	String	是	打包類型，取值：HLSPackage（HLS自適應碼率打包）。
PackageConfig	PackageConfig	否	打包配置資訊（VideoPackage類型模板必傳該參數）。
SubtitleExtractConfigList	SubtitleExtractConfig[]	否	字幕打包配置資訊（SubtitlePackage類型模板必傳該參數，其他類型模板不傳）。

PackageConfig：視頻打包配置

說明

僅HLS自適應碼流打包需要設定該參數。

名稱

類型

是否必填

描述

BandWidth

String

是

頻寬上限，HLS打包必傳該參數，單位：bps。

僅VideoPackage需要配置該參數。

PackageSetting參數樣本

VideoPackage 類型模板配置：
{
        "PackageType":"HLSPackage",
        "PackageConfig":{
                "BandWidth":"400000"
        }
}

SubtitleExtractConfig：字幕打包配置

名稱	類型	是否必填	描述
SubtitleUrlList	String[]	是	字幕地址，僅支援HTTP的OSS地址，不支援Http CDN地址和HTTPS地址。說明目前僅支援一個HTTP地址。字幕檔案僅支援儲存在點播分配的系統Bucket中。
Language	String	是	語言類型，請參考RFC5646，例如：en-US。
Format	String	是	字幕檔案格式，僅支援vtt格式，例如：subtitle.vtt。
Name	String	是	字幕軌在播放終端顯示的名稱，例如：中文、英文等。

SubtitlePackage參數樣本

SubtitlePackage 類型模板配置：
 {
      "PackageType": "HLSPackage",
      "SubtitleExtractConfigList": [
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d****-eng.vtt"
          ],
          "Language": "en-US",
          "Format": "vtt",
          "Name": "英文"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5****-jpn.vtt"
          ],
          "Language": "ja",
          "Format": "vtt",
          "Name": "日文"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8****-cn.vtt"
          ],
          "Language": "cn",
          "Format": "vtt",
          "Name": "中文"
        }
      ]
    }

SubtitleConfig：字幕配置

名稱

類型

是否必填

描述

SubtitleUrl

String

是

字幕檔案OSS地址（不支援HTTPS地址、不支援純CDN網域名稱加速地址）。字幕格式支援：srt、ass。

說明

字幕檔案必須和視頻源檔案在同一個地區（例如：cn-shanghai），並且在同一個bucket當中。

CharEncode

String

是

編碼格式。取值：

auto：自動檢測。
UTF-8
GBK
BIG5

預設值為UTF-8。

說明

字幕檔案上傳詳細參見擷取輔助媒資上傳地址和憑證、OSS檔案上傳。

SubtitleConfig參數樣本

{
        "SubtitleUrl": "http://outin-40564284ef058b2d300163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****.ass",
        "CharEncode": "UTF-8"
}

Volume：音量配置

名稱	類型	是否必填	描述
Method	String	否	音量調整方式。取值：auto、dynamic、linear。
IntegratedLoudnessTarget	String	否	目標音量，數字。取值範圍：[-70,-5]。需指定Method為dynamic。預設值為-6。
TruePeak	String	否	最大峰值，數字。取值範圍：[-9,0]。需指定Method為dynamic。預設值為-1。
LoudnessRangeTarget	String	否	音量範圍，數字。取值範圍：[1,20]。需指定Method為dynamic。預設值為8。

Volume參數樣本

{
        "Method":"dynamic",
        "IntegratedLoudnessTarget":"-6",
        "TruePeak":"-1",
        "LoudnessRangeTarget":"8"
}

Container與Audio Codecs組合支援情況

Container	Audio Codecs
mp3	MP3
mp4	AAC
ogg	VORBIS、FLAC
flac	FLAC

Container與Audio Codecs、Video Codecs組合支援情況

Container	Video Codecs	Audio Codecs
flv	H.264	AAC、MP3
mp4	H.264、H.265	AAC、MP3
ts	H.264、H.265	AAC、MP3
m3u8	H.264、H.265	AAC、MP3
gif	GIF	不支援

Video Codecs與不同視頻流配置參數的組合支援情況

Video Codecs	H.264	H.265	GIF
Profile	√	×	×
Bitrate	√	√	×
Crf	√	√	×
Width	√	√	√
Height	√	√	√
Fps	√	√	√
Gop	√	√	×
Preset	√	×	×
ScanMode	√	√	√
Bufsize	√	√	×
Maxrate	√	√	×
PixFmt	√	√	bgr8

TranscodeSummary：轉碼摘要資訊

名稱	類型	描述
VideoId	String	視頻ID。
TranscodeTemplateGroupId	String	轉碼使用的模板組ID。
TranscodeStatus	String	轉碼處理狀態，取值： Processing：處理中。 Partial：部分轉碼完成。 CompleteAllSucc：全部處理完成，且全部轉碼成功。 CompleteAllFail：全部處理完成，且全部轉碼失敗,如果源片有問題，則不會發起任何轉碼作業，整個轉碼任務失敗。 CompletePartialSucc：全部轉碼完成，但僅部分轉碼成功。
TranscodeJobInfoSummaryList	TranscodeJobInfoSummary[]	轉碼作業摘要資訊列表。
CreationTime	String	轉碼任務建立時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ。
CompleteTime	String	轉碼任務完成時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ。

TranscodeJobInfoSummary：轉碼作業資訊摘要

名稱	類型	描述
TranscodeTemplateId	String	使用的轉碼模板ID。
Width	String	轉碼輸出視頻的畫面寬，單位：Px。
Height	String	轉碼輸出視頻的畫面高，單位：Px。
Duration	String	轉碼輸出視頻時間長度，單位：秒。
Filesize	String	轉碼輸出視頻的檔案大小，單位：Byte。
Bitrate	String	轉碼輸出視頻的平均碼率，單位：kbps。
Fps	String	轉碼輸出視頻的幀率，單位：N幀/秒。
Format	String	轉碼輸出視頻的封裝格式。
WatermarkIdList	String[]	轉碼使用的浮水印列表。
TranscodeProgress	Long	轉碼進度，取值範圍：[0,100]。
TranscodeJobStatus	String	轉碼作業狀態，取值： Transcoding：轉碼中。 TranscodeSuccess：轉碼成功。 TranscodeFail：轉碼失敗。
CreationTime	String	轉碼作業建立時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ
CompleteTime	String	轉碼作業完成時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ。
ErrorCode	String	轉碼失敗的錯誤碼。
ErrorMessage	String	轉碼失敗的錯誤資訊。

TranscodeTask：轉碼任務資訊

名稱	類型	描述
TranscodeTaskId	String	轉碼任務ID。
TranscodeTemplateGroupId	String	轉碼使用的模板組ID。
VideoId	String	視頻ID。
TaskStatus	String	轉碼任務狀態，取值： Processing：處理中。 Partial：部分轉碼完成。 CompleteAllSucc：全部處理完成，且全部轉碼成功。 CompleteAllFail：全部處理完成，且全部轉碼失敗,如果源片有問題，則不會發起任何轉碼作業，整個轉碼任務失敗。 CompletePartialSucc：全部轉碼完成，但僅部分轉碼成功。
CreationTime	String	轉碼任務建立時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ。
CompleteTime	String	轉碼任務完成時間，UTC時間：yyyy-MM-ddTHH:mm:ssZ。
Trigger	String	觸發類型，取值： Auto：上傳視頻，自動觸發。 Manual：調用SubmitTranscodeJobs介面觸發。
TranscodeJobInfoList	TranscodeJobInfo	轉碼作業資訊。

TranscodeJobInfo：轉碼作業資訊

名稱	類型	描述
TranscodeTaskId	String	轉碼任務ID。
TranscodeJobId	String	轉碼作業ID
VideoId	String	視頻ID。
TranscodeProgress	Long	轉碼作業處理進度。取值範圍：[0,100]。
TranscodeJobStatus	String	轉碼作業狀態，取值： Transcoding：轉碼中。 TranscodeSuccess：轉碼成功。 TranscodeFail：轉碼失敗。
Priority	String	轉碼任務優先順序。
Definition	String	清晰度。說明該值為轉碼模板配置的清晰度標記，不表示轉碼輸出檔案實際的解析度範圍。
TranscodeTemplateId	String	轉碼使用的轉碼模板ID。
CreationTime	String	轉碼作業建立時間。
CompleteTime	String	轉碼作業完成時間。
InputFileUrl	String	轉碼源檔案的OSS地址。
OutputFile	OutputFile	轉碼輸出檔案的資訊。
ErrorCode	String	轉碼失敗錯誤碼。
ErrorMessage	String	轉碼失敗錯誤資訊。

OutputFile：轉碼輸出檔案

名稱	類型	描述
OutputFileUrl	String	轉碼輸出檔案的OSS地址。
Format	String	轉碼輸出檔案的封裝格式。
Width	String	轉碼輸出檔案視頻畫面寬，單位：Px。
Height	String	轉碼輸出檔案視頻畫面高，單位：Px。
Duration	String	轉碼輸出檔案時間長度，單位：秒。
Bitrate	String	轉碼輸出檔案平均碼率，單位：kbps。
Fps	String	轉碼輸出檔案的幀率，單位：N幀/秒。
Filesize	Long	轉碼輸出檔案大小，單位：Byte。
EncryptType	String	轉碼輸出檔案使用的加密類型（JSON串）。
WatermarkIdList	String	轉碼輸出檔案使用的浮水印ID列表。
VideoStreamList	String	視頻流列表。更多資訊，請參見VideoStream：視頻流資訊。
AudioStreamList	String	音頻流列表。更多資訊，請參見AudioStream：音頻流資訊。

資料統計

TopPlayVideoStatis：視頻播放每日TOP統計資料

名稱	類型	描述
VideoId	String	視頻ID。
PlayDuration	String	播放時間長度，單位：毫秒。
Title	String	視頻名稱。
VV	String	播放次數。
UV	String	播放使用者數。

VideoPlayStatisDetail：指定視頻每日統計資料

名稱	類型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
PlayDuration	String	播放時間長度，單位：毫秒。
Title	String	視頻名稱。
VV	String	播放次數。
UV	String	播放使用者數。
PlayRange	String	播放時間長度分布。

UserPlayStatisTotals：使用者播放總量每日統計資料

名稱	類型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
PlayDuration	String	播放總時間長度，單位：毫秒。
PlayRange	String	播放時間長度分布。
VV	VV	播放次數總量統計。
UV	UV	播放使用者數總量統計。

UserPlayStatisAvgs：使用者每日平均播放均值統計資料

名稱	類型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
AvgPlayDuration	String	平均播放時間長度，單位：毫秒。
AvgPlayCount	String	平均播放次數。

播放數VV分布

僅支援阿里雲點播播放器SDk的播放資料統計。

名稱	類型	描述
Android	String	Android播放器播放總次數。
iOS	String	IOS播放器播放總次數。
Flash	String	Flash播放器播放總次數。
HTML5	String	Html5播放器播放總次數。

播放數UV分布

僅支援阿里雲點播播放器SDk的播放資料統計。

名稱	類型	描述
Android	String	Android播放器播放總使用者數。
iOS	String	iOS播放器播放總使用者數。
Flash	String	Flash播放器播放總使用者數。
HTML5	String	HTML5播放器播放總使用者數。

事件通知

MessageCallback：事件通知配置

名稱	類型	描述
CallbackType	String	回調方式，取值：HTTP、MNS。
CallbackURL	String	回調方式選擇HTTP時，回調地址。
MnsEndpoint	String	回調方式選擇MNS時，訊息佇列公網Endpoint。
MnsQueueName	String	回調方式選擇MNS時，訊息佇列名稱。
EventTypeList	String	回調事件類型。
AuthSwitch	String	回調方式選擇HTTP時，回調鑒權開關，取值： on：啟用。 off：不啟用。
AuthKey	String	回調方式選擇HTTP時，鑒權Key。

多應用體系

AppInfo：應用資訊

名稱	類型	描述
AppId	String	應用ID。
AppName	String	應用程式名稱。
Description	String	應用描述。
Type	String	應用類型，取值： System：系統預設。 Custom：使用者建立。
Status	String	應用狀態，取值： Normal：正常。 Disable：停用。
CreationTime	String	UTC建立時間。
ModificationTime	String	UTC更新時間。

AppPolicy：應用授權策略資訊

名稱	類型	描述
AppId	String	應用ID。
PolicyType	String	策略類型，取值： System：系統策略。 Custom：使用者自訂。
PolicyName	String	策略名稱稱。
CreationTime	String	UTC建立時間。
Description	String	策略描述。