Exemple de lecteur
Le plugin peut être utilisé pour afficher n'importe quelle superposition d'image prête pour le Web sur le dessus du lecteur. Vous pouvez contrôler l'affichage du message en fonction:
- Emplacement - l'image peut être affichée à différents endroits sur le lecteur
- Événements des joueurs - tels
playquepausedes événements personnalisés - Intervalle de temps - à une heure spécifiée pendant la lecture vidéo
Dans l'exemple suivant, vous voyez un logo affiché dans le coin inférieur gauche du lecteur. Au bout de cinq secondes dans la vidéo, le logo disparaîtra lentement.
Voir le stylo Plugin de superposition de logo par Brightcove Learning Services (@bcls ) 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 :
- 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 | Événements API | Plugins de lecteur Brightcove |
|---|---|---|
| désactivé () | mise à jour | Superposition d'affichage |
| au() | ||
| Heure actuelle () |
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
le Plug-in de superposition d'affichage Le fichier JavaScript est lié à la page à l'aide d'un <script> marque. Notez que le CSS pour le Plug-in de superposition d'affichage n'est PAS lié à la page. Le CSS personnalisé est utilisé dans la page pour faciliter les modifications.
Flux d'application
La logique de base derrière cette application est la suivante :
- Une fonction est définie qui supprime l'image de superposition au bon moment.
- Une fonction est définie qui affiche l'image de superposition au bon moment.
- Les options de configuration personnalisées sont fusionnées avec les options par défaut. Les options par défaut ne sont utilisées que si une option personnalisée n'est pas fournie.
- La fonction est appelée qui affiche l'image de superposition.
Supprimer la superposition
Trouvez le code étiqueté :
// ### Remove overlay ###
Cette fonction est appelée lorsque l'image de superposition est initialement affichée. La logique de la fonction vérifie quand l'image de superposition doit être supprimée, y compris si une heure d'expiration a été définie. Également timeupdate l'écouteur d'événements est supprimé.
Ajouter une superposition
Trouvez le code étiqueté :
// ### Add overlay function ###
Le plugin Overlay est appelé ici en utilisant les paramètres de configuration utilisateur. Les paramètres déterminent ce qui doit être affiché, son emplacement et sa durée. le timeupdate un écouteur d'événement est ajouté pour vérifier une heure d'expiration.
Construire un overlayOptions objet
Trouvez le code étiqueté :
// ### Call function to merge default options with passed in options ###
Les options de configuration personnalisées et les options par défaut sont transmises à une fonction. La fonction utilise les options par défaut uniquement si une option personnalisée correspondante n'est pas transmise.
Appeler le showoverlay méthode
Trouvez le code étiqueté :
// ### Show overlay ###
La fonction qui affiche l'image de superposition est appelée. Selon les options, l'image peut être affichée immédiatement ou ultérieurement.
Style d'application
Le long CSS définit à quoi doit ressembler l'image de superposition, ainsi que l'endroit où l'image est affichée. Le CSS par défaut pour le Plug-in de superposition d'affichage n'est PAS utilisé pour faciliter la personnalisation CSS.
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: logo-overlay.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. Dans le cas de ce plugin, les options seront très probablement transmises au plugin, sous la forme:
videojs.getPlayer('myPlayerID').ready(function() {
var myPlayer = this;
myPlayer.logoOverlay(
{
'align': 'bottom-left',
'imageURL' : 'https://solutions.brightcove.com/bcls/brightcove-player/logo-overlay/bc-logo.png',
'clickThruURL': 'https://support.brightcove.com/',
'start': 'loadstart',
'end': 5
}
)
});