Auftragseinstellungen

api_key

API-Versionen: V2

Gültige Werte: Ihr Zencoder API-Schlüssel von https://app.zencoder.com/api

Kompatible Auftragstypen: VOD

Beispiel: bcafecadfecabafedac

Beschreibung:

Der API-Schlüssel für Ihr Zencoder-Konto. Sie finden Ihren API-Schlüssel unter https://app.zencoder.com/api. Sie können Ihren API-Schlüssel auch auf dieser Seite neu generieren.

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

dynamic_profile_options

API-Versionen: V2

Kompatible Auftragstypen: VOD

Beschreibung:

Mit CAE kann sich die Anzahl der Ausgaben und Parameter dieser Ausgaben für jede Eingabedatei dynamisch ändern. Das dynamic_profile_options Einstellungen definieren, wie Wiedergaben erstellt werden sollen. Sehen CAE-Einstellungen für Details. Sie müssen auch einstellen generate_dynamic_profile gleicht true um diese Funktion zu nutzen.

  {
    "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-Versionen: V2

Gültige Werte: richtig oder falsch

Standardwert: falsch

Kompatible Auftragstypen: VOD

Beschreibung:

Mit CAE kann sich die Anzahl der Ausgaben und Parameter dieser Ausgaben für jede Eingabedatei dynamisch ändern. Um die Anzahl der zu generierenden Ausgaben sowie andere Profileinschränkungen zu begrenzen, muss die CAE-Jobanforderung auch enthalten dynamic_profile_options Objekt. Die für CAE-Verwendung reservierten Ausgaben sollten keine Codec-bezogenen Parameter enthalten resolution. bitrate Stattdessen sollten sie Beschriftungen enthalten dynamic_profile_rendition. Die Anzahl der für die CAE-Verwendung reservierten Ausgänge muss mit der angegebenen Anzahl übereinstimmen max_renditions im 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-Versionen: V2

Gültige Werte: Eine gültige URL zu einer Mediendatei (HTTP / HTTPS, FTP / FTPS, SFTP, Azure, GCS, CF oder S3) mit oder ohne Authentifizierung

Kompatible Auftragstypen: vod

Beispiel:

• http://example.com/path/to/input.avi
• sftp: // user: pass@example.com/path/to/input.mp3
• s3://my-bucket/video.mp4
• cf: // Benutzername: api_key@container/video.wmv
• cf + uk: // Benutzername: api_key@container/video.wmv
• azure: // Kontoname: account-key@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

Beschreibung:

Eine URL für die zu transkodierende Datei. Wenn der Remote-Server eine Authentifizierung erfordert, müssen Sie Ihren Benutzernamen und Ihr Kennwort in die Eingabe-URL-Zeichenfolge aufnehmen.

Wenn die URL eine Authentifizierung mit Sonderzeichen enthält, Stellen Sie sicher, dass sie ordnungsgemäß entkommen sind.

Anmerkungen zu S3:

Du musst gewähren schreiben Berechtigungen für Zencoder für den Ausgabe-Bucket bevor Sie einen Auftrag an Zencoder senden. Bitte beachten Sie, dass der S3-Bucket und nicht der S3-Pfad eine Schreibberechtigung benötigt. Zum Beispiel ein Vermögenswert bei http://s3.amazonaws.com/my_files/0000/video.mp4 Schreibzugriff muss zu "my_files" (dem Bucket-Namen) hinzugefügt werden, nicht zu "my_files / 0000" (dem Pfad).

Um Schlüssel mit Sonderzeichen zu erstellen, die in URLs (? Oder #) nicht gültig sind, müssen Sie diese per URL codieren (% 3F bzw.% 23). Alle anderen Zeichen dürfen nicht URL-codiert sein.

Wenn die S3-URL vorsigniert wurde (mit Abfrageparametern „Signatur“, „Abläuft“ und „awsAccessKeyId“), müssen alle Zeichen URL-codiert sein.

Sie können die Region des S3-Buckets angeben, indem Sie das Protokoll der URL auf festlegen s3+region-name, wobei „Regionenname“ durch dieses Dokument definiert ist. Um beispielsweise aus einem Bucket in der Region Asien-Pazifik (Singapur) auf eine Datei zuzugreifen, setzen Sie die URL auf s3+ap-southeast-1://my-bucket/file.mp4.

Hinweise zu Azure:

Wenn die URL eine Authentifizierung mit Sonderzeichen enthält, Stellen Sie sicher, dass sie ordnungsgemäß entkommen sind.

Hinweise zu Cloud-Dateien:

Sie können die zu verwendende Region (DFW, ORD oder UK) angeben, indem Sie sie dem Protokoll hinzufügen, cf+ord://username:api_key@container/objectz. Derzeit werden nur DFW, ORD und UK als Cloud Files-Regionen unterstützt. Die DFW-Region wird standardmäßig verwendet.

Alle Sonderzeichen im Containernamen müssen URL-codiert sein.

Hinweise zum Google Cloud Storage:

GCS-Zugriffsschlüssel finden Sie im Abschnitt "Interoperabler Zugriff" im Google APIs-Konsole. Zugangsschlüssel müssen sein richtig entkommen.

GCS-Bucket-Namen, die Punkte enthalten, werden nicht unterstützt.

Anmerkungen zu Aspera:

Der ssh-port-Teil der URL ist nicht erforderlich und wird standardmäßig auf 22 gesetzt.

Zencoder betreibt einen Aspera Client auf den Videocodierungsservern, der eine Verbindung zu Ihrem Aspera Enterprise oder Connect Server herstellt, der die Dateien hostet.

Dies ist eine ähnliche Situation wie bei einem FTP-Server, um Ihre Dateien verfügbar zu machen, und bei Zencoder, der einen FTP-Client für die Dateiübertragung verwendet.

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

outputs

API-Versionen: V2

Gültige Werte: Ein Array von Hashes oder ein einzelner Hash

Kompatible Auftragstypen: VOD

Beispiel:

• "Ausgaben": [{}]
• "Ausgabe": {}

Beschreibung:

Unsere Standardausgabe ist eine einzelne Videodatei mit den folgenden Einstellungen:

• H.264 Video, AAC Audio, MP4 Dateiformat
• Video: mittlere Qualität
• Audio: Stereo, mittlere Qualität (ungefähr 112 kbps), 44100 Hz

Wenn Sie keinen Ausgabespeicherort angeben, wird die Datei vorübergehend von Zencoder gehostet. Nach 24 Stunden ist die Datei nicht mehr verfügbar.

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

region

API-Versionen: V2

Standard: uns

Gültige Werte: wir, europa, asien, sa, australien, us-virginia, us-oregon, us-n-kalifornien, eu-dublin, asien-singapur, asien-tokyo, sa-saopaulo, australien-sydney, us-central-gce, EU-West-Gce oder Asien-Ost-Gce

Kompatible Auftragstypen: VOD

Beispiel: us-virginia

Beschreibung:

Sie können eine Amazon AWS-Region angeben, die zum Codieren eines Jobs verwendet werden soll. Der Job wird dann auf Servern in der angegebenen Region verarbeitet.

Eine kontinentweite Region kann angegeben werden: wir, Europa, Asien, Sa oder Australien. Wenn eine davon verwendet wird, kann jede Region innerhalb des Kontinents zur Bearbeitung des Auftrags verwendet werden.

Eine spezifischere Region kann verwendet werden, um auf eine bestimmte AWS-Region abzuzielen: USA-Virginia, USA-Oregon, USA-Kalifornien, EU-Dublin, Asien-Singapur, Asien-Tokio, Sa-Saopaulo und Australien-Sydney.

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

test

API-Versionen: V2

Standard: falsch

Gültige Werte: richtig oder falsch

Kompatible Auftragstypen: VOD

Beschreibung:

Aktivieren Sie den Testmodus für einen Job ("Integrationsmodus"). Im Integrationsmodus werden alle verschlüsselten Dateien auf 5 Sekunden verkürzt, und der Auftrag wird Ihnen nicht in Rechnung gestellt.

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

private

API-Versionen: V2

Standard: falsch

Gültige Werte: richtig oder falsch

Kompatible Auftragstypen: VOD

Beschreibung:

Im Datenschutzmodus werden bestimmte API-Parameter erzwungen, um Ihre Inhalte vor nicht autorisierten Ansichten zu schützen und potenziell vertrauliche Informationen zu verschleiern. Zencoder Mitarbeiter werden aus keinem Grund private Dateien einsehen.

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

download_connections

API-Versionen: V2

Standard: 5

Gültige Werte: Eine ganze Zahl zwischen 0 und 25

Kompatible Auftragstypen: vod

Beschreibung:

Sie können die Anzahl der Verbindungen angeben, die zum Herunterladen einer Verbindung verwendet werden sollen input Datei. Dies kann die Übertragungsübertragungszeiten beschleunigen, abhängig von der Bandbreite auf Ihrem Remote-Server. Beachten Sie, dass mehr Verbindungen den Server stärker belasten können. Wenn Sie Probleme mit Zeitüberschreitungen beim Herunterladen haben oder verhindern möchten, dass Zencoder beim Abrufen einer Datei zu viel Bandbreite verwendet, setzen Sie diese auf 1.

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

pass_through

API-Versionen: V2

Gültige Werte: Beliebige Zeichenfolge mit bis zu 255 Zeichen.

Kompatible Auftragstypen: VOD

Beispiel: Mein-Custom-Pass-Through-Wert

Beschreibung:

Optionale Informationen, die neben diesem Job gespeichert werden sollen.

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

mock

API-Versionen: V2

Standard: falsch

Gültige Werte: richtig oder falsch

Kompatible Auftragstypen: VOD

Beschreibung:

Verspottet eine Jobanforderung und gibt die normale Antwort zurück, ohne tatsächlich einen Job zu erstellen. Job- und Ausgabe-IDs sind null.

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

grouping

API-Versionen: V2

Gültige Werte: Beliebige Zeichenfolge.

Kompatible Auftragstypen: VOD

Beispiel: Mein-Custom-Pass-Through-Wert

Beschreibung:

Sie können hier eine beliebige Zeichenfolge übergeben, um eine Gruppierung für Berichtszwecke zu erstellen. Dadurch werden statistische Informationen für jede Gruppierung gesammelt, die über das abgerufen werden können Berichts-API.

Mithilfe von Berichtsgruppierungen können Sie die Minutenverwendung für jedes Ihrer Projekte, Kunden oder Abteilungen verfolgen.

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

aspera_transfer_policy

API-Versionen: V2

Standard: Messe

Gültige Werte: fair oder niedrig

Kompatible Auftragstypen: vod

Beschreibung:

Legt fest, wie Zencoder die verfügbare Bandbreite des Codierungsservers beim Übertragen von Dateien von Ihrem Aspera-Server verwendet.

Messe teilt die Bandbreite gleichmäßig auf alle auf dem Codierungsserver ausgeführten Jobs auf.

Niedrig Verwendet jede verfügbare Bandbreite auf dem Codierungsserver, räumt jedoch anderen Jobs Vorrang ein. Niedrig ist nützlich, wenn Sie Bedenken haben, Ihren Server mit zu viel Datenverkehr zu überlaufen.

Hinweis: Die Option Hoch in Aspera wird in Zencoder nicht unterstützt. Standardmäßig verwenden wir so viel Bandbreite wie möglich, priorisieren jedoch nicht den Zugriff auf die Bandbreite für einen Job gegenüber allen anderen auf einem Codierungsserver.

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

Siehe auch: transfer_minimum_rate und transfer_maximum_rate

transfer_minimum_rate

API-Versionen: V2

Standard: 1000

Gültige Werte: 1000-249999

Kompatible Auftragstypen: vod

Beschreibung:

Legt eine Übertragungsratenuntergrenze fest, die während der Dateiübertragung mit Aspera verwendet werden soll. Dies garantiert nicht, dass die Rate erreicht wird. Wenn jedoch Bandbreite verfügbar ist, wird die Dateiübertragung diese Geschwindigkeit nicht unterschreiten.

Dies muss kleiner sein als transfer_maximum_rate.

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

Siehe auch: transfer_maximum_rate und aspera_transfer_policy

transfer_maximum_rate

API-Versionen: V2

Standard: 250000

Gültige Werte: 1001-250000

Kompatible Auftragstypen: vod

Beschreibung:

Legt eine Übertragungsratenobergrenze fest, die während der Dateiübertragung mit Aspera verwendet werden soll. Dies garantiert nicht, dass die Rate erreicht wird. Wenn jedoch Bandbreite verfügbar ist, wird die Dateiübertragung diese Geschwindigkeit nicht überschreiten.

Das Festlegen der maximalen Übertragungsrate wird empfohlen, wenn eine große Anzahl von Jobs gleichzeitig codiert wird, um zu vermeiden, dass die Quell- und Zielserver mit Datenverkehr überlastet werden.

Dies muss größer sein als transfer_minimum_rate.

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

Siehe auch: transfer_minimum_rate und aspera_transfer_policy

expected_md5_checksum

API-Versionen: V2

Kompatible Auftragstypen: vod

Beschreibung:

Die erwartete MD5-Prüfsumme der Eingabedatei. Wenn die Prüfsumme der Datei nicht mit der angegebenen Prüfsumme übereinstimmt, schlägt der Job fehl.

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

credentials

API-Versionen: V2

Kompatible Auftragstypen: vod

Beispiel: ftp_dev_server

Beschreibung:

Verweist auf den Spitznamen der gespeicherten Anmeldeinformationen, die für die Übertragung verwendet werden sollen und in der verwaltet werden Abschnitt "Kontoanmeldeinformationen".

Dies kann für FTP, SFTP, FTPS, S3, GCS oder CF verwendet werden.

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

Siehe auch: input