概述:頁內體驗用戶端 API

本主題概述了頁內體驗客戶端API。如果您正在尋找用於創建和管理頁內體驗的平台API,請參見概述:頁內體驗API

簡介

頁面內體驗用戶端 API 是一個 JavaScript 程式庫,可協助您在執行階段管理頁面內體驗的行為,類似 Brightcove 播放程式 API 用來控制播放程式行為的方式。此 API 可在執行一或多個 Brightcove 嵌入式體驗的任何頁面上提供。它旨在幫助Brightcove的第三方體驗集成。提供對當前播放器,視頻和狀態信息以及與播放有關的事件的偵聽器的訪問。

查看完整API參考有關可用方法和事件的詳細信息。

入門。

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

引用經驗的最簡單方法是給它一個id(在裡面div標籤)。的id可以是任何您喜歡的東西,只要它在頁面中是唯一的即可,但是由於體驗ID本身存在於腳本的URL中(請參見上面代碼中突出顯示的部分),您最好使用:

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

現在您已經準備好參考JavaScript的經驗。請記住,經驗是在iframe,因此您無法通過父頁面中的腳本輕鬆地與之通信。相反,您需要將腳本放置在自定義HTML塊在體驗本身。

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

一旦參考了經驗,就可以從API調用方法。請注意,所有方法都在子級上clientApi目的:

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