Muestra de Brightcove Player: Paginación de la API de reproducción

En este tema, aprenderá a implementar la paginación de listas de reproducción al recuperar datos de la API de reproducción.

Limitaciones

Ejemplo de jugador

Este ejemplo usa un Brightcove Player para mostrar un video en el reproductor junto con los primeros 3 videos de la lista de reproducción. Selecciona el Vídeos siguientes para mostrar los siguientes 3 videos en la lista de reproducción. Cuando llegue al último conjunto de videos en la lista de reproducción, los videos que se muestran se sitúan al principio de la lista de reproducción.

Ver la pluma 18171-reproducción-api-paginación por Brightcove Learning Services ( bcls1969 ) en CodePen.

Código fuente

Ver el solución completa en GitHub.

API de reproducción

Este ejemplo utiliza la API de reproducción para devolver videos de una lista de reproducción específica. Para desplazarse por los videos de la lista de reproducción, este ejemplo utiliza los siguientes parámetros de URL de solicitud:

  • limit- define la cantidad de videos que se devolverán desde la API de reproducción
  • offset: establece la cantidad de videos que se omitirán en una lista de reproducción desde la API de reproducción

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 Descripción
Catalog.getVideo () Método para realizar una solicitud de catálogo para el video con la identificación especificada e invoca una devolución de llamada cuando se completa la solicitud.
catalog.load () Método para cargar un video en el reproductor.
lista de reproducción () Método para asignar una serie de objetos de video a la lista de reproducción de un jugador. Tenga en cuenta que este método también se puede utilizar para recuperar la lista de reproducción que se está reproduciendo actualmente en el reproductor, pero no se utilizará de esta forma en este documento.

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

  • En Video Cloud Studio, navegue hasta el Jugadores módulo y luego Ajustes sección. Selecciona el Editar y haga lo siguiente:
    • Selecciona el Mostrar lista de reproducción opción a Activado.
    • Selecciona el Dimensionamiento opción a Sensible.
    • Configure las Dimensiones del reproductor para que se ajusten a su página web.

Otros HTML

Agrega un Vídeos siguientes para obtener el siguiente conjunto de 3 videos en la lista de reproducción.

Opcional: Agregue un contenedor para mostrar la URL de solicitud de la API de reproducción actual.

Flujo de aplicaciones

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

  • Cargue el primer conjunto de videos.
  • Botón Escuchar vídeos siguientes
  • Crear URL de solicitud.
  • Obtenga el siguiente conjunto de datos de video.
  • Carga la lista de reproducción actual en el reproductor.

Cargar el primer conjunto de videos

Busque el código etiquetado:

    // +++ Load first set of videos +++

Utilizar el catalog library para obtener el objeto de lista de reproducción para el ID de lista de reproducción especificado. Cargue este primer conjunto de videos en el reproductor.

Botón Escuchar vídeos siguientes

Busque el código etiquetado:

    // +++ Listen for Next Videos button +++

Agregue un detector de eventos para cargar el siguiente conjunto de videos en la lista de reproducción.

Crear URL de solicitud

Busque el código etiquetado:

    // +++ Create request URL +++

Cree la URL de solicitud de la API de reproducción con el limit y offset parámetros.

Obtener datos de video

Busque el código etiquetado:

    // +++ Get video data +++

Llama a la API de reproducción para obtener el siguiente conjunto de vídeos de la lista de reproducción.

Cargar datos de video

Busque el código etiquetado:

    // +++ Load video data +++

Llama a la API de reproducción para obtener el siguiente conjunto de vídeos de la lista de reproducción. Cargue el primer video en el reproductor. Cargue los videos de la matriz en la lista de reproducción del reproductor.

Estilismo de aplicaciones

El CSS aplica estilo al reproductor y a la lista de reproducción horizontal debajo del reproductor.

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: reproducción-paginación.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.