ジョブ設定

このトピックでは、ジョブ全体に関連するエンコーディング設定の詳細について説明します。

api_key

api_key:String

API バージョン:V1、V2

有効な値:https://app.zencoder.com/api から君のZencoder APIキー

互換性のあるジョブタイプ:すべて

例: bcafecadfecabafedac

説明:

Zencoder アカウントの API キー。API キーは https://app.zencoder.com/api で入手できます。そのページで API キーを再生成することもできます。

  {
    "input": "s3://zencodertesting/test.mov",
    "api_key": "bcafecadfecabafedac"
  }

dynamic_profile_options

dynamic_profile_options:Object

API バージョン:V2

互換性のあるジョブタイプ:すべて

説明:

CAEでは、出力の数とパラメータは入力ファイルごとに動的に変化する可能性があります。dynamic_profile_optionsこの設定は、レンディションの作成方法を定義します。詳細については、 CAE設定を参照してください。この機能を使用するには、 generate_dynamic_profile trueをに等しく設定する必要があります。

  {
    "input": "s3://zencodertesting/test.mov",
    "generate_dynamic_profile": true,
    "dynamic_profile_options": {
      "min_renditions": 2,
      "max_renditions": 8
    },
    "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},
      {"dynamic_profile_rendition": 7},
      {"dynamic_profile_rendition": 8}
  ]
  }

generate_dynamic_profile

generate_dynamic_profile:Boolean

API バージョン:V2

有効な値:真または偽

デフォルト値:偽

互換性のあるジョブタイプ:すべて

説明:

CAEでは、出力の数とパラメータは入力ファイルごとに動的に変化する可能性があります。生成される出力数の制限およびその他のプロファイル制約を指定するには、CAE ジョブ要求に dynamic_profile_optionsオブジェクトも含まれていなければなりません。CAE 用に予約されている出力にはresolution、、bitrate、またはコーデック関連のパラメータを含めないでください。代わりに、ラベルを含める必要がありますdynamic_profile_rendition。CAE 用に予約された出力の数は、max_renditionsで指定した数と一致する必要があります。dynamic_profile_options。

  {
    "input": "s3://zencodertesting/test.mov",
    "generate_dynamic_profile": true,
    "dynamic_profile_options": {
      "min_renditions": 2,
      "max_renditions": 8
    },
    "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},
       {"dynamic_profile_rendition": 7},
       {"dynamic_profile_rendition": 8}
    ]
  }

入力

input:String

API バージョン:V1、V2

有効な値:認証の有無にかかわらず、メディアファイルへの有効な URL (HTTP/HTTPS、FTP/FTPS、Azure、GCS、CF または S3)

互換性のあるジョブの種類: vod

例:

http://example.com/path/to/input.avi
s ftp://user:pass@example.com/path/to/input.mp3
s3: //my-bucket/video.mp4
cf: //ユーザー名api_key @container /video.wmv
cf+uk: //ユーザー名:api_key @container /video.wmv
Azure: //アカウント名:アカウントキー @container /video.wmv
gcs: //access_key: secret_key @gcs-bucket/video.mov
aspera: //user: pass @host: ssh-port/path/to/file.mp4
s3+eu-central-1: //my-bucket/video.mp4

説明:

トランスコードするファイルの URL。リモートサーバが認証を必要とする場合は、入力 URL 文字列にユーザ名とパスワードを含める必要があります。

URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。

S3 に関する注意事項:

絶対です許す書きます出力バケットでのZencoderへのアクセス許可 Zencoderにジョブを送信する前。これは S3 バケットであり、書き込み許可を必要とする S3 の「パス」ではないことに注意してください。たとえば、のアセットでは、「my_files/0000」(パス) ではなく、「my_files」(バケット名) http://s3.amazonaws.com/my_files/0000/video.mp4への書き込みアクセス権を追加する必要があります。

URL で有効でない特殊文字を含むキーを作成するには (?または #) の場合は、URL エンコードする必要があります (それぞれ%3F と%23)。その他の文字はすべて URL エンコードできません。

S3 URL が署名済み (「署名」、「有効期限」、および「AWSAccessKeyId」クエリパラメータを含む) の場合は、すべての文字を URL エンコードする必要があります。

URL のプロトコルをに設定することで、S3 バケットのリージョンを指定できます。ここでs3+region-name、このドキュメントでは「region-name」が定義されます。たとえば、アジアパシフィック (シンガポール) リージョンのバケットからファイルにアクセスするには、URL をに設定しますs3+ap-southeast-1://my-bucket/file.mp4。

Azure に関する注意事項:

URL に特殊文字を含む認証が含まれている場合は、正しくエスケープされていることを確認してください。

クラウドファイルに関する注意事項:

使用するリージョン（DFW、ORD、または英国）は、のようにプロトコルに追加することで指定できますcf+ord://username:api_key@container/object。現在、サポートされているクラウドファイルリージョンは、分散ファイアウォール、ORD、英国のみです。デフォルトでは、分散分散ファイアウォール領域が使用されます。

コンテナ名に含まれる特殊文字は、URL エンコードする必要があります。

Google クラウドストレージに関する注意事項:

GCS アクセスキーは、 Google API コンソールの「相互運用可能なアクセス」セクションにあります。アクセスキーは適切にエスケープする必要があります。

ドットを含む GCS バケット名はサポートされていません。

Aspera に関する注意事項:

URL の ssh-port 部分は必須ではなく、デフォルトで 22 です。

Zencoder はビデオエンコーディングサーバー上で Aspera クライアントを実行し、 Aspera Enterpriseまたはファイルをホストする接続サーバーに接続します。

これは、FTP サーバーを実行してファイルを使用できるようにする場合や、Zencoder が FTP クライアントを使用してファイル転送を行う場合と同様です。

  {
    "input": "http://example.com/path/to/input.avi"
  }

出力

outputs:Array or Hash

API バージョン:V1、V2

有効な値:ハッシュの配列または単一のハッシュ

互換性のあるジョブタイプ:すべて

例：

「出力」: [ {} ]
「出力」: {}

説明:

デフォルトの出力は、次の設定を持つ 1 つのビデオファイルです。

H.264 ビデオ、AAC オーディオ、MP4 ファイル形式
ビデオ: 中品質
オーディオ：ステレオ、中品質（約112kbps）、44100 Hz

出力場所を指定しない場合、ファイルは Zencoder によって一時的にホストされます。24 時間が経過すると、ファイルは利用できなくなります。

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url": "s3://my-output-bucket/final-1.mp4"
      },
      {
        "url": "s3://my-output-bucket/final-2.webm"
      }
    ]
  }

領域

region:String

API バージョン:V1、V2

デフォルト:私たち

有効な値：米国、ヨーロッパ、アジア、米国、オーストラリア、米国バージニア州、米国オレゴン、米国-カリフォルニア、EU-ダブリン、アジアシンガポール、アジア東京、SA-saopaulo、オーストラリアシドニー、米国中央GCE、EU-WEST-GCE、またはアジア東-GCE

互換性のあるジョブタイプ:すべて

例:米国バージニア州

説明:

ジョブのエンコードに使用する Amazon AWS リージョンを指定できます。指定したリージョンのサーバーでジョブを処理します。

大陸全体のリージョン (米国、ヨーロッパ、アジア、SA、オーストラリアなど) を指定できます。これらのいずれかを使用すると、大陸内の任意のリージョンを使用してジョブを処理できます。

より具体的なリージョンを使用して、特定の AWS リージョン (米国-バージニア、米国-オレゴン、米国-カリフォルニア州、欧州-ダブリン、アジアシンガポール、アジア東京、SA-Saopaulo、オーストラリア-シドニーなど) をターゲットにすることができます。

  {
    "input": "s3://zencodertesting/test.mov",
    "region": "us-virginia"
  }

テスト

test:Boolean

API バージョン:V1、V2

デフォルト:偽

有効な値:真または偽

互換性のあるジョブタイプ:すべて

説明:

ジョブのテストモード (「統合モード」) を有効にします。統合モードでは、エンコードされたすべてのファイルは 5 秒に短縮され、ジョブに対する課金は発生しません。

  {
    "input": "s3://zencodertesting/test.mov",
    "test": true
  }

非公開

private:Boolean

API バージョン:V1、V2

デフォルト:偽

有効な値:真または偽

互換性のあるジョブタイプ:すべて

説明:

プライバシーモードでは、特定の API パラメータを適用して、不正なビューからコンテンツを保護し、機密情報を難読化することができます。Zencoder の従業員は、何らかの理由でプライベートファイルを表示しません。

  {
    "input": "s3://zencodertesting/test.mov",
    "private": true
  }

download_connections

download_connections:Integer

API バージョン:V1、V2

デフォルト:5

有効な値:0から25までの整数

互換性のあるジョブの種類: vod

説明:

ファイルのダウンロードに使用する接続数を指定できます。inputこれにより、リモートサーバーの帯域幅によっては、ダウンロードの転送時間が短縮されます。接続数が多くなると、サーバーの負荷が重くなる可能性があることに注意してください。ダウンロードのタイムアウトに問題がある場合、または Zencoder がファイルの取得時に帯域幅を使いすぎないようにするには、これを 1 に設定します。

  {
    "input": "s3://zencodertesting/test.mov",
    "download_connections": 3
  }

pass_through

pass_through:String

API バージョン:V1、V2

有効な値:255文字までの任意の文字列。

互換性のあるジョブタイプ:すべて

例: my-custom-pass-through value

説明:

このジョブと一緒に格納するオプションの情報。

  {
    "input": "s3://zencodertesting/test.mov",
    "pass_through": "my-custom-pass-through-value"
  }

モック

mock:Boolean

API バージョン:V1、V2

デフォルト:偽

有効な値:真または偽

互換性のあるジョブタイプ:すべて

説明:

ジョブリクエストをモックし、実際にジョブを作成せずに通常の応答を返します。ジョブ ID と出力 ID は NULL になります。

  {
    "input": "s3://zencodertesting/test.mov",
    "mock": true
  }

グループ化

grouping:String

API バージョン:V1、V2

有効な値:任意の文字列。

互換性のあるジョブタイプ:すべて

例: my-custom-pass-through value

説明:

ここで任意の文字列を渡して、レポート用のグループ化を作成できます。これにより、レポート API を介して取得できる各グループの統計情報が収集されます。

レポートグループを使用すると、プロジェクト、クライアント、または部門ごとに分間の使用量を追跡できます。

  {
    "input": "s3://zencodertesting/test.mov",
    "grouping": "my-custom-pass-through-value"
  }

aspera_transfer_policy

aspera_transfer_policy:String

API バージョン:V1、V2

デフォルト:フェア

有効な値:公平または低

互換性のあるジョブの種類: vod

説明:

Aspera サーバーからファイルを転送するときに、エンコードサーバーの利用可能な帯域幅を Zencoder がどのように使用するかを設定します。

[フェア] は、エンコードサーバー上のすべての実行中のジョブ間で帯域幅を均等に分割します。

Lowは、エンコーディングサーバーで使用可能な帯域幅を使用しますが、他のジョブが優先されます。[低] は、大量のトラフィックでサーバーのオーバーランが懸念される場合に便利です。

注:Aspera の High オプションは Zencoder でサポートされていません。デフォルトでは、可能な限り多くの帯域幅を使用しますが、エンコーディングサーバ上の他のすべてのジョブよりも帯域幅へのアクセスが優先されません。

  {
    "input": "s3://zencodertesting/test.mov",
    "aspera_transfer_policy": "fair"
  }

参照:transfer_minimum_rateとtransfer_maximum_rate

transfer_minimum_rate

transfer_minimum_rate:Number

API バージョン:V1、V2

デフォルト:1000

有効な値:1000-249999

互換性のあるジョブの種類: vod

説明:

Aspera でのファイル転送時に使用する転送レートフロアを設定します。これは、レートに達することを保証するものではありませんが、帯域幅が利用可能な場合、ファイル転送はこの速度を下回ることはありません。

これはより小さくなければなりませんtransfer_maximum_rate。

  {
    "input": "s3://zencodertesting/test.mov",
    "transfer_minimum_rate": 2500
  }

参照:transfer_maximum_rateとaspera_transfer_policy

transfer_maximum_rate

transfer_maximum_rate:String

API バージョン:V1、V2

デフォルト:250000

有効な値:1001-250000

互換性のあるジョブの種類: vod

説明:

Aspera でのファイル転送時に使用する転送速度の上限を設定します。これは、レートに達することを保証するものではありませんが、帯域幅が利用可能な場合、ファイル転送はこの速度を超えません。

大量のジョブを同時にエンコードする場合は、送信元サーバと宛先サーバのトラフィックが過負荷にならないように、最大転送レートを設定することをお勧めします。

これはより大きくなければなりませんtransfer_minimum_rate。

  {
    "input": "s3://zencodertesting/test.mov",
    "transfer_maximum_rate": 25000
  }

参照:transfer_minimum_rateとaspera_transfer_policy

expected_md5_checksum

expected_md5_checksum:String

API バージョン:V2

互換性のあるジョブの種類: vod

説明:

入力ファイルの予想されるMD5チェックサム。ファイルのチェックサムが指定されたチェックサムと一致しない場合、ジョブは失敗します。

  {
    "input": "s3://zencodertesting/test.mov",
    "expected_md5_checksum": "d5ed34b6b49f57a4a5f4be72fc0a2cd4"
  }

資格情報

credentials:String

API バージョン:V2

互換性のあるジョブの種類: vod

例: ftp_dev_server

説明:

転送に使用する、保存された認証情報のニックネームを参照します。これらは、[ アカウント認証情報]セクションで管理されます。

これは、FTP、SFTP、FTPS、S3、GCS、またはCFに使用できます。

  {
    "input": "ftp://ftp.example.com/file.mp4",
    "credentials": "ftp_dev_server"
  }

以下も参照してください。input

ページコンテンツ

ジョブ設定

api_key

dynamic_profile_options

generate_dynamic_profile

入力

出力

領域

テスト

非公開

download_connections

pass_through

モック

グループ化

aspera_transfer_policy

transfer_minimum_rate

transfer_maximum_rate

expected_md5_checksum

資格情報