Muestra de Brightcove Player: Complemento de superposición de logotipo

En este tema, aprenderá a crear un complemento de superposición de logotipo que utilice el complemento de superposición estándar para mostrar una superposición de logotipo para videos, con una URL de clic opcional. Si planea utilizar el complemento con una implementación de iframe del reproductor, no puede utilizar la URL de destino, ya que la nueva página solo se abrirá en el iframe.

Ejemplo de jugador

El complemento se puede utilizar para mostrar cualquier superposición de imágenes lista para la web en la parte superior del reproductor. Puede controlar la visualización del mensaje en función de:

  • Ubicación: la imagen se puede mostrar en diferentes ubicaciones sobre el reproductor
  • Eventos de jugadores play, como eventos personalizados pause o
  • Intervalo de tiempo: en un momento específico durante la reproducción de vídeo

En el siguiente ejemplo, verá un logotipo en la parte inferior izquierda del reproductor. A los cinco segundos del video, el logotipo se desvanecerá lentamente.

Ver la pluma Complemento de superposición de logotipo por Brightcove Learning Services (@bcls ) 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.

Recursos de API/plugins utilizados

Métodos API Eventos API Complementos de Brightcove Player
off () actualización de tiempo Superposición de pantalla
sobre()    
Hora actual ()    

Configuración de reproductor/HTML

En esta sección se detalla cualquier configuración especial necesaria durante la creación del reproductor. Además, se describen otros elementos HTML que deben agregarse a la página, más allá del código de implementación del reproductor de incrustación de la página.

Configuración del reproductor

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

Otros HTML

La Complemento de superposición de pantalla El archivo JavaScript está vinculado a la página mediante un <script> etiqueta. Tenga en cuenta que el CSS para el Complemento de superposición de pantalla NO está vinculado a la página. Se utiliza CSS personalizado en la página para facilitar los cambios.

Flujo de aplicaciones

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

  • Se define una función que elimina la imagen superpuesta en el momento adecuado.
  • Se define una función que muestra la imagen superpuesta en el momento adecuado.
  • Las opciones de configuración personalizadas se combinan con las opciones predeterminadas. Las opciones predeterminadas solo se utilizan si no se proporciona una opción personalizada.
  • Se llama a la función que muestra la imagen superpuesta.

Quitar superposición

Busque el código etiquetado:

// ### Remove overlay ###

Esta función se llama cuando se muestra inicialmente la imagen superpuesta. La lógica de la función comprueba cuándo debe eliminarse la imagen superpuesta, incluso si se ha establecido un tiempo de caducidad. También el timeupdate Se elimina el detector de eventos.

Agregar superposición

Busque el código etiquetado:

// ### Add overlay function ###

El complemento de superposición se llama aquí utilizando los ajustes de configuración del usuario. La configuración determina qué se debe mostrar, dónde se muestra y durante cuánto tiempo. La timeupdate El detector de eventos se agrega para verificar el tiempo de vencimiento.

Construye un overlayOptions objeto

Busque el código etiquetado:

// ### Call function to merge default options with passed in options ###

Tanto las opciones de configuración personalizadas como las opciones predeterminadas se pasan a una función. La función usa las opciones predeterminadas solo si no se pasa una opción personalizada correspondiente.

Llama a showoverlay método

Busque el código etiquetado:

// ### Show overlay ###

Se llama a la función que muestra la imagen superpuesta. Dependiendo de las opciones, la imagen puede mostrarse inmediatamente o más tarde.

Estilismo de aplicaciones

El CSS extenso define cómo debe verse la imagen superpuesta, así como dónde se muestra la imagen. El CSS predeterminado para Complemento de superposición de pantalla NO se utiliza para facilitar la personalización de CSS.

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: logo-overlay.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. En el caso de este complemento, lo más probable es que las opciones se pasen al complemento, en la forma:

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
    }
  )
});