Muestra de Brightcove Player: Puerta de edad con diálogo modal

En este tema, aprenderá a utilizar Brightcove Player con una ventana modal de puerta de edad simple. El usuario debe certificar su edad haciendo clic en la ventana modal antes de que se reproduzca el video.

Ejemplo de jugador

Este ejemplo usa ModalDialog para cubrir inicialmente al jugador. Cuando el usuario confirma su edad haciendo clic en la ventana modal, se muestran los controles y se reproduce el video. Pruebe la funcionalidad haciendo clic en cualquier lugar de la ventana modal.

Ver la pluma 18193-brightcove-player-sample-age-gate-modaldialog por Brightcove Learning Services ( bcls1969 ) en CodePen.

Código fuente

Ver el solución completa en GitHub.

Uso de CodePen

Estos son algunos consejos para utilizar eficazmente el CodePen anterior:

  • Cambie la visualización real del reproductor haciendo clic en el Result botón.
  • Haga clic en el HTML/CSS/JS botones para mostrar UNO de los tipos de código.
  • Más adelante, en este documento, la lógica, el flujo y el estilo utilizados en la aplicación se analizarán en la configuración de reproductor/HTML, Flujo de aplicaciones y Estilo de la aplicación. secciones. La mejor manera de seguir la información de estas secciones es:
    1. Haga clic en el EDIT ON CODEPEN en el CodePen y tenga el código disponible en un navegador / pestaña del navegador.
    2. En CodePen, ajusta el código que quieres que se muestre. Puede cambiar el ancho de las distintas secciones de código dentro de CodePen.
    3. Ver el Configuración de reproductor / HTML , Flujo de aplicación y / o Estilo de aplicación secciones en otra pestaña del navegador / navegador. Ahora podrá seguir las explicaciones del código y, al mismo tiempo, ver el código.

secuencia de desarrollo

Esta es la secuencia de desarrollo recomendada:

  1. Utilice la implementación del reproductor de incrustación en la página para probar la funcionalidad de su reproductor, complemento y CSS (si es necesario CSS)
  2. Coloque el JavaScript y CSS del plugin en archivos separados para pruebas locales
  3. Implementa el código del plugin y CSS en tu servidor una vez que hayas resuelto cualquier error.
  4. Usa Studio para agregar el plugin y CSS a tu reproductor
  5. Reemplace la implementación del reproductor de incrustación en página si determina que la implementación de iframe se ajusta mejor (se detalla en la siguiente sección)

Para obtener más información sobre estos pasos, consulte la sección Paso a paso: Guía de desarrollo de plugins.

iframe o incrustación en página

Al desarrollar mejoras para Brightcove Player, deberás decidir si el código se ajusta mejor a la implementación de iframe o incrustación en la página. La recomendación de práctica recomendada es crear un complemento para usarlo con una implementación de iframe. Las ventajas de utilizar el reproductor iframe son:

  • Sin colisiones con JavaScript y/o CSS existentes
  • Responde automáticamente
  • El iframe facilita el uso en aplicaciones de redes sociales (o siempre que el vídeo tenga que «viajar» a otras aplicaciones)

Aunque la integración del reproductor de incrustación en la página puede ser más compleja, hay ocasiones en que planificará el código en torno a esa implementación. Para generalizar, este enfoque es mejor cuando la página que contiene necesita comunicarse con el reproductor. En concreto, estos son algunos ejemplos:

  • El código de la página que contiene necesita escuchar y actuar en función de los eventos de los jugadores
  • El reproductor utiliza estilos de la página que lo contiene
  • El iframe hará que la lógica de la aplicación falle, como un redireccionamiento desde la página que contiene

Incluso si tu implementación final no utiliza el código iframe, puedes seguir usando el código de incrustación en la página con un plugin para tu JavaScript y un archivo separado para tu CSS. Esto encapsula tu lógica para que puedas utilizarla fácilmente en varios reproductores.

Algunas ventajas de utilizar el ModalDialog El componente incluye lo siguiente:

  • Cubre todo el reproductor de forma predeterminada
  • Dispone de métodos para abrir y cerrar fácilmente la ventana modal

Recursos de API/plugins utilizados

Métodos API Eventos API Métodos de la API de ModalDialog
Agregar hijo () listo open ()
    sobre()
    close ()

Configuración de reproductor/HTML

No se requiere ninguna configuración especial para el reproductor de Brightcove que crea para este ejemplo.

Flujo de aplicaciones

La lógica básica detrás de esta aplicación es:

  • Muestra ModalDialog con texto en el que se puede hacer clic.
  • Cuando el usuario hace clic en el texto ModalDialog, cierre el ModalDialog e inicie la reproducción de video.

Mostrar texto de ModalDialog

El ModalDialog se muestra tan pronto como se carga el video. El texto de la puerta de edad se define como una opción para ModalDialog.

Configurar el ModalDialog

Busque el código etiquetado:

// +++ Configure the ModalDialog +++

Cree un objeto de opciones y establezca propiedades para el Clase ModalDialog. Para obtener detalles sobre este objeto, consulte la Implementación de ModalDialog documento. Aquí hacemos lo siguiente:

  • Definir el texto de la puerta de edad
  • Establecer el diálogo como temporal para que podamos cerrarlo
  • Ocultar el botón cerrar en el diálogo

Crear instancias y abrir ModalDialog

Busque el código etiquetado:

// +++ Instantiate and open the ModalDialog +++

Cree una instancia del cuadro de diálogo con nuestro texto de puerta de edad, agréguelo al reproductor y abra el cuadro de diálogo.

Escuche el evento de clic en ModalDialog

Busque el código etiquetado:

// +++ Listen for the click event on the ModalDialog +++

Al ModalDialog, agregue un detector de eventos para el click evento. Cuando un usuario selecciona el texto de la puerta de edad, cierre el cuadro de diálogo e inicie la reproducción de video.

Estilismo de aplicaciones

El CSS aplica estilo y posiciona el texto de la puerta de edad dentro del ModalDialog.

Código de plugin

Normalmente, al convertir JavaScript en un complemento de Brightcove Player, se necesitan cambios nominales. Un cambio necesario es reemplazar el uso estándar del ready() método por el código que define un complemento.

Aquí está el código de inicio a JavaScript muy utilizado que funcionará con el reproductor:

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

Cambiarás la primera línea para usar la sintaxis estándar para iniciar un plugin de Brightcove Player:

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

Como se mencionó anteriormente, puede ver el código JavaScript del complemento en el repositorio de GitHub correspondiente de este documento: age-gate-modal.js.

Uso del complemento con un reproductor

Una vez que tengas los archivos CSS y JavaScript del plugin almacenados en una ubicación accesible a Internet, puedes usar el plugin con un reproductor. En Studio's JUGADORES módulo puedes elegir un jugador, luego en el PLUGINS sección agregue las URL a los archivos CSS y JavaScript, y también agregue el Nombre y Opciones , si se necesitan opciones.