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

ミッドロール挿入点

Web Sender SDK は、特定のメディア ストリーム内の広告ブレークとコンパニオン広告をサポートします。

広告ブレークの仕組みについて詳しくは、ウェブ レシーバの広告ブレークの概要をご覧ください。

ブレークは送信側と受信側の両方で指定できますが、プラットフォーム間で一貫した動作を維持するため、ウェブ レシーバーAndroid TV レシーバーで指定することをおすすめします。

ウェブでは、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)

トラック 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 を渡すことで、メディア アイテムに関連付けられた 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 は Cast メディア プロトコルを使用します。このプロトコルは、このシナリオや他のシナリオでの帯域幅消費を最適化するため、独自のステータス同期を実装する必要はありません。API を使用したメディア再生の進行状況インジケーターの適切な実装については、CastVideos-chrome サンプルアプリをご覧ください。

CORS の要件

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

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

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

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

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

loadMedia() を呼び出した後、getSessionId() を使用して、アクティブな CastSessionsessionId を見つけることができます。

おすすめの方法は次のとおりです。

  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)用の送信側アプリを構築するか、受信側アプリを構築できるようになりました。