本页面包含代码段,并介绍了自定义 Web 接收器应用可用的功能。
- 一个
cast-media-player
元素,表示 Web 接收器随附的内置播放器界面。 cast-media-player
元素的自定义类 CSS 样式,用于设置各种界面元素的样式,例如background-image
、splash-image
和font-family
。- 用于加载 Web 接收器框架的脚本元素。
- 用于拦截消息和处理事件的 JavaScript 代码。
- 排队等待自动播放。
- 用于配置播放的选项。
- 用于设置 Web 接收器上下文的选项。
- 用于设置 Web 接收器应用支持的命令的选项。
- 用于启动 Web 接收器应用的 JavaScript 调用。
应用配置和选项
配置应用
CastReceiverContext
是向开发者公开的最外层类,用于管理底层库的加载并处理 Web 接收器 SDK 的初始化。该 SDK 提供了一些 API,可让应用开发者通过 CastReceiverOptions
配置 SDK。
这些配置在每次应用启动时评估一次,并在调用 start
时设置可选参数时传递给 SDK。
以下示例展示了如何替换用于检测发送者连接是否仍处于活动连接状态的默认行为。如果 Web 接收器在 maxInactivity
秒内无法与发送器通信,则会调度 SENDER_DISCONNECTED
事件。以下配置会替换此超时时间。这在调试问题时非常有用,因为它可以防止 Web 接收器应用在处于 IDLE
状态时因没有连接的发送方而关闭 Chrome 远程调试器会话。
const context = cast.framework.CastReceiverContext.getInstance();
const options = new cast.framework.CastReceiverOptions();
options.maxInactivity = 3600; // Development only
context.start(options);
配置播放器
加载内容时,Web Receiver SDK 提供了一种使用 cast.framework.PlaybackConfig
配置播放变量(例如 DRM 信息、重试配置和请求处理程序)的方法。此信息由 PlayerManager
处理,并在创建玩家时进行评估。每次向 Web 接收器 SDK 传递新加载时,都会创建播放器。在创建播放器后对 PlaybackConfig
进行的修改会在下一次内容加载时进行评估。该 SDK 提供了以下用于修改 PlaybackConfig
的方法。
CastReceiverOptions.playbackConfig
,以便在初始化CastReceiverContext
时替换默认配置选项。PlayerManager.getPlaybackConfig()
以获取当前配置。PlayerManager.setPlaybackConfig()
以覆盖当前配置。此设置会应用于所有后续加载,直到再次被替换。PlayerManager.setMediaPlaybackInfoHandler()
仅用于在当前配置的基础上应用其他配置。处理程序会在创建播放器之前调用。在此处所做的更改不是永久性的,也不会包含在对getPlaybackConfig()
的查询中。加载下一个媒体项时,系统会再次调用此处理程序。
以下示例展示了如何在初始化 CastReceiverContext
时设置 PlaybackConfig
。配置会替换用于获取清单的出站请求。该处理程序指定应使用凭据(例如 Cookie 或授权标头)发出 CORS Access-Control 请求。
const playbackConfig = new cast.framework.PlaybackConfig();
playbackConfig.manifestRequestHandler = requestInfo => {
requestInfo.withCredentials = true;
};
context.start({playbackConfig: playbackConfig});
以下示例展示了如何使用 PlayerManager
中提供的 getter 和 setter 替换 PlaybackConfig
。此设置可将播放器配置为在加载 1 个片段后恢复内容播放。
const playerManager =
cast.framework.CastReceiverContext.getInstance().getPlayerManager();
const playbackConfig = (Object.assign(
new cast.framework.PlaybackConfig(), playerManager.getPlaybackConfig()));
playbackConfig.autoResumeNumberOfSegments = 1;
playerManager.setPlaybackConfig(playbackConfig);
以下示例展示了如何使用媒体播放信息处理程序针对特定加载请求替换 PlaybackConfig
。处理程序调用应用实现的方法 getLicenseUrlForMedia
,以从当前商品的 contentId
中获取 licenseUrl
。
playerManager.setMediaPlaybackInfoHandler((loadRequestData, playbackConfig) => {
const mediaInformation = loadRequestData.media;
playbackConfig.licenseUrl = getLicenseUrlForMedia(mediaInformation.contentId);
return playbackConfig;
});
事件监听器
借助 Web Receiver SDK,您的 Web Receiver 应用可以处理播放器事件。事件监听器采用一个 cast.framework.events.EventType
参数(或这些参数的数组),用于指定应触发监听器的事件。可在 cast.framework.events.category
中找到对调试有用的预配置 cast.framework.events.EventType
数组。该事件参数提供有关事件的其他信息。
例如,如果您想知道何时广播 mediaStatus
更改,可以使用以下逻辑来处理该事件:
const playerManager =
cast.framework.CastReceiverContext.getInstance().getPlayerManager();
playerManager.addEventListener(
cast.framework.events.EventType.MEDIA_STATUS, (event) => {
// Write your own event handling code, for example
// using the event.mediaStatus value
});
消息拦截
借助 Web 接收器 SDK,Web 接收器应用可以拦截消息并对这些消息执行自定义代码。消息拦截器采用 cast.framework.messages.MessageType
参数,用于指定应拦截的消息类型。
拦截器应返回修改后的请求或一个解析为修改后的请求值的 Promise。返回 null
将阻止调用默认消息处理程序。如需了解详情,请参阅加载媒体。
例如,如果您想更改加载请求数据,可以使用以下逻辑来拦截并修改它:
const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.LOAD, loadRequestData => {
const error = new cast.framework.messages.ErrorData(
cast.framework.messages.ErrorType.LOAD_FAILED);
if (!loadRequestData.media) {
error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
return error;
}
if (!loadRequestData.media.entity) {
return loadRequestData;
}
return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
loadRequestData.credentials)
.then(asset => {
if (!asset) {
throw cast.framework.messages.ErrorReason.INVALID_REQUEST;
}
loadRequestData.media.contentUrl = asset.url;
loadRequestData.media.metadata = asset.metadata;
loadRequestData.media.tracks = asset.tracks;
return loadRequestData;
}).catch(reason => {
error.reason = reason; // cast.framework.messages.ErrorReason
return error;
});
});
context.start();
错误处理
当消息拦截器中发生错误时,Web Receiver 应用应返回适当的 cast.framework.messages.ErrorType
和 cast.framework.messages.ErrorReason
。
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.LOAD, loadRequestData => {
const error = new cast.framework.messages.ErrorData(
cast.framework.messages.ErrorType.LOAD_CANCELLED);
if (!loadRequestData.media) {
error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
return error;
}
...
return fetchAssetAndAuth(loadRequestData.media.entity,
loadRequestData.credentials)
.then(asset => {
...
return loadRequestData;
}).catch(reason => {
error.reason = reason; // cast.framework.messages.ErrorReason
return error;
});
});
消息拦截与事件监听器
消息拦截和事件监听器之间的一些主要区别如下:
- 事件监听器不允许您修改请求数据。
- 事件监听器最适合用于触发分析或自定义函数。
playerManager.addEventListener(cast.framework.events.category.CORE,
event => {
console.log(event);
});
- 消息拦截功能可让您监听消息、拦截消息,并修改请求数据本身。
- 消息拦截最适合用于处理与请求数据相关的自定义逻辑。
加载媒体
MediaInformation
提供了许多属性,用于在 cast.framework.messages.MessageType.LOAD
消息中加载媒体,包括 entity
、contentUrl
和 contentId
。
entity
是建议在发送方应用和接收方应用的实现中使用的属性。该属性是一个深层链接网址,可以是播放列表,也可以是媒体内容。您的应用应解析此网址,并填充其他两个字段中的至少一个。contentUrl
对应于播放器将用于加载内容的可播放网址。例如,此网址可能指向 DASH 清单。contentId
可以是可播放的内容网址(类似于contentUrl
属性的网址),也可以是正在加载的内容或播放列表的唯一标识符。如果使用此属性作为标识符,您的应用应在contentUrl
中填充可播放的网址。
建议使用 entity
存储实际 ID 或密钥参数,并使用 contentUrl
存储媒体的网址。以下代码段展示了一个示例,其中 entity
存在于 LOAD
请求中,并且检索到了可播放的 contentUrl
:
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.LOAD, loadRequestData => {
...
if (!loadRequestData.media.entity) {
// Copy the value from contentId for legacy reasons if needed
loadRequestData.media.entity = loadRequestData.media.contentId;
}
return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
loadRequestData.credentials)
.then(asset => {
loadRequestData.media.contentUrl = asset.url;
...
return loadRequestData;
});
});
设备功能
getDeviceCapabilities
方法可提供有关所连接的 Cast 设备以及附加到该设备的视频或音频设备的信息。getDeviceCapabilities
方法可提供有关 Google 助理、蓝牙以及所连接的显示和音频设备的支持信息。
此方法会返回一个对象,您可以通过传入指定的枚举之一来查询该对象,以获取相应枚举的设备功能。枚举在 cast.framework.system.DeviceCapabilities
中定义。
此示例检查 Web 接收器设备是否能够分别使用 IS_HDR_SUPPORTED
和 IS_DV_SUPPORTED
键播放 HDR 和 DolbyVision (DV)。
const context = cast.framework.CastReceiverContext.getInstance();
context.addEventListener(cast.framework.system.EventType.READY, () => {
const deviceCapabilities = context.getDeviceCapabilities();
if (deviceCapabilities &&
deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED]) {
// Write your own event handling code, for example
// using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED] value
}
if (deviceCapabilities &&
deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED]) {
// Write your own event handling code, for example
// using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED] value
}
});
context.start();
处理用户互动
用户可以通过发送方应用(Web、Android 和 iOS)、支持 Google 助理的设备上的语音指令、智能显示屏上的触控功能以及 Android TV 设备上的遥控器与您的 Web Receiver 应用互动。Cast SDK 提供了各种 API,可让 Web 接收器应用处理这些互动,通过用户操作状态更新应用界面,并可选择性地发送更改以更新任何后端服务。
支持的媒体命令
界面控件状态由以下因素决定:iOS 和 Android 发送方扩展控制器、在触控设备上运行的接收方和遥控器应用,以及 Android TV 设备上的接收方应用。MediaStatus.supportedMediaCommands
当属性中启用了特定按位 Command
时,与该操作相关的按钮也会启用。如果未设置该值,则按钮处于停用状态。您可以在 Web 接收器上更改这些值,方法如下:
- 使用
PlayerManager.setSupportedMediaCommands
设置特定的Commands
- 使用
addSupportedMediaCommands
添加新命令 - 使用
removeSupportedMediaCommands
移除现有命令。
playerManager.setSupportedMediaCommands(cast.framework.messages.Command.SEEK |
cast.framework.messages.Command.PAUSE);
当接收方准备更新后的 MediaStatus
时,它会在 supportedMediaCommands
属性中包含相应更改。当状态广播时,已连接的发送方应用会相应地更新其界面中的按钮。
如需详细了解支持的媒体命令和触控设备,请参阅 Accessing UI controls
指南。
管理用户操作状态
当用户与界面互动或发送语音指令时,可以控制内容的播放以及与正在播放的商品相关的属性。控制播放的请求由 SDK 自动处理。修改当前播放项属性的请求(例如 LIKE
命令)需要接收器应用进行处理。SDK 提供了一系列 API 来处理这些类型的请求。为了支持这些请求,必须执行以下操作:
- 加载媒体内容时,根据用户偏好设置
MediaInformation
userActionStates
。 - 拦截
USER_ACTION
消息并确定所请求的操作。 - 更新
MediaInformation
UserActionState
以更新界面。
以下代码段会拦截 LOAD
请求并填充 LoadRequestData
的 MediaInformation
。在这种情况下,用户喜欢正在加载的内容。
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.LOAD, (loadRequestData) => {
const userActionLike = new cast.framework.messages.UserActionState(
cast.framework.messages.UserAction.LIKE);
loadRequestData.media.userActionStates = [userActionLike];
return loadRequestData;
});
以下代码段会拦截 USER_ACTION
消息,并处理使用所请求的更改调用后端的操作。然后,它会调用以更新接收器上的 UserActionState
。
playerManager.setMessageInterceptor(cast.framework.messages.MessageType.USER_ACTION,
(userActionRequestData) => {
// Obtain the media information of the current content to associate the action to.
let mediaInfo = playerManager.getMediaInformation();
// If there is no media info return an error and ignore the request.
if (!mediaInfo) {
console.error('Not playing media, user action is not supported');
return new cast.framework.messages.ErrorData(messages.ErrorType.BAD_REQUEST);
}
// Reach out to backend services to store user action modifications. See sample below.
return sendUserAction(userActionRequestData, mediaInfo)
// Upon response from the backend, update the client's UserActionState.
.then(backendResponse => updateUserActionStates(backendResponse))
// If any errors occurred in the backend return them to the cast receiver.
.catch((error) => {
console.error(error);
return error;
});
});
以下代码段模拟了对后端服务的调用。该函数会检查 UserActionRequestData
以了解用户请求的更改类型,并且仅在后端支持相应操作时才进行网络调用。
function sendUserAction(userActionRequestData, mediaInfo) {
return new Promise((resolve, reject) => {
switch (userActionRequestData.userAction) {
// Handle user action changes supported by the backend.
case cast.framework.messages.UserAction.LIKE:
case cast.framework.messages.UserAction.DISLIKE:
case cast.framework.messages.UserAction.FOLLOW:
case cast.framework.messages.UserAction.UNFOLLOW:
case cast.framework.messages.UserAction.FLAG:
case cast.framework.messages.UserAction.SKIP_AD:
let backendResponse = {userActionRequestData: userActionRequestData, mediaInfo: mediaInfo};
setTimeout(() => {resolve(backendResponse)}, 1000);
break;
// Reject all other user action changes.
default:
reject(
new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType.INVALID_REQUEST));
}
});
}
以下代码段会获取 UserActionRequestData
,并从 MediaInformation
中添加或移除 UserActionState
。更新 MediaInformation
的 UserActionState
会更改与所请求操作关联的按钮的状态。此更改会反映在智能显示屏控件界面、遥控器应用和 Android TV 界面中。它还通过传出的 MediaStatus
消息进行广播,以更新 iOS 和 Android 发送设备的展开控制器的界面。
function updateUserActionStates(backendResponse) {
// Unwrap the backend response.
let mediaInfo = backendResponse.mediaInfo;
let userActionRequestData = backendResponse.userActionRequestData;
// If the current item playing has changed, don't update the UserActionState for the current item.
if (playerManager.getMediaInformation().entity !== mediaInfo.entity) {
return;
}
// Check for existing userActionStates in the MediaInformation.
// If none, initialize a new array to populate states with.
let userActionStates = mediaInfo.userActionStates || [];
// Locate the index of the UserActionState that will be updated in the userActionStates array.
let index = userActionStates.findIndex((currUserActionState) => {
return currUserActionState.userAction == userActionRequestData.userAction;
});
if (userActionRequestData.clear) {
// Remove the user action state from the array if cleared.
if (index >= 0) {
userActionStates.splice(index, 1);
}
else {
console.warn("Could not find UserActionState to remove in MediaInformation");
}
} else {
// Add the UserActionState to the array if enabled.
userActionStates.push(
new cast.framework.messages.UserActionState(userActionRequestData.userAction));
}
// Update the UserActionState array and set the new MediaInformation
mediaInfo.userActionStates = userActionStates;
playerManager.setMediaInformation(mediaInfo, true);
return;
}
语音指令
目前,Web 接收器 SDK 在支持 Google 助理的设备上支持以下媒体命令。这些命令的默认实现位于 cast.framework.PlayerManager
中。
命令 | 说明 |
---|---|
Play | 播放或从暂停状态恢复播放。 |
暂停 | 暂停当前正在播放的内容。 |
上一步 | 跳至媒体队列中的上一个媒体内容。 |
继续 | 跳到媒体队列中的下一个媒体内容。 |
停止 | 停止当前正在播放的媒体内容。 |
不重复播放 | 在播放完队列中的最后一项媒体内容后,禁止重复播放队列中的媒体内容。 |
重复单曲 | 无限期重复播放当前正在播放的媒体。 |
全部重复播放 | 在播放完队列中的最后一项内容后,重复播放队列中的所有内容。 |
全部重复和随机播放 | 播放完队列中的最后一项内容后,随机播放队列中的所有内容。 |
Shuffle | 随机播放媒体队列中的媒体项。 |
开启 / 关闭字幕 | 为媒体内容启用 / 停用字幕。您还可以按语言启用 / 停用。 |
跳转到绝对时间 | 跳转到指定的绝对时间。 |
搜索相对于当前时间的时间 | 相对于当前播放时间向前或向后跳转指定的时间段。 |
再次播放 | 重新开始播放当前正在播放的媒体,或者在当前没有播放任何内容时播放上次播放的媒体项。 |
设置播放速率 | 改变媒体播放速率。这应默认处理。您可以使用 SET_PLAYBACK_RATE 消息拦截器来替换传入的速率请求。 |
支持的语音媒体命令
如需防止语音指令在支持 Google 助理的设备上触发媒体指令,您必须先设置计划支持的受支持的媒体指令。然后,您必须通过启用 CastReceiverOptions.enforceSupportedCommands
属性来强制执行这些命令。Cast SDK 发送方和支持触控的设备上的界面将发生变化,以反映这些配置。如果未启用该标志,则会执行传入的语音指令。
例如,如果您允许从发送方应用和支持触控的设备发送 PAUSE
,则还必须配置接收方以反映这些设置。配置完成后,如果任何传入的语音指令不在支持的指令列表中,系统都会将其舍弃。
在下面的示例中,我们在启动 CastReceiverContext
时提供 CastReceiverOptions
。我们添加了对 PAUSE
命令的支持,并强制播放器仅支持该命令。现在,如果语音指令请求其他操作(例如 SEEK
),系统会拒绝该请求。系统会通知用户,该命令尚不受支持。
const context = cast.framework.CastReceiverContext.getInstance();
context.start({
enforceSupportedCommands: true,
supportedCommands: cast.framework.messages.Command.PAUSE
});
您可以为要限制的每个命令应用单独的逻辑。移除 enforceSupportedCommands
标志,并针对要限制的每个命令拦截传入的消息。在此处,我们拦截了 SDK 提供的请求,以便向支持 Google 助理的设备发出的 SEEK
命令不会在 Web 接收器应用中触发搜索操作。
对于应用不支持的媒体命令,请返回适当的错误原因,例如 NOT_SUPPORTED
。
playerManager.setMessageInterceptor(cast.framework.messages.MessageType.SEEK,
seekData => {
// Block seeking if the SEEK supported media command is disabled
if (!(playerManager.getSupportedMediaCommands() & cast.framework.messages.Command.SEEK)) {
let e = new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType
.INVALID_REQUEST);
e.reason = cast.framework.messages.ErrorReason.NOT_SUPPORTED;
return e;
}
return seekData;
});
通过语音活动进入后台
如果 Cast 平台因 Google 助理活动(例如聆听用户语音或回复用户)而将应用的音频置于后台,则当该活动开始时,系统会向 Web 接收器应用发送 FocusState
消息(值为 NOT_IN_FOCUS
)。当 activity 结束时,系统会发送另一条包含 IN_FOCUS
的消息。根据您的应用和正在播放的媒体,您可能希望在 FocusState
为 NOT_IN_FOCUS
时通过拦截消息类型 FOCUS_STATE
来暂停媒体。
例如,如果 Google 助理正在响应用户查询,暂停有声读物播放可带来良好的用户体验。
playerManager.setMessageInterceptor(cast.framework.messages.MessageType.FOCUS_STATE,
focusStateRequestData => {
// Pause content when the app is out of focus. Resume when focus is restored.
if (focusStateRequestData.state == cast.framework.messages.FocusState.NOT_IN_FOCUS) {
playerManager.pause();
} else {
playerManager.play();
}
return focusStateRequestData;
});
通过语音指定的字幕语言
如果用户未明确指定字幕语言,则字幕所用的语言与说出命令时所用的语言相同。在这些情况下,传入消息的 isSuggestedLanguage
参数会指明关联语言是由用户建议还是明确请求的。
例如,对于“OK Google,开启字幕”这一指令,isSuggestedLanguage
设置为 true
,因为系统会根据说出指令时所用的语言来推断语言。如果明确请求了语言,例如“OK Google,开启英语字幕”,则 isSuggestedLanguage
会设置为 false
。
元数据和语音投屏
虽然语音指令默认由 Web 接收器处理,但您应确保内容的元数据完整且准确。这样可确保助理正确处理语音指令,并确保元数据在 Google Home 应用和 Google Home Hub 等智能显示屏等新型界面上正确显示。
流传输
保留会话状态是流传输的基础,用户可以使用语音指令、Google Home 应用或智能显示屏在设备之间转移现有的音频和视频流。媒体内容在一部设备(源设备)上停止播放,并在另一部设备(目标设备)上继续播放。任何搭载最新固件的 Cast 设备都可以作为流传输中的来源或目的地。
流传输的事件流如下:
- 在源设备上:
- 媒体停止播放。
- Web Receiver 应用收到保存当前媒体状态的命令。
- Web 接收器应用已关闭。
- 在目标设备上:
- Web Receiver 应用已加载。
- Web 接收器应用收到一条命令,用于恢复已保存的媒体状态。
- 媒体恢复播放。
媒体状态的元素包括:
- 歌曲、视频或媒体内容的具体位置或时间戳。
- 它在更广泛的队列(例如歌单或音乐人电台)中的位置。
- 经过身份验证的用户。
- 播放状态(例如正在播放或已暂停)。
启用流转移
如需为 Web 接收器实现数据流转移,请执行以下操作:
- 使用
STREAM_TRANSFER
命令更新supportedMediaCommands
:playerManager.addSupportedMediaCommands( cast.framework.messages.Command.STREAM_TRANSFER, true);
- (可选)按照保留会话状态中的说明替换
SESSION_STATE
和RESUME_SESSION
消息拦截器。仅当需要将自定义数据存储为会话快照的一部分时,才替换这些方法。否则,用于保留会话状态的默认实现将支持流转移。
保留会话状态
Web 接收器 SDK 为 Web 接收器应用提供了一种默认实现,用于通过以下方式保留会话状态:拍摄当前媒体状态的快照、将该状态转换为加载请求,以及使用该加载请求恢复会话。
如有必要,可以在 SESSION_STATE
消息拦截器中替换 Web 接收器生成的加载请求。如果您想在加载请求中添加自定义数据,建议将其放在 loadRequestData.customData
中。
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.SESSION_STATE,
function (sessionState) {
// Override sessionState.loadRequestData if needed.
const newCredentials = updateCredentials_(sessionState.loadRequestData.credentials);
sessionState.loadRequestData.credentials = newCredentials;
// Add custom data if needed.
sessionState.loadRequestData.customData = {
'membership': 'PREMIUM'
};
return sessionState;
});
可以在 RESUME_SESSION
消息拦截器中从 loadRequestData.customData
检索自定义数据。
let cred_ = null;
let membership_ = null;
playerManager.setMessageInterceptor(
cast.framework.messages.MessageType.RESUME_SESSION,
function (resumeSessionRequest) {
let sessionState = resumeSessionRequest.sessionState;
// Modify sessionState.loadRequestData if needed.
cred_ = sessionState.loadRequestData.credentials;
// Retrieve custom data.
membership_ = sessionState.loadRequestData.customData.membership;
return resumeSessionRequest;
});
内容预加载
Web 接收器支持在队列中当前播放的媒体项之后预加载媒体项。
预加载操作会预先下载即将播放的多个片段。规范是在 QueueItem 对象中的 preloadTime 值上完成的(如果未提供,则默认为 20 秒)。时间以秒为单位表示,相对于当前播放项的结束时间。仅正值有效。例如,如果该值为 10 秒,则系统会在前一个项完成播放前 10 秒预加载此项。如果预加载时间高于当前项的剩余时间,系统会尽快进行预加载。因此,如果在 queueItem 上指定了非常大的预加载值,则可以实现以下效果:无论何时播放当前项,我们都会预加载下一项。不过,我们让开发者自行设置和选择此值,因为此值可能会影响当前播放项的带宽和流式传输性能。
默认情况下,预加载功能适用于 HLS、DASH 和 Smooth Streaming 内容。
常规 MP4 视频和音频文件(例如 MP3)不会预加载,因为 Cast 设备仅支持一个媒体元素,并且在现有内容项仍在播放时无法用于预加载。
自定义消息
消息交换是 Web 接收器应用的主要互动方法。
发送者使用其运行平台(Android、iOS、Web)的发送者 API 向 Web 接收者发送消息。传递给事件监听器的事件对象(消息的体现)具有一个数据元素 (event.data
),其中数据采用特定事件类型的属性。
Web Receiver 应用可以选择侦听指定命名空间中的消息。这样一来,Web 接收器应用便支持该命名空间协议。然后,任何希望在该命名空间上进行通信的已连接发送者都可以使用适当的协议。
所有命名空间都由一个字符串定义,并且必须以“urn:x-cast:
”开头,后跟任意字符串。例如,“urn:x-cast:com.example.cast.mynamespace
”。
以下是 Web 接收器用于监听来自已连接发送者的自定义消息的代码段:
const context = cast.framework.CastReceiverContext.getInstance();
const CUSTOM_CHANNEL = 'urn:x-cast:com.example.cast.mynamespace';
context.addCustomMessageListener(CUSTOM_CHANNEL, function(customEvent) {
// handle customEvent.
});
context.start();
同样,Web 接收器应用也可以通过向已连接的发送者发送消息,让发送者了解 Web 接收器的状态。Web 接收器应用可以使用 CastReceiverContext
上的 sendCustomMessage(namespace, senderId, message)
发送消息。Web Receiver 可以向单个发送者发送消息,无论是为了响应收到的消息,还是由于应用状态发生变化。除了点对点消息传递(限制为 64kb)之外,Web 接收器还可以向所有已连接的发送器广播消息。
音频设备的投屏功能
如需获得有关仅播放音频的支持,请参阅 Google Cast 音频设备指南。
Android TV
本部分讨论了 Google Web Receiver 如何将您的输入用作播放内容,以及 Android TV 兼容性。
将应用与遥控器集成
在 Android TV 设备上运行的 Google Web Receiver 会将来自设备控制输入源(即手持遥控器)的输入转换为为 urn:x-cast:com.google.cast.media
命名空间定义的媒体播放消息,如媒体播放消息中所述。您的应用必须支持这些消息,才能控制应用媒体播放,从而允许通过 Android TV 的控制输入进行基本播放控制。
Android TV 兼容性指南
以下是一些建议和需要避免的常见陷阱,可确保您的应用与 Android TV 兼容:
- 请注意,用户代理字符串同时包含“Android”和“CrKey”;某些网站可能会重定向到仅限移动设备的网站,因为它们检测到“Android”标签。请勿假设用户代理字符串中的“Android”始终表示移动用户。
- Android 的媒体堆栈可能会使用透明 GZIP 来提取数据。确保您的媒体数据可以响应
Accept-Encoding: gzip
。 - Android TV HTML5 媒体事件的触发时间可能与 Chromecast 不同,这可能会揭示 Chromecast 上隐藏的问题。
- 更新媒体时,请使用
<audio>/<video>
元素(例如timeupdate
、pause
和waiting
)触发的媒体相关事件。避免使用progress
、suspend
和stalled
等与网络相关的事件,因为这些事件往往依赖于平台。如需详细了解如何在接收器中处理媒体事件,请参阅媒体事件。 - 配置接收方网站的 HTTPS 证书时,请务必包含中间 CA 证书。请访问 Qualsys SSL 测试页面进行验证:如果网站的可信证书路径包含标记为“额外下载”的 CA 证书,则该证书可能无法在基于 Android 的平台上加载。
- 当 Chromecast 在 720p 图形平面上显示接收器页面时,包括 Android TV 在内的其他 Cast 平台可能会以最高 1080p 的分辨率显示该页面。确保接收器页面在不同分辨率下都能正常缩放。