Référence des champs vidéo

Il s'agit d'une référence aux champs vidéo renvoyés par l'API de lecture.

Champs principaux

Tableau 1 : Champs principaux
Champ Type Défaut Description
id Chaîne aucun L'identifiant de la vidéo
account_id Chaîne aucun L'identifiant du compte
created_at Chaîne date-heure ISO 8601 aucun La date et l'heure à laquelle la vidéo a été ajoutée au compte ; exemple : « 2014-12-09T 06:07:11 .877Z »
cue_points Tableau de Objets cue_point tableau vide Marqueurs pour les demandes d'annonces midroll ou toute autre action à créer via l'API du lecteur
custom_fields Objet Objet vide Carte du nom de champ personnalisé : paires de valeurs ; seuls les champs qui ont des valeurs sont inclus
description Chaîne nul Courte description de la vidéo : 250 caractères codés sur un octet maximum
duration Numéro nul Durée de la vidéo en millisecondes
economics Chaîne AD_SUPPORTED Indique si les demandes d'annonces sont autorisées pour la vidéo. Valeurs : AD_SUPPORTED ou FREE
labels Tableau de cordes nul Tableau de Étiquettes attribué à la vidéo
link lien Objet nul Un lien connexe
long_description Chaîne nul 5000 caractères à un octet maximum
name Chaîne aucun Titre de la vidéo : champ obligatoire (256 caractères codés sur un octet maximum)
poster Chaîne nul URL de l'image de l'affiche
poster_sources Réseau [] Un tableau d'objets correspondant aux affiches de la vidéo. Actuellement, il n'y a qu'une seule affiche, et donc un seul objet. L'objet a une seule propriété src dont la valeur est l'URL de l'image de l'affiche.
published_at Chaîne date-heure ISO 8601 aucun Date et heure de publication de la vidéo ; exemple : « 2014-12-09T 06:07:11 .877Z »
reference_id Chaîne nul Toute valeur unique au sein du compte (150 caractères à un octet maximum)
sources Réseau Tableau vide Tableau de source vidéo Objets
tags Réseau Tableau vide Tableau de balises (chaînes) ajoutées à la vidéo (128 caractères à un octet par balise maximum)
text_tracks Tableau de Objets text_track Tableau vide Données pour les sous-titres WebVTT associés à la vidéo
thumbnail Chaîne nul L'URL de l'image miniature
thumbnail_sources Réseau [] Un tableau d'objets correspondant aux vignettes de la vidéo. Actuellement, il n'y a qu'une seule vignette, et donc un seul objet. L'objet a une seule propriété src dont la valeur est l'URL de l'image miniature.
updated_at Chaîne date-heure ISO 8601 aucun Date et heure de la dernière modification d'une vidéo ;[1-2] exemple : « 2015-01-13T 17:45:21 .977Z »
variants Réseau [] Un tableau d'objets contenant des métadonnées multilingues pour les vidéos

Remarques

  • [1-2] La modification peut avoir été effectuée par un utilisateur ou par le système Video Cloud

Objet source

Tableau 2 : champs de l'objet source
Champ Type Défaut Description
asset_id Chaîne aucun L'identifiant du rendu dans Video Cloud
app_name Chaîne aucun L'adresse RTMP pour les flux RTMP
avg_bitrate Entier aucun Débit binaire moyen pour le rendu
codec Chaîne aucun Le codec vidéo
container Chaîne aucun Le type de conteneur vidéo
duration Entier aucun La durée en millisecondes
key_systems Objet aucun Objet de spécification DRM : si cet objet est défini, son contenu est protégé
size Entier aucun La taille en octets
src Chaîne aucun L'URL source
stream_name Chaîne aucun Le nom du flux pour les flux RTMP
type Chaîne aucun Type MIME vidéo qui définit le protocole de communication utilisé. Valeurs :
  • HLS : application/x-mpegURL
  • HLS : application/vnd.apple.mpegurl
  • TIRET : application/dash+xml
  • MP4 : video/mp4
width Entier aucun Largeur en pixels du rendu

Objet cue_point

Tableau 3 : Champs d'objet de point de repère
Champ Type Défaut Description
id Chaîne aucun L'identifiant du point de repère
name Chaîne nul Nom facultatif du point de repère (128 caractères à un octet maximum)
type Chaîne AD Valeurs : AD ou CODE
time Numéro aucun Heure du point de repère en secondes ; exemple : 10 527
metadata Chaîne nul Chaîne de métadonnées facultative (512 caractères à un octet maximum)
force-stop Booléen false Si la vidéo est arrêtée de force au point de repère
Tableau 4 : liens vers des champs d'objets
Champ Type Défaut Description
text Chaîne nul Afficher le texte du lien
url Chaîne nul URL du lien

Objet text_track

Tableau 5 : Champs de piste de texte
Champ Type Défaut Description
src Chaîne (URL) nul URL où se trouve le fichier .vtt
srclang Code de langue ISO-639-1 nul Langue des sous-titres
label Chaîne nul L'étiquette à utiliser dans le menu du lecteur : elle doit être dans la même langue que les sous-titres
kind Chaîne nul

Comment la piste est censée être utilisée : subtitles captions, descriptions, chapters, metadata

Pour plus de détails sur ces valeurs, consultez le Ajout de sous-titres aux vidéos à l'aide du module multimédia document.
mime_type Cordes nul Le type mime_des légendes[9-1]
default Booléen false Définir ce paramètre sur true en fait le fichier de sous-titres par défaut dans le menu du lecteur

Remarques

  • [9-1] La définition du type MIME est facultative, mais les légendes doivent être codées en UTF-8 et avoir un type MIME « text/vtt »

key_systems Objet

L'objet key_systems contient une liste d'objets, un pour chaque nom de clé DRM. Si cet objet est défini, alors sa source est protégée par le contenu.

Tableau 4 : Objet key_systems
Champ Type Défaut Description
nom de clé Objet nul Nom de l'objet qui spécifie le type de DRM. Les clés valides incluent

:* FairPlay com.apple.fps.1_0
:* PlayReady com.microsoft.playready
:* Widevine : com.widevine.alpha
Utilisations de FairPlay key_request_url et certificate_url
autres utilisent license_url		 Chaîne nul URL de l'emplacement de votre licence ou certificat DRM
 

Exemple 1 :

    "key_systems": {
      "com.apple.fps.1_0": {
        "key_request_url": "https://....",
        "certificate_url": "https://..."
      }
    }

Exemple 2 :

    "key_systems": {
      "com.microsoft.playready": {
        "license_url": "https://..."
      },
      "com.widevine.alpha": {
        "license_url": "https://..."
      }
    },

variant objet

chaque variant contient une version des métadonnées vidéo pour une langue particulière.

Tableau 5 : Variante Object
Champ Type Défaut Description
language Chaîne aucun La langue de la variante sous la forme language-COUNTRY, telle que ja-JA
name Chaîne aucun Le titre traduit
description chaîne aucun La description traduite
long_description chaîne aucun La longue_description traduite
custom_fields objet {} Une carte des paires clé-valeur pour les champs personnalisés

Exemple

{
  "language": "ja-JA",
  "name": "バーゼル：ライン川",
  "description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
  "long_description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
  "custom_fields": {
    "language": "Japanese"
  }
}