Transfert FTP Batch : référence pour le manifeste XML

Product
Video Cloud
S'applique aux utilisateurs
Éditeur, Développeur
Version
Brightcove 5
Édition
Pro, Entreprise

Ceci est un document de référence pour la création du manifeste XML de transfert FTP Batch, étape obligatoire avant l’utilisation du système de transfert FTP Batch Video Cloud. Ce document vous présente les spécifications détaillées et des exemples de code des éléments et attributs XML requis dans votre fichier de manifeste XML. Vous trouverez également les spécifications pour effectuer des actions avec le fichier de manifeste XML, telles que charger des ressources, créer ou mettre à jour des vidéos, réencoder des vidéos et plus encore.

Cette rubrique contient les sections suivantes :

Pourquoi utiliser le transfert FTP batch ?

Le transfert Batch permet de charger et de diffuser plusieurs vidéos et sélections à la fois par le biais d’un manifeste XML et du serveur FTP de Video Cloud. Souvent, les éditeurs utilisent le transfert FTP Batch pour intégrer leur système de gestion du contenu (CMS) avec l'édition vidéo dans Video Cloud ou pour l'intégration initiale de vidéos dans les services d'édition de Video Cloud.

Conditions préalables

Vérifiez que vous avez rempli les conditions suivantes avant de continuer :

  • Le transfert FTP Batch n’est accessible qu’aux clients Video Cloud Pro et Enterprise. Si vous désirez en savoir plus sur la mise à niveau de votre compte Video Cloud, contactez Brightcove.
  • Si vous êtes toujours en cours de formation XML, consultez les ressources de base énumérées dans Utilisation du transfert FTP Batch ou regardez la démonstration suivante :
    vidéosTutoriel vidéo : introduction au XML
  • Voir Utilisation du transfert FTP Batch pour des informations préliminaires et une explication en détail des procédures. Consultez également la liste des liens connexes en haut à droite de ce document.
  • Exemple de fichier de manifeste XML de transfert FTP Batch. Téléchargez cet exemple simple pour découvrir comment charger une vidéo avec le fichier de manifeste XML. Ouvrez ce fichier et examinez-le en même temps que l'article. Si vous utilisez ce fichier, vous devrez le modifier de façon à ce qu'il fonctionne avec votre compte et vos paramètres d'environnement d'exécution.

Validation de votre fichier de manifeste XML

Vous pouvez valider votre fichier de manifeste XML avec la DTD (définition de type de document) du transfert FTP Batch. Téléchargez la DTD du transfert Batch.

Avant de valider votre fichier de manifeste XML, vous devez vous assurer qu'il ne possède pas de caractères non valides. Si ce n’est pas le cas, des erreurs peuvent se produire lors du processus de chargement et mener à des ressources inexploitables ou indisponibles. A cette fin, utilisez un utilitaire qui vérifie que le XML est bien formulé. Voici comment les caractères non valides devraient être représentés dans votre manifeste XML :

  • & devrait être représenté sous la forme &&
  • < et > devrait être représenté sous la forme &lt; et &gt;
  • ' et " devrait être représenté sous la forme &#39; et &quot;

Ces restrictions s’appliquent aux valeurs des attributs XML dans le manifeste ; dans le corps des éléments XML qui autorisent CDATA, vous pouvez représenter ces caractères directement. Comparez par exemple comment est représentée l'expression « Réné et Moi » dans l'attribut <title name > et dans le CDATA au sein de l’élément <short-description> :

<title name="R&#233;n&#233; &amp; Moi" refid="myVideo" active="TRUE" video-full-refid="asset2">
<short-description>
<![CDATA[
Réné et moi remarquons qu'il est tellement romantique,
de manière énigmatique, de se tenir debout sur la terrasse
à Chichen Itza et d'observer la montée de la lune gibbeuse!
]]>
</short-description>
</title>

Structure de document du manifeste XML

Les sections suivantes décrivent la structure du fichier de manifeste XML, expliquent la syntaxe requise et les actions facultatives que vous pouvez entreprendre avec le fichier et le système de transfert FTP Batch.

Identification du document XML

Obligatoire. La première balise identifie le type de document XML et doit toujours être formulée comme suit :

<?xml version="1.0" encoding="utf-8"?>

Balise d’ouverture du fichier de manifeste XML

Obligatoire. Cette balise spécifique à Video Cloud marque le début du manifeste de chargement.

Exemple

<publisher-upload-manifest publisher-id="101" preparer="3rd Street Video" report-success="true">

La balise publisher-upload-manifest utilise les attributs suivants.

Nom Obligatoire ? Description
publisher-id Obligatoire Identifie l’éditeur auquel les fichiers sont attribués. Cet attribut permet de certifier que votre vidéo sera dans le bon compte. Votre identifiant d'éditeur se trouve dans la section Informations sur le compte > Profil de Video Cloud Studio.
preparer Obligatoire Cet attribut doit contenir les informations d’identification de la personne qui a publié le manifeste. Il est particulièrement utile lorsqu’un tiers prépare des ressources pour un éditeur et les transfère directement à Video Cloud.
report-success Facultatif TRUE ou FALSE. Ce paramètre définit si Brightcove doit envoyer ou non un avis par courrier électronique lorsque le chargement est terminé. Le paramètre par défaut est FALSE. À moins que vous ne souhaitiez inclure cet attribut en le définissant sur TRUE, vous ne recevrez pas d’avis une fois le chargement terminé.

La balise publisher-upload-manifest peut inclure un ou plusieurs attributs parmi la liste suivante ; chacun d’entre eux est décrit plus en détail dans ce document :

Nom Description
notify Adresse pour le courrier électronique d’avis [Facultatif]
callback URL pour rappel d’état par HTTP [Facultatif]
asset Identifie les ressources à charger [Facultatif]
title Création ou mise à jour de vidéos [Facultatif]
manual-lineup Création ou mise à jour de sélections manuelles [Facultatif]
automatic-lineup Création ou mise à jour intelligentes de sélections [Facultatif]

Adresse pour le courrier électronique d’avis ou la fonction de rappel HTTP

Facultatif. La balise notify identifie l’adresse à laquelle Brightcove enverra l’avis de succès ou d’échec. Bien que cette balise soit facultative, il est préférable d'avoir une personne à qui envoyer un courrier en cas de problème. Vous ne recevrez des avis qu’en cas d’échec, à moins que vous ne désiriez activer les avis une fois l’envoi réussi en définissant l’attribut report-success="true" dans la balise publisher-upload-manifest. Pour envoyer l’avis à plusieurs adresses, utilisez une instance distincte de la balise pour chaque adresse de courrier électronique. La notification par e-mail proviendra de l'adresse donotreply@brightcove.com. Vérifiez que cette adresse n'est pas mise dans votre liste noire.

Exemple

<notify email="vous@exemple.com"/>
<notify email="moi@exemple.com"/>

La balise notify utilise l’attribut suivant :

attribut notify

Nom Obligatoire ? Description
email Obligatoire Identifie une adresse de courrier électronique pour les avis relatifs au chargement.

En plus de recevoir des notifications par courriel, vous pouvez également utiliser la balise callback pour envoyer des notifications de chargement à une page Web. L'avis est envoyé en POST à l'URL fournie dans l'attribut entity-url de la balise callback. Le POST comprend :

referenceId=<L’identifiant de référence fourni dans le manifeste> 
id=<l’identifiant du titre, de la sélection ou de la ressource dans la base de données> 
entity=<VIDEO, LINEUP ou ASSET> 
action=<CREATE, DELETE ou UPDATE> 
status=<FAILED ou SUCCESS> 
error=<message d’erreur>

L’état est toujours mentionné dans la requête de rappel. En cas d’état FAILED, l’inclusion des autres informations dans la requête de rappel dépend de leur disponibilité au moment de l’échec. Voici un exemple d'utilisation de la fonction de rappel HTTP dans le système de transfert FTP batch, utilisant PHP pour créer un fichier journal à partir des données générées par le transfert FTP batch.

Exemple

<callback entity-url="http://example.com/batch-callback.php"/>

attribut callback

Nom Obligatoire ? description
entity-url Obligatoire Identifie une URL de destination des avis d’état de chargement.

Actions généralement entreprises avec le fichier de manifeste XML de transfert FTP Batch

Les sections ci-dessous décrivent plusieurs actions que vous êtes à même d'entreprendre avec votre fichier de manifeste XML de transfert FTP Batch. Un seul fichier de manifeste XML permet de faire une ou plusieurs choses, suivant vos besoins au niveau du contenu.

Identification des ressources pour le chargement de données

Facultatif. La balise asset décrit un fichier en cours de chargement via le fichier de manifeste XML. Chaque fichier supplémentaire en cours de chargement doit avoir sa balise asset distincte.

Exemple

<asset filename="MyVideo.flv"
       refid="asset1"
       size="188812"
       hash-code="a4ade1e2b09d517ff7360f91527639b3"
       display-name="Ma vidéo (FLV)"
       type="VIDEO_FULL"/>

La balise asset utilise les attributs suivants :

Attributs des ressources

Nom Obligatoire ? Description
filename Obligatoire Le nom du fichier tel qu’il apparait sur le disque. Taille limitée à 125 caractères. Consultez la section Préparation des ressources dans la rubrique Utilisation du transfert FTP Batch pour plus de détails sur les noms de fichiers valides.
refid Obligatoire Un identifiant unique qui permet de référencer cette ressource dans le fichier de manifeste par le biais d’un titre. Cet identifiant doit être utilisé par votre système de gestion de contenus. Seuls les caractères alphanumériques sont acceptés. Taille limitée à 150 caractères.
size Facultatif La taille du fichier en octets. Vous devrez probablement convertir les kilo-octets ou les méga-octets pour obtenir la taille en octets. Inclure la taille du fichier est facultatif (sauf pour les ressources distantes), mais peut vous aider à détecter et à résoudre des problèmes de téléchargement. La taille de fichier est obligatoire pour les ressources distantes.
encoding-rate Facultatif Le taux d’encodage en bits par seconde pour les rendus de la diffusion en continu à plusieurs débits que vous chargez. Par exemple, 150 kbit/s sera écrit 150000.
frame-width Facultatif La largeur du cadre de la vidéo pour les rendus de diffusion en continu à plusieurs débits que vous chargez.
frame-height Facultatif La hauteur du cadre de la vidéo pour les rendus de diffusion en continu à plusieurs débits que vous chargez.
hash-code Facultatif La somme de contrôle MD5 (code de hachage) du fichier. L’utilisation d’une somme de contrôle MD5 n’est pas obligatoire, mais néanmoins recommandée. Les sommes de contrôle permettent à Video Cloud de vérifier que le fichier a été correctement transféré. Cela peut donc permettre de détecter et de dépanner les problèmes de chargement. Pour plus d’informations sur la création d’une somme de contrôle pour vos fichiers, voir Création de sommes de contrôle pour le transfert FTP batch.
display-name Facultatif Un nom visible par l’éditeur dans le module Média de Video Cloud. Si cet attribut n’est pas défini, le nom du fichier sera affiché à la place.
encode-to Facultatif FLV ou MP4. Encode la vidéo au format spécifié. Le FLV utilise le codec VP6 et le MP4 le codec H.264. Brightcove recommande l’utilisation du MP4 (H.264). Si cet attribut n’est pas précisé, le fichier vidéo ne sera pas converti.

Si vous utilisez l'élément reencode-from-new-source pour réencoder la vidéo, cet attribut est nécessaire dans l'élément asset qui fournit le nouveau fichier source.
encode-multiple Facultatif TRUE ou FALSE. Si TRUE, plusieurs rendus de ce fichier vidéo pour une diffusion en continu à plusieurs débits seront encodés. Ce paramètre est défini sur FALSE par défaut ; si l’attribut n'est pas défini, Brightcove n’effectuera une conversion que vers une seule vidéo. Cet attribut peut s’utiliser en même temps que encode-to.

Si vous utilisez l'élément reencode-from-new-source pour réencoder la vidéo, cet attribut est nécessaire dans l'élément asset qui fournit le nouveau fichier source.
h264-preserve-as-rendition Facultatif TRUE ou FALSE. Si TRUE, Video Cloud stocke une copie du fichier vidéo H.264 original en tant que ressource vidéo. Le fichier H.264 sera conservé en tant que rendu supplémentaire pour la diffusion en continu à plusieurs débits. Le paramètre est défini sur FALSE par défaut. Le fichier source doit être une vidéo H.264 valide. Si TRUE, Video Cloud crée plusieurs rendus du fichier original tout en conservant l’original pour l’utiliser comme rendu supplémentaire. Cette option est recommandée pour une qualité vidéo optimale. Cet attribut peut s’utiliser en même temps que encode-to et encode-multiple="true". Le fichier source doit être une vidéo H.264 valide.
h264-no-processing Facultatif TRUE ou FALSE. Si TRUE, le fichier H.264 sera chargé sans conversion. Le fichier H.264 sera conservé en tant que rendu supplémentaire pour la diffusion en continu à plusieurs débits. Le paramètre est défini sur FALSE par défaut. Cet attribut ne peut pas être utilisé en même temps que encode-to ou toute autre option de conversion. Le fichier source doit être une vidéo H.264 valide.
type Obligatoire Identifie le type de ressource à charger. La valeur doit être l’une des chaînes majuscules suivantes :
VIDEO_FULL : une vidéo Flash VP6 (FLV) ou H.264 (MP4) complète. La valeur FLV_FULL est obsolète pour l’attribut type ; utilisez VIDEO_FULL à la place.
FLV_BUMPER : une vidéo Flash VP6 (FLV) ou H.264 (MP4) intercalaire (clip de 15 secondes maximum).
THUMBNAIL : un fichier image utilisé comme imagette sur les listes.
VIDEO_STILL : une capture d’écran de la vidéo (ou une image représentative provenant d’une autre source).
BACKGROUND : une image d’arrière-plan pour les lecteurs vidéo.
LOGO : le logo de l’éditeur.
LOGO_OVERLAY : une image pour promouvoir la marque, superposée à la vidéo.
OTHER_IMAGE : type d’image divers.
Les fichiers vidéo chargés avec le transfert FTP Batch doivent être de type VP6 (FLV) ou H.264 (MP4).

Si vous utilisez des ressources à distance, identifiez-les avec la balise remote-asset et non pas avec la balise asset. Voir Création de vidéos à l’aide de fichiers vidéo distants pour plus de détails sur l’utilisation des ressources à distance et sur les attributs de la balise remote-asset.

Création ou mise à jour de vidéos avec l’élément titre

Facultatif. La balise title décrit les vidéos que vous désirez créer ou mettre à jour. Utilisez une balise title distincte pour chaque vidéo à inclure dans l’envoi dans votre manifeste XML.

Exemple

<title name="Mon titre"
       refid="title1"
       active="TRUE"
       start-date="01/01/2007 12:00 AM"
       end-date="01/01/2007 12:00 AM"
       video-full-refid="asset2"
       thumbnail-refid="asset4"
       video-still-refid="asset5"
       flash-prebumper-refid="asset6"
       shared="true"
       economic-type="AD"
       ad-keys=";key=value;key=value" >
    <short-description>Ma description courte.</short-description>
    <long-description>Ma description longue.</long-description>
    <related-link-url>http://votre-entreprise.com/</related-link-url>
    <related-link-text>Venez découvrir notre entreprise !</related-link-text>
    <tag>funny</tag>
    <tag>entertaining</tag>
    <logo-overlay
         asset-refid="12345" 
         click-thru="http://www.example.com" 
         tooltip="Aller à Exemple" alignment="bottom right" />
</title>

Les balises titre comprennent un mélange d’attributs et de balises enfant qui s’adaptent aux champs de la fenêtre Édition de vidéos du module Médias. Vous pouvez faire en sorte qu'une vidéo envoie toujours une requête publicitaire en l’éditant dans Video Cloud Studio. Cela est par contre impossible avec le transfert FTP batch.

Attributs de titre

Nom Obligatoire ? Description
name Obligatoire Le nom de la vidéo tel qu’il apparaît dans un lecteur. Les spectateurs verront ce nom lors de leur navigation ou de leurs recherches. Il ne doit pas compter plus de 255 caractères.
refid Obligatoire Un identifiant unique qui permet de référencer cet élément dans le fichier de manifeste par le biais des listes de reproduction. Taille limitée à 150 caractères.
active Facultatif TRUE ou FALSE. Spécifie si la vidéo doit être active dès sa création. S’il n’est pas défini, sa valeur sera celle par défaut : FALSE.
start-date Facultatif L’heure et la date du début de la programmation de la vidéo. Le format requis est MM/JJ/AAAA HH:MM AM. Par exemple : start-date="01.01.08 12:00 AM". Remarque : La date de fin dans le manifeste de chargement est calquée sur l’heure du Pacifique. Toutefois, une fois l’envoi terminé, la date de départ affichée dans le module média sera calquée sur l’heure de l’Est.
end-date Facultatif L’heure et la date de fin de la programmation de la vidéo. Le format requis est MM/JJ/AAAA HH:MM AM. Par exemple : start-date="31.12.08 12:00 AM". Remarque : La date de fin dans le manifeste de chargement est calquée sur l’heure du Pacifique. Toutefois, une fois le chargement terminé, la date de fin affichée dans le module média sera calquée sur l’heure de l’Est.
video-full-refid Facultatif L’attribut d’identifiant de référence d’un fichier vidéo complet à inclure dans cette vidéo. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
thumbnail-refid Facultatif Le paramètre d’identifiant de référence d’une ressource d'imagettes. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste. N’utilisez pas cet attribut si vous utilisez déjà l’attribut encode-to pour la ressource vidéo correspondante. Une vignette est automatiquement créée lorsque Video Cloud convertit une vidéo.
video-still-refid Facultatif Le paramètre d’identifiant de référence d’une ressource d'arrêt sur image. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste. N’utilisez pas cet attribut si vous utilisez déjà l’attribut encode-to pour la ressource vidéo correspondante. Un arrêt sur image est automatiquement créé lorsque Video Cloud convertit une vidéo.
flash-prebumper-refid Facultatif Le paramètre d’identifiant de référence d’une ressource vidéo intercalaire. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
allow-viral-syndication Facultatif TRUE ou FALSE. Si FALSE, la distribution virale ne sera pas autorisée pour cette vidéo ; les boutons « obtenir le code » et « partager » du lecteur seront désactivés. Le paramètre est défini sur TRUE par défaut.
shared Facultatif TRUE ou FALSE. Voulez-vous partager cette vidéo avec des comptes de filiales ? Si TRUE, vous devez également inclure un ou plusieurs éléments enfants share-to-id dans l’élément title pour spécifier les identifiants de compte des comptes associés avec lesquels vous comptez effectuer un partage. Cliquez ici pour plus d’informations sur le partage de médias.
auto-accept-shared Facultatif TRUE ou FALSE. Si cette vidéo est destinée à être partagée avec des comptes de filiales, lesdites filiales peuvent-elles l’accepter automatiquement dans leur médiathèque Video Cloud au lieu de l’accepter manuellement dans le module média de Video Cloud Studio ? Cet attribut n’a aucune répercussion à moins que shared="TRUE" pour cette vidéo et que le compte associé ait activé l’acceptation automatique pour le compte qui héberge la source de la vidéo partagée. Cliquez ici pour plus d’informations sur le partage de médias.
economic-type Facultatif L’une des valeurs suivantes : FREE ou AD. Si aucune valeur n’est spécifiée, la vidéo sera définie sur AD par défaut, si la valeur est FREE, aucune requête publicitaire ne sera envoyée par cette vidéo.
ad-keys Facultatif Une chaîne de combinaisons clés/valeurs séparées par des points-virgules, et qui débute par un point-virgule. Par exemple :
ad-keys=";clé=valeur;clé=valeur;clé=valeur"
overlay-update Facultatif TRUE ou FALSE. Si true, et si cette vidéo existe déjà, seuls les attributs et éléments enfants de ce titre qui ont été explicitement définis seront modifiés. Si false (par défaut), tout attribut ou élément enfant du titre non explicitement défini sera défini comme nul.

Balises de sous-élément de titre

Une balise title peut contenir les éléments enfants suivants.

Nom Obligatoire ? Description
short-description Obligatoire Une courte description de la vidéo en 250 caractères maximum. Selon le modèle de lecteur, les spectateurs peuvent voir ou non cette description. La courte description est généralement affichée dans les flux RSS qui parlent de la vidéo.
long-description Facultatif Une longue description de la vidéo en 5 000 caractères maximum. Les spectateurs peuvent voir cette description lorsqu'ils utilisent des moteurs de recherche ou naviguent sur des sites.
related-link-url Facultatif Une URL liée à la vidéo. Taille limitée à 255 caractères.
related-link-text Facultatif Le texte de l’URL facultative liée. Taille limitée à 255 caractères.
custom-string-value Facultatif Un champ de métadonnées personnalisé de type String. Utilisez l’attribut name pour le nom du champ et l’attribut value pour la valeur de la chaîne du champ. Taille limitée à 1 024 caractères.
custom-enum-value Facultatif Un champ de métadonnées personnalisé de type Enum. Utilisez l’attribut name pour le nom du champ et l’attribut value pour la valeur de la chaîne du champ. Taille limitée à 100 caractères.
tag Facultatif Une ou plusieurs balises qui aident au filtrage et à la recherche de la vidéo. Chacune ne doit pas compter plus de 128 caractères. Vous disposez d’un maximum de 1 200 balises par vidéo. Les balises peuvent également aider les éditeurs à filtrer les vidéos dans une sélection intelligente. Vous pouvez utiliser plusieurs instances de cet élément pour associer plusieurs balises à une même vidéo. Chaque balise doit être contenue dans son propre élément <tag>. Par exemple :

<tag>voyage</tag>
<tag>Mozambique</tag>

rendition-refid Facultatif Un identifiant de référence pour un rendu de cette vidéo pour la diffusion en continu à plusieurs débits. Cette balise ne devrait être utilisée que lorsque vous assignez des ressources qui ne nécessitent pas de conversion de la part de Video Cloud.
share-to-id Facultatif Si vous partagez cette vidéo et avez défini <title shared="true" >, vous devez inclure un ou plusieurs éléments enfants share-to-id dans l'élément titre pour spécifier les identifiants de compte Video Cloud des comptes avec lesquels vous partagez cette vidéo. Cliquez ici pour plus d’informations sur le partage de médias.
logo-overlay Facultatif Une collection de métadonnées pour définir une image qui sera superposée à la fenêtre de vidéo à des fins publicitaires et pour diriger le trafic vers une adresse précise. Cette balise utilise les attributs de logo-overlay. Cliquez ici pour plus d’informations sur les superpositions de logos.

Attributs de logo-overlay

Facultatif. Vous pouvez utiliser le fichier de manifeste XML pour spécifier une image commerciale qui sera positionnée sur la fenêtre vidéo dans le but de rediriger le trafic vers une page donnée grâce à la balise logo-overlay. Cliquez ici pour plus d’informations sur les superpositions de logos. La balise logo-overlay utilise les attributs suivants :

Nom Obligatoire ? Description
asset-refid Obligatoire Le paramètre d’identifiant de référence de la ressource de superposition de logo. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
Balise click-thrulogo-overlay Facultatif L’URL de la fenêtre du navigateur à ouvrir lorsque l’utilisateur clique sur le logo superposé. Taille limitée à 128 caractères.
tooltip Facultatif L’info-bulle, ou balise alternative, qui apparaît lorsqu’on laisse le curseur sur le logo superposé. Taille limitée à 128 caractères.
alignment Facultatif L’alignement du logo superposé dans la fenêtre de la vidéo. Les valeurs sont « top left », « top right », « bottom left » ou « bottom right ». Par exemple :

<alignment="top right"/>

Réencodage de vidéos existantes

Facultatif. Vous pouvez utiliser le fichier de manifeste XML pour que Video Cloud réencode les fichiers vidéo pour une vidéo tout en conservant toutes les métadonnées de la vidéo. Utilisez l’élément reencode-from-existing-source en tant qu’enfant de l’élément principal publisher-upload-manifest si vous désirez utiliser le fichier source existant dans votre médiathèque Video Cloud en tant que source pour le réencodage. Utilisez l’élément reencode-from-new-source si vous proposez un nouveau fichier source (probablement de meilleure qualité) avec le manifeste XML. Cliquez ici pour des informations détaillées sur le réencodage de vidéos existantes.

Nom Description
reencode-from-existing-source Identifie une vidéo à réencoder depuis la source actuelle.
reencode-from-new-source Identifie une vidéo à réencoder depuis une nouvelle source ou depuis une source déjà présente dans notre système, mais non associée à cette vidéo.

Les attributs reencode-from-existing-source

Nom Obligatoire ? Description
title-refid Obligatoire L’identifiant de référence de la vidéo à réencoder
encode-to Facultatif FLV ou MP4. Encode la vidéo au format spécifié. FLV correspond au VP6 et MP4 au H.264. Si cet attribut n’est pas défini, le codec par défaut de l’éditeur sera utilisé.
encode-multiple Facultatif TRUE ou FALSE. Si TRUE, plusieurs rendus seront créés pour la vidéo. Si FALSE, un seul rendu sera créé. Si cet attribut n’est pas défini, sa valeur sera TRUE par défaut.
overwrite-images Facultatif TRUE ou FALSE. Si TRUE, les images pour la vidéo réencodée (arrêt sur image et imagette) seront remplacées par la nouvelle image capturée pendant le réencodage. Si FALSE, les images actuelles seront conservées. Si cet attribut n’est pas défini, sa valeur sera FALSE par défaut. Si la vidéo ne possède pas d’imagette ou d’arrêt sur image associés, ils seront créés pendant le réencodage, quelle que soit la valeur de cet attribut.
preserve-source-as-rendition Facultatif TRUE ou FALSE. Si TRUE, Video Cloud crée plusieurs rendus du fichier original tout en conservant l’original pour l’utiliser comme rendu supplémentaire. Si cet attribut n’est pas défini, sa valeur sera FALSE par défaut.

Les attributs reencode-from-new-source

Nom Obligatoire ? Description
title-refid Obligatoire L’identifiant de référence de la vidéo à réencoder
new-source-refid Obligatoire L’identifiant de référence de la ressource à utiliser comme nouvelle source pour le réencodage de la vidéo. Cette ressource peut apparaître dans le même manifeste que l’élément reencode-from-existing-source, ou déjà exister en tant que ressource dans le système Video Cloud.
overwrite-images Facultatif TRUE ou FALSE. Si TRUE, les images pour la vidéo réencodée (arrêt sur image et imagette) seront remplacées par la nouvelle image capturée pendant le réencodage. Si FALSE, les images actuelles seront conservées. Si cet attribut n’est pas défini, sa valeur sera FALSE par défaut. Si la vidéo ne possède pas d’imagette ou d’arrêt sur image associés, ils seront créés pendant le réencodage, quelle que soit la valeur de cet attribut.

Création ou mise à jour de sélections avec l’élément lineup

Facultatif. Il existe deux types de sélections : manuelle et intelligente. Cliquez ici pour en savoir plus sur les l'utilisation des sélections.

  • Sélections manuelles : vous déterminez la place des vidéos dans la sélection en créant une liste de toutes les vidéos à inclure dedans. Utilisez la balise manual-lineup.
  • Sélections intelligentes : toutes les vidéos dans le compte de l’éditeur sont automatiquement ajoutées à la sélection. Vous spécifiez la méthode de classement de ces vidéos : alphabétique, par date de départ ou de création (de la plus ancienne à la plus récente ou inversement), par popularité en général ou pendant la semaine passée. Utilisez la balise automatic-lineup.

Il n’est pas nécessaire de créer une sélection avec le fichier de manifeste XML. Vous pouvez utiliser ce dernier pour charger des ressources, des ressources et des vidéos ou créer vos sélections avec le module média.

Sélections manuelles

Dans le cas d’une sélection manuelle, utilisez la balise manual-lineup. Dans la balise manual-lineup, utilisez des balises title-refid pour lister chaque vidéo à inclure dans la sélection.

Exemple

<manual-lineup
    name="Ma liste manuelle"
    refid="lineup1"
    thumbnail-refid="asset4"> <title-refid>title1</title-refid>
  <title-refid>title3</title-refid>
  <title-refid>title137</title-refid>
</manual-lineup>

La balise manual-lineup utilise un mélange d’attributs et de balises éléments enfant qui s’adaptent aux champs du formulaire de création de sélection du module média.

Attributs de manual-lineup

Nom Obligatoire ? Description
name Obligatoire Le nom de la sélection tel qu’il apparaît dans les lecteurs. Les spectateurs verront cette sélection lors de leur navigation ou de leurs recherches. Taille limitée à 50 caractères.
refid Obligatoire Un identifiant unique pour référencer la sélection à une date ultérieure. Taille limitée à 150 caractères.
thumbnail-refid Facultatif L’attribut refid d’une ressource d’imagette à inclure sur la liste de reproduction. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
overlay-update Facultatif TRUE ou FALSE. Si TRUE, et si cette sélection existe déjà, seuls les attributs de cette dernière qui ont été explicitement définis seront modifiés. Si FALSE (par défaut), tout attribut de la sélection non explicitement défini sera défini comme nul.
Vous ne pouvez pas utiliser overlay-update pour ajouter de nouvelles vidéos à une sélection existante. Pour ajouter des vidéos à une sélection existante, incluez l'ensemble de la liste de vidéos avec un élément title-refid pour chaque vidéo.

Balises d’élément enfant pour la balise manual-lineup

Nom Obligatoire ? Description
title-refid Obligatoire Le paramètre refid de la vidéo à inclure dans cette sélection manuelle. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
description Facultatif Une courte description de cette sélection ne dépassant pas 250 caractères.

Sélections intelligentes

Dans le cas de sélections intelligentes, utilisez la balise automatic-lineup. Vous ne référencez pas ces vidéos de façon explicite, mais spécifiez à la place comment les classer avec l’attribut type. Vous pouvez également filtrer des vidéos en utilisant l’attribut tag-filter et l’élément enfant title-tag.

Exemple

<automatic-lineup name="Ma liste automatique"
    refid="lineup2"
    type="NEWEST_TO_OLDEST"
    tag-filter="AND"
    title-limit="50"
    thumbnail-refid="asset4">
  <title-tag>sporty</title-tag>
</automatic-lineup>

L’élément automatic-lineup utilise un mélange d’attributs et de balises de sous-éléments qui s’adaptent aux champs du formulaire de création de sélection du module média.

Les attributs de automatic-lineup

Nom Obligatoire ? Description
name Obligatoire Le nom de la sélection tel qu’il apparaît dans les lecteurs. Les spectateurs verront cette sélection lors de leur navigation ou de leurs recherches.
refid Obligatoire Un identifiant unique pour référencer la sélection à une date ultérieure.
type Facultatif

La méthode de classement des vidéos d’une sélection. Les valeurs acceptées sont :
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)
PLAYS_TOTAL
PLAYS_TRAILING_WEEK

tag-filter Facultatif Les valeurs acceptées sont AND ou OR. Si vous utilisez des filtres de balises pour créer cette sélection intelligente, l’attribut tag-filter indique si ces filtres doivent être considérés comme des requêtes « and » ou « or ». Supposons par exemple que vous spécifiez les balises « sports » et « football » dans votre élément title-tag. Si vous avez défini tag-filter="AND", la sélection inclura les vidéos possédant à la fois sports et football. Si vous avez défini tag-filter="OR", la sélection inclura les vidéos possédant soit sports, soit football.
title-limit Facultatif Le nombre maximum de vidéos à inclure sur la liste de reproduction. Ce nombre ne peut pas être supérieur à 100.
thumbnail-refid Facultatif Le paramètre refid d’une ressource d’imagette à inclure dans cette sélection intelligente. L’identifiant de référence peut être soit un identifiant précédemment entré dans le système, soit un identifiant spécifié dans une balise asset dans le même fichier de manifeste.
overlay-update Facultatif TRUE ou FALSE. Si TRUE, et si cette sélection existe déjà, seuls les attributs et éléments enfants de cette dernière qui ont été explicitement définis seront modifiés. Si false (par défaut), tout attribut ou élément enfant de la sélection non explicitement défini sera défini comme nul.

Balises d’élément enfant pour la balise automatic-lineup

Nom Obligatoire ? Description
title-tag Facultatif Vous pouvez utiliser cet élément pour filtrer les vidéos à inclure dans cette liste de reproduction automatique. Utilisez un élément title-tag distinct pour chaque balise de filtrage de titres. Voir tag-filter pour plus d’informations sur le filtrage avec plus d’une balise. Par exemple :

<automatic-lineup name="Ma liste automatique"
...
tag-filter="AND">
   <title-tag>sports</title-tag>
   <title-tag>soccer</title-tag>
</automatic-lineup>

Dans cet exemple, seuls les titres qui possèdent la balise « sports » et « soccer » (football) seront affichés sur la liste.
description Facultatif Une courte description de cette sélection ne dépassant pas 250 caractères.

Création de marqueurs temporels

Facultatif. Vous pouvez ajouter des marqueurs temporels dans une vidéo avec l’élément XML cuepoint dans votre fichier de manifeste XML de transfert FTP Batch. Un marqueur temporel 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. En savoir plus sur l’ajout de marqueurs temporels à une vidéo.

La balise cuepoint est une balise de premier niveau qui permet de définir un marqueur temporel dans une vidéo. Elle a une balise enfant associée, metadata. La balise enfant metadata peut contenir CDATA ou une chaîne pour donner des informations sur le marqueur temporel.

Exemples

<cuepoint name="MMarqueur y" type="CODE" time="500000" video-refid="video001" />
<cuepoint name="Mon deuxième marqueur" type="AD" time="50000" video-refid="video001" />
<cuepoint name="Mon troisième marqueur" type="AD" time="120000" video-refid="video001">
  <metadata>Quelque chose d’intéressant à propos de ce marqueur.</metadata>
</cuepoint>
<cuepoint name="Mon quatrième marqueur" type="AD" time="270000" video-refid="video055">
  <metadata>
    <![CDATA[
 Ceci est un ensemble de métadonnées à plusieurs lignes
    ]]>
  </metadata>
</cuepoint>

Attributs de la balise cuepoint

Nom Obligatoire ? Description
Nom Obligatoire Le nom du marqueur pour un référencement ultérieur. Taille limitée à 128 caractères.
video-refid Obligatoire L’identifiant de référence de la vidéo concernée par le marqueur temporel.
time Obligatoire L’emplacement du marqueur, exprimé en millisecondes à partir du début de la vidéo.
type Obligatoire Le type de marqueur : AD ou CODE. Un marqueur AD déclenche les requêtes de spots publicitaires mid-roll. Un marqueur CODE permet d’écouter et de répondre à un événement qu’il a provoqué et peut indiquer un chapitre ou une coupure de scène dans la vidéo.
metadata Facultatif Une chaîne qui peut être transmise avec un marqueur CODE. Taille limitée à 512 caractères.

Balise enfant pour la balise cuepoint

Une balise cuepoint peut éventuellement inclure un élément enfant metadata unique. L’élément metadata contient une chaîne qui peut être transmise avec le marqueur.

Suppression de ressources, de vidéos ou de sélections

Facultatif. Vous pouvez également utiliser le système de transfert FTP Batch pour supprimer des ressources, des vidéos, des sélections ou des marqueurs temporels de votre compte. Attention : une ressource ne peut pas être supprimée tant qu’elle est référencée par une vidéo, et une vidéo ne peut pas être supprimée tant qu’elle est référencée par une sélection.

Exemple

<delete-asset refid="RandomAssetsRefID"/>
<delete-title refid="RandomTitlesRefID"/>
<delete-lineup refid="RandomLineupsRefID"/>
<delete-cuepoint video-refid="video0001" id="0123456789"/>

Utilisez les balises suivantes en définissant l’attribut refid sur le refid de la ressource, vidéo, sélection ou l'identifiant du marqueur à supprimer.

Nom Obligatoire ? Description
delete-asset Facultatif Supprime la ressource portant le refid spécifié dans l’attribut refid.
delete-title Facultatif Supprime la vidéo portant le refid spécifié dans l’attribut refid.
delete-lineup Facultatif Supprime la sélection portant le refid spécifié dans l’attribut refid.
delete-cuepoint Facultatif Supprime le marqueur temporel portant l'identifiant spécifié par l'attribut id.

Balise de fermeture du fichier de manifeste XML

Obligatoire. La dernière balise marque la fin du fichier de manifeste XML et indique que le manifeste est présent dans sa totalité.

</publisher-upload-manifest>

Rubriques connexes

Pour mieux comprendre le fonctionnement du transfert FTP Batch, Video Cloud propose les rubriques suivantes :

 

Balises
référence