Paramètres généraux de sortie

type

Versions de l'API : V1, V2

Parent : outputs

Par défaut : standard

Valeurs valides : standard, segmented, captions playlist, et transfer-only

Types de tâches compatibles : Tous

Exemple : segmented

Description :

Par défaut, Zencoder considérera les sorties comme des fichiers audio ou vidéo standard. Actuellement, il existe deux types spéciaux de sorties : segmented et playlist.

• :segmented Le cas d'utilisation typique de la segmentation est celui de la diffusion HTTP en direct d'Apple (voir Streaming segmenté). Pour les sorties segmentées, le format par défaut sera changé en ts au lieu de mp4.
• :captions API V2 uniquement
  Le type de sortie des sous-titres crée un fichier contenant uniquement les sous-titres de la vidéo source, plutôt qu'une vidéo avec des sous-titres ajoutés. Remarque: les sorties de type sous-titrage peuvent ne pas être les seules sorties d'un travail.
  Les légendes peuvent être fournies à Zencoder dans un fichier séparé (en utilisant le caption_url option), ou sera extrait de la vidéo source par défaut.
  Les formats pris en charge pour l'extraction des sous-titres de la vidéo source sont MP4 et TS. Dans un fichier MP4, les sous-titres peuvent être situés dans une piste distincte (au format CEA-608) ; sinon, les sous-titres d'un fichier MP4 ou TS doivent être intégrés dans un flux vidéo MPEG2 ou AVC, conforme aux normes A/53 ou SCTE-128 (CC1 et CC3).
  Formats de sortie pris en charge pour les sorties de type sous-titrage: 'mp4','scc','webvtt','vtt','m3u8','dfxp».
• playlist: Le type de sortie de la liste de lecture est utilisé dans les flux de sortie multi-débits pour générer le fichier de liste de lecture principal M3U8. Remarque: les sorties de type liste de lecture peuvent ne pas être les seules sorties d'un travail.
• :transfer-only API V2 uniquement
  UNE transfer-only la sortie ignore l'encodage et envoie la vidéo originale à un url.
  UNE transfer-only la sortie peut également utiliser source pour transférer la vidéo d'une autre sortie vers le url , plutôt que d'utiliser l'entrée.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "type": "segmented"
    }
  ]
}

Voir également: source et caption_url

label

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : Un string

Types de tâches compatibles : Tous

Exemple : iphone4

Description :

Une étiquette facultative pour la sortie. Depuis l'API v2, les étiquettes doivent être uniques (insensibles à la casse) par tâche lorsqu'elles sont utilisées sur plusieurs sorties.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "label": "iphone4"
    }
  ]
}

Voir également: source

dynamic_profile_rendition

Versions de l'API : V2

Parent : outputs

Types de tâches compatibles : Tous

Description :

Ce dynamic_profile_rendition paramètre spécifie que cette sortie doit utiliser les paramètres du profil CAE généré dynamiquement, et plus précisément le rendu du profil à partir duquel utiliser les paramètres. Lorsque dynamic_profile_rendition cette option est définie, il n'est pas nécessaire de spécifier des paramètres de codage tels que resolution: bitrate, etc. (Voir le Guide CAE pour la liste complète des paramètres automatiquement définis par 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}
  ]
}

Voir également: source

url

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : Une adresse S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, Azure ou HTTP valide.

Types de tâches compatibles : Tous

Exemple :

• 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

Description :

Une URL complète, y compris un nom de fichier, vers laquelle le fichier de sortie sera téléchargé. S'il te plait regarde base_url pour plus d'informations sur les fournisseurs.

Nous prenons officiellement en charge le téléchargement HTTP vers S3, GCS, Cloud Files et Akamai.

Remarques sur S3 :

Vous devez subvention écrire autorisations à Zencoder sur le compartiment de sortie avant de soumettre un travail à Zencoder. Veuillez noter que c'est le compartiment S3, et non le "chemin" S3 qui nécessite une autorisation d'écriture. Par exemple, un actif à http://s3.amazonaws.com/my_files/0000/video.mp4 a besoin d'un accès en écriture ajouté à "mes_fichiers" (le nom du compartiment), pas à "mes_fichiers / 0000" (le chemin).

Pour créer des clés contenant des caractères spéciaux qui ne sont pas valides dans les URL (? Ou #), vous devez les encoder par URL (% 3F et% 23, respectivement). Tous les autres caractères ne doivent pas être encodés en URL.

Vous pouvez fournir la région du compartiment S3 en définissant le protocole de l'URL sur s3+region-name, où « nom de région » est défini par ce document. Par exemple, pour accéder à un fichier à partir d'un compartiment de la région Asie-Pacifique (Singapour), définissez l'URL sur s3+ap-southeast-1://my-bucket/file.mp4.

Remarques sur les fichiers Cloud :

Vous pouvez spécifier la région à utiliser (DFW, ORD ou UK) en l'ajoutant au protocole, comme cf+ord://username:api_key@container/object. Actuellement, les seules régions Cloud Files prises en charge sont DFW, ORD et UK. La région DFW sera utilisée par défaut.

Tous les caractères spéciaux du nom du conteneur doivent être encodés en URL.

Remarques sur Google Cloud Storage :

Les clés d'accès GCS se trouvent dans la section "Accès interopérable" du Console des API Google. Les clés d'accès doivent être correctement échappé.

Les noms de compartiment GCS qui incluent des points ne sont pas pris en charge.

Remarques sur Azure :

Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.

Remarques sur FTP :

Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.

Nous essayons d'écrire à partir de la racine de votre serveur, utilisez donc un chemin absolu pour votre URL afin de nous assurer que nous pouvons écrire sur votre serveur avec succès.

Remarques sur Aspera :

La partie ssh-port de l'URL n'est pas requise et sera par défaut 22.

Zencoder exécute un client Aspera sur les serveurs de codage vidéo, qui se connecte à votre Aspera Enterprise ou Connect Server, qui héberge les fichiers.

Il s'agit d'une situation similaire à vous exécutant un serveur FTP pour rendre vos fichiers disponibles et Zencoder utilisant un client FTP pour le transfert de fichiers.

Remarques sur Akamai NetStorage via HTTPS :

Zencoder peut télécharger du contenu sur Akamai NetStorage via FTP ou HTTPS. Pour télécharger du contenu via HTTPS, créez une URL de sortie comme https://[Host]-nsu.akamaihd.net/[CPCode]/[path]/[file.ext].

Vous pouvez référencer votre nom de clé et clé Akamai NetStorage comme Serveur externe identifiants en définissant le Utilisateur du serveur externe champ au nom de clé Akamai NetStorage et Mot de passe du serveur externe à la clé Akamai NetStorage.

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

Voir également: secondary_url

secondary_url

Versions de l'API : V2

Parent : outputs

Valeurs valides : Une URL valide S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, Azure ou HTTP.

Types de tâches compatibles : Tous

Exemple : Voir la documentation URL

Description :

Pour les emplois VOD

Une URL complète, y compris un nom de fichier, vers laquelle le fichier de sortie sera téléchargé en cas de transfert vers url échoue.

Voir également: url

base_url

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : Une URL S3, Cloud Files, GCS, Aspera, FTP, FTPS ou SFTP valide, sans nom de fichier.

Types de tâches compatibles : Tous

Exemple :

• 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/

Description :

Une URL de répertoire de base S3, Cloud Files, GCS, FTP, FTPS ou SFTP où le fichier transcodé sera téléchargé, sans nom de fichier. Si nom de fichier n'est pas spécifié, un nom de fichier aléatoire plus une extension appropriée sera généré.

Remarques sur S3 :

Vous devez subvention écrire autorisations à Zencoder sur le compartiment de sortie avant de soumettre un travail à Zencoder. Veuillez noter que c'est le compartiment S3, et non le "chemin" S3 qui nécessite une autorisation d'écriture. Par exemple, un actif à http://s3.amazonaws.com/my_files/0000/video.mp4 a besoin d'un accès en écriture ajouté à "mes_fichiers" (le nom du compartiment), pas à "mes_fichiers / 0000" (le chemin).

Vous pouvez fournir la région du compartiment S3 en définissant le protocole de l'URL sur s3+region-name, où « nom de région » est défini par ce document. Par exemple, pour accéder à un fichier à partir d'un compartiment de la région Asie-Pacifique (Singapour), définissez l'URL sur s3+ap-southeast-1://my-bucket/.

Remarques sur les fichiers Cloud :

Vous pouvez spécifier la région à utiliser (DFW, ORD ou UK) en l'ajoutant au protocole, comme cf+ord://username:api_key@container/object. Actuellement, les seules régions Cloud Files prises en charge sont DFW, ORD et UK. La région DFW sera utilisée par défaut.

Tous les caractères spéciaux du nom du conteneur doivent être encodés en URL.

Remarques sur Google Cloud Storage :

Les clés d'accès GCS se trouvent dans la section "Accès interopérable" du Console des API Google. Les clés d'accès doivent être correctement échappé.

Les noms de compartiment GCS qui incluent des points ne sont pas pris en charge.

Remarques sur Azure :

Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.

Remarques sur FTP :

Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.

Nous essayons d'écrire à partir de la racine de votre serveur, utilisez donc un chemin absolu pour votre URL afin de nous assurer que nous pouvons écrire sur votre serveur avec succès.

Remarques sur Aspera :

La partie ssh-port de l'URL n'est pas requise et sera par défaut 22.

Remarques sur HTTP :

Nous prenons officiellement en charge le téléchargement HTTP vers S3, GCS, Cloud Files et Akamai.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "base_url": "s3://my-output-bucket/"
    }
  ]
}

Voir également: filename

filename

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : Un nom de fichier vidéo ou audio valide.

Types de tâches compatibles : Tous

Exemple : final.mp4

Description :

Le filename fichier terminé. Si vous fournissez un fichier filename mais non un base_url, nous stockerons temporairement le fichier avec ce nom de fichier dans un compartiment S3 pour que vous puissiez le télécharger.

Remarques sur S3 :

Pour créer des clés contenant des caractères spéciaux qui ne sont pas valides dans les URL (? Ou #), vous devez les encoder par URL (% 3F et% 23, respectivement). Tous les autres caractères ne doivent pas être encodés en URL.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "filename": "final.mp4"
    }
  ]
}

Voir également: base_url

package_filename

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : Un nom de fichier de package valide.

Types de tâches compatibles : Tous

Exemple : final.zip

Description :

Nom de fichier d'une sortie empaquetée. Si l'extension correspond à un package_format , cela définira également la valeur par défaut pour package_format. Lorsqu'elle est spécifiée, cette valeur est utilisée en combinaison avec base_url pour générer une URL de sortie, plutôt que filename. Si filename n'est pas spécifié, il sera par défaut le même que package_filename , mais avec l'extension de fichier correcte pour le type de support.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "package_filename": "final.zip"
    }
  ]
}

Voir également: base_url et nom de fichier

package_format

Versions de l'API : V1, V2

Parent : outputs

Valeurs valides : zip et tar

Types de tâches compatibles : Tous

Exemple : zip

Description :

Crée un zip ou tar contenant tous les fichiers multimédias d'une sortie, et télécharge ce package unique plutôt que tous les fichiers individuels. Miniatures sans un base_url seront également inclus dans les sous-répertoires du fichier de package.

Si package_filename non spécifié, le nom de fichier du package sera généré en fonction de nom de fichier (mais avec le format du package comme extension). Voir package_filename pour plus de détails sur la gestion des URL.

Remarque : Lorsque des miniatures sont incluses dans le fichier du package, les chemins dans le package seront renvoyés via l'API en tant qu'URL, plutôt qu'en tant qu'URL complète.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "package_format": "zip"
    }
  ]
}

Voir également: package_filename

device_profile

Versions de l'API : V1, V2

Valeurs valides : mobile/advanced, mobile/baseline, mobile/legacy, v1/mobile/advanced, v1/mobile/baseline, v1/mobile/legacy, v2/mobile/advanced v2/mobile/baseline, et v2/mobile/legacy

Types de tâches compatibles : Tous

Exemple : mobile/advanced

Description :

Les profils de périphérique de Zencoder sont des raccourcis vers un ensemble d'options qui ciblent la capacité de lecture d'un périphérique ou d'un ensemble de périphériques particulier. La définition d'un profil d'appareil ne fera rien de plus que de modifier les valeurs par défaut utilisées dans l'appel d'API. Cela signifie que vous pouvez remplacer complètement les paramètres individuels d'un profil en fonction de vos besoins particuliers très facilement.

Les profils d'appareil versionnés sont disponibles et répertoriés ci-dessous. La spécification d'une version (v1/mobile/baseline) garantit que vous obtiendrez toujours le même profil, tandis que les profils non spécifiques à la version (mobile/baseline) peuvent être modifiés sur à mesure que de meilleures options sont disponibles.

Les profils et leurs valeurs par défaut :

• 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/mobile/avancé : {"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"
    }
  ]
}

Voir également: format

strict

Versions de l'API : V1, V2

Parent : outputs

Par défaut : false

Valeurs valides : true ou false

Types de tâches compatibles : Tous

Exemple : true

Description :

Activez le modestrict« ». Par défaut, nous essaierons de corriger les problèmes d'encodage pour vous. C'est ce qu'on appelle le modecompatible« ». Par exemple, si vous définissez un débit vidéo trop bas pour notre encodeur, nous corrigerons automatiquement et utiliserons le débit binaire le plus bas possible. Donc, si vous demandez un débit de 150 kbps, mais que l'encodeur ne peut rien faire de moins de 200 kbps, nous encoderons automatiquement la vidéo à 200 kbps pour vous.

Si vous activez le modestrict« », nous ne corrigerons pas de tels paramètres d'encodage. Au lieu de cela, nous échouerons le travail, car nous ne pouvons pas atteindre vos spécifications cibles.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "strict": true
    }
  ]
}

skip_video

Versions de l'API : V1, V2

Parent : outputs

Par défaut : false

Valeurs valides : true ou false

Types de tâches compatibles : Tous

Exemple : vrai

Description :

Qui passe skip_video supprimera ou supprimera la piste vidéo de l'entrée et le fichier résultant ne contiendra que de l'audio.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "skip_video": true
    }
  ]
}

skip_audio

Versions de l'API : V1, V2

Parent : outputs

Par défaut : false

Valeurs valides : true ou false

Types de tâches compatibles : Tous

Exemple : vrai

Description :

Qui passe skip_audio supprimera ou supprimera la piste audio de l'entrée et le fichier résultant ne contiendra que de la vidéo.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "skip_audio": true
    }
  ]
}

source

Versions de l'API : V2

Parent : outputs

Types de tâches compatibles : Tous

Exemple : parent

Description :

Fait référence à une étiquette sur une autre sortie et utilise la vidéo créée par cette sortie pour le traitement au lieu du fichier d'entrée.

Utilisation de la source en conjonction avec un type de "transfert uniquement" permet de transférer une seule vidéo de sortie vers une seconde url. Utile pour envoyer une seule vidéo vers plusieurs destinations.

{
  "input": "s3://zencodertesting/test.mov",
  "output": [
    {
      "label": "parent",
      "url": "s3://bucket/video.mp4"
    },
    {
      "source": "parent",
      "url": "s3://other-bucket/video.mp4",
      "type": "transfer-only"
    }
  ]
}

Voir également: étiquette et type

credentials

Versions de l'API : V2

Parent : outputs

Types de tâches compatibles : Tous

Exemple : s3_production

Description :

Fait référence au surnom de saved credentials à utiliser pour le transfert.

Les informations d'identification ne peuvent être utilisées qu'avec des URL correspondant à leur type. Par exemple, les informations d'identification S3 associées à une URL FTP seront rejetées.

Remarque : Les informations d'identification les plus "précises" spécifiées ont priorité. Par exemple, les informations d'identification transmises dans l'URL auront priorité sur le paramètre credentials, tout comme le paramètre credentials est prioritaire sur les informations d'identification par défaut.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "url": "s3://bucket/video.mp4",
      "credentials": "s3_production"
    }
  ]
}

Voir également: url et base_url

generate_md5_checksum

Versions de l'API : V2

Par défaut : false

Valeurs valides : true ou false

Types de tâches compatibles : Tous

Description :

Génère une somme de contrôle MD5 pour le fichier de sortie généré.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "generate_md5_checksum": true
    }
  ]
}

parallel_upload_limit

Versions de l'API : V1, V2

Par défaut : 30 pour S3, 10 pour toutes les autres destinations.

Valeurs valides : Un entier entre 1 et 30

Types de tâches compatibles : vod

Exemple : 5

Description :

Le nombre maximum de téléchargements simultanés effectués lors du téléchargement de sorties en plusieurs parties, principalement des segments HLS.

Cela peut accélérer les temps de transfert, en fonction de la bande passante de votre serveur distant. Sachez que plus de connexions peuvent alourdir la charge du serveur. Si vous rencontrez des problèmes avec les délais de téléchargement ou si vous souhaitez empêcher Zencoder d'utiliser trop de bande passante lors du téléchargement de fichiers, définissez ce paramètre sur 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

Versions de l'API : V1, V2

Parents : sorties ou miniatures

Types de tâches compatibles : Tous

Exemple : { "Content-Type": "binary/octet-stream" }

Description :

En-têtes HTTP à envoyer avec votre fichier lorsque nous le chargeons. Cette fonctionnalité est actuellement prise en charge lors de l'utilisation de S3, GCS et Cloud Files.

Zencoder prend en charge la définition d'un sous-ensemble limité de ces en-têtes : 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 et x-goog-meta-*.

Les en-têtes seront ignorés lorsqu'un emplacement de sortie n'est pas spécifié.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "url": "s3://my-bucket/file.mp4",
      "headers": {
        "Content-Type": "binary/octet-stream",
        "x-amz-acl": "public-read-write"
      }
    }
  ]
}