タイプ
type:String
API バージョン:V1、V2
親:出力
デフォルト:標準
有効な値:standard
、segmented
、captions
、playlist
、、transfer-only
互換性のあるジョブタイプ:すべて
例:segmented
説明:
デフォルトでは、Zencoder は出力を標準のオーディオファイルまたはビデオファイルと見なします。現在、segmented
出力にはとの 2 つの特殊なタイプがありますplaylist
。
segmented
:セグメンテーションの典型的なユースケースは、Appleのライブ HTTP ストリーミング(セグメント化されたストリーミングを参照)です。セグメント出力の場合、デフォルトのフォーマットは mp4 ではなく ts に変更されます。captions
: APIV2のみ
キャプション出力タイプは、キャプションが追加されたビデオではなく、ソースビデオのキャプションのみを含むファイルを作成します。 注:キャプションタイプの出力は、ジョブの唯一の出力ではない場合があります。
キャプションは、( caption_urlオプションを使用して) 別のファイルとしてZencoder に提供するか、デフォルトでソースビデオから抽出されます。
ソースビデオからキャプションを抽出するためにサポートされている形式は、MP4とTSです。MP4ファイルでは、キャプションは別のトラック(CEA-608形式)に配置される場合があります。それ以外の場合、MP4またはTSファイルのキャプションは、A / 53またはSCTE-128(CC1およびCC3)標準に準拠したMPEG2またはAVCビデオストリームに埋め込む必要があります。
キャプションタイプの出力でサポートされる出力形式:mp4
'',scc
','webvtt
','vtt
',',m3u8
','dfxp
'。- プレイリスト:プレイリスト出力タイプは、マスターM3U8プレイリストファイルを生成するためにマルチビットレート出力ストリームで使用されます。 注:ジョブの出力は、プレイリストタイプの出力だけではない場合があります。
transfer-only
: APIV2のみ
transfer-only
出力はエンコーディングをスキップし、元のビデオを URLに送信します。
transfer-only
出力では、 sourceを使用して、別の出力から指定された URLにビデオを転送することもできます。入力。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"type": "segmented"
}
]
}
参照:sourceと caption_url
ラベル
label:String
API バージョン:V1、V2
親:出力
有効な値:文字列
互換性のあるジョブタイプ:すべて
例:iphone4
説明:
出力用のオプションのラベル。API v2 では、複数の出力で使用する場合、ラベルはジョブごとに一意である必要があります(大文字と小文字は区別されません)。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"label": "iphone4"
}
]
}
参照:source
dynamic_profile_rendition
dynamic_profile_rendition:Integer
API バージョン:V2
親:出力
互換性のあるジョブタイプ:すべて
説明:
dynamic_profile_rendition
この設定では、この Output が動的に生成された 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
親:出力
有効な値:有効な S3、クラウドファイル、GCS、FTP、FTPS、SFTP、アスペラ、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。見てくださいbase_urlプロバイダーの詳細については。
S3、GCS、Cloud Files、AkamaiへのHTTPアップロードを正式にサポートしています。
S3 に関する注意事項:
絶対です許す書きます出力バケットでのZencoderへのアクセス許可 Zencoderにジョブを送信する前。これは S3 バケットであり、書き込み許可を必要とする S3 の「パス」ではないことに注意してください。たとえば、のアセットでは、「my_files/0000」(パス) ではなく、「my_files」(バケット名) http://s3.amazonaws.com/my_files/0000/video.mp4
への書き込みアクセス権を追加する必要があります。
URL で有効でない特殊文字を含むキーを作成するには (?または #) の場合は、URL エンコードする必要があります (それぞれ%3F と%23)。その他の文字はすべて URL エンコードできません。
URL のプロトコルをに設定することで、S3 バケットのリージョンを指定できます。ここでs3+region-name
、このドキュメントでは「region-name」が定義されます。たとえば、アジアパシフィック (シンガポール) リージョンのバケットからファイルにアクセスするには、URL をに設定しますs3+ap-southeast-1://my-bucket/file.mp4
。
クラウドファイルに関する注意事項:
使用するリージョン(DFW、ORD、または英国)は、のようにプロトコルに追加することで指定できますcf+ord://username:api_key@container/object
。現在、サポートされているクラウドファイルリージョンは、分散ファイアウォール、ORD、英国のみです。デフォルトでは、分散分散ファイアウォール領域が使用されます。
コンテナ名に含まれる特殊文字は、URL エンコードする必要があります。
Google クラウドストレージに関する注意事項:
GCS アクセスキーは、 Google API コンソールの「相互運用可能なアクセス」セクションにあります。アクセスキーは適切にエスケープする必要があります。
ドットを含む GCS バケット名はサポートされていません。
Azure に関する注意事項:
URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。
FTP に関する注意事項:
URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。
サーバーのルートから書き込もうとします。そのため、URL の絶対パスを使用して、サーバーに正常に書き込めるようにします。
Aspera に関する注意事項:
URL の ssh-port 部分は必須ではなく、デフォルトで 22 です。
Zencoder はビデオエンコーディングサーバー上で Aspera クライアントを実行し、 Aspera Enterpriseまたはファイルをホストする接続サーバーに接続します。
これは、FTP サーバーを実行してファイルを使用できるようにする場合や、Zencoder が FTP クライアントを使用してファイル転送を行う場合と同様です。
HTTPS 経由の Akamai NetStorage に関する注意事項:
Zencoder は、FTP または HTTPS 経由で Akamai NetStorage にコンテンツをアップロードできます。HTTPS 経由でコンテンツをアップロードするには、のような出力 URL を作成します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:String
API バージョン:V2
親:出力
有効な値:有効な S3、クラウドファイル、GCS、FTP、FTPS、SFTP、アスペラ、Azure、または HTTP URL。
互換性のあるジョブタイプ:すべて
例:URL ドキュメントを参照してください
説明:
VODジョブの場合
に転送する場合に出力ファイルがアップロードされるファイル名を含む完全なURL URL失敗します。
参照:url
base_url
base_url:String
API バージョン:V1、V2
親:出力
有効な値:有効な S3、クラウドファイル、GCS、アスペラ、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(ファイル名なし)。filenameが指定されていない場合は、ランダムなファイル名と適切な拡張子が生成されます。
S3 に関する注意事項:
絶対です許す書きます出力バケットでのZencoderへのアクセス許可 Zencoderにジョブを送信する前。これは S3 バケットであり、書き込み許可を必要とする S3 の「パス」ではないことに注意してください。たとえば、のアセットでは、「my_files/0000」(パス) ではなく、「my_files」(バケット名) http://s3.amazonaws.com/my_files/0000/video.mp4
への書き込みアクセス権を追加する必要があります。
URL のプロトコルをに設定することで、S3 バケットのリージョンを指定できます。ここでs3+region-name
、このドキュメントでは「region-name」が定義されます。たとえば、アジアパシフィック (シンガポール) リージョンのバケットからファイルにアクセスするには、URL をに設定しますs3+ap-southeast-1://my-bucket/
。
クラウドファイルに関する注意事項:
使用するリージョン(DFW、ORD、または英国)は、のようにプロトコルに追加することで指定できますcf+ord://username:api_key@container/object
。現在、サポートされているクラウドファイルリージョンは、分散ファイアウォール、ORD、英国のみです。デフォルトでは、分散分散ファイアウォール領域が使用されます。
コンテナ名に含まれる特殊文字は、URL エンコードする必要があります。
Google クラウドストレージに関する注意事項:
GCS アクセスキーは、 Google API コンソールの「相互運用可能なアクセス」セクションにあります。アクセスキーは適切にエスケープする必要があります。
ドットを含む GCS バケット名はサポートされていません。
Azure に関する注意事項:
URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。
FTP に関する注意事項:
URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。
サーバーのルートから書き込もうとします。そのため、URL の絶対パスを使用して、サーバーに正常に書き込めるようにします。
Aspera に関する注意事項:
URL の ssh-port 部分は必須ではなく、デフォルトで 22 です。
HTTP に関する注意事項:
S3、GCS、クラウドファイル、Akamai への HTTP アップロードを正式にサポートしています。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"base_url": "s3://my-output-bucket/"
}
]
}
参照:ファイル名
filename
filename:String
API バージョン:V1、V2
親:出力
有効な値:有効なビデオまたはオーディオファイル名。
互換性のあるジョブタイプ:すべて
例: 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
親:出力
有効な値:有効なパッケージファイル名。
互換性のあるジョブタイプ:すべて
例: final.zip
説明:
パッケージ化された出力のファイル名。拡張機能が有効な package_format と一致する場合、package_format のデフォルト値も設定されます。指定すると、この値は base_urlと組み合わせて使用され、ファイル名ではなく出力 URL が生成されます。filename を指定しない場合、デフォルトはと同じになりますがpackage_filename
、メディアタイプに適切なファイル拡張子が付けられます。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_filename": "final.zip"
}
]
}
package_format
package_format:String
API バージョン:V1、V2
親:出力
有効な値:zip
とtar
互換性のあるジョブタイプ:すべて
例:zip
説明:
zip
tar
出力のすべてのメディアファイルを含むまたはファイルを作成し、個々のファイルではなく、この単一のパッケージをアップロードします。別個の base_urlのないサムネイルは、パッケージファイル内のサブディレクトリにも含まれます。
package_filenameが指定されていない場合、パッケージファイル名はファイル名に基づいて生成されます (ただし、パッケージ形式は拡張子として)。見るpackage_filename URL処理の詳細については。
注:サムネイルがパッケージファイルに含まれる場合、パッケージ内のパスは完全な URL ではなく、その URL として API を通じて返されます。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_format": "zip"
}
]
}
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"
}
]
}
参照:フォーマット
厳しい
strict:Boolean
API バージョン:V1、V2
親:出力
デフォルト: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
親:出力
デフォルト:false
有効な値:true
またはfalse
互換性のあるジョブタイプ:すべて
例:真
説明:
skip_video
パッシングを行うと、入力からビデオトラックが取り除かれます。結果のファイルには、オーディオのみが含まれます。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_video": true
}
]
}
skip_audio
skip_audio:Boolean
API バージョン:V1、V2
親:出力
デフォルト:false
有効な値:true
またはfalse
互換性のあるジョブタイプ:すべて
例:真
説明:
skip_audio
パスすると、入力からオーディオトラックが取り除かれます。結果のファイルにはビデオのみが含まれます。
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_audio": true
}
]
}
出典
source:String
API バージョン:V2
親:出力
互換性のあるジョブタイプ:すべて
例:parent
説明:
別の出力のラベルを参照し、入力ファイルの代わりにその出力によって作成されたビデオを処理に使用します。
ソースを「転送専用」のタイプと組み合わせて使用すると、1 つの出力ビデオを第 2 の URLに転送できます。1 つのビデオを複数の宛先に送信する場合に便利です。
{
"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:String
API バージョン:V2
親:出力
互換性のあるジョブタイプ:すべて
例:s3_production
説明:
転送に使用する保存された認証情報のニックネームを参照します。
資格情報は、そのタイプに一致するURLでのみ使用できます。たとえば、FTPURLとペアになっているS3認証情報は拒否されます。
注:指定した「正確な」クレデンシャルが優先されます。たとえば、URL で渡された認証情報は、credentials パラメーターがデフォルトの認証情報よりも優先されるのと同様に、credentials パラメーターよりも優先されます。
{
"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 までの整数
互換性のあるジョブの種類: vod
例: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: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"
}
}
]
}