soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Resumen: API de cliente de experiencia en página

    En este tema se proporciona una descripción general de la API de cliente de experiencia en página. Si está buscando la API de plataforma para crear y administrar experiencias en página, consulte Descripción general: API de experiencia en página.

    Introducción

    La API de cliente de experiencias en página es una biblioteca JavaScript que le ayuda a administrar el comportamiento de la experiencia en página en tiempo de ejecución, similar a la forma en que se utiliza la API de Brightcove Player para controlar el comportamiento del reproductor. La API está disponible en cualquier página que ejecute una o más experiencias integradas de Brightcove. Está diseñado para ayudar a terceros con la integración de experiencias de Brightcove. Proporciona acceso a la información actual del reproductor, los vídeos y el estado, así como a los oyentes para eventos relacionados con la reproducción.

    Consulte la referencia completa de la API para obtener detalles de los métodos y eventos disponibles.

    Empezando.

    <div data-experience="5bb2134180b4990011750f06"></div>
    <script src="https://players.brightcove.net/1752604059001/experience_5bb2134180b4990011750f06/live.js"></script>

    La forma más fácil de obtener una referencia a la experiencia es darle un id (en la div etiqueta). El id puede ser cualquier cosa que desee siempre y cuando sea único dentro de la página, pero dado que el identificador de experiencia en sí está allí en la URL del script (vea la parte resaltada del código anterior), también podría usar eso:

    <div data-experience="5bb2134180b4990011750f06" id="experience_5bb2134180b4990011750f06"></div>
    <script src="https://players.brightcove.net/1752604059001/experience_5bb2134180b4990011750f06/live.js"></script>

    Ahora está listo para obtener una referencia a la experiencia en JavaScript. Recuerde que la experiencia se implementa en un iframe, por lo que no puede comunicarse fácilmente con él desde un script en la página principal. En su lugar, debe colocar su script en un bloque HTML personalizado en la propia experiencia.

    var experience = window.top.bcov.gal.getEmbed('experience_5bb2134180b4990011750f06');

    Una vez que tenga una referencia a la experiencia, puede invocar métodos desde la API. Tenga en cuenta que todos los métodos están en el clientApi objeto secundario:

    var experience = window.top.bcov.gal.getEmbed('experience_5bb2134180b4990011750f06'),
    experienceApi,
    video,
    current_video = document.getElementById('current_video'),
    video_paused = document.getElementById('video_paused');
    
    experienceApi = experience.clientApi;
    
    // get initial video
    video = experienceApi.getCurrentVideo();
    current_video.textContent = video.name;
    
    // event listeners
    experienceApi.on('videoChanged', function() {
      video = experienceApi.getCurrentVideo();
      current_video.textContent = video.name;
    });
    
    experienceApi.on('videoStarted', function() {
      video_paused.textContent = 'false';
    });
    
    experienceApi.on('videoPaused', function() {
      video_paused.textContent = 'true';
    });