為 Web Sender 應用程式新增進階功能

廣告插播

Web Sender SDK 支援特定媒體串流中的廣告插斷和隨播廣告。

如要進一步瞭解廣告插播的運作方式，請參閱「Web Receiver 廣告插播總覽」。

雖然可以在傳送端和接收端指定中斷點，但建議在 Web Receiver 和 Android TV Receiver 上指定中斷點，以確保各平台行為一致。

在網路上，使用 BreakClip 和 Break，在載入指令中指定廣告插播時間點：

let breakClip1 = new BreakClip('bc0');
breakClip1.title = 'Clip title'
breakClip1.posterUrl = 'https://www.some.url';
breakClip1.duration = 60;
breakClip.whenSKippable = 5;

let breakClip2 = ...
let breakClip3 = ...

let break1 = new Break('b0', ['bc0', 'bc1', 'bc2'], 10);

let mediaInfo = new chrome.cast.media.MediaInfo(<contentId>, '<contentType');
...
mediaInfo.breakClips = [breakClip1, breakClip2, breakClip3];
mediaInfo.breaks = [break1];

let request = new chrome.cast.media.LoadRequest(mediaInfo);

cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request)

使用曲目 API

軌道可以是文字 (字幕或隱藏式輔助字幕) 物件，也可以是音訊或影片串流物件。您可以使用 Tracks API 在應用程式中處理這些物件。

Track 物件代表 SDK 中的軌跡。您可以設定軌道並指派專屬 ID，如下所示：

var englishSubtitle = new chrome.cast.media.Track(1, // track ID
  chrome.cast.media.TrackType.TEXT);
englishSubtitle.trackContentId = 'https://some-url/caption_en.vtt';
englishSubtitle.trackContentType = 'text/vtt';
englishSubtitle.subtype = chrome.cast.media.TextTrackType.SUBTITLES;
englishSubtitle.name = 'English Subtitles';
englishSubtitle.language = 'en-US';
englishSubtitle.customData = null;

var frenchSubtitle = new chrome.cast.media.Track(2, // track ID
  chrome.cast.media.TrackType.TEXT);
frenchSubtitle.trackContentId = 'https://some-url/caption_fr.vtt';
frenchSubtitle.trackContentType = 'text/vtt';
frenchSubtitle.subtype = chrome.cast.media.TextTrackType.SUBTITLES;
frenchSubtitle.name = 'French Subtitles';
frenchSubtitle.language = 'fr';
frenchSubtitle.customData = null;

var frenchAudio = new chrome.cast.media.Track(3, // track ID
  chrome.cast.media.TrackType.AUDIO);
frenchAudio.trackContentId = 'trk0001';
frenchAudio.trackContentType = 'audio/mp3';
frenchAudio.subtype = null;
frenchAudio.name = 'French Audio';
frenchAudio.language = 'fr';
frenchAudio.customData = null;

媒體項目可能有多個音軌，例如多個字幕 (每種語言各一個) 或多個替代音訊串流 (每種語言各一個)。

MediaInfo 這個類別會建立媒體項目模型。如要將物件集合 Track 與媒體項目建立關聯，請更新媒體項目的 tracks 屬性。媒體載入接收器前，必須先建立關聯：

var tracks = [englishSubtitle, frenchSubtitle, frenchAudio];
var mediaInfo = new chrome.cast.media.MediaInfo(mediaURL);
mediaInfo.contentType = 'video/mp4';
mediaInfo.metadata = new chrome.cast.media.GenericMediaMetadata();
mediaInfo.customData = null;
mediaInfo.streamType = chrome.cast.media.StreamType.BUFFERED;
mediaInfo.textTrackStyle = new chrome.cast.media.TextTrackStyle();
mediaInfo.duration = null;
mediaInfo.tracks = tracks;

您可以在媒體 activeTrackIds 要求中設定有效軌。

媒體項目載入後，您也可以呼叫 EditTracksInfoRequest(opt_activeTrackIds, opt_textTrackStyle)，並在 opt_activeTrackIds 中傳遞要啟用的曲目 ID，啟用與媒體項目相關聯的一或多個曲目。請注意，這兩個參數都是選用參數，您可以自行選擇要設定的參數 (有效曲目或風格)。舉例來說，以下說明如何啟用法文字幕 (2) 和法文音訊 (3)：

var activeTrackIds = [2, 3];
var tracksInfoRequest = new chrome.cast.media.EditTracksInfoRequest(activeTrackIds);
media.editTracksInfo(tracksInfoRequest, successCallback, errorCallback);

如要從目前的媒體移除所有音訊或視訊軌，只要設定 mediaInfo.tracks=null (空陣列) 並重新載入媒體即可。

如要從目前的媒體移除所有文字軌 (例如關閉字幕)，請執行下列任一操作：

  • 更新先前顯示的 var activeTrackIds = [2, 3];，使其只包含音軌 [3]。
  • 請設定 mediaInfo.tracks=null。請注意，如要關閉文字說明 (track.hidden)，不必重新載入媒體。傳送activeTracksId陣列時，不包含先前啟用的 trackId，即可停用文字軌。

設定文字軌樣式

TextTrackStyle 是封裝文字軌樣式資訊的物件。建立或更新現有的 TextTrackStyle 物件後，您可以呼叫目前播放媒體項目的 editTrackInfo 方法，將物件套用至該項目，如下所示：

var textTrackStyle = new chrome.cast.media.TextTrackStyle();
var tracksInfoRequest = new chrome.cast.media.EditTracksInfoRequest(textTrackStyle);
media.editTracksInfo(tracksInfoRequest, successCallback, errorCallback);

您可以透過回呼結果 (成功或錯誤) 追蹤要求狀態，並據此更新原始傳送者。

應用程式應允許使用者更新文字軌的樣式，方法是使用系統提供的設定，或透過應用程式本身進行設定。

你可以設定下列文字軌樣式元素：

  • 前景 (文字) 顏色和不透明度
  • 背景色彩和透明度
  • 邊緣類型
  • 邊緣顏色
  • 字型縮放
  • 字型系列
  • 字型樣式

舉例來說，如要將文字顏色設為紅色，不透明度為 75%，請使用下列程式碼：

var textTrackStyle = new chrome.cast.media.TextTrackStyle();
textTrackStyle.foregroundColor = '#80FF0000';

音量控制項

您可以使用 RemotePlayer 和 RemotePlayerController 設定接收器音量。

function changeVolume(newVolume) {
  player.volumeLevel = newVolume;
  playerController.setVolumeLevel();
  // Update sender UI to reflect change
}

寄件者應用程式應遵循下列音量控制指南：

  • 傳送端應用程式必須與接收端同步，傳送端 UI 才能一律根據接收端回報音量。使用 RemotePlayerEventType.VOLUME_LEVEL_CHANGED 和 RemotePlayerEventType.IS_MUTED_CHANGED 回呼，在傳送端維持音量。詳情請參閱「狀態更新」一文。
  • 應用程式在接收器上載入時，傳送端應用程式不得將音量設為特定預先定義的音量，也不得將音量設為傳送端裝置的鈴聲/媒體音量。

請參閱設計檢查清單中的「傳送者音量控制」。

傳送媒體訊息給接收者

Media Messages 可從寄件者傳送至收件者。舉例來說，如要傳送 SKIP_AD 訊息給接收者：

// Get a handle to the skip button element
const skipButton = document.getElementById('skip');
skipButton.addEventListener("click", function() {
  if (castSession) {
    const media = castSession.getMediaSession();
    castSession.sendMessage('urn:x-cast:com.google.cast.media', {
      type: 'SKIP_AD',
      requestId: 1,
      mediaSessionId: media.mediaSessionId
    });
  }
});

最新動態

如果多個傳送端連線至同一個接收端，即使變更是由其他傳送端發起，每個傳送端也必須瞭解接收端的變更。

為此，應用程式應在 RemotePlayerController 上註冊所有必要的事件監聽器。如果目前媒體的 TextTrackStyle 發生變化，系統會通知所有已連線的傳送者，並在回呼中將目前媒體工作階段的相應屬性 (例如 MediaInfo 欄位的 activeTrackIds 和 textTrackStyle) 傳送給傳送者。在這種情況下，接收器 SDK 不會驗證新樣式是否與先前的樣式不同，而是通知所有已連線的傳送器。

進度指標

大多數應用程式都必須在傳送端顯示播放位置和進度指標。Cast API 使用 Cast 媒體通訊協定，可針對此情境和其他情境最佳化頻寬用量，因此您不需要自行實作狀態同步。如要瞭解如何使用 API 正確實作媒體播放進度指標，請參閱 CastVideos-chrome 範例應用程式。

CORS 規定

如果是自適應媒體串流，Google Cast 必須有 CORS 標頭，但即使是簡單的 MP4 媒體串流，如果包含軌道，也需要 CORS。如要為任何媒體啟用軌道，必須為軌道串流和媒體串流啟用 CORS。因此，如果伺服器上簡單的 mp4 媒體沒有可用的 CORS 標頭，而您新增簡單的字幕軌，就必須更新伺服器，加入適當的 CORS 標頭，才能串流播放媒體。

您需要下列標題：Content-Type、Accept-Encoding 和 Range。 請注意，最後兩個標頭 Accept-Encoding 和 Range 是額外標頭，您先前可能不需要。

萬用字元「*」無法用於 Access-Control-Allow-Origin 標頭。如果網頁含有受保護的媒體內容，則必須使用網域，而非萬用字元。

繼續工作階段，不必重新載入網頁

如要繼續現有的 CastSession，請使用 requestSessionById(sessionId) 和您嘗試加入的階段 sessionId。

您可以使用 getSessionId() 在作用中的 CastSession 上找到 sessionId，方法是呼叫 loadMedia()。

建議做法如下：

  1. 呼叫 loadMedia() 即可開始工作階段
  2. 在當地商店購買「sessionId」
  3. 視需要使用 requestSessionById(sessionId) 重新加入工作階段
let sessionId;

function rejoinCastSession() {
  chrome.cast.requestSessionById(sessionId);

  // Add any business logic to load new content or only resume the session
}

document.getElementById('play-button').addEventListener(("click"), function() {
  if (sessionId == null) {
    let castSession = cast.framework.CastContext.getInstance().getCurrentSession();
    if (castSession) {
      let mediaInfo = createMediaInfo();
      let request = new chrome.cast.media.LoadRequest(mediaInfo);
      castSession.loadMedia(request)

      sessionId = CastSession.getSessionId();
    } else {
      console.log("Error: Attempting to play media without a Cast Session");
    }
  } else {
    rejoinCastSession();
  }
});

後續步驟

至此，您已瞭解如何將功能新增至網頁傳送器應用程式。 現在可以為其他平台 (Android 或 iOS) 建立傳送器應用程式，或建立接收器應用程式。

上一頁
整合 Cast