工作設定

api_key

API 版本：V2

有效值：您的Zencoder API密鑰來自https://app.zencoder.com/api

兼容的工作類型：VOD

例： bcafecadfecabafedac

描述：

您的Zencoder帳戶的API密鑰。您可以在以下位置找到您的API密鑰https://app.zencoder.com/api。您也可以在該頁面上重新生成API密鑰。

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

dynamic_profile_options

API 版本：V2

兼容的工作類型：VOD

描述：

使用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

API 版本：V2

有效值：對或錯

默認值：假

兼容的工作類型：VOD

描述：

使用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

API 版本：V2

有效值：帶有或不帶有身份驗證的媒體文件（HTTP / HTTPS，FTP / FTPS，SFTP，Azure，GCS，CF或S3）的有效URL

兼容的工作類型：伏特

例：

• http://example.com/path/to/input.avi
• sftp：// 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
• 天藍色：// account-name：account-key@container/video.wmv
• gcs：// access_key：secret_key@gcs-bucket/video.mov
• aspera：//用戶：pass @ host：ssh-port / path / to / file.mp4
• s3 + eu-central-1：//my-bucket/video.mp4

描述：

待轉碼文件的URL。如果遠程服務器需要身份驗證，則必須在輸入URL字符串中包括用戶名和密碼。

如果網址包含帶有特殊字符的身份驗證，確保它們已正確逃脫。

關於S3的注意事項：

你必須授予寫在輸出存儲桶上對Zencoder的權限在將作業提交給Zencoder之前。請注意，需要寫入權限的是S3存儲桶，而不是S3“路徑”。例如，位於http://s3.amazonaws.com/my_files/0000/video.mp4需要將寫訪問權限添加到“ my_files”（存儲桶名稱），而不是“ my_files / 0000”（路徑）。

若要創建包含在URL（？或＃）中無效的特殊字符的鍵，必須對它們進行URL編碼（分別為％3F和％23）。所有其他字符不能被 URL 編碼。

如果S3 URL已被預簽名（包含“ Signature”，“ Expires”和“ AWSAccessKeyId”查詢參數），則所有字符都必須經過URL編碼。

您可以通過將URL的協議設置為來提供S3存儲桶的區域s3+region-name，其中“區域名稱”由這個文件。例如，要從亞太地區（新加坡）區域的存儲桶中訪問文件，請將URL設置為s3+ap-southeast-1://my-bucket/file.mp4。

關於Azure的說明：

如果網址包含帶有特殊字符的身份驗證，確保它們已正確逃脫。

關於雲文件的注意事項：

您可以通過將其添加到協議中來指定要使用的區域（DFW，ORD或UK），例如cf+ord://username:api_key@container/object。當前僅支持的Cloud Files區域是DFW，ORD和UK。默認情況下將使用DFW區域。

容器名稱中的任何特殊字元都必須經過 URL 編碼。

關於Google雲端存儲的注意事項：

GCS訪問密鑰可在以下頁面的“互操作訪問”部分中找到Google API控制台。訪問密鑰必須是正確逃脫。

不支持包含點的GCS存儲桶名稱。

關於Aspera的注意事項：

URL的ssh-port部分不是必需的，默認為22。

Zencoder在視頻編碼服務器上運行一個Aspera客戶端，該服務器連接到您的Aspera Enterprise或Connect服務器，用於託管文件。

這與運行FTP服務器以使文件可用以及使用FTP客戶端進行文件傳輸的Zencoder相似。

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

outputs

API 版本：V2

有效值：哈希數組或單個哈希

兼容的工作類型：VOD

例：

• “輸出”：[{}]
• “輸出”：{}

描述：

我們的默認輸出是具有以下設置的單個視頻文件：

• 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

API 版本：V2

默認：我們

有效值：我們，歐洲，亞洲，sa，澳大利亞，美國弗吉尼亞州，美國俄勒岡州，美國北加州，歐盟都柏林，亞洲新加坡，亞洲東京，sa-saopaulo，澳大利亞悉尼，us-central-gce， eu-west-gce或asia-east-gce

兼容的工作類型：VOD

例：弗吉尼亞州

描述：

您可以指定用於對作業進行編碼的Amazon AWS區域，我們將在指定區域中的服務器上處理該作業。

可以指定整個非洲地區：美國，歐洲，亞洲，美國或澳大利亞。當使用其中之一時，可以使用該大陸內的任何區域來處理作業。

可以使用更特定的區域來定位特定的AWS區域：美國弗吉尼亞州，美國俄勒岡州，美國加利福尼亞州，歐盟都柏林，亞洲新加坡，亞洲東京，sa-saopaulo和澳大利亞悉尼。

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

test

API 版本：V2

默認：假

有效值：對或錯

兼容的工作類型：VOD

描述：

為作業啟用測試模式（“集成模式”）。在集成模式下，所有編碼文件都將縮短為5秒，並且無需為這項工作付費。

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

private

API 版本：V2

默認：假

有效值：對或錯

兼容的工作類型：VOD

描述：

隱私模式將強制使用某些API參數，以保護您的內容免遭未經授權的查看並混淆任何潛在的敏感信息。Zencoder員工不會出於任何原因查看私人文件。

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

download_connections

API 版本：V2

默認：5

有效值：0到25之間的整數

兼容的工作類型：伏特

描述：

您可以指定用於下載附件的連接數input文件。這可能會加快下載傳輸時間，具體取決於遠程服務器上的帶寬。請注意，更多的連線可能會造成伺服器負載較重。如果您在下載超時方面遇到麻煩，或者想防止Zencoder在檢索文件時佔用過多帶寬，請將其設置為1。

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

pass_through

API 版本：V2

有效值：最多255個字符的任何字符串。

兼容的工作類型：VOD

例：我的自定義傳遞值

描述：

與該作業一起存儲的可選信息。

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

mock

API 版本：V2

默認：假

有效值：對或錯

兼容的工作類型：VOD

描述：

嘲笑一個工作請求，返回正常響應而沒有實際創建工作。作業和輸出ID將為空。

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

grouping

API 版本：V2

有效值：任何字符串。

兼容的工作類型：VOD

例：我的自定義傳遞值

描述：

您可以在此處傳遞任意字符串以創建用於報告目的的分組。這將收集可通過以下方式檢索到的每個分組的統計信息：報告API。

報告分組可用於跟踪每個項目，客戶或部門的分鐘使用情況。

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

aspera_transfer_policy

API 版本：V2

默認：公平

有效值：中等或低

兼容的工作類型：伏特

描述：

設置從Aspera服務器傳輸文件時Zencoder如何使用編碼服務器的可用帶寬。

公平在編碼服務器上所有正在運行的作業之間平均分配帶寬。

低使用編碼服務器上的任何可用帶寬，但將優先處理其他作業。如果您擔心過多的流量會使服務器超載，則低值很有用。

注意：Zencoder不支持Aspera中的“高”選項。默認情況下，我們將盡可能使用盡可能多的帶寬，但不會優先訪問一個工作的帶寬訪問在編碼服務器上的所有其他工作。

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

也可以看看：transfer_minimum_rate和transfer_maximum_rate

transfer_minimum_rate

API 版本：V2

默認：+1000

有效值：1000-249999

兼容的工作類型：伏特

描述：

設置在使用Aspera進行文件傳輸時使用的傳輸速率下限。這不能保證達到該速率，但是如果帶寬可用，則文件傳輸不會低於該速度。

這必須小於transfer_maximum_rate。

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

也可以看看：transfer_maximum_rate和aspera_transfer_policy

transfer_maximum_rate

API 版本：V2

默認：+250000

有效值：1001-250000

兼容的工作類型：伏特

描述：

設置在使用Aspera進行文件傳輸時使用的傳輸速率上限。這不能保證達到該速率，但是如果帶寬可用，則文件傳輸不會超過該速度。

同時編碼大量作業時，建議設置最大傳輸速率，以避免源服務器和目標服務器的流量過多。

此值必須大於transfer_minimum_rate。

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

也可以看看：transfer_minimum_rate和aspera_transfer_policy

expected_md5_checksum

API 版本：V2

兼容的工作類型：伏特

描述：

輸入文件的預期MD5校驗和。如果文件的校驗和與提供的校驗和不匹配，則作業將失敗。

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

credentials

API 版本：V2

兼容的工作類型：伏特

例： ftp_dev_server

描述：

引用要用於傳輸的已保存憑據的暱稱，該別名在帳戶憑據部分。

可以用於FTP，SFTP，FTPS，S3，GCS或CF。

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

也可以看看：input