向 Web Sender 应用添加高级功能

广告插播时间点

Web Sender SDK 支持在给定媒体串流中投放广告插播和随播广告。

如需详细了解广告插播的运作方式,请参阅网站接收器广告插播概览

虽然您可以在发送器和接收器上指定广告插播时间点,但建议您在 Web 接收器Android TV 接收器上指定这些时间点,以便在各个平台上保持一致的行为。

在 Web 上,使用 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) 并在 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)。发送包含之前启用的 trackIdactiveTracksId 数组会停用字幕轨道。

设置文本轨道的样式

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
}

发件人应用应遵循以下音量控制准则:

  • 发送器应用必须与接收器同步,以便发送器界面始终按接收器报告音量。使用 RemotePlayerEventType.VOLUME_LEVEL_CHANGEDRemotePlayerEventType.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。请注意,最后两个标头 Accept-EncodingRange 是您之前可能不需要的额外标头。

Access-Control-Allow-Origin 标头不能使用通配符“*”。如果网页包含受保护的媒体内容,则必须使用域名,而不是通配符。

在不重新加载网页的情况下恢复会话

如需恢复现有 CastSession,请将 requestSessionById(sessionId) 与您尝试加入的会话的 sessionId 搭配使用。

在调用 loadMedia() 后,您可以使用 getSessionId() 在活动 CastSession 上找到 sessionId

建议采用如下方法:

  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 发件人应用添加的功能已全部介绍完毕。现在,您可以为其他平台(AndroidiOS)构建发件人应用,也可以构建接收器应用