api_key
api_key:String
Versions de l'API : V2
Valeurs valides : Votre clé API Zencoder de https://app.zencoder.com/api
Types de tâches compatibles : VOD
Exemple : bcafecadfecabafedac
Description :
La clé API de votre compte Zencoder. Vous pouvez trouver votre clé API sur https://app.zencoder.com/api. Vous pouvez également régénérer votre clé API sur cette page.
{
"input": "s3://zencodertesting/test.mov",
"api_key": "bcafecadfecabafedac"
}
dynamic_profile_options
dynamic_profile_options:Object
Versions de l'API : V2
Types de tâches compatibles : VOD
Description :
Avec CAE, le nombre de sorties et les paramètres de ces sorties peuvent changer dynamiquement pour chaque fichier d'entrée. Les dynamic_profile_options paramètres définissent la façon dont les rendus doivent être créés. Voir Paramètres CAE pour plus de détails. Vous devez également définir generate_dynamic_profile égal à true pour utiliser cette fonctionnalité.
{
"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
Versions de l'API : V2
Valeurs valides : vrai ou faux
Valeur par défaut : false
Types de tâches compatibles : VOD
Description :
Avec CAE, le nombre de sorties et les paramètres de ces sorties peuvent changer dynamiquement pour chaque fichier d'entrée. Pour spécifier des limites sur le nombre de sorties à générer ainsi que d'autres contraintes de profil, la demande de travail CAE doit également inclure dynamic_profile_options objet. Les sorties réservées à l'utilisation CAE ne doivent pas inclure resolution bitrate, ni les paramètres liés au codec. Au lieu de cela, ils devraient inclure des étiquettes dynamic_profile_rendition. Le nombre de sorties réservées à l'utilisation de CAE doit correspondre au nombre spécifié comme max_renditions dans 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
input:String
Versions de l'API : V2
Valeurs valides : Une URL valide vers un fichier multimédia (HTTP / HTTPS, FTP / FTPS, SFTP, Azure, GCS, CF ou S3), avec ou sans authentification
Types de tâches compatibles : vod
Exemple :
- http://example.com/path/to/input.avi
- ftp://user:pass@example.com/path/to/input.mp3
- s3://my-bucket/video.mp4
- cf : //nom d'utilisateur:api_key @container /video.wmv
- cf+uk : //nom d'utilisateur:api_key @container /video.wmv
- azure : //nom-compte:clé de compte @container /video.wmv
- gcs : //access_key:secret_key @gcs -bucket/video.mov
- aspera : //utilisateur:pass @host:ssh-port/chemin/vers/file.mp4
- s3+eu-central-1 : //my-bucket/video.mp4
Description :
Une URL pour le fichier à transcoder. Si le serveur distant requiert une authentification, vous devez inclure votre nom d'utilisateur et votre mot de passe dans la chaîne d'URL d'entrée.
Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.
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.
Si l'URL S3 a été présignée (contenant les paramètres de requête « Signature », « Expire » et « AWSAccessKeyID »), tous les caractères doivent être encodés par 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 Azure :
Si l'URL contient une authentification avec des caractères spéciaux, assurez-vous qu'ils sont correctement échappés.
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 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.
{
"input": "http://example.com/path/to/input.avi"
}
outputs
outputs:Array or Hash
Versions de l'API : V2
Valeurs valides : Un tableau de hachages ou un seul hachage
Types de tâches compatibles : VOD
Exemple :
- "les sorties": [{}]
- "production": {}
Description :
Notre sortie par défaut est un fichier vidéo unique avec les paramètres suivants :
- Vidéo H.264, audio AAC, format de fichier MP4
- Vidéo : de qualité moyenne
- Audio : stéréo, qualité moyenne (environ 112 kbps), 44100 Hz
Si vous ne spécifiez pas d'emplacement de sortie, le fichier sera temporairement hébergé par Zencoder. Après 24 heures, le fichier ne sera plus disponible.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://my-output-bucket/final-1.mp4"
},
{
"url": "s3://my-output-bucket/final-2.webm"
}
]
}
region
region:String
Versions de l'API : V2
Par défaut : nous
Valeurs valides : États-Unis, Europe, Asie, USA, Australie, États-Unis, Virginie, États-Unis, Californie, eu-Dublin, Asie-Singapour, Asie-Tokyo, Sa-Saopaulo, Australie-Sydney, US-central-gce, eu-west-gce ou asie-est-gce
Types de tâches compatibles : VOD
Exemple : États-Unis - Virginie
Description :
Vous pouvez spécifier une région Amazon AWS à utiliser pour encoder une tâche et nous traiterons la tâche sur les serveurs de la région spécifiée.
Une région continentale peut être spécifiée : les États-Unis, l'Europe, l'Asie, la SA ou l'Australie. Lorsque l'un de ces éléments est utilisé, n'importe quelle région du continent peut être utilisée pour traiter le travail.
Une région plus spécifique peut être utilisée pour cibler une région AWS spécifique : États-Unis, Virginie, États-Unis, Californie, eu-Dublin, Asie-Singapour, Asie-Tokyo, Sa-Saopaulo et Australie-Sydney.
{
"input": "s3://zencodertesting/test.mov",
"region": "us-virginia"
}
test
test:Boolean
Versions de l'API : V2
Valeur par défaut : false
Valeurs valides : vrai ou faux
Types de tâches compatibles : VOD
Description :
Activer le mode test pour un travail ("Mode d'intégration"). En mode d'intégration, tous les fichiers encodés seront raccourcis à 5 secondes et vous ne serez pas facturé pour le travail.
{
"input": "s3://zencodertesting/test.mov",
"test": true
}
private
private:Boolean
Versions de l'API : V2
Valeur par défaut : false
Valeurs valides : vrai ou faux
Types de tâches compatibles : VOD
Description :
Le mode de confidentialité appliquera certains paramètres d'API pour protéger votre contenu contre les vues non autorisées et masquer toute information potentiellement sensible. Zencoder les employés ne verront pas les fichiers privés pour quelque raison que ce soit.
{
"input": "s3://zencodertesting/test.mov",
"private": true
}
download_connections
download_connections:Integer
Versions de l'API : V2
Par défaut : 5
Valeurs valides : Un entier entre 0 et 25
Types de tâches compatibles : vod
Description :
Vous pouvez spécifier le nombre de connexions à utiliser pour télécharger un input fichier. Cela peut accélérer les temps de transfert de téléchargement, 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 de la récupération d'un fichier, définissez ce paramètre sur 1.
{
"input": "s3://zencodertesting/test.mov",
"download_connections": 3
}
pass_through
pass_through:String
Versions de l'API : V2
Valeurs valides : Toute chaîne de 255 caractères maximum.
Types de tâches compatibles : VOD
Exemple : my-custom-pass-through value
Description :
Informations facultatives à stocker à côté de cette tâche.
{
"input": "s3://zencodertesting/test.mov",
"pass_through": "my-custom-pass-through-value"
}
mock
mock:Boolean
Versions de l'API : V2
Valeur par défaut : false
Valeurs valides : vrai ou faux
Types de tâches compatibles : VOD
Description :
Se moque d'une demande de travail, renvoyant la réponse normale sans créer réellement de travail. Les ID de travail et de sortie seront nuls.
{
"input": "s3://zencodertesting/test.mov",
"mock": true
}
grouping
grouping:String
Versions de l'API : V2
Valeurs valides : N'importe quelle chaîne.
Types de tâches compatibles : VOD
Exemple : my-custom-pass-through value
Description :
Vous pouvez passer n'importe quelle chaîne arbitraire ici pour créer un regroupement à des fins de rapport. Cela rassemblera des informations statistiques pour chaque groupement qui peuvent être récupérées via le API de reporting.
Les regroupements de rapports peuvent être utilisés pour suivre l'utilisation par minute de chacun de vos projets, clients ou services.
{
"input": "s3://zencodertesting/test.mov",
"grouping": "my-custom-pass-through-value"
}
aspera_transfer_policy
aspera_transfer_policy:String
Versions de l'API : V2
Par défaut : juste
Valeurs valides : justes ou faibles
Types de tâches compatibles : vod
Description :
Définit comment Zencoder utilisera la bande passante disponible du serveur d'encodage lors du transfert de fichiers depuis votre serveur Aspera.
Juste répartit uniformément la bande passante entre toutes les tâches en cours d'exécution sur le serveur d'encodage.
Faible utilise toute bande passante disponible sur le serveur d'encodage, mais donnera la priorité aux autres travaux. Low est utile si vous craignez de surcharger votre serveur avec trop de trafic.
Remarque : L'option High d'Aspera n'est pas prise en charge dans Zencoder. Par défaut, nous utiliserons autant de bande passante que possible, mais nous ne donnerons pas la priorité à l'accès à la bande passante pour un travail par rapport à tous les autres sur un serveur d'encodage.
{
"input": "s3://zencodertesting/test.mov",
"aspera_transfer_policy": "fair"
}
Voir aussi : transfer_minimum_rate et transfer_maximum_rate
transfer_minimum_rate
transfer_minimum_rate:Number
Versions de l'API : V2
Par défaut : 1 000
Valeurs valides : 1000-249999
Types de tâches compatibles : vod
Description :
Définit un taux de transfert plancher à utiliser lors du transfert de fichiers avec Aspera. Cela ne garantit pas que le taux sera atteint, mais si la bande passante est disponible, le transfert de fichiers ne descendra pas en dessous de cette vitesse.
Cela doit être inférieur à transfer_maximum_rate.
{
"input": "s3://zencodertesting/test.mov",
"transfer_minimum_rate": 2500
}
Voir aussi : transfer_maximum_rate et aspera_transfer_policy
transfer_maximum_rate
transfer_maximum_rate:String
Versions de l'API : V2
Par défaut : 250000
Valeurs valides : 1001-250000
Types de tâches compatibles : vod
Description :
Définit un plafond de taux de transfert à utiliser lors du transfert de fichiers avec Aspera. Cela ne garantit pas que le taux sera atteint, mais si la bande passante est disponible, le transfert de fichiers ne dépassera pas cette vitesse.
Il est recommandé de définir le taux de transfert maximal lors du codage simultané d'un grand nombre de travaux, afin d'éviter de surcharger les serveurs source et de destination de trafic.
Cela doit être supérieur à transfer_minimum_rate.
{
"input": "s3://zencodertesting/test.mov",
"transfer_maximum_rate": 25000
}
Voir aussi : transfer_minimum_rate et aspera_transfer_policy
expected_md5_checksum
expected_md5_checksum:String
Versions de l'API : V2
Types de tâches compatibles : vod
Description :
Somme de contrôle MD5 attendue du fichier d'entrée. Si la somme de contrôle du fichier ne correspond pas à la somme de contrôle fournie, le travail échouera.
{
"input": "s3://zencodertesting/test.mov",
"expected_md5_checksum": "d5ed34b6b49f57a4a5f4be72fc0a2cd4"
}
credentials
credentials:String
Versions de l'API : V2
Types de tâches compatibles : vod
Exemple : ftp_dev_server
Description :
Référence le surnom des informations d'identification enregistrées à utiliser pour le transfert, qui sont gérées dans le Section des informations d'identification du compte.
Cela peut être utilisé pour FTP, SFTP, FTPS, S3, GCS ou CF.
{
"input": "ftp://ftp.example.com/file.mp4",
"credentials": "ftp_dev_server"
}
Voir aussi : input