在 ads_manager.js
中,為 IMA SDK StreamManager 定義包裝函式類別,以便發出串流要求、取得廣告連播資訊清單、監聽 IMA 串流事件,並將 emsg 事件傳遞至 IMA SDK。
在 ads_manager.js
中,IMA HbbTV 範例應用程式會設定下列方法:
requestStream()
onStreamEvent()
onEmsgEvent()
loadAdPodManifest()
初始化廣告管理工具
初始化廣告管理員類別,並為 IMA 串流事件設定事件監聽器。在這個呼叫中,請使用 VideoPlayer.setEmsgEventHandler()
方法設定 emsg 事件處理常式。
/** * Wraps IMA SDK ad stream manager. * @param {!VideoPlayer} videoPlayer Reference an instance of the wrapper from * video_player.js. */ var AdManager = function(videoPlayer) { this.streamData = null; this.videoPlayer = videoPlayer; // Ad UI is not supported for HBBTV, so no 'adUiElement' is passed in the // StreamManager constructor. this.streamManager = new google.ima.dai.api.StreamManager( this.videoPlayer.videoElement); this.streamManager.addEventListener( [ google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED, google.ima.dai.api.StreamEvent.Type.ERROR, google.ima.dai.api.StreamEvent.Type.CLICK, google.ima.dai.api.StreamEvent.Type.STARTED, google.ima.dai.api.StreamEvent.Type.FIRST_QUARTILE, google.ima.dai.api.StreamEvent.Type.MIDPOINT, google.ima.dai.api.StreamEvent.Type.THIRD_QUARTILE, google.ima.dai.api.StreamEvent.Type.COMPLETE, google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED, google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED, google.ima.dai.api.StreamEvent.Type.AD_PROGRESS, google.ima.dai.api.StreamEvent.Type.PAUSED, google.ima.dai.api.StreamEvent.Type.RESUMED ], this.onStreamEvent.bind(this), false); this.videoPlayer.setEmsgEventHandler(this.onEmsgEvent, this); };
要求廣告連播串流
建立 AdManager.requestStream()
方法,以便使用 Google Ad Manager 聯播網代碼和串流的自訂資產鍵建立 PodStreamRequest
物件。使用 IMA 範例 DASH 廣告連播放送串流,搭配下列串流參數測試 HbbTV 應用程式:
- 聯播網代碼:
'21775744923'
- 自訂素材資源鍵:
'hbbtv-dash'
/** * Makes a pod stream request. * @param {string} networkCode The network code. * @param {string} customAssetKey The custom asset key. */ AdManager.prototype.requestStream = function(networkCode, customAssetKey) { var streamRequest = new google.ima.dai.api.PodStreamRequest(); streamRequest.networkCode = networkCode; streamRequest.customAssetKey = customAssetKey; streamRequest.format = 'dash'; debugView.log('AdsManager: make PodStreamRequest'); this.streamManager.requestStream(streamRequest); };
監聽廣告串流事件
建立 AdManager.onStreamEvent()
方法,以便處理應用程式對 IMA 串流事件 STREAM_INITIALIZED
、AD_BREAK_STARTED
和 AD_BREAK_ENDED
的回應。
/** * Handles IMA playback events. * @param {!Event} event The event object. */ AdManager.prototype.onStreamEvent = function(event) { switch (event.type) { // Once the stream response data is received, generate pod manifest url // for the video stream. case google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED: debugView.log('IMA SDK: stream initialized'); this.streamData = event.getStreamData(); break; case google.ima.dai.api.StreamEvent.Type.ERROR: break; // Hide video controls while ad is playing. case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED: debugView.log('IMA SDK: ad break started'); this.adPlaying = true; this.adBreakStarted = true; break; // Show video controls when ad ends. case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED: debugView.log('IMA SDK: ad break ended'); this.adPlaying = false; this.adBreakStarted = false; break; // Update ad countdown timers. case google.ima.dai.api.StreamEvent.Type.AD_PROGRESS: break; default: debugView.log('IMA SDK: ' + event.type); break; } };
處理廣告串流中繼資料
如要將 emsg 事件資訊傳遞至 IMA,請使用 StreamManager.processMetadata()
方法建立 AdManager.onEmsgEvent()
方法。影片播放器類別會使用 VideoPlayer.setEmsgEventHandler()
方法呼叫這個方法。
/** * Callback on Emsg event. * Instructs IMA SDK to fire back VAST events accordingly. * @param {!Event} event The event object. */ AdManager.prototype.onEmsgEvent = function(event) { var data = event.event.messageData; var pts = event.event.calculatedPresentationTime; if ((data instanceof Uint8Array) && data.byteLength > 0) { this.streamManager.processMetadata('ID3', data, pts); } };
載入廣告連播資訊清單
建立 AdManager.loadAdPodManifest()
方法,以便透過影片播放器預先載入廣告連播資訊清單。使用方法:DASH 子集資訊清單中的結構,建構資訊清單網址。
/** * Creates DAI pod url and instructs video player to load manifest. * @param {string} networkCode The network code. * @param {string} customAssetKey The custom asset key. * @param {number} podDuration The duration of the ad pod. */ AdManager.prototype.loadAdPodManifest = function(networkCode, customAssetKey, podDuration) { if (!this.streamData) { debugView.log('IMA SDK: No DAI pod session registered.'); return; } var MANIFEST_BASE_URL = 'https://dai.google.com/linear/pods/v1/dash/network/'; // Method: DASH pod manifest reference docs: // https://developers.google.com/ad-manager/dynamic-ad-insertion/api/pod-serving/reference/live#method_dash_pod_manifest var manifestUrl = MANIFEST_BASE_URL + networkCode + '/custom_asset/' + customAssetKey + '/stream/' + this.streamData.streamId + '/pod/' + this.getPodId() + '/manifest.mpd?pd=' + podDuration; this.videoPlayer.preload(manifestUrl); };
HbbTV 範例應用程式會使用隨機產生的不重複 podId
。在正式版應用程式中,podId
是一個從 1 開始的整數,每個廣告插播都會遞增 1。請確認所有廣告插播的觀眾都會看到相同的 podId
值。如要取得 podId
,建議您使用 Early ad break notifications (EABN) API。在實際環境中,請在 HbbTV 串流事件 AD_BREAK_ANNOUNCE
中加入 podId
和 podDuration
。
接下來,請為 HbbTV 應用程式建立主要應用程式類別,以便與 HbbTV 廣播互動。