Paramètres des vignettes

Cette rubrique contient des détails sur les paramètres d'encodage liés aux miniatures vidéo.

miniatures

thumbnails:Array or Hash

Versions de l'API : V2

Parent : sorties

Types de tâches compatibles : VOD

Exemple :

  • "vignettes": [{}]
  • "vignettes": {}

Description :

Pour chaque sortie, vous pouvez demander une ou plusieurs vignettes.

Chaque sortie peut avoir ses propres jeux de miniatures avec une taille unique, base_url et access_control.

Plusieurs ensembles de vignettes peuvent être créés pour une seule sortie en passant plusieurs hachages de vignettes dans un tableau. Si les options de vignette sont passées dans un tableau, un étiquette doit être défini pour l'ensemble.

Définir S3 contrôle d'accès en utilisant les mêmes options que vous utilisez pour les vidéos de sortie.

Les miniatures sont limitées à 100 par jeu. Si plus de vignettes seraient générées compte tenu des options demandées, un avertissement sera ajouté à la sortie et la création de vignettes s'arrêtera lorsque la limite sera atteinte.

Remarque: Il n'y a pas de travail de vignettes uniquement. Spécifier une sortie avec seulement des vignettes créera également un mp4 pleine longueur facturable avec nos paramètres de transcodage par défaut et téléchargez-le dans un stockage temporaire.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": [
        {
          "label": "premier",
          "number": dix
        },
        {
          "label": "second",
          "interval_in_frames": 5 000
        }
      ]
    }
  ]
}

Voir aussi : label

étiquette

label:String

Versions de l'API : V2

Parent : sorties/ miniatures

Types de tâches compatibles : VOD

Exemple : affiche

Description :

Un nom pour l'ensemble de vignettes. Obligatoire lors de la demande d'ensembles de vignettes dans un tableau.

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

format

format:String

Versions de l'API : V2

Parent : sorties/ miniatures

Par défaut : png

Valeurs valides : png ou jpg

Types de tâches compatibles : VOD

Exemple : jpg

Description :

Format de l'image miniature.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "format": "jpg"
      }
    }
  ]
}

numéro

number:Integer

Versions de l'API : V2

Parent : sorties/ miniatures

Valeurs valides : Un entier positif

Types de tâches compatibles : VOD

Exemple : 3

Description :

Un certain nombre de vignettes à capturer. Zencoder récupérera des miniatures régulièrement espacées sur toute la durée du fichier. Donc, si vous demandez 1 vignette, ce sera vers le milieu du fichier. La spécification de 3 miniatures sur une vidéo de 8 minutes se traduira par des miniatures à environ 2, 4 et 6 minutes.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "number": 3
      }
    }
  ]
}

start_at_first_frame

start_at_first_frame:Boolean

Versions de l'API : V2

Parent : sorties/ miniatures

Valeur par défaut : false

Valeurs valides : vrai ou faux

Types de tâches compatibles : VOD

Exemple : vrai

Description :

Lors de l'utilisation du nombre option pour la génération de vignettes, cela commencera à prendre des vignettes avec la première image.

Par exemple, lorsque vous utilisez si votre vidéo dure 5 secondes et que vous demandez 5 miniatures à l'aide de nombre option, cela créera des miniatures à 0s, 1s, 2s, 3s et 4s. Normalement, il saisirait les vignettes à 0,83 s, 1,66 s, 2,49 s, 3,32 s et 4,15 s.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "number": 5,
        "start_at_first_frame": vrai
      }
    }
  ]
}

intervalle

interval:Float

Versions de l'API : V2

Parent : sorties/ miniatures

Types de tâches compatibles : VOD

Exemple : 60

Description :

Prenez des vignettes à un intervalle pair, en secondes. Zencoder renverra une vignette toutes les N secondes du fichier. Donc, si vous choisissez un intervalle de 60 et que votre fichier d'entrée dure 12 minutes, vous obtiendrez 12 miniatures, chacune à la minute.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "intervalle": 60
      }
    }
  ]
}

Voir aussi : interval_in_frames

interval_in_frames

interval_in_frames:Float

Versions de l'API : V2

Parent : sorties/ miniatures

Types de tâches compatibles : VOD

Exemple : 120

Description :

Prenez des vignettes à un intervalle pair, en images. Zencoder renverra une vignette pour toutes les N images du fichier. Donc, si vous choisissez un intervalle de 120 et que votre fichier d'entrée est de 29,97 images par seconde, vous obtiendrez des miniatures toutes les 4 secondes environ.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "interval_in_frames": 120
      }
    }
  ]
}

Voir aussi : intervalle

temps

times:Array

Versions de l'API : V2

Parent : sorties/ miniatures

Types de tâches compatibles : VOD

Exemple : [0, 30, 60, 90]

Description :

Tableau de temps, en secondes, auquel saisir une vignette. Les décimales sont valides. Ainsi, régler les heures sur [12,5, 25] saisirait deux vignettes, une à 12,5 secondes et une à 25 secondes. Cette valeur doit être un tableau de nombres non négatifs.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "fois": [0, 30, 60, 90]
      }
    }
  ]
}

aspect_mode

aspect_mode:String

Versions de l'API : V2

Parent : sorties/ miniatures

Par défaut : Conserver

Valeurs valides : conserver, étirer, rogner ou tampon

Types de tâches compatibles : VOD

Exemple : pad

Description :

Le mode d'aspect à utiliser lors de la création de vignettes.

  • préserver: Par défaut, Zencoder conservera le rapport hauteur / largeur du fichier vidéo de sortie, donc si vous soumettez un contenu grand écran et demandez une résolution standard, le fichier miniature conservera le rapport hauteur / largeur grand écran et s'adaptera à la taille demandée.
  • étirement: Lorsque le mode aspect est « étiré », la vignette correspond exactement à la largeur et à la hauteur demandées, même si elle déforme l'image.
  • culture: Cette option indique à Zencoder de "zoomer" sur la vignette pour qu'elle corresponde à la taille demandée, en recadrant les pixels de haut / bas ou de gauche / droite.
  • pad: L'option pad indique à Zencoder de boîte aux lettres la vignette correspondant à la taille d'image demandée. Utilisez cette option pour conserver le rapport hauteur / largeur de la vidéo de sortie, mais obtenez toujours des miniatures de la même taille.

Remarque : En raison des contraintes des algorithmes de mise à l'échelle vidéo, les dimensions des vignettes seront un nombre pair. Si vous demandez des miniatures de 100x75, par exemple, vous obtiendrez des miniatures de 100x74.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "aspect_mode": "pad",
        "width": 200,
        "height": 200
      }
    }
  ]
}

Voir également: Taille , largeur , et la taille

Taille

size:String

Versions de l'API : V2

Parent : sorties/ miniatures

Types de tâches compatibles : VOD

Exemple : 400 x 300

Description :

Une résolution cible pour les vignettes, comme "160 × 120". Si aucune taille n'est fournie, les miniatures auront la même taille que la vidéo de sortie. Par défaut, nous conserverons le rapport hauteur / largeur, donc si le rapport hauteur / largeur de ce paramètre de taille ne correspond pas au rapport hauteur / largeur du film, le fichier résultant peut ne pas correspondre exactement à cette taille. Si Stretch est défini sur true pour le fichier de sortie correspondant, cette vignette sera également étirée pour remplir la résolution.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "Taille": "400 x 300"
      }
    }
  ]
}

Voir également: largeur , la taille , et aspect_mode

largeur

width:Integer

Versions de l'API : V2

Parent : sorties/ miniatures

Valeurs valides : Un entier positif

Types de tâches compatibles : VOD

Exemple : 640

Description :

Largeur de la vignette. Si aucune largeur n'est fournie, nous utiliserons la largeur du fichier de sortie ou l'échelle à Taille ou la taille réglage.

Notez que Taille a priorité sur soit largeur et la taille.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "width": 640
      }
    }
  ]
}

Voir également: Taille , la taille , et aspect_mode

hauteur

height:Integer

Versions de l'API : V2

Parent : sorties/ miniatures

Valeurs valides : Un entier positif

Types de tâches compatibles : VOD

Exemple : 480

Description :

Hauteur de la vignette. Si aucune hauteur n'est fournie, nous utiliserons la hauteur du fichier de sortie ou l'échelle à Taille ou largeur réglage.

Notez que Taille a priorité sur soit largeur et la taille.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "height": 480
      }
    }
  ]
}

Voir également: Taille , largeur , et aspect_mode

base_url

base_url:String

Versions de l'API : V2

Parent : sorties/ miniatures

Valeurs valides : Une URL S3, Cloud Files, GCS, FTP, FTPS ou SFTP valide, moins le nom de fichier. Format : s3 ://[nom du compartiment]/[chemin] ou ftp://[user]:[password]@[ftp.url]/[path]

Types de tâches compatibles : VOD

Exemple :

  • s3 : //mon-seau de sortie/
  • cf : //nom d'utilisateur:api_key @container /path/
  • ftp://user:password@ftp.example.com/path/to

Description :

Une destination de sortie pour les miniatures. Si base_url est vide, nous stockerons les miniatures dans notre compartiment Zencoder S3. Les fichiers stockés dans le compartiment Zencoder S3 seront disponibles après 24 heures. Notez que les noms de fichiers ne sont pas uniques entre les sorties (par exemple frame_0000.png), donc la destination doit être un répertoire ou un préfixe de clé unique pour éviter d'écraser les fichiers.

Utilisateurs FTP : nous essayons d'écrire à partir de la racine de votre serveur. Par conséquent, utilisez un chemin absolu pour votre URL pour vous assurer que nous pouvons écrire sur votre serveur avec succès.

Remarques sur les informations d'identification :

Si vous fournissez des informations d'identification via base_url, elles seront présentes dans les URL apparaissant dans les requêtes relatives aux détails de la tâche, aux détails de sortie, etc. Si identifiants sont stockés avec Zencoder, ils n'apparaîtront pas dans les URL de ces réponses.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "base_url": "s3: // mon-compartiment-de-sortie /"
      }
    }
  ]
}

Voir aussi : préfixe et nom de fichier

préfixe

prefix:String

Versions de l'API : V2

Parent : sorties/ miniatures

Par défaut : frame

Types de tâches compatibles : VOD

Exemple :

  • les pouces
  • vignettes vidéo

Description :

Les fichiers miniatures seront exportés avec des noms de fichiers séquentiels. Cependant, vous pouvez spécifier un préfixe personnalisé pour les fichiers de vignettes. Si aucun préfixe n'est spécifié, nous utiliserons frame. Par exemple, si vous utilisez le préfixe 'custom', les fichiers exportés seront nommés custom_0000.png, custom_0001.png, etc. Sans un préfixe personnalisé, ils seraient nommés frame_0000.png, frame_0001.png, etc.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "prefix": "thumbs"
      }
    }
  ]
}

Voir aussi : base_url et filename

nom de fichier

filename:String

Versions de l'API : V2

Parent : sorties/ miniatures

Par défaut : frame

Types de tâches compatibles : VOD

Exemple :

  • miniature _ {{number}}
  • {{number}} _ {{width}} x {{height}} - miniature

Description :

Les fichiers miniatures peuvent recevoir un nom de fichier basé sur plusieurs attributs. Les attributs incluent le nombre, le nombre rempli, la largeur, la hauteur et la taille. Il n'est pas nécessaire d'ajouter une extension de fichier, car Zencoder l'ajoutera en fonction de l'option « format ».

number ou padded-number doit être utilisé, tous les autres sont facultatifs. padded-number utilise 4 points (0000, 0001, etc.).

la hauteur, la largeur et la taille seront basées sur la taille réelle de la vignette générée.

Exemple: _x-miniature

Les caractères valides incluent les lettres, les chiffres, les tirets, les traits de soulignement et les valeurs interpolées.

Remarque: Si vous spécifiez un nom de fichier, tout préfixe sera ignoré.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "filename": "_x-miniature"
      }
    }
  ]
}

Voir aussi : base_url et préfixe

public

public:Boolean

Versions de l'API : V2

Parent : sorties/ miniatures

Valeur par défaut : false

Valeurs valides : vrai ou faux

Types de tâches compatibles : VOD

Description :

Le même que Publique pour les fichiers de sortie. Voir Publique pour une documentation complète de cette option.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "number": dix,
        "public": vrai
      }
    }
  ]
}

Voir aussi : access_control

access_control

access_control:Array

Versions de l'API : V2

Parent : sorties/ miniatures

Valeurs valides : Un tableau de hachages contenant deux paramètres : le bénéficiaire et l'autorisation.

Types de tâches compatibles : VOD

Description :

Le même que contrôle d'accès pour les fichiers de sortie. Voir contrôle d'accès pour une documentation complète de cette option.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "access_control": [
          {
            "permission": "LIS",
            "bénéficiaire": "quelqu'un@exemple.com"
          }
        ]
      }
    }
  ]
}

Voir également: Publique , bénéficiaire , et autorisation

bénéficiaire

grantee:String

Versions de l'API : V2

Parent : sorties/ miniatures/ access_control

Valeurs valides : Un bénéficiaire S3 valide (e-mail, ID ou URI)

Types de tâches compatibles : VOD

Description :

Le même que bénéficiaire pour les fichiers de sortie. Voir bénéficiaire pour une documentation complète de cette option.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "access_control": [
          {
            "permission": "FULL_CONTROL",
            "grantee": "cdc7931a9574b1055d5b76112021d0e9"
          }
        ]
      }
    }
  ]
}

Voir aussi : access_control et permission

autorisation

permission:String

Versions de l'API : V2

Parent : sorties/ miniatures/ access_control

Valeurs valides : Une chaîne ou un tableau de chaînes contenant : READ, READ_ACP, WRITE_ACP ou FULL_CONTROL

Types de tâches compatibles : VOD

Description :

Le même que autorisation pour les fichiers de sortie. Voir autorisation pour une documentation complète de cette option.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "access_control": [
          {
            "permission": "FULL_CONTROL",
            "grantee": "cdc7931a9574b1055d5b76112021d0e9"
          }
        ]
      }
    }
  ]
}

Voir aussi : access_control and grantee

rss

rrs:Boolean

Versions de l'API : V2

Parent : sorties/ miniatures

Valeur par défaut : false

Valeurs valides : vrai ou faux

Types de tâches compatibles : VOD

Description :

Le même que rrs pour les fichiers de sortie. Voir rrs pour une documentation complète de cette option.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "rrs": vrai
      }
    }
  ]
}

en-têtes

headers:Hash

Versions de l'API : V2

Parents : sorties ou miniatures

Types de tâches compatibles : VOD

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

Description :

En-têtes HTTP à envoyer avec vos vignettes lorsque nous les téléchargeons. Cette fonctionnalité est actuellement prise en charge lors de l'utilisation de S3 et Cloud Files.

Zencoder prend en charge la définition d'un sous-ensemble limité de ces en-têtes : Contrôle du cache, Disposition du contenu, Encodage de contenu, Type de contenu, Expire, x-amz-acl, x-amz-storage-class, cryptage côté serveur x-amz-server-* et x-amz-meta-*.

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

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "headers": {
          "Content-Type": "binaire / octet-stream",
          "x-amz-acl": "public-read-write"
        }
      }
    }
  ]
}

informations d'identification

credentials:String

Versions de l'API : V2

Parent : sorties/ miniatures

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.

REMARQUE : Les informations d'identification pour les services de syndication concernent uniquement les vidéos de sortie.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "thumbnails": {
        "base_url": "ftp://ftp.example.com/thumbnails/",
        "credentials": "ftp_dev_server"
      }
    }
  ]
}

Voir aussi : base_url

parallel_upload_limit

parallel_upload_limit:Integer

Versions de l'API : 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 miniatures.

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": [
    {
      "thumbnails": {
        "base_url": "ftp://ftp.example.com/thumbnails/",
        "parallel_upload_limit": 5
      }
    }
  ]
}