"Watchfolder" FTP

Cette fonctionnalité permet de traiter de façon automatique (création ou modification) des médias déposés sur le ftp de votre compte.

 

Processus et workflow

Sur votre compte ftp sont disponibles 4 répertoires de traitement automatisé :

  • 1_ToBeProcessed
  • 2_BeingProcessed
  • 3_ProcessedOk
  • 4_ProcessedError

 

 

Il vous suffit de déposer vos médias dans le répertoire 1_ToBeProcessed (un fichier descripteur optionnel peut également être ajouté pour modifier les méta-données de la vidéo)

Note : l'upload d'un fichier est considéré comme étant terminé lorsque la durée d'inactivité sur ce fichier est supérieure à 5 minutes(durée arbitraire). Il déplacé dans le répertoire 2_BeingProcessed pour être traité.  

 

Si un descripteur au format json est présent, il doit être déposé avant que le média ne soit traité. Soit moins de cinq minutes avant la fin de l'upload du média. Nous conseillons d'uploader le ou les descripteurs avant les médias, puisqu'un descripteur seul ne sera pas traité.

 

Si l'encodage s'est bien terminé, le média est déplacé dans le répertoire 3_ProcessedOk.

En cas de problème rencontré par le process, le fichier est déplacé dans 4_ProcessedError préfixé de l'erreur rencontrée :

  • _UNAUTHORIZED_EXTENSION_ si l'extension du média n'est pas reconnue (cf documentation application)
  • _PERMALINK_ALREADY_USED_ERROR_ si le permalink que vous avez indiqué existe déjà sur un compte autre que le vôtre
  • _DESCRIPTOR_JSON_ERROR_ si le fichier descripteur n'est pas valide, ou si les valeurs saisies ne sont pas acceptées
  • _USER_ERROR_ si vous liez le média à un utilisateur inexistant sur votre compte société
  • _ENCODING_ERROR_ si une erreur d'encodage a eu lieu
  • _DESCRIPTOR_FORMAT_ERROR_ si le fichier json ne peut être décodé (problèmes UTF8 ou BOM)

 

Par exemple, sample.mp4 apparaîtra dans 4_ProcessedError/_PERMALINK_ALREADY_USED_ERROR_sample.mp4 en cas de doublon illicite de permalink.

 

 

Dépose ftp avec fichier descripteur json

L'ajout d'un descripteur permet de préciser les métadonnées d'un média (création ou modification).

Si le média traité existe déjà sur votre compte (vérification sur la valeur du permalien), ses informations seront mises à jour.

 

Le descripteur a la forme suivante :

{
 "file_descriptor":{
    "media_name": "Media from WF",
    "media_description":"The media description",
    "media_permalink":"mediapermalink",
    "user_login":"jdoe",
    "media_status":"online",
    "media_credits":"Streamlike",
    "media_keywords":"keywordA, keywordB",
    "media_custom1": "value1",
    "media_custom2": "value2",
    "media_custom3": "value3",
    "media_custom4": "value4",
    "media_playlists": [ "f4652249f825afb3", "34b5d4c81e027eb9" ],
    "media_tags": [ 1, 2, 12 ]
  }
}

 

L'ensemble des champs n'est pas obligatoire. Si un champ optionnel n'est pas renseigné en cas de modification d'un média, il ne sera pas mis à jour.
 
Les valeurs obligatoires sont les suivantes :
  • media_name : le titre du média
  • media_status : valeur parmi les suivantes : online, offline, archived
 
Les valeurs facultatives sont les suivantes :
  • media_description : la description du média
  • media_permalink : le permalien du média
  • media_credits : les crédits du média
  • media_keywords : les mots clés du média
  • ext2_html5 : Option d'encodage HTL5 (si vous avez l'option) du média : true ou false 
  • user_login : le login de l'utilisateur auquel va être rattaché le media. En cas d'absence, l'utilisateur auquel est rattaché le média est l'un des utilisateurs de plus haut profil de la société

 
Les limites des longueur de champs sont disponibles dans le module MEDIA de l'API.
 
Le fichier descripteur doit être nommé de la même manière que le média. Si votre média se nomme sample.mp4 ou sample.mp3, votre descripteur sera sample.json.

Si vous avez indiqué un permalien existant sur un autre compte, le média est traité en erreur. Si vous n'avez pas indiqué de permalien, il est généré aléatoirement.

 
 
Dépose ftp simple, sans descripteur

Sans descripteur, il n'est pas possible de modifier un média existant.

Le nom du média correspond au nom du fichier nettoyé et sans l'extension.

Le permalien correspond au nom du média mis au format permalien. Si le permalien existe déjà, un permalien aléatoire est généré.

Par défaut, le statut du média est online.

Si vous avez souscrit à l'option HTML5, les encodages associés seront réalisés.

L'utilisateur auquel est rattaché le média est par défaut l'un des utilisateurs de plus haut profil.

 

 

Notes

Les fichiers audio sont désormais traités par le workflow.

Si les informations mises à jour via ce process ne sont pas suffisantes à vos besoins, reportez-vous sur l'utilisation des API qui permettent d'enrichir totalement les médias.

Création : 19/06/2013  -  Dernière modification : 02/03/2017