ウェブ センダー アプリに高度な機能を追加する

ミッドロール挿入点

Web Sender SDK は、特定のメディア ストリーム内のミッドロール挿入点とコンパニオン広告をサポートしています。

ミッドロール挿入点の仕組みについて詳しくは、Web Receiver のミッドロール挿入点の概要をご覧ください。

挿入点はセンダーとレシーバーの両方で指定できますが、プラットフォーム間で動作の一貫性を維持するため、Web ReceiverAndroid TV Receiver で指定することをおすすめします。

ウェブの場合、BreakClipBreak を使用して、読み込みコマンドでミッドロール挿入点を指定します。

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)

Tracks 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) を呼び出して、有効にするトラックの ID を opt_activeTrackIds に渡すことで、メディア アイテムに関連付けられた 1 つ以上のトラックを有効にすることもできます。どちらのパラメータも省略可能で、どのアクティブなトラックまたはスタイルを使用するかをご自身の判断で選択できます。たとえば、フランス語の字幕(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)をオフにするためにメディアを再読み込みする必要はありません。以前に有効化した trackId含まない activeTracksId 配列を送信すると、テキスト トラックが無効になります。

テキスト トラックのスタイルを設定する

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

音量調節

RemotePlayerRemotePlayerController を使用して、レシーバーの音量を設定できます。

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 フィールドの activeTrackIdstextTrackStyle など)がコールバックでセンダーに送信されます。この場合、レシーバ SDK は新しいスタイルが以前のスタイルと異なるかどうかを確認せず、接続されているすべての送信者に通知します。

進行状況インジケーター

ほとんどのアプリでは、送信側に再生場所の進行状況インジケーターを表示する必要があります。Cast API はキャスト メディア プロトコルを使用します。このプロトコルにより、このシナリオやその他のシナリオで帯域幅の消費が最適化されるため、独自のステータス同期を実装する必要はありません。API を使用したメディア再生の進行状況インジケーターを適切に実装する方法については、CastVideos-chrome サンプルアプリをご覧ください。

CORS の要件

アダプティブなメディア ストリーミングの場合、Google Cast には CORS ヘッダーの存在が必要ですが、シンプルな mp4 メディア ストリームであっても Tracks が含まれている場合は CORS が必要です。メディアのトラックを有効にするには、トラック ストリームとメディア ストリームの両方で CORS を有効にする必要があります。そのため、サーバーでシンプルな mp4 メディアで使用できる CORS ヘッダーがなく、それからシンプルな字幕トラックを追加した場合は、適切な CORS ヘッダーを含めるようにサーバーを更新しない限り、メディアをストリーミングできません。

Content-TypeAccept-EncodingRange の各ヘッダーが必要です。最後の 2 つのヘッダー Accept-EncodingRange は、以前は必要でなかった追加のヘッダーです。

Access-Control-Allow-Origin ヘッダーにワイルドカード「*」は使用できません。保護されたメディア コンテンツがページに含まれている場合は、ワイルドカードの代わりにドメインを使用する必要があります。

ウェブページを再読み込みせずにセッションを再開する

既存の CastSession を再開するには、参加しようとしているセッションの sessionIdrequestSessionById(sessionId) を使用します。

sessionId は、loadMedia() を呼び出した後に getSessionId() を使用して、アクティブな CastSession で確認できます。

推奨されるアプローチは次のとおりです。

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

次のステップ

これで、Web Sender アプリに追加できる機能は完了です。これで、別のプラットフォーム(Android または iOS)用の送信側アプリ、または受信側アプリを構築できます。