Contraintes
Exemple de lecteur
Cet exemple utilise un Brightcove Player pour afficher une vidéo dans le lecteur avec les 3 premières vidéos de la playlist. Sélectionnez le Vidéos suivantes pour afficher les 3 prochaines vidéos de la playlist. Lorsque vous atteignez le dernier ensemble de vidéos de la playlist, les vidéos affichées reviennent au début de la playlist.
Voir le stylo 18171-lecture-api-pagination par Brightcove Learning Services ( bcls1969 ) sur CodePen.
Code source
Voir le solution complète sur GitHub.
API de lecture
Cet exemple utilise l'API Playback pour renvoyer les vidéos d'une playlist spécifiée. Pour parcourir les vidéos de la playlist, cet exemple utilise les paramètres d'URL de demande suivants:
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 :
- Cliquez sur le EDIT ON CODEPEN bouton dans le CodePen et ayez le code disponible dans un onglet navigateur/navigateur.
- Dans CodePen, réglez le code que vous souhaitez afficher. Vous pouvez modifier la largeur de différentes sections de code dans CodePen.
- 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 :
- 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)
- Placez le JavaScript et le CSS du plugin dans des fichiers séparés pour des tests locaux
- Déployez le code du plugin et le CSS sur votre serveur une fois que vous avez corrigé des erreurs.
- Utilisez Studio pour ajouter le plugin et le CSS à votre lecteur
- 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
| Méthodes API | Description |
|---|---|
| Catalog.getVideo () | Méthode pour effectuer une demande de catalogue pour la vidéo avec l'ID spécifié et invoque un rappel lorsque la demande se termine. |
| catalog.load () | Méthode pour charger une vidéo dans le lecteur. |
| playlist () | Méthode pour affecter un tableau d'objets vidéo à la liste de lecture d'un lecteur. Notez que cette méthode peut également être utilisée pour récupérer la playlist en cours de lecture dans le lecteur, mais ne sera pas utilisée de cette manière dans ce document. |
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
- Dans Video Cloud Studio, accédez au Joueurs module puis Réglages section. Sélectionnez le Éditer et procédez comme suit:
- Met le Afficher la liste de lecture option pour Activée.
- Met le Dimensionnement possibilité de Sensible.
- Définissez les dimensions du lecteur en fonction de votre page Web.
Autre HTML
Ajouter un Vidéos suivantes pour obtenir la prochaine série de 3 vidéos dans la playlist.
Optionnel: Ajoutez un conteneur pour afficher l'URL actuelle de la requête de l'API Playback.
Flux d'application
La logique de base derrière cette application est la suivante :
- Chargez la première série de vidéos.
- Bouton Écouter les vidéos suivantes
- Créez une URL de demande.
- Obtenez le prochain ensemble de données vidéo.
- Chargez la liste de lecture actuelle dans le lecteur.
Charger la première série de vidéos
Trouvez le code étiqueté :
// +++ Load first set of videos +++
Utilisez le catalog library pour obtenir l'objet playlist pour l'ID de playlist spécifié. Chargez cette première série de vidéos dans le lecteur.
Bouton Écouter les vidéos suivantes
Trouvez le code étiqueté :
// +++ Listen for Next Videos button +++
Ajoutez un écouteur d'événements pour charger la prochaine série de vidéos dans la playlist.
Créer une URL de demande
Trouvez le code étiqueté :
// +++ Create request URL +++
Créez l'URL de requête de l'API Playback à l'aide du limit et offset paramètres.
Obtenez des données vidéo
Trouvez le code étiqueté :
// +++ Get video data +++
Appelez l'API de lecture pour obtenir le prochain ensemble de vidéos dans la liste de lecture.
Charger les données vidéo
Trouvez le code étiqueté :
// +++ Load video data +++
Appelez l'API de lecture pour obtenir le prochain ensemble de vidéos dans la liste de lecture. Chargez la première vidéo dans le lecteur. Chargez les vidéos du tableau dans la playlist du lecteur.
Style d'application
Le CSS stylise le lecteur et la liste de lecture horizontale sous le lecteur.
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: playback-paging.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.