Exemple de joueur Brightcove : Barre de marqueurs de chapitre en cours

Dans cette rubrique, vous apprendrez à ajouter des marqueurs dans la barre de progression pour afficher les chapitres définis.

Exemple de lecteur

Après avoir démarré la lecture de la vidéo, vous verrez des marqueurs bleus dans la barre de progression qui indiquent les emplacements des chapitres définis dans la vidéo. Vous pouvez utiliser l'icône des chapitres pour accéder aux chapitres et confirmer les emplacements.

Voir le stylo Marqueurs de chapitre dans la barre de progression par Brightcove Learning Services ( rcrooks1969 ) sur CodePen.

Code source

Voir le solution complète sur GitHub.

Utilisation du CodePen

Voici quelques conseils pour utiliser efficacement le CodePen ci-dessus :

  • Basculez l'affichage réel du joueur en cliquant sur le Result bouton.
  • Cliquez sur les HTML/CSS/JS boutons pour afficher L'UN des types de code.
  • Plus loin dans ce document, la logique, le flux et le style utilisés dans l'application seront discutés dans la configuration Plateur/HTML, le flux d'application et le style de l'application. sections. La meilleure façon de suivre les informations contenues dans ces sections est de :
    1. Cliquez sur le EDIT ON CODEPEN bouton dans le CodePen et ayez le code disponible dans un onglet navigateur/navigateur.
    2. Dans CodePen, réglez le code que vous souhaitez afficher. Vous pouvez modifier la largeur de différentes sections de code dans CodePen.
    3. Voir le Configuration du lecteur/HTML , Flux de candidature et/ou Style d'application sections dans un autre navigateur/onglet de navigateur. Vous pourrez maintenant suivre les explications du code et en même temps afficher le code.

Séquence de développement

Voici la séquence de développement recommandée :

  1. Utilisez l'implémentation du lecteur intégré In-Page pour tester les fonctionnalités de votre lecteur, de votre plugin et de votre CSS (si CSS est nécessaire)
  2. Placez le JavaScript et le CSS du plugin dans des fichiers séparés pour des tests locaux
  3. Déployez le code du plugin et le CSS sur votre serveur une fois que vous avez corrigé des erreurs.
  4. Utilisez Studio pour ajouter le plugin et le CSS à votre lecteur
  5. Remplacez l'implémentation du lecteur intégré dans la page si vous déterminez que l'implémentation iframe est mieux adaptée (détaillée dans la section suivante)

Pour plus de détails sur ces étapes, consultez la section étape par étape : Guide de développement de plug-ins.

Intégrer iFrame ou In-Page

Lorsque vous développez des améliorations pour Brightcove Player, vous devrez décider si le code convient le mieux à l'implémentation intégrée iframe ou In-Page. La recommandation des meilleures pratiques consiste à créer un plugin à utiliser avec une implémentation iframe. Les avantages de l'utilisation du lecteur iframe sont les suivants :

  • Aucune collision avec JavaScript et/ou CSS existants
  • Réactif automatiquement
  • L'iframe facilite l'utilisation dans les applications de médias sociaux (ou lorsque la vidéo devra « voyager » dans d'autres applications)

Bien que l'intégration du lecteur d'intégration dans la page puisse être plus complexe, il y a des moments où vous planifiez votre code autour de cette implémentation. Pour généraliser, cette approche est préférable lorsque la page contenante doit communiquer avec le lecteur. En particulier, voici quelques exemples :

  • Le code dans la page contenant doit écouter et agir sur les événements du joueur
  • Le lecteur utilise des styles de la page contenante
  • L'iframe entraînera l'échec de la logique de l'application, comme une redirection à partir de la page contenant

Même si votre implémentation finale n'utilise pas le code iframe, vous pouvez toujours utiliser le code intégré In-Page avec un plugin pour votre JavaScript et un fichier séparé pour votre CSS. Cela encapsule votre logique afin que vous puissiez facilement l'utiliser sur plusieurs joueurs.

Ressources API/Plugin utilisées

Propriétés de l'API
mediainfo.duration

Configuration du lecteur/HTML

Cette section détaille toute configuration spéciale nécessaire lors de la création du lecteur. En outre, d'autres éléments HTML qui doivent être ajoutés à la page, au-delà du code d'implémentation du lecteur intégré dans la page, sont décrits.

Configuration du lecteur

Aucune configuration spéciale n'est requise pour le lecteur Brightcove que vous créez pour cet exemple.

Autre HTML

Aucun autre élément HTML n'est ajouté à la page.

Flux d'application

La logique de base derrière cette application est la suivante :

  • Extrayez le tableau des points de repère à partir des informations vidéo.
  • Créez un tableau contenant les heures de début de tous les chapitres associés à une vidéo.
  • Appelez une fonction qui fait les marques sur la barre de progression. Vous passerez le tableau des heures de début de chapitre avec la durée de la vidéo.

Récupérer la structure de données contenant des points de repère de chapitre

Trouvez le code étiqueté :

// ### Use the array filter function to retrieve data structure that contains chapter cue points ###

Vous devez extraire les données des informations vidéo qui contiennent les points de repère (agissant comme des chapitres). Vous devez utiliser la fonction de tableau JavaScript filter. Puisque nous n'avons pas de tableau avec lequel nous interagissons, utilisez simplement un tableau vide. D'où le code [].filter. Pour plus d'informations, voir Array.prototype.filter ().

Extraire les heures de début de chapitre et les stocker dans un tableau

Trouvez le code étiqueté :

// ### Loop over chapter cue points and get start time of each ###

C'est un code assez simple pour boucler sur le tableau de points de repère et placer chaque point de repère startTime dans un tableau.

Placez des marques sur la barre de progression

Trouvez le code étiqueté :

// ### Call function to create marks in progressbar ###

Vous appelez la méthode pour placer les marques sur la barre de progression. Vous passez le tableau des heures de début du chapitre et la durée de la vidéo. Dans la fonction, vous obtenez d'abord une référence à l'élément de barre de progression à l'aide de JavaScript document.getElementsByClassName() méthode. Ensuite, vous bouclez sur le tableau de points de repère, et pour chaque point de repère, créez dynamiquement un div, calculez un pourcentage de l'endroit où il devrait être placé sur la barre de progression, puis utilisez JavaScript. appendChild() méthode pour placer la marque sur la barre de progression.

Style d'application

CSS est utilisé pour contrôler l'apparence des marqueurs de chapitre:

.vjs-marker {
  position: absolute;
  opacity: 1;
  height: 100%;
  background-color: blue;
  width: 4px;
}

Code du plug-in

Normalement, lors de la conversion du JavaScript en plugin Brightcove Player, des modifications nominales sont nécessaires. Une modification requise consiste à remplacer l'utilisation standard de la ready() méthode par le code qui définit un plugin.

Voici le code de début de JavaScript très couramment utilisé qui fonctionnera avec le lecteur :

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  ...
});

Vous allez modifier la première ligne pour utiliser la syntaxe standard pour démarrer un plugin Brightcove Player :

videojs.registerPlugin('pluginName', function(options) {
  var myPlayer = this;
  ...
});

Comme mentionné précédemment, vous pouvez voir le code JavaScript du plugin dans le référentiel GitHub correspondant de ce document: Chapter-markers.js.

Utilisation du plugin avec un lecteur

Une fois que les fichiers CSS et JavaScript du plugin sont stockés dans un emplacement accessible à Internet, vous pouvez utiliser le plugin avec un lecteur. Dans les studios JOUEURS module, vous pouvez choisir un joueur, puis dans le PLUGINS section ajouter les URL aux fichiers CSS et JavaScript, et également ajouter le Nom et Options , si des options sont nécessaires.