Exemple de joueur Brightcove : Message d'erreur personnalisé en direct

Dans cette rubrique, vous apprendrez à afficher une image de superposition personnalisée lorsqu'un utilisateur tente de lire un flux vidéo en direct qui n'est pas disponible.

Exemple de lecteur

Le joueur ne pourra pas se connecter au flux en direct. Un objet ModalDialog est créé, une image personnalisée y est placée, puis le ModalDialog s'affiche. Si le ModalDialog est fermé, l'erreur par défaut est affichée.

Voir le stylo 18199-message-d'erreur-personnalisé-en direct 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

Méthodes API Événements API Propriétés de l'API
addChild () erreur player.error (). code
au() fermeture modale    
durée ()    
player.errorDisplay.hide ()    
player.errorDisplay.show ()    

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 :

  • Créez une instance d'un ModalDialog et placez une image personnalisée à l'intérieur.
  • Écoutez une erreur, et s'il s'agit du type d'erreur correct, affichez le ModalDialog personnalisé.
  • Si le spectateur de la vidéo choisit de fermer le ModalDialog personnalisé, affichez le message d'erreur par défaut.

Créer un HTML div élément

Trouvez le code étiqueté :

// ### Create a div in which to place HTML content and place image inside ###

Vous créez un HTML div et placez-y une image que vous souhaitez afficher si le flux en direct ne fonctionne pas.

Construisez un objet dans lequel le HTML div l'élément sera placé

Trouvez le code étiqueté :

  // ### Define options object to be used for modal content ###

Cela est nécessaire lorsque vous créez le ModalDialog.

Créez le ModalDialog et placez l'image comme son contenu

Trouvez le code étiqueté :

// ### Create Modal with options object ###

Il s'agit d'un code standard pour créer une instance ModalDialog et l'ajouter au lecteur. Par défaut, il n'est PAS affiché.

Écoutez une erreur à envoyer

Trouvez le code étiqueté :

// ### Listen for an error event ###

Lorsqu'une erreur est envoyée, obtenez le code d'erreur et la durée.

Vérifiez le type d'erreur

Trouvez le code étiqueté :

  // ### Check if the error code and duration mean no video has loaded ###

Pour vérifier si un flux en direct n'est pas en cours de lecture, utilisez les éléments suivants:

if (((errNo == "4" && durée == 0) || (errNo == "4" &&
Number.isNaN (durée)))) {
  // Masquer l'affichage des erreurs
  myPlayer.errorDisplay.hide ();
  // Si les conditions sont remplies, afficher le modal personnalisé
  myModal.open ();
}

Le contrôle de l'état errNo == "4" && duration == 0 fonctionne pour Chrome et Firefox. Le deuxième contrôle de condition errNo == "4" && Number.isNaN(duration) est nécessaire pour Safari et les navigateurs sur Android.

L'erreur d'affichage par défaut est personnalisée.

Trouvez le code étiqueté :

// ### If custom modal error closed, show the default error ###

Cela n'est fait que si vous souhaitez implémenter ce comportement. Écoutez simplement le modalclose event et dans son gestionnaire d'événements afficher l'erreur par défaut.

Style d'application

Le seul CSS dimensionne simplement 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: liveCustomError.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.