type
type:String
API 版本:V1,V2
上級:outputs
默認:標準
有效值:standard
,segmented
,captions
,playlist
和transfer-only
兼容的工作類型:所有
例:segmented
描述:
默認情況下,Zencoder將輸出視為標準音頻或視頻文件。當前,有兩種特殊類型的輸出:segmented
和playlist
。
segmented
:細分的典型用例是Apple的Live HTTP Streaming(請參閱分段流)。對於分段輸出,默認格式將更改為ts而不是mp4。captions
:僅API V2
字幕輸出類型會創建一個僅包含源視頻字幕的文件,而不是添加了字幕的視頻。注意:字幕類型輸出可能不是作業的唯一輸出。
字幕可以作為單獨的文件提供給Zencoder(使用caption_url選項),或默認情況下將從源視頻中提取。
支持從源視頻中提取字幕的格式是MP4和TS。在MP4文件中,字幕可能位於單獨的軌道中(CEA-608格式);否則,必須將MP4或TS文件中的字幕嵌入到符合A / 53或SCTE-128(CC1和CC3)標準的MPEG2或AVC視頻流中。
字幕類型輸出支持的輸出格式:'mp4
','scc
','webvtt
','vtt
','m3u8
','dfxp
'。- 播放清單:播放列表輸出類型用於多比特率輸出流中,以生成主M3U8播放列表文件。注意:播放列表類型的輸出可能不是作業的唯一輸出。
transfer-only
:僅API V2
一種transfer-only
輸出會跳過編碼,並將原始視頻發送到url。
一種transfer-only
輸出也可以使用source將視頻從另一個輸出傳輸到指定的url,而不是使用輸入。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"type": "segmented"
}
]
}
也可以看看:source和caption_url
label
label:String
API 版本:V1,V2
上級:outputs
有效值:一串
兼容的工作類型:所有
例:iphone4
描述:
輸出的可選標籤。從API v2開始,在多個輸出上使用時,每個作業的標籤必須唯一(不區分大小寫)。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"label": "iphone4"
}
]
}
也可以看看:source
dynamic_profile_rendition
dynamic_profile_rendition:Integer
API 版本:V2
上級:outputs
兼容的工作類型:所有
描述:
的dynamic_profile_rendition
設置指定此輸出應使用動態生成的CAE概要文件中的設置,尤其是要使用概要文件的哪個格式版本來使用設置。什麼時候dynamic_profile_rendition
設置,則無需指定編碼設置,例如resolution
,bitrate
等(請參閱CAE指南有關由CAE自動設置的設置的完整列表。)
{
"input": "s3://zencodertesting/test.mov",
"generate_dynamic_profile": true,
"dynamic_profile_options":{ "max_renditions": 6 },
"outputs" :[
{"dynamic_profile_rendition": 1},
{"dynamic_profile_rendition": 2},
{"dynamic_profile_rendition": 3},
{"dynamic_profile_rendition": 4},
{"dynamic_profile_rendition": 5},
{"dynamic_profile_rendition": 6}
]
}
也可以看看:source
url
url:String
API 版本:V1,V2
上級:outputs
有效值:有效的S3,雲文件,GCS,FTP,FTPS,SFTP,Aspera,Azure或HTTP地址。
兼容的工作類型:所有
例:
- s3://my-output-bucket/final.mp4
- cf://username:api_key@container/object
- cf+uk://username:api_key@container/object
- gcs://access_key:secret_key@gcs-bucket/object
- ftp://user:password@ftp.example.com/final.mp4
- sftp://user:password@sftp.example.com/final.mp4
- aspera://user:password@host:ssh-port/path/to/file.mp4
描述:
完整的URL,包括文件名,輸出文件將被上傳到該URL。請參閱base_url有關提供商的更多信息。
我們正式支持HTTP上載到S3,GCS,雲文件和Akamai。
關於S3的注意事項:
你必須授予寫在輸出存儲桶上對Zencoder的權限在將作業提交給Zencoder之前。請注意,需要寫入權限的是S3存儲桶,而不是S3“路徑”。例如,位於http://s3.amazonaws.com/my_files/0000/video.mp4
需要將寫訪問權限添加到“ my_files”(存儲桶名稱),而不是“ my_files / 0000”(路徑)。
若要創建包含在URL(?或#)中無效的特殊字符的鍵,必須對它們進行URL編碼(分別為%3F和%23)。所有其他字符不能被 URL 編碼。
您可以通過將URL的協議設置為來提供S3存儲桶的區域s3+region-name
,其中“區域名稱”由這個文件。例如,要從亞太地區(新加坡)區域的存儲桶中訪問文件,請將URL設置為s3+ap-southeast-1://my-bucket/file.mp4
。
關於雲文件的注意事項:
您可以通過將其添加到協議中來指定要使用的區域(DFW,ORD或UK),例如cf+ord://username:api_key@container/object
。當前僅支持的Cloud Files區域是DFW,ORD和UK。默認情況下將使用DFW區域。
容器名稱中的任何特殊字元都必須經過 URL 編碼。
關於Google雲端存儲的注意事項:
GCS訪問密鑰可在以下頁面的“互操作訪問”部分中找到Google API控制台。訪問密鑰必須是正確逃脫。
不支持包含點的GCS存儲桶名稱。
關於Azure的說明:
如果網址包含帶有特殊字符的身份驗證,確保它們已正確逃脫。
關於FTP的注意事項:
如果網址包含帶有特殊字符的身份驗證,確保它們已正確逃脫。
我們嘗試從服務器的根目錄進行寫入,因此請為您的URL使用絕對路徑,以確保我們可以成功寫入服務器。
關於Aspera的注意事項:
URL的ssh-port部分不是必需的,默認為22。
Zencoder在視頻編碼服務器上運行一個Aspera客戶端,該服務器連接到您的Aspera Enterprise或Connect服務器,用於託管文件。
這與運行FTP服務器以使文件可用以及使用FTP客戶端進行文件傳輸的Zencoder相似。
通過HTTPS關於Akamai NetStorage的說明:
Zencoder可以通過FTP或HTTPS將內容上傳到Akamai NetStorage。要通過HTTPS上傳內容,請構造一個輸出網址,例如https://[Host]-nsu.akamaihd.net/[CPCode]/[path]/[file.ext]
。
您可以將您的Akamai NetStorage密鑰名稱和密鑰引用為外部伺服器證書通過設置外部服務器用戶字段到Akamai NetStorage密鑰名和外部服務器密碼 Akamai NetStorage密鑰。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://my-output-bucket/final.mp4"
}
]
}
也可以看看:secondary_url
secondary_url
secondary_url:String
API 版本:V2
上級:outputs
有效值:有效的S3,雲文件,GCS,FTP,FTPS,SFTP,Aspera,Azure或HTTP URL。
兼容的工作類型:所有
例:請參閱URL文檔
描述:
對於VOD職位
完整的URL(包括文件名),如果傳輸到則將輸出文件上傳到該URL url失敗。
也可以看看:url
base_url
base_url:String
API 版本:V1,V2
上級:outputs
有效值:有效的S3,雲文件,GCS,Aspera,FTP,FTPS或SFTP URL,沒有文件名。
兼容的工作類型:所有
例:
- s3://my-output-bucket/
- cf://username:api_key@container/
- gcs://access_key:secret_key@gcs-bucket/
- ftp://user:password@ftp.example.com/path/to
- http://s3.amazonaws.com/my-output-bucket/
- aspera://user:password@host:ssh-port/path/to/
描述:
基本S3,雲文件,GCS,FTP,FTPS或SFTP目錄URL,將在其中上傳轉碼後的文件(不帶文件名)。如果文檔名稱如果未指定,則會生成隨機文件名和適當的擴展名。
關於S3的注意事項:
你必須授予寫在輸出存儲桶上對Zencoder的權限在將作業提交給Zencoder之前。請注意,需要寫入權限的是S3存儲桶,而不是S3“路徑”。例如,位於http://s3.amazonaws.com/my_files/0000/video.mp4
需要將寫訪問權限添加到“ my_files”(存儲桶名稱),而不是“ my_files / 0000”(路徑)。
您可以通過將URL的協議設置為來提供S3存儲桶的區域s3+region-name
,其中“區域名稱”由這個文件。例如,要從亞太地區(新加坡)區域的存儲桶中訪問文件,請將URL設置為s3+ap-southeast-1://my-bucket/
。
關於雲文件的注意事項:
您可以通過將其添加到協議中來指定要使用的區域(DFW,ORD或UK),例如cf+ord://username:api_key@container/object
。當前僅支持的Cloud Files區域是DFW,ORD和UK。默認情況下將使用DFW區域。
容器名稱中的任何特殊字元都必須經過 URL 編碼。
關於Google雲端存儲的注意事項:
GCS訪問密鑰可在以下頁面的“互操作訪問”部分中找到Google API控制台。訪問密鑰必須是正確逃脫。
不支持包含點的GCS存儲桶名稱。
關於Azure的說明:
如果網址包含帶有特殊字符的身份驗證,確保它們已正確逃脫。
關於FTP的注意事項:
如果網址包含帶有特殊字符的身份驗證,確保它們已正確逃脫。
我們嘗試從服務器的根目錄進行寫入,因此請為您的URL使用絕對路徑,以確保我們可以成功寫入服務器。
關於Aspera的注意事項:
URL的ssh-port部分不是必需的,默認為22。
HTTP注意事項:
我們正式支持HTTP上載到S3,GCS,雲文件和Akamai。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"base_url": "s3://my-output-bucket/"
}
]
}
也可以看看:filename
filename
filename:String
API 版本:V1,V2
上級:outputs
有效值:有效的視頻或音頻文件名。
兼容的工作類型:所有
例: final.mp4
描述:
的filename
一個完成的文件。如果您提供filename
但不是base_url
,我們會將具有此文件名的文件臨時存儲在S3存儲桶中,以供您下載。
關於S3的注意事項:
若要創建包含在URL(?或#)中無效的特殊字符的鍵,必須對它們進行URL編碼(分別為%3F和%23)。所有其他字符不能被 URL 編碼。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"filename": "final.mp4"
}
]
}
也可以看看:base_url
package_filename
package_filename:String
API 版本:V1,V2
上級:outputs
有效值:有效的軟件包文件名。
兼容的工作類型:所有
例: final.zip
描述:
打包輸出的文件名。如果擴展名匹配有效package_format,這也將設置package_format的默認值。指定時,此值與base_url生成一個輸出URL,而不是filename。如果filename未指定,默認為package_filename
,但媒體類型具有正確的文件擴展名。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_filename": "final.zip"
}
]
}
package_format
package_format:String
API 版本:V1,V2
上級:outputs
有效值:zip
和tar
兼容的工作類型:所有
例:zip
描述:
創建一個zip
要么tar
包含輸出的所有媒體文件的文件,並上傳此單個程序包而不是所有單個文件。沒有單獨的縮略圖base_url也將包含在軟件包文件內的子目錄中。
如果package_filename如果未指定,則包文件名將基於文檔名稱(但以軟件包格式作為擴展名)。看到package_filename有關URL處理的詳細信息。
注意:當打包文件中包含縮略圖時,打包中的路徑將通過API作為其URL(而不是完整URL)返回。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_format": "zip"
}
]
}
也可以看看:package_filename
device_profile
device_profile:String
API 版本:V1,V2
有效值:mobile/advanced
,mobile/baseline
,mobile/legacy
,v1/mobile/advanced
,v1/mobile/baseline
,v1/mobile/legacy
,v2/mobile/advanced
,v2/mobile/baseline
和v2/mobile/legacy
兼容的工作類型:所有
例:mobile/advanced
描述:
Zencoder的設備配置文件是指向一組特定設備或一組設備的播放功能的選項的快捷方式。設置設備配置文件只會改變API調用中使用的默認值。這意味著您可以完全輕鬆地覆蓋配置文件的各個設置,以非常適合您的特定需求。
版本控制的設備配置文件可用,並在下面列出。指定版本(v1/mobile/baseline
)將確保您始終獲得相同的配置文件,而非版本專用的配置文件(mobile/baseline
)可能會隨著時間的推移而變化,因為會有更好的選擇可用。
配置文件及其默認值:
mobile/advanced
:{"size": "1280x720", "audio_bitrate": 56, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500, "video_reference_frames": 1}
mobile/legacy
:{"size": "320x240", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 768, "video_codec_level": 1.3, "video_reference_frames": 1}
v1/mobile/advanced
:{"size": "1280x720", "audio_bitrate": 128, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
v1/mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500}
v1/mobile/legacy
:{"size": "320x240", "audio_bitrate": 24, "max_audio_sample_rate": 16000, "max_frame_rate": 15, "max_video_bitrate": 192, "video_bitrate": 192, "bitrate_cap": 192, "upscale": true, "aspect_mode": "pad", "format": "3gp", "video_codec": "mpeg4"}
- v2 /移動/高級:
{"size": "1280x720", "audio_bitrate": 56, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
v2/mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500, "video_reference_frames": 1}
v2/mobile/legacy
:{"size": "320x240", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 768, "video_codec_level": 1.3, "video_reference_frames": 1}
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"device_profile": "mobile/advanced"
}
]
}
也可以看看:format
strict
strict:Boolean
API 版本:V1,V2
上級:outputs
默認:false
有效值:true
要么false
兼容的工作類型:所有
例:true
描述:
啟用“strict
”模式。默認情況下,我們將嘗試為您糾正編碼問題。這就是所謂的 ”compatible
”模式。例如,如果您設置的視頻比特率對於我們的編碼器而言過低,我們將自動更正並使用最低的比特率。因此,如果您要求150kbps的比特率,但編碼器不能執行低於200kbps的任何操作,我們將自動為您編碼200kbps的視頻。
如果啟用“strict
”模式,我們將不會更正此類編碼設置。相反,我們將無法完成工作,因為我們無法達到您的目標規格。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"strict": true
}
]
}
skip_video
skip_video:Boolean
API 版本:V1,V2
上級:outputs
默認:false
有效值:true
要么false
兼容的工作類型:所有
例:真正
描述:
通過skip_video
將從輸入中剝離或移除視頻軌道,並且結果文件將僅包含音頻。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_video": true
}
]
}
skip_audio
skip_audio:Boolean
API 版本:V1,V2
上級:outputs
默認:false
有效值:true
要么false
兼容的工作類型:所有
例:真正
描述:
通過skip_audio
將從輸入中刪除或刪除音軌,並且結果文件將僅包含視頻。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_audio": true
}
]
}
source
source:String
API 版本:V2
上級:outputs
兼容的工作類型:所有
例:parent
描述:
引用另一個輸出上的標籤,並使用該輸出創建的視頻(而不是輸入文件)進行處理。
將源代碼與type“僅傳輸”的允許將單個輸出視頻傳輸到第二個url。對於將單個視頻發送到多個目的地很有用。
{
"input": "s3://zencodertesting/test.mov",
"output": [
{
"label": "parent",
"url": "s3://bucket/video.mp4"
},
{
"source": "parent",
"url": "s3://other-bucket/video.mp4",
"type": "transfer-only"
}
]
}
credentials
credentials:String
API 版本:V2
上級:outputs
兼容的工作類型:所有
例:s3_production
描述:
引用的暱稱saved credentials用於轉移。
憑證只能與類型匹配的URL一起使用。例如,與FTP URL配對的S3憑據將被拒絕。
注意:指定的最“精確”憑證優先。例如,在URL中傳遞的憑據將優先於憑據參數,就像憑據參數優先於默認憑據一樣。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://bucket/video.mp4",
"credentials": "s3_production"
}
]
}
generate_md5_checksum
generate_md5_checksum:Boolean
API 版本:V2
默認:false
有效值:true
要么false
兼容的工作類型:所有
描述:
為生成的輸出文件生成MD5校驗和。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"generate_md5_checksum": true
}
]
}
parallel_upload_limit
parallel_upload_limit:Integer
API 版本:V1,V2
默認:S3為30,其他所有目的地為10。
有效值:介於 1 到 30 之間的整數
兼容的工作類型:伏特
例:5
描述:
上載分段輸出(主要是HLS段)時進行的最大同時上載數量。
parallel_upload_limit
必須為單個輸出而不是整個作業設置。
這可能會加快傳輸時間,具體取決於遠程服務器上的帶寬。請注意,更多的連線可能會造成伺服器負載較重。如果您在上傳超時方面遇到問題,或者想防止Zencoder在上傳文件時使用過多帶寬,請將其設置為1。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"parallel_upload_limit": 5,
"url": "s3://my-output-bucket/final.mp4",
"credentials": "s3_production"
},
{
"parallel_upload_limit": 5,
"device_profile": "mobile/advanced",
"url": "s3://my-output-bucket/mobile.mp4",
"credentials": "s3_production"
}
]
}
headers
headers:Hash
API 版本:V1,V2
兼容的工作類型:所有
例:{ "Content-Type": "binary/octet-stream" }
描述:
當我們上傳文件時與文件一起發送的HTTP標頭。當前在使用S3,GCS和雲文件時支持此功能。
Zencoder支持設置以下標頭的有限子集:Cache-Control
,Content-Disposition
,Content-Encoding
,Content-Type
,Expires
,x-amz-acl
,x-amz-storage-class
,x-amz-server-side-encryption
,x-amz-meta-*
,x-goog-acl和x-goog-meta-*
。
未指定輸出位置時,標題將被忽略。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://my-bucket/file.mp4",
"headers": {
"Content-Type": "binary/octet-stream",
"x-amz-acl": "public-read-write"
}
}
]
}