label: string

Default value: "Upload with Clipchamp!"

L’étiquette sur le bouton intégré. Il s’agit du texte qui s’affiche sur le bouton et qui est placé dans l’élément enveloppant.

size: string

Default value: "medium"
Allowed values:
tiny small medium large

Les dimensions du bouton Clipchamp. Choisir parmi 4 dimensions.

title: string

Default value: "Ye' olde video-upload shoppe"

Le titre de l’IU qui apparaît après qu’un utilisateur clique sur le bouton intégré. Le titre s’affiche en haut du pop-up iframe.

logo: string

Default value: "https://api.clipchamp.com/static/button/images/logo.svg"

L’URL de l’image du logo pour l’IU. Il s’agit d’une image qui s’affiche dans le coin supérieur à gauche du iframe.

color: string

Default value: "#303030"

Déterminer la couleur du bouton Clipchamp, l’arrière-plan de la barre de titre du pop-up et d’autres éléments graphiques. Cela peut être un nom de couleur, (tel que blue, un code hexadécimal de couleur (tel que #3300cc) ou un code couleur RGB (tel que rgba(78,24,212,0.5)).

style: object

Default value: undefined

Permet la personnalisation détaillée de l’apparence visuelle de l’API Clipchamp en utilisant une feuille de style CSS. Une feuille de style CSS peut être fournie sous forme d’URL (style.url propriétaire) ou un string des déclarations CSS (style.text). Dans les deux cas, les déclarations CSS personnalisées augmentent mais ne remplacent pas le style par défaut de l’interface utilisateur, basé sur le style par défaut Bootstrap 3. Ainsi, le style CSS personnalisé CSS est mis en couche sur le dessus du style CSS existant là où les classes CSS existantes peuvent être augmentées et les propriétés CSS peuvent être ajoutées ou remplacées. Plan Entreprise.

inline: object

Default value: undefined

Permet un positionnement en ligne du widget de l’API où le <iframe> qui contient le widget Clipchamp est placé à l’intérieur d’un élément enveloppeur nominatif dans la page intégrante. Plan Entreprise.

encoding: object

Default value: undefined

Configurer les paramètres d’encodage en sortie.

inputs: Array<string>

Default value: ["file", "camera"]
Allowed values:
file camera direct

Les sources parmi lesquelles l’utilisateur peut choisir une vidéo en entrée : camera pour sa webcam et file pour le système de fichier de son ordinateur. L’option direct commande à l’API Clipchamp de recevoir les fichiers vidéo en entrée sans action de l’utilisateur final directement avec le paramètre direct.files. Par conséquent, l’option d’entrée direct ne doit pas être utilisée en combinaison avec l’un des deux autres options (file, camera). Si les deux direct et file ou camera sont indiqués dans la plage inputs, alors les options file et camera seront ignorées et le paramètre direct.files sera considéré comme une plage des instances de Blob.

output: string

Default value: "dummy"
Allowed values:
dummy blob azure s3 youtube gdrive dropbox

Les destinations où nous rendrons la vidéo en sortie disponible ou vers laquelle nous la téléchargerons. Si « blob » est choisi, nous fournissons la vidéo en sortie sous forme de Blob au code JavaScript de votre client. Si vous sélectionnez « youtube », « azure » ou « s3 », vous devez nous autoriser à télécharger la vidéo dans le compte approprié depuis la page de configuration. La sortie « dummy » ne permet aucune sortie mais elle simule un téléchargement avec une simple minuterie et elle peut être utilisée pour l’intégration et le test initial sans avoir de backend configuré.

upload: object

Default value: undefined

Les paramètres qui configurent le processus de téléchargement vers toutes les destinations de téléchargement supportées.

camera: object

Default value: undefined

Les éléments de configuration pour personnaliser l’enregistrement de la caméra.

direct: object

Default value: undefined

Les paramètres supplémentaires qui s’appliquent à l’option direct dans les paramètres d’entrée.

enable: Array<string>

Default value: []
Allowed values:
batch fixup-webcam-webm mobile-webcam-format-fallback no-branding no-error-bypass no-hidden-run no-popout no-probe-reject no-thank-you no-user-retry

Activer le comportement spécial de l’API Clipchamp :

  • batch – permet à de multiples fichiers d’être traités et téléchargés en séquence sans interaction supplémentaire de l’utilisateur.
  • fixup-webcam-webm – « fixes » enregistrements webcam WebM qui peuvent avoir des métadonnées de durée incorrectes ou manquantes. Utiliser cet indicateur si vous voulez vous assurer que les étapes suivantes dans votre pipeline de traitement vidéo reçoivent les fichiers WebM pour lesquels les métadonnées vidéo intégrées soient correctes et complètes. Cet indicateur ne s’applique pas actuellement aux appareils mobiles (c.-à-d. les téléphones Android avec l’indicateur mobile-webcam-format-fallback actif). BETA
  • mobile-webcam-format-fallback – active la compression des enregistrements de webcam sur les appareils mobiles même quand le format cible n’est pas disponible (expérimental). Cette fonctionnalité est actuellement restreinte à Chrome sur Android où, avec cet indicateur, l’API Clipchamp produit les fichiers WebM en utilisant le codec vidéo VP8 ou VP9.
  • no-branding – supprime le branding Clipchamp de l’interface utilisateur, si disponible dans votre plan. Cela ne s’applique pas au bouton intégré. Utiliser l’option bouton API personnalisé pour créer le style du bouton intégré (si disponible dans votre plan).
  • no-error-bypass – si le transcodage échoue pour quelque raison que ce soit, Clipchamp procéderait simplement au téléchargement du fichier en entrée tel quel. Cet indicateur supprime ce comportement. Les échecs de transcodage les plus fréquents sont dus à des codecs d’entrée non supportés.
  • no-hidden-run – désactive l’option pour continuer le traitement et le téléchargement en arrière-plan si l’utilisateur ferme la fenêtre après avoir cliqué sur « soumettre ».
  • no-popout – certains navigateurs bloquent l’utilisation de certaines fonctionnalités pour du code tiers. Quand cela est détecté, Clipchamp ouvrira une nouvelle fenêtre afin d’avoir accès à ces fonctionnalités. Le paramètre no-popout supprime ce comportement et force Clipchamp à tenter de faire avec ce qui est disponible. Cela pourrait conduire à des requêtes en mémoire accrues, entre autres choses.
  • no-probe-reject – dans le cas où nous ne sommes pas en mesure de déterminer si un fichier en entrée est une vidéo, celui-ci serait normalement rejeté. Cette option accepte tous les fichiers en entrée et passe directement au téléchargement pour les fichiers non-vidéo.
  • no-thank-you – désactive l’écran de remerciement et ferme la fenêtre immédiatement. Si des erreurs sont survenues au cours du processus, le dernier écran sera toujours affiché.
  • no-user-retry – désactive la confirmation de l’utilisateur et l’option pour une nouvelle tentative après qu’un enregistrement de webcam soit terminé et avant que le fichier ne soit téléchargé. L’ajout de cet indicateur lancera immédiatement le téléchargement après la fin de l’enregistrement de la webcam. Les utilisateurs n’auront pas la possibilité de répéter leur enregistrement de webcam.

experimental: Array<string>

Default value: []
Allowed values:
force-popout overlong-recording h264-hardware-acceleration

Activer le comportement expérimental de l’API Clipchamp

  • force-popout – toujours lancer l’interface de l’API Clipchamp dans une fenêtre distincte « popout » du navigateur, même si elle pouvait fonctionner à l’intérieur d’un iframe à l’intérieur du DOM du site web intégrant. Ne doit pas être utilisé en combinaison avec le paramètre (enable) de l’indicateur no-popout.
  • overlong-recording – autorise les enregistrements avec une caméra webcam/mobile sans limitation de la durée de l’enregistrement (telq qu’appliqué par ailleurs par l’API Clipchamp). La durée de l’enregistrement peut toujours être délibérément limitée en indiquant une valeur numérique (nombre de secondes) dans le paramètre camera.limit. Les clients doivent s’assurer de ne paramétrer cet indicateur overlong-recording que dans les navigateurs supportés (actuellement : Chrome, Opera et Firefox).
  • h264-hardware-acceleration – activer l’encodage vidéo H.264 pour l’accélération matérielle sur les plateformes supportées (actuellement : appareils ChromeOS/Chromebook x86). L’indicateur ne s’applique qu’au preset web (par défaut) et qu’au format (par défaut) mp4. Selon l’équipement sous-jacent, une accélération en plusieurs fois peut être obtenue en paramétrant l’indicateur h264-hardware-acceleration. Les clients feront l’expérience d’un taux de compression différent pour la même qualité perçue en sortie (subjectivement) et ils sont encouragés à ajuster le paramètre de compression pour aboutir à un rapport qualité / compression acceptable.

dropbox: object

Default value: undefined

Éléments de configuration en cas d’utilisation de la cible de téléchargement vers Dropbox.

youtube: object

Default value: undefined

Éléments de configuration en cas d’utilisation de la cible de téléchargement vers YouTube.

onWebcamStatusChange(status): function

Cette fonction de rappel est invoquée pour un certain nombre d’évènements affectant l’enregistrement des vidéos et également la webcam ou la caméra du téléphone, où le status est un String reflétant le nouveau statut de la webcam ou de l’enregistrement :

  • capture_started – la webcam ou la caméra du téléphone a été allumée avec succès et elle effectue la capture (mais pas encore l’enregistrement) d’une vidéo en streaming
  • capture_ended – la webcam ou la caméra du téléphone a été éteinte et elle ne capture plus de vidéo en streaming.
  • capture_failed – l’accès à la webcam ou à la caméra du téléphone a échoué
  • recording_running – l’enregistrement de la webcam a débuté ou a été repris après avoir été mis en pause précédemment
  • recording_paused – l’enregistrement de la webcam a été mis en pause et il peut être repris ultérieurement ou terminé
  • recording_finished – l’enregistrement de la webcam a été terminé mais il peut toujours être traité avant qu’il ne soit téléchargé ou rendu disponible dans le rappel onVideoCreated
  • recording_cancelled – l’enregistrement de la webcam a été annulé

Le suivi du statut de la the webcam ou de la caméra du téléphone est supporté dans les navigateurs de PC (et dans Chrome sous Android quand l’indicateur mobile-webcam-format-fallback est fixé en enable dans le tableau de paramétrage).

onMetadataAvailable(metadata): function

Cette fonction de rappel est invoquée pour chaque enregistrement de webcam et pour chaque fichier vidéo en entrée quand l’enregistrement de la webcam ou le fichier vidéo en entrée a été analysé avec succès. Le paramètre metadata est un objet avec les propriétés suivantes :

  • raw – les métadonnées vidéo brutes sont un objet avec les propriétés suivantes :
    • format – informations sur le format du conteneur vidéo
    • streams – tableau des streams vidéo, audio, de sous-titre, de données, etc. contenus dans la vidéo

Vous devez noter que, quand l’utilisateur choisit de rejeter et de répéter un enregistrement de webcam, ce rappel sera invoqué à de multiples reprises avec les métadonnées des différents enregistrements. onMetadataAvailable sera également invoqué à de multiples reprises quand l’indicateur batch est utilisé, où l’utilisateur peut sélectionner de multiples vidéos en entrée. BETA

onPreviewAvailable(imageBlob): function

onPreviewAvailable est appelé avec une image d’aperçu quand il y en a une disponible. Noter que le paramètre est une instance Blob et pas une URL, l’image n’est pas téléchargée vers la destination de téléchargement désignée en parallèle de la vidéo en sortie. Noter également que tous les scénarios ne produiront pas une image d’aperçu, en particulier si la vidéo en entrée est corrompue ou si elle comporte des métadonnées invalides / incomplètes. BETA

onUploadComplete(data): function

Cette fonction de rappel est invoquée une fois quand la vidéo en sortie a terminé son téléchargement et où un objet unique data contient les méta informations sur le fichier téléchargé. Il y a deux propriétés communes :

  • filename – le nom du fichier vidéo d’origine
  • duration – la durée de la vidéo. Ce champ peut être absent dans certaines conditions.

Il y a également un certainnombre de propriétés spécifiques output :

  • En utlisant la sortie « youtube »
    • kind – « youtube »
    • id – l’identifiant de la vidéo
    • url – l’URL d’affichage
    • embedHtml – le snipet HTML fourni par YouTube pour l’intégration de la vidéo (si fourni).
  • En utilisant la sortie « azure »
    • kind – « azure »
    • blob – le nom blob actuel Azure qui est finalement utilisé lors du stockage du téléchargement.
  • En utilisant la sortie « s3 »
    • kind – « s3 »
    • key – la clé d’objet Amazon S3 actuelle qui est finalement utilisée lors du stockage du téléchargement.
  • En utilisant la sortie « gdrive »
    • kind – « gdrive »
    • id – l’identifiant de fichier Google
    • name – le nom du fichier tel que stocké dans Google Drive.
    • url – une URL vers le fichier
    • folder – l’identifiant du dossier Google dans lequel se trouve le fichier, ou le « root » si on se trouve au niveau supérieur.
  • En utilisant la sortie « dropbox »
    • kind – « dropbox »
    • id – l’identifiant du fichier Dropbox
    • name – le nom du fichier tel que stocké dans Dropbox
    • path – le chemin d’accès au fichier dans Dropbox
    • link – le lien partagé du fichier dans Dropbox (nécessite que l’option correspondante soit activée dans les paramètres de l’API Clipchamp)
  • En utilisant la sortie « blob »
    • kind – « blob »
    • data – le tableau de tout onVideoCreated ce qui en a résulté

onVideoCreated(blob [,done [,fail [,notify]]]): function

onVideoCreated est appelé si la sortie est paramétrée en blob et que le blob vidéo en sortie sera passé comme premier paramètre. Le blob est valide jusqu’à ce que cette fonctionnalité termine le traitement, ce qui est déterminé en utilisant l’un des trois cas suivants :

  1. Si la signature de la fonctionnalité contient au moins un paramètre exécuté et si un rappel exécuté ou échoué est appelé.
  2. Si une promesse (ou un ‘thenable’) est retournée, attendre qu’elle soit résolue ou rejetée.
  3. Si la fonctionnalité retourne quelque chose d’autre qu’une promesse, et ne spécifie pas au moins un paramètre de retour exécuté, le traitement sera immédiatement considéré comme terminé en retour.

Jusqu’à ce la fonctionnalité termine le traitement, le fichier de sortie est considéré comme « being uploaded ». Si une promesse capable de rapports de progression est retournée (c.-à-d. où la fonctionnalité subséquente accepte un troisième rappel), ou si le rappel notifié est utilisé, une progression numérique sera interprétée sous la forme d’un poucentage de téléchargement et il sera affiché tel quel à l’écran. Après la fin du traitement (tel que déterminé ci-dessus), le blob ne peut plus être utilisé de façon fiable car le magasin de stockage peut avoir été déplacé.

onErrorOccurred(error): function

onErrorOccurred est appelé quand une erreur a été détectée pendant l’enregistrement, le traitement ou le téléchargement d’une vidéo ou d’un enregistrement de webcam / caméra. Le paramètre error est un objet avec une propriété obligatoire type, qui peut être l’une des suivantes :

  • webcam_processing, quand l’erreur est survenue au cours d’un enregistrement de webcam (ou de caméra de téléphone);
  • video_processing, quand l’erreur est survenue pendantqu’une vidéo en entrée ou un enregistrement de webcam / caméra était traité (transcodé / compressé) avant le téléchargement de la vidéo;
  • video_uploading, quand l’erreur est survenue quand le fichier traité de la vidéo en sortie était en cours de téléchargement vers son emplacement de stockage sélectionné;
  • other_unknown, quand la cause de l’erreur est quelque chose d’autre, voire même inconnue;

Une seconde propriété (optionnelle) message représente une explication consultable de l’erreur. Vous pouvez utiliser la valeur de string de la propriété message pour afficher un message d’erreur à vos utilisateurs. Une propriété optionnelle details est un tableau qui contient des informations techniques supplémentaires à propos de l’erreur, telles que des exceptions, des évènements d’erreur et ainsi de suite. Utiliser la valeur de la propriété details pour communiquer les problèmes au support de Clipchamp. Le rappel onErrorOccurred peut occasionnellement être rappelé à de multiples reprises pour la même cause. Veuillez noter que l’API Clipchamp possède les dispositions pour compenser certains des incidents qui sont rapportés dans le rappel onErrorOccurred. Par exemple, l’indicateur no-probe-reject (voir l’activation de paramètre) garantira qu’un fichier vidéo passe par le moteur de transcodage même si nous n’avons pas pu extraire les métadonnées techniques de ce fichier.

localization: object

Default value: undefined

Une liste des strings qui sont disponibles pour la localisation. À utiliser pour ajuster tous les éléments dédiés à l’utilisateur de l’API qui apparaissent dans la langue de votre site web si différente de l’anglais. Vous pouvez également utiliser ces strings pour effacer les snippets de texte dont vous ne voulez pas du tout qu’ils soient affichés à vos utilisateurs.