Référence pour les objets de l'API médias

Product
Video Cloud
S'applique aux utilisateurs
Développeur
Version
Brightcove 5
Modules
API médias
Édition
Tous
Créé par Jessica Nutting.

Cette rubrique se veut une référence pour les objets Vidéo, Sélection, Image, Rendu, CuePoint et LogoOverlay produits par les méthodes de lecture de l’API médias :

Sachez que ces objets de l’API médias sont similaires, mais non identiques aux objets utilisés dans l’API du lecteur Flash. La Référence pour l’API médias comprend également des données de base sur les objets connexes :

Objet Vidéo

L’objet Vidéo est un ensemble de métadonnées et d’informations associé à une vidéo. L’objet Vidéo présente les propriétés suivantes :

Nom de la propriété Débit Lecture seule ? Description
name Chaîne non Titre de la vidéo, limité à 255 caractères. La propriété name est obligatoire lorsque vous créez une vidéo.
id Long oui Référence permettant d’identifier la vidéo de manière unique. Affectée par Vidéo Cloud à la création de la vidéo.
referenceId Chaîne non Référence définie par l’utilisateur permettant d’identifier la vidéo. Limitée à 150 caractères. L’option referenceId peut être utilisée comme « foreign-key » pour identifier la vidéo sur un autre système. Sachez que la méthode find_videos_by_reference_ids ne peut pas gérer une valeur referenceId avec des virgules. Evitez donc les virgules pour cet élément.
accountId Long oui Cette propriété est un chiffre affecté par Video Cloud qui identifie par un code unique le compte auquel la vidéo appartient.
shortDescription Chaîne non Courte description de la vidéo. Limitée à 250 caractères. La propriété shortDescription est obligatoire lorsque vous créez une vidéo.
longDescription Chaîne non Une longue description de la vidéo en 5 000 caractères maximum.
FLVURL Chaîne oui L'URL du fichier vidéo correspondant. La propriété est accessible à l’aide de l’API médias uniquement en présence d’une clé de lecture ou d’écriture spécial. La propriété s’applique que la vidéo soit codée au format FLV (VP6) ou MP4 (H.264). Voir Accès au contenu vidéo à l’aide de l’API médias.
renditions Tableau non Tableau de rendus représentant les diffusions en continu à plusieurs débits disponibles pour la vidéo. La vidéo ne doit pas compter plus de 10 rendus. La propriété est accessible à l’aide de l’API médias uniquement en présence d’une clé de lecture ou d’écriture spécial. Voir Accès au contenu vidéo à l’aide de l’API médias.
videoFullLength Rendu non Rendu unique représentant le fichier vidéo correspondant. La propriété est accessible à l’aide de l’API médias uniquement en présence d’une clé de lecture ou d’écriture spécial. Voir Accès au contenu vidéo à l’aide de l’API médias.
creationDate Date oui Date de création de la vidéo exprimée en millisecondes depuis l'époque UNIX.
publishedDate Date oui Date de la dernière activation de la vidéo exprimée en millisecondes depuis l'époque UNIX.
lastModifiedDate Date oui Date de dernière modification de la vidéo exprimée en millisecondes depuis l'époque UNIX.
itemState Enum non Un ItemStateEnum. L’une des propriétés suivantes : ACTIVE, INACTIVE ou DELETED. Vous pouvez définir cette propriété uniquement sur ACTIVE ou INACTIVE ; vous ne pouvez pas supprimer une vidéo en définissant son itemState sur DELETED.
startDate Date non Date de mise à disposition de la vidéo exprimée en millisecondes depuis l'époque UNIX.
endDate Date non Date de fin de disponibilité de la vidéo exprimée en millisecondes depuis l'époque UNIX.
linkURL Chaîne non URL facultative vers un élément connexe. Limitée à 255 caractères.
linkText Chaîne non Texte affiché pour l'option linkURL. Limité à 255 caractères.
tags List non Ensemble de chaînes représentant les balises associées à la vidéo. Chaque balise est limitée à 128 caractères. Chaque vidéo est limitée à 1 200 balises.
videoStillURL Chaîne oui URL vers la capture d'écran associée à la vidéo. Les captures d’écran font 480 x 360 pixels.
thumbnailURL Chaîne oui URL vers l'imagette associée à la vidéo. Les imagettes font 120 x 90 pixels.
length Long oui Longueur de la vidéo en millisecondes.
customFields Objet non Ensemble de noms et de valeur pour les champs personnalisés définis pour les vidéos dans votre compte. Plus d’informations et d’exemples.
economics Enum non EconomicsEnum. Soit FREE ou AD_SUPPORTED. AD_SUPPORTED indique que les requêtes publicitaires sont actives pour la vidéo.
adKeys Chaîne non Chaîne représentant les couples clé/valeur affectés à la vidéo. Les couples clé/valeur présentent le format clé=valeur et sont séparés par des esperluettes (&). Par exemple :
"adKeys":"category=sports&live=true"
geoRestricted booléen non La valeur « true » indique que la vidéo est soumise au filtre géographique.
geoFilteredCountries List non Liste des codes nationaux à deux lettres au format ISO-3166 correspondant aux pays concernés par le filtre géographique. Les codes de pays doivent être inscrits en minuscules.
geoFilterExclude booléen non Si la valeur est « true », la vidéo est accessible dans tous les pays à l’exception de ceux figurant sur la liste geoFilteredCountries. Si la valeur est « false », la vidéo est accessible uniquement dans les pays de la liste geoFilteredCountries.
cuePoints List non Liste des objets CuePoints associés à la vidéo.
playsTotal Entier oui Nombre d'affichages de la vidéo depuis sa création.
playsTrailingWeek Entier oui Nombre d’affichage de la vidéo au cours des sept derniers jours, à l’exception du jour actuel.

Objet Sélection

L’objet Sélection représente un ensemble de vidéos. L’objet palis présente les propriétés suivantes :

Nom de la propriété Débit Lecture seule ? Description
id Long oui Valeur identifiant la sélection de manière unique. L’identifiant est automatiquement affecté à la création de la sélection.
referenceId Chaîne non Identifiant défini par l’utilisateur et limité à 150 caractères identifiant la sélection de manière unique. Sachez que la méthode find_playlists_by_reference_ids ne peut pas gérer une valeur referenceId avec des virgules. Évitez donc les virgules pour les valeurs referenceId .
accountId Long oui Cette propriété est affectée par Video Cloud et identifie par un code unique le compte auquel la sélection appartient.
name Chaîne non Titre de la sélection, limité à 100 caractères. Cette propriété est obligatoire lorsque vous créez une sélection.
shortDescription Chaîne non Courte description de la sélection. Limitée à 250 caractères.
videoIds List non Liste des identifiants des vidéos intégrées à la sélection.
videos List non Liste des objets vidéos intégrés à la sélection.
playlistType Enum non

Dans le cas d’une sélection manuelle, utilisez la valeur EXPLICIT. Pour une sélection intelligente, indiquez comment organiser la sélection en définissant l’une des valeurs suivantes : OLDEST_TO_NEWEST (par date d'activation)
NEWEST_TO_OLDEST (par date d'activation)
START_DATE_OLDEST_TO_NEWEST
START_DATE_NEWEST_TO_OLDEST ALPHABETICAL (par nom de vidéo)
PLAYS_TOTAL
PLAYS_TRAILING_WEEK

La propriété playlistType est obligatoire lorsque vous créez une sélection.
filterTags List non Liste des balises s’appliquant à la sélection intelligente. Par exemple :

"filterTags":["Sitka","tiques"]
tagInclusionRule Enum non Dans le cas d'une sélection intelligente, définit si la vidéo doit contenir tout ou partie des valeurs contenues dans filterTags. Utilisez AND pour « tout contenir » et OR pour "contenir une ou plusieurs valeurs ». Cela ne concerne pas les méthodes d'API de lecture.
thumbnailURL Chaîne oui URL vers l'imagette associée à la sélection.

Objet Image

L’objet représente les métadonnées d’un fichier image de votre compte. Les images sont associées à des vidéos sous forme d'imagettes, de captures d’écran ou de logos superposés. L’image peut être au format JPEG, GIF ou PNG. Sachez que, lors de la création d’une image, la seule propriété requise est type. Si vous ne chargez pas de fichier, la propriété remoteUrl est également requise. Pour plus d’informations, consultez la rubrique Ajout d’images aux vidéos avec l’API médias et Ajout de logos superposés aux vidéos avec l’API médias.

Nom de la propriété Débit Lecture seule ? Description
id Long oui Valeur identifiant l’image de manière unique. L’identifiant est automatiquement affecté par Video Cloud à la création de l’image.
referenceId Chaîne non Référence définie par l’utilisateur et identifiant l’image.
type ImageTypeEnum non THUMBNAIL, VIDEO_STILL ou LOGO_OVERLAY. Le type est éditable et obligatoire lorsque vous créez une image. Il ne peut pas être modifié par la suite.
remoteUrl Chaîne non URL d'un fichier image distant. Cette propriété est nécessaire si vous ne chargez pas de fichier pour l’image.
displayName Chaîne non Nom de la ressource s’affichant dans le module médias.

Objet de rendu

L'objet de rendu représente l'un des rendus de diffusion en continu multidébits d'une vidéo dotée d'une conteneur MP4 ou FLV (v. Objet de rendu iOS pour des rendus avec un conteneur M2TS). La vidéo ne doit pas compter plus de 10 objets de rendu et objets de rendu iOS. Pour plus d’informations, consultez la rubrique Utilisation de la diffusion en continu à plusieurs débits et Création de vidéos pour la diffusion en continu à plusieurs débits.

Nom de la propriété Débit Lecture seule ? Description
audioOnly booléen non Si true, ce rendu sera uniquement audio et ne comportera donc pas de vidéo. Les rendus uniquement audio peuvent servir lors d'une diffusion en continu sur des connexions à bas débit. Les vidéos pour les applications iOS devraient toujours comprendre un rendu audio 64 kbits/s.
controllerType Enum non Selon votre CDN, l'une des valeurs suivantes :
  • AKAMAI_STREAMING
  • AKAMAI_SECURE_STREAMING
  • AKAMAI_LIVE
  • AKAMAI_HD
  • AKAMAI_HD_LIVE
  • LIMELIGHT_LIVE
  • LIMELIGHT_MEDIAVAULT
Consultez la section Définition de la valeur de controllerType pour plus d'informations.
encodingRate Entier oui Le débit d’encodage du rendu, en bits par seconde.
frameHeight Entier oui Hauteur d’affichage du rendu, en pixels.
frameWidth Entier oui Largeur d’affichage du rendu, en pixels.
id Long non L'ID de la vidéo.
referenceid Chaîne non L'ID de référence de la vidéo.
remoteUrl Chaîne non Requis pour les ressources distantes. Le chemin complet du fichier hébergé sur le serveur distant. Si le fichier est distribué via téléchargement progressif, vous devez inclure le nom du fichier et son extension. Vous pouvez également utiliser une URL qui redirige vers une autre URL qui inclut le nom et l’extension du fichier. Si le fichier est distribué en diffusion Flash, utilisez l’attribut remoteStreamName pour fournir le nom du flux.
remoteStreamName Chaîne non [Facultatif, requis pour la diffusion en continu des ressources distantes uniquement] Nom du flux d’une diffusion en continu au format Flash ajoutée à la propriété remoteUrl.
size Long oui Obligatoire. La taille du fichier de rendu en octets.
uploadTimestampMillis Long non La date/heure de chargement de vidéo sur Video Cloud, en millièmes de seconde depuis l'époque Unix.
url Chaîne oui URL du fichier de rendu.
videoCodec Enum non Obligatoire. Les valeurs acceptées sont SORENSON, ON2 ET H264.
videoContainer Enum non Le format du wrapper qui fournit les métadonnées et qui décrit comment la vidéo et l'audio sont stockés dans le fichier. Les valeurs acceptées sont FLV et MP4 (pour les rendus M2TS, v. Objet de rendu iOS). Consultez la rubrique Conteneurs et codecs vidéo pris en charge pour plus d'informations.
videoDuration Long non Obligatoire. La durée de la ressource vidéo distante en millièmes de seconde.

Définition de la valeur de controllerType

La valeur du champ controllerType dans l'objet de rendu dépend de la méthode de diffusion du contenu et du CDN utilisé. Voici les valeurs possibles de controllerType :

Valeur de controllerType description
AKAMAI_STREAMING CDN Akamai, pas de diffusion en direct, pas de TTL
AKAMAI_SECURE_STREAMING CDN Akamai, pas de diffusion en direct, avec TTL
AKAMAI_LIVE CDN Akamai, avec diffusion en direct, sans DVR
AKAMAI_HD Akamai HD
AKAMAI_HD_LIVE Live DVR (quel que soit le CDN principal de votre compte)
LIMELIGHT_LIVE CDN Limelight, diffusion en direct
LIMELIGHT_MEDIAVAULT CDN Limelight avec option de service Media Vault de Limelight

Objet de rendu iOS

L'objet de rendu iOS représente l'un des rendus de diffusion multidébits d'une vidéo dotée d'un conteneur M2TS. Le flux HLS peut donc être lu sur les périphériques iOS. La vidéo ne doit pas compter plus de 10 objets de rendu et objets de rendu iOS. Pour plus d’informations, consultez la rubrique Utilisation de la diffusion en continu à plusieurs débits et Création de vidéos pour la diffusion en continu à plusieurs débits.

Nom de la propriété Débit Lecture seule ? Description
audioOnly booléen non Si true, ce rendu sera uniquement audio et ne comportera donc pas de vidéo. Les rendus uniquement audio peuvent servir lors d'une diffusion en continu sur des connexions à bas débit. Les vidéos pour les applications iOS devraient toujours comprendre un rendu audio 64 kbits/s.
controllerType Enum non PAR DEFAUT
encodingRate Entier oui Le débit d’encodage du rendu, en bits par seconde.
frameHeight Entier oui Hauteur d’affichage du rendu, en pixels.
frameWidth Entier oui Largeur d’affichage du rendu, en pixels.
id Long non L'ID de la vidéo.
referenceid Chaîne non L'ID de référence de la vidéo.
remoteUrl Chaîne non Requis pour les ressources distantes. Le chemin complet du fichier hébergé sur le serveur distant. Si le fichier est distribué via téléchargement progressif, vous devez inclure le nom du fichier et son extension. Vous pouvez également utiliser une URL qui redirige vers une autre URL qui inclut le nom et l’extension du fichier. Si le fichier est distribué en diffusion Flash, utilisez l’attribut remoteStreamName pour fournir le nom du flux.
remoteStreamName Chaîne non [Facultatif, requis pour la diffusion en continu des ressources distantes uniquement] Nom du flux d’une diffusion en continu au format Flash ajoutée à la propriété remoteUrl.
size Long oui Obligatoire. La taille du fichier de rendu en octets.
uploadTimestampMillis Long non La date/heure de chargement de vidéo sur Video Cloud, en millièmes de seconde depuis l'époque Unix.
url Chaîne non L'URL du flux m3u8.
videoCodec Enum non Obligatoire. La valeur acceptée est H264.
videoContainer Enum non Le format du wrapper qui fournit les métadonnées et qui décrit comment la vidéo et l'audio sont stockés dans le fichier. La valeur acceptée est M2TS. Consultez la rubrique Conteneurs et codecs vidéo pris en charge pour plus d'informations.
videoDuration Long non Obligatoire. La durée de la ressource vidéo distante en millièmes de seconde.

CuePoint

L’objet CuePoint sert à indiquer un moment précis dans une vidéo. Vous pouvez les utiliser pour déclencher des spots publicitaires mid-roll ou pour séparer des chapitres ou des scènes dans une vidéo de longue durée. Pour plus d’informations, consultez la rubrique Ajouts de marqueurs temporels à des vidéos et Définition de marqueurs temporels avec l’API médias.

Nom de la propriété Débit Lecture seule ? Description
name Chaîne oui Obligatoire. Le nom du marqueur pour un référencement ultérieur.
videoId Chaîne oui Liste séparée par des virgules contenant les identifiants des vidéos concernées par le marqueur temporel.
time Long oui Obligatoire. L’emplacement du marqueur, exprimé en millisecondes à partir du début de la vidéo.
forceStop Booléen non Si la valeur est « true », la vidéo se met en pause une fois le marqueur atteint. Ce paramètre ne s’applique qu’aux marqueurs de type AD.
type Enum oui Obligatoire. Nombre entier correspondant au type de marqueur temporel. 0 (AD) ou 1 (CODE). Un marqueur temporel publicitaire déclenche les requêtes de spots publicitaires mid-roll. Le marqueur Code peut être utilisé pour indiquer une interruption au niveau d’un chapitre ou d’une scène d’une vidéo.
metadata Chaîne non Une chaîne qui peut être transmise avec un marqueur CODE. Limitée à 512 caractères.

 

LogoOverlay

L’objet LogoOverlay désigne un logo superposé affecté à une vidéo. Le logo superposé s’affiche sur une partie de la vidéo pendant toute la durée de la vidéo. Pour plus d’informations, consultez la rubrique Création de logos superposés et Ajout de logos superposés aux vidéos à l’aide de l’API médias. Vous pouvez également définir un logo superposé par défaut pour votre compte. Si vous disposez d’un logo superposé général pour toutes les vidéos du compte et que vous avez également défini un logo pour une vidéo en particulier, le logo défini pour la vidéo s'affichera et le logo du compte sera ignoré.

Nom de la propriété Débit Description
id Long Valeur identifiant le LogoOverlay de manière unique. L’identifiant est automatiquement affecté par Video Cloud à la création du LogoOverlay.
image Image Objet Image défini à l’aide de son identifiant ou du referenceID, avec type=LOGO_OVERLAY
tooltip Chaîne Facultatif. Texte affiché lorsque l’utilisateur survole le logo avec la souris.
linkURL Chaîne Facultatif. URL de destination si l’utilisateur clique sur le logo superposé.
alignment Enum Facultatif. Propriété LogoOverlayAlignmentEnum représentant l’orientation du logo par rapport à la vidéo. L’une des valeurs suivantes : TOP_LEFT, BOTTOM_LEFT, TOP_RIGHT ou BOTTOM_RIGHT. La valeur par défaut est BOTTOM_RIGHT.
Balises
référence