cast. framework. 消息
这是 cast.framework.messages
命名空间。
类
AudiobookChapterMediaMetadata
有声读物章节说明。
AudiobookContainerMetadata
有声读物容器说明。
AudioTrackInfo
描述音轨的音轨信息。
休息时间
表示主视频中包含的广告插播时间点(例如广告插播时间点)。
BreakClip
表示广告插播剪辑(例如,广告插播期间的广告剪辑)
BreakStatus
表示广告插播的状态。
CloudMediaStatus
仅向云端发送方(例如 Google 助理)发送的 MediaStatus
。
ContainerMetadata
用作 QueueData
一部分的通用容器元数据。
ContentRating
内容分级(家长分级、心智成熟度分级)。
CustomCommandRequestData
CustomCommand
请求数据。
DisplayStatusRequestData
DisplayStatusRequest
数据。
EditAudioTracksRequestData
媒体事件 EDIT_AUDIO_TRACKS 请求数据。如果未提供语言,系统将启用媒体的默认音轨。
EditTracksInfoRequestData
媒体事件 EDIT_TRACKS_INFO 请求数据。
ErrorData
表示错误信息。
ExtendedMediaStatus
扩展的媒体状态信息
FetchItemsRequestData
提取商品请求数据。
FocusStateRequestData
将焦点置于状态更改消息。
GenericMediaMetadata
一般的媒体说明。
GetItemsInfoRequestData
获取商品信息请求数据。
GetStatusRequestData
媒体事件 GET_STATUS 请求数据。
图片
描述接收方应用或媒体内容的图片。该资源可以是应用图标、封面图片或缩略图。
ItemsInfo
表示包含每个请求 ID 的项目信息的数据消息。
LiveSeekableRange
提供开始和结束时间(以秒为单位)的实时可搜索范围。
LoadByEntityRequestData
LoadByEntity
请求数据。
LoadOptions
为加载请求提供其他选项。
LoadRequestData
媒体事件 LOAD 请求数据。
MediaInformation
表示媒体信息。
MediaMetadata
常规媒体元数据,用作 MediaInformation
的一部分,或用于将媒体部分描述为容器元数据的一部分。
MediaStatus
表示媒体会话的状态。
MovieMediaMetadata
电影的媒体说明。
MusicTrackMediaMetadata
音乐曲目媒体说明。
PhotoMediaMetadata
照片媒体说明。
PrecacheRequestData
媒体事件 PRECACHE 请求数据。 (忽略加载请求的某些字段,如 autoplay 和 queueData)。
PreloadRequestData
媒体事件 PRELOAD 请求数据。
QueueChange
表示队列更改消息,例如插入、移除和更新。
QueueData
将数据作为 LOAD 请求的一部分加入队列。
QueueIds
表示包含队列 ID 的完整列表的数据消息。
QueueInsertRequestData
媒体事件队列 INSERT 请求数据。
QueueItem
队列项信息。应用开发者可能需要创建 QueueItem,以使用 cast.framework.messages.InsertQueueItems 插入队列元素。在这种情况下,它们不应提供 itemId(因为当项插入队列中时,系统会分配实际的 itemId)。这样可以防止与从发送者应用添加的项发生 ID 冲突。
QueueLoadRequestData
媒体事件队列 LOAD 请求数据。
QueueRemoveRequestData
媒体事件队列 REMOVE 请求数据。
QueueReorderRequestData
媒体事件队列 REORDER 请求数据。
QueueUpdateRequestData
媒体事件 UPDATE 队列请求数据。
RefreshCredentialsRequestData
RefreshCredentials
请求数据。
RequestData
媒体事件请求数据。
ResumeSessionRequestData
RESUME_SESSION 请求数据
SeekableRange
提供以秒为单位的可搜索范围。
SeekRequestData
媒体事件 SEEK 请求数据。
SessionState
一个状态对象,其中包含要存储在 StoreSession 中以及在 ResumeSession 中恢复的所有数据。
SetCredentialsRequestData
SetCredentials
请求数据。
SetPlaybackRateRequestData
媒体事件播放速率请求数据。
StoreSessionRequestData
STORE_SESSION 请求数据
StoreSessionResponseData
STORE_SESSION 命令的响应数据。
TextTrackStyle
描述文本轨道的样式信息。
跟踪
描述曲目元数据信息。
TracksInfo
跟踪信息。
TvShowMediaMetadata
电视剧集的媒体说明。
UserActionRequestData
UserAction
请求数据。
UserActionState
表示媒体的用户操作状态。
VastAdsRequest
VAST 广告请求配置。
VideoInformation
视频信息,例如视频分辨率和高动态范围 (HDR)。
Volume
表示媒体会话流的音量。
VolumeRequestData
媒体事件 SET_VOLUME 请求数据。
枚举
CaptionMimeType
string
文字轨道的字幕 MIME 类型。
值 |
|
---|---|
CEA608 |
string 欧洲、中东和非洲地区 608 |
TTML |
string TTML |
VTT |
string VTT |
TTML_MP4 |
string TTML MP4 |
命令
number
位掩码值列表,用于为 cast.framework.messages.MediaStatus#supportedMediaCommands 设置或检索应用支持的媒体命令。
值 |
|
---|---|
暂停 |
number 暂停命令。 |
寻找 |
number 跳转命令。 |
STREAM_VOLUME |
number 在线播放音量命令。 |
STREAM_MUTE |
number 在线播放音量命令。 |
ALL_BASIC_MEDIA |
number 所有基本媒体。包含强制性命令 |
QUEUE_NEXT |
number Queue Next 命令。 |
QUEUE_PREV |
number 队列上一个命令。 |
QUEUE_SHUFFLE |
number 队列重排命令。 |
QUEUE_REPEAT_ALL |
number 队列全部重复模式。 |
QUEUE_REPEAT_ONE |
number 队列重复一次模式。 |
QUEUE_REPEAT |
number 队列重复模式。 |
SKIP_AD |
number 跳过 AD 命令。 |
EDIT_TRACKS |
number 修改跟踪命令。 |
PLAYBACK_RATE |
number 播放速率命令。 |
LIKE |
number 用户操作,如命令。 |
踩 |
number 用户操作“踩”命令。 |
关注 |
number 用户操作 - 按照命令执行操作。 |
取消关注 |
number 用户操作“取消关注”命令。 |
STREAM_TRANSFER |
number 流式传输命令。 |
歌词 |
number 歌词命令。 |
ContainerType
number
容器元数据的类型。
值 |
|
---|---|
GENERIC_CONTAINER |
number 适合大多数媒体类型的通用模板。 由 cast.framework.messages.ContainerMetadata 使用。 |
AUDIOBOOK_CONTAINER |
number 有声读物的元数据。 由 cast.framework.messages.AudiobookContainerMetadata 使用。 |
- 另请参阅
- cast.framework.messages.QueueData.containerMetadata
ContentFilteringMode
string
表示内容过滤模式。
值 |
|
---|---|
FILTER_EXPLICIT |
string 请勿播放露骨内容。 |
ErrorReason
string
表示媒体错误消息原因。
值 |
|
---|---|
INVALID_COMMAND |
string 当命令无效或未实现时,系统会返回此错误代码。 |
INVALID_PARAMS |
string 当参数无效或缺少必需参数时,系统会返回此错误代码。 |
INVALID_MEDIA_SESSION_ID |
string 当媒体会话不存在时,系统会返回此错误代码。 |
SKIP_LIMIT_REACHED |
string 当因达到跳过限制而无法跳过更多项时返回。 |
NOT_SUPPORTED |
string 当应用不支持请求时,系统会返回此错误代码。 |
LANGUAGE_NOT_SUPPORTED |
string 当请求的语言不受支持时,系统会返回此错误代码。 |
END_OF_QUEUE |
string 当由于返回超出第一项或前进超出队列中的最后一项而无法跳过时,系统会返回此错误代码。 |
DUPLICATE_REQUEST_ID |
string 当请求 ID 不唯一(接收器正在处理具有相同 ID 的请求)时,系统会返回此错误代码。 |
VIDEO_DEVICE_REQUIRED |
string 当因为需要支持视频的设备而无法完成请求时,系统会返回此错误代码。 |
PREMIUM_ACCOUNT_REQUIRED |
string 当请求成功需要使用高级账号时,系统会返回此错误代码。 |
APP_ERROR |
string 当应用状态无效而无法满足请求时,系统会返回此错误代码。 |
AUTHENTICATION_EXPIRED |
string 当身份验证已过期(例如用户更改密码或令牌被撤消)时,系统会返回此错误代码。 |
CONCURRENT_STREAM_LIMIT |
string 当检测到太多并发流时,系统会返回此错误代码。 |
PARENTAL_CONTROL_RESTRICTED |
string 当内容因家长控制而被屏蔽时,系统会返回此错误代码。 |
CONTENT_FILTERED |
string 当内容因过滤而被屏蔽时,系统会返回此值。 |
NOT_AVAILABLE_IN_REGION |
string 当内容因在部分地区不可用而被屏蔽时,系统会返回此值。 |
CONTENT_ALREADY_PLAYING |
string 当请求的内容已经开始播放时返回。 |
INVALID_REQUEST |
string 当请求无效时,系统会返回此错误代码。 |
GENERIC_LOAD_ERROR |
string 当加载请求遇到间歇性问题时,系统会返回此错误代码。 |
ErrorType
string
表示媒体错误消息类型。
值 |
|
---|---|
INVALID_PLAYER_STATE |
string 当播放器的状态无效而无法满足请求时返回。 |
LOAD_FAILED |
string LOAD 请求失败时返回。 |
LOAD_CANCELLED |
string 当 LOAD 请求被第二个传入的 LOAD 请求取消时,系统会返回此错误代码。 |
INVALID_REQUEST |
string 当请求无效时,系统会返回此错误代码。 |
错误 |
string 一般错误,针对任何其他错误情况。 |
ExtendedPlayerState
string
扩展了播放器状态信息。
值 |
|
---|---|
正在加载 |
string 播放器处于“正在加载”状态。 |
FocusState
string
焦点状态。
值 |
|
---|---|
IN_FOCUS |
string 接收者对焦。 |
NOT_IN_FOCUS |
string 接收器未处于焦点,其他活动处于活动状态。 |
GetStatusOptions
number
GetStatusOptions
用于确定在对 GET_STATUS
消息的媒体状态响应中必须包含的数据量。
值 |
|
---|---|
NO_METADATA |
number 请勿包含元数据标志。 |
NO_QUEUE_ITEMS |
number 请勿添加队列项标志。 |
HdrType
string
表示视频高动态范围 (HDR) 类型。
值 |
|
---|---|
SDR |
string 标准动态范围。 |
HDR |
string 高动态范围。 |
DV |
string 杜比视界。 |
HlsSegmentFormat
string
HLS 音频片段的格式。
值 |
|
---|---|
AAC |
string AAC 打包音频基本流。 |
AC3 |
string AC3 打包的音频基本流。 |
MP3 |
string MP3 打包音频基本流。 |
TS |
string MPEG-2 传输流。 |
TS_AAC |
string AAC 低复杂性打包 MPEG-2 传输流 (AAC-LC)。 |
TS_HE_AAC |
string AAC 高效打包 MPEG-2 传输流 (HE-AAC)。 |
E_AC3 |
string E-AC3 打包音频基本流。 |
FMP4 |
string 以 ISO BMFF CMAF 拆分 MP4 格式打包的音频。 |
HlsVideoSegmentFormat
string
HLS 视频片段的格式。
值 |
|
---|---|
MPEG2_TS |
string MPEG-2 传输流。支持 AVC。 |
FMP4 |
string 以 ISO BMFF CMAF 分段 MP4 格式打包的视频。支持 AVC 和 HEVC。 |
IdleReason
string
播放器处于闲置状态的原因。
值 |
|
---|---|
CANCELLED |
string 发送者使用 STOP 命令请求停止播放。 |
INTERRUPTED |
string 发送者请求使用 LOAD 命令播放其他媒体。 |
FINISHED |
string 媒体播放完毕。 |
错误 |
string 媒体因出错而中断。例如,如果播放器因网络错误而无法下载媒体,就可能会发生这种情况。 |
MediaCategory
string
媒体类别。
值 |
|
---|---|
音频 |
string 媒体内容仅包含音频。 |
视频 |
string 媒体为视频和音频(默认)。 |
IMAGE |
string 媒体就是图片。 |
MessageType
string
表示要被 cast.framework.PlayerManager 拦截的媒体消息类型。消息类型分为请求或传出消息。通过请求,应用可以在 Web 接收器 SDK 处理数据之前修改任何数据。外发的消息允许应用在将消息发送到连接的系统和发送者应用之前修改任何数据。
值 |
|
---|---|
MEDIA_STATUS |
string 表示当前媒体状态的传出消息。 消息类型为:cast.framework.messages.MediaStatus。 |
CLOUD_STATUS |
string 向云端发送器发送的媒体状态消息。 消息类型为:cast.framework.messages.CloudMediaStatus。 |
QUEUE_CHANGE |
string 队列更改的传出消息。消息类型为:cast.framework.messages.QueueChange。 |
QUEUE_ITEMS |
string 队列项信息的传出消息。消息类型为:cast.framework.messages.ItemsInfo。 |
QUEUE_ITEM_IDS |
string 队列 ID 列表的传出消息。消息类型为:cast.framework.messages.QueueIds。 |
GET_STATUS |
string 请求当前媒体状态。 消息类型为:cast.framework.messages.GetStatusRequestData。 |
放进 |
string 请求加载媒体。 消息类型为:cast.framework.messages.LoadRequestData。 |
暂停 |
string 请求暂停播放器。 消息类型为:cast.framework.messages.RequestData |
停止 |
string 请求停止播放器。 消息类型为:cast.framework.messages.RequestData。 |
游戏 |
string 请求继续播放。 消息类型为:cast.framework.messages.RequestData。 |
SKIP_AD |
string 请求跳过广告。 消息类型为:cast.framework.messages.RequestData。 |
PLAY_AGAIN |
string 请求再次播放当前媒体。 消息类型为:cast.framework.messages.RequestData。 |
寻找 |
string 请求播放媒体。 消息类型为:cast.framework.messages.SeekRequestData。 |
SET_PLAYBACK_RATE |
string 请求更改播放速率。 消息类型为:cast.framework.messages.SetPlaybackRateRequestData。 |
SET_VOLUME |
string 请求更改当前媒体音量。 消息类型为:cast.framework.messages.VolumeRequestData。 |
EDIT_TRACKS_INFO |
string 请求更改播放文本或音轨。 消息类型为:cast.framework.messages.EditTracksInfoRequestData。 |
EDIT_AUDIO_TRACKS |
string 请求更改播放曲目。 消息类型为:cast.framework.messages.EditAudioTracksRequestData。 |
预缓存 |
string 请求预缓存数据。 消息类型为:cast.framework.messages.PrecacheRequestData。 |
预加载 |
string 请求预加载商品。 消息类型为:cast.framework.messages.PreloadRequestData。 |
QUEUE_LOAD |
string 请求加载队列。 消息类型为:cast.framework.messages.QueueLoadRequestData。 |
QUEUE_INSERT |
string 请求插入队列中。 消息类型为:cast.framework.messages.QueueInsertRequestData。 |
QUEUE_UPDATE |
string 请求更新队列。 消息类型为:cast.framework.messages.QueueUpdateRequestData。 |
QUEUE_REMOVE |
string 请求从队列中移除。 消息类型为:cast.framework.messages.QueueRemoveRequestData。 |
QUEUE_REORDER |
string 请求对队列重新排序。 消息类型为:cast.framework.messages.QueueReorderRequestData。 |
QUEUE_NEXT |
string 请求队列中的下一项。当接收器从发送者收到此信息时,消息会映射到 |
QUEUE_PREV |
string 请求队列中的上一项。当接收器从发送者收到此信息时,消息会映射到 |
QUEUE_GET_ITEM_RANGE |
string 请求提取队列中的项。 消息类型为:cast.framework.messages.FetchItemsRequestData。 |
QUEUE_GET_ITEMS |
string 请求获取内容信息。消息类型为:cast.framework.messages.GetItemsInfoRequestData。 |
QUEUE_GET_ITEM_IDS |
string 请求获取队列 ID。 消息类型为:cast.framework.messages.RequestData。 |
QUEUE_SHUFFLE |
string 请求随机播放队列。 消息类型为:cast.framework.messages.RequestData。 |
SET_CREDENTIALS |
string 设置用户凭据。 消息类型为:cast.framework.messages.SetCredentialsRequestData。 |
LOAD_BY_ENTITY |
string 按实体 ID 加载媒体。 消息类型为:cast.framework.messages.LoadByEntityRequestData。 |
USER_ACTION |
string 按如下方式处理用户操作。 消息类型为:cast.framework.messages.UserActionRequestData。 |
DISPLAY_STATUS |
string 在屏幕上显示媒体状态。 消息类型为:cast.framework.messages.DisplayStatusRequestData。 |
FOCUS_STATE |
string 接收端应用焦点状态已更改。 消息类型为:cast.framework.messages.FocusStateRequestData。 |
CUSTOM_COMMAND |
string 处理自定义应用命令。 消息类型为:cast.framework.messages.CustomCommandRequestData。 |
STORE_SESSION |
string 存储会话命令。 消息类型为:cast.framework.messages.StoreSessionRequestData。 |
RESUME_SESSION |
string 恢复会话命令。 消息类型为:cast.framework.messages.ResumeSessionRequestData。 |
SESSION_STATE |
string StoreSession 的响应类型。 消息类型为:cast.framework.messages.StoreSessionResponseData。 |
MetadataType
number
媒体元数据的类型。
值 |
|
---|---|
常规 |
number 适合大多数媒体类型的通用模板。 由 cast.framework.messages.GenericMediaMetadata 使用。 |
电影 |
number 完整影片。 由 cast.framework.messages.MovieMediaMetadata 使用。 |
TV_SHOW |
number 电视连续剧的剧集。 由 cast.framework.messages.TvShowMediaMetadata 使用。 |
MUSIC_TRACK |
number 音乐曲目。 供 cast.framework.messages.MusicTrackMediaMetadata 使用。 |
照片 |
number |
AUDIOBOOK_CHAPTER |
number 有声读物章节。 由 cast.framework.messages.AudiobookChapterMediaMetadata 使用。 |
- 另请参阅
- cast.framework.messages.MediaInformation.metadata
PlayerState
string
表示播放器状态。
值 |
|
---|---|
空闲 |
string 播放器处于闲置状态。IDLE 状态表示没有正在进行的播放。通常,在 Cast 应用启动后,播放器会在收到 LOAD 请求之前或播放结束后即处于此状态。播放器会根据 cast.framework.messages.MediaStatus 中设置的 cast.framework.messages.IdleReason 转换为此状态。 |
正在播放 |
string 播放器处于“正在播放”状态。 |
已暂停 |
string 播放器处于暂停状态。 |
正在缓冲 |
string 播放器处于“正在缓冲”状态。 |
QueueChangeType
string
QUEUE_CHANGE
传出消息使用的队列更改类型。
值 |
|
---|---|
INSERT |
string 队列中已插入项。 |
移除 (Remove) |
string 队列已移除项目。 |
ITEMS_CHANGE |
string 已更改的内容列表。 |
更新 |
string 队列已更新,并发送一个新的有序列表。 |
NO_CHANGE |
string 队列没有任何变化。当多个发送者最终请求了相同的数据时,这用于回显。 |
QueueType
string
媒体容器/队列的类型。
值 |
|
---|---|
专辑 |
string 音乐专辑。 |
播放列表 |
string 音乐播放列表,例如私享播放列表、公开播放列表或自动生成的播放列表。 |
有声读物 |
string 有声读物。 |
RADIO_STATION |
string 传统电台。 |
PODCAST_SERIES |
string 播客系列。 |
TV_SERIES |
string 电视连续剧。 |
VIDEO_PLAYLIST |
string 视频播放列表。 |
LIVE_TV |
string 直播电视频道。 |
电影 |
string 影片。 |
RepeatMode
string
播放所有项时队列的行为。
值 |
|
---|---|
REPEAT_OFF |
string 队列完成后,媒体会话会终止。 |
REPEAT_ALL |
string 队列中的所有项都将无限播放,当最后一项被播放时,它会再次播放第一项。 |
REPEAT_SINGLE |
string 系统会重复播放当前项。 |
REPEAT_ALL_AND_SHUFFLE |
string 队列中的所有项都将无限播放,当最后一项被播放时,它将再次播放第一项(列表将首先由接收器随机播放)。 |
SeekResumeState
string
表示 SEEK 请求之后的播放状态。
值 |
|
---|---|
PLAYBACK_START |
string 这会强制启动媒体。 |
PLAYBACK_PAUSE |
string 这会强制媒体暂停播放。 |
StreamingProtocolType
number
流式传输协议类型。
值 |
|
---|---|
未知 |
number 未知的流式传输协议类型。 |
MPEG_DASH |
number MPEG-DASH(基于 HTTP 的动态自适应流式传输)协议类型。 |
HLS |
number HLS (HTTP Live Streaming) 协议类型。 |
SMOOTH_STREAMING |
number 流畅流式传输协议类型。 |
StreamType
string
表示流类型。
值 |
|
---|---|
缓冲 |
string VOD 和 DVR 内容。 |
直播 |
string 线性直播内容。 |
无 |
string |
TextTrackEdgeType
string
定义文本轨道边缘(边框)类型。
值 |
|
---|---|
无 |
string 文本周围没有显示边框。 |
大纲 |
string 文本周围会显示一个实心轮廓。 |
DROP_SHADOW |
string 文本周围渲染淡出阴影。 |
已提升 |
string 文字相对于背景有压花或凸起。 |
抑制 |
string 文字的背景似乎有凹痕。 |
TextTrackFontGenericFamily
string
如果文本轨道中未定义相应字体,则要使用的通用字体系列。
值 |
|
---|---|
SANS_SERIF |
string 使用 sans-serif 字体。 |
MONOSPACED_SANS_SERIF |
string 使用等宽的 Sans-serif 字体。 |
Serif |
string 使用 serif 字体。 |
MONOSPACED_SERIF |
string 使用等宽 serif 字体。 |
随机观众 |
string 使用休闲的手写样式字体。 |
游行 |
string 使用手写字体。 |
SMALL_CAPITALS |
string 使用较小的大写字母。 |
TextTrackFontStyle
string
文本轨道字体样式。
值 |
|
---|---|
NORMAL |
string 未经修改的字体。 |
粗体 |
string 粗体样式。 |
BOLD_ITALIC |
string 同时以粗体和斜体显示样式。 |
位置 |
string 斜体样式。 |
TextTrackType
string
文本轨道类型(遵循 HTML5 文本轨道类型定义)。
值 |
|
---|---|
字幕 |
string 对话的转录或翻译,适合在有声音但观看者无法听懂的情况下(例如,因为观看者不理解媒体资源配乐的语言)。 |
字幕 |
string 对话、音效、相关音乐提示和其他相关音频信息的转录或翻译,适合在配乐不可用(例如,由于声音被静音或用户听力受损)时使用。字幕会显示在视频上。 |
说明 |
string 媒体资源的视频组件的文字说明,适用于视觉组件不可用时(例如,因为用户在没有屏幕的情况下与应用互动,或者用户有视力障碍)时进行音频合成。说明将合成为单独的音轨。 |
章节 |
string 章节标题,旨在用于浏览媒体资源。 |
元数据 |
string 旨在通过脚本使用的轨道。 |
TextTrackWindowType
string
文本跟踪窗口类型。
值 |
|
---|---|
无 |
string |
NORMAL |
string |
ROUNDED_CORNERS |
string |
TrackType
string
媒体轨道类型。
值 |
|
---|---|
文字 |
string 文本轨道。 |
音频 |
string 音轨。 |
视频 |
string 视频轨道。 |
UserAction
string
用户操作。
值 |
|
---|---|
LIKE |
string 用户表明对当前正在播放的内容具有类似偏好。 |
踩 |
string 用户表示不喜欢当前正在播放的内容。 |
关注 |
string 用户想要关注当前播放的内容或为其加注星标。 |
取消关注 |
string 用户想要停止关注当前正在播放的内容。 |
举报 |
string 用户标记当前正在播放的内容为不当内容。 |
SKIP_AD |
string 用户想要跳过当前播放的广告。 |
歌词 |
string 用户想显示当前播放的歌曲的歌词。 |
UserActionContext
string
UserAction
的上下文信息。
值 |
|
---|---|
UNKNOWN_CONTEXT |
string |
跟踪 |
string |
专辑 |
string |
音乐人 |
string |
播放列表 |
string |
分集 |
string |
系列 |
string |
电影 |
string |
频道 |
string |
团队 |
string |
播放器 |
string |
教练 |
string |
属性
CaptionMimeType
string
文字轨道的字幕 MIME 类型。
值 |
|
---|---|
CEA608 |
string 欧洲、中东和非洲地区 608 |
TTML |
string TTML |
VTT |
string VTT |
TTML_MP4 |
string TTML MP4 |
命令
number
位掩码值列表,用于为 cast.framework.messages.MediaStatus#supportedMediaCommands 设置或检索应用支持的媒体命令。
值 |
|
---|---|
暂停 |
number 暂停命令。 |
寻找 |
number 跳转命令。 |
STREAM_VOLUME |
number 在线播放音量命令。 |
STREAM_MUTE |
number 在线播放音量命令。 |
ALL_BASIC_MEDIA |
number 所有基本媒体。包含强制性命令 |
QUEUE_NEXT |
number Queue Next 命令。 |
QUEUE_PREV |
number 队列上一个命令。 |
QUEUE_SHUFFLE |
number 队列重排命令。 |
QUEUE_REPEAT_ALL |
number 队列全部重复模式。 |
QUEUE_REPEAT_ONE |
number 队列重复一次模式。 |
QUEUE_REPEAT |
number 队列重复模式。 |
SKIP_AD |
number 跳过 AD 命令。 |
EDIT_TRACKS |
number 修改跟踪命令。 |
PLAYBACK_RATE |
number 播放速率命令。 |
LIKE |
number 用户操作,如命令。 |
踩 |
number 用户操作“踩”命令。 |
关注 |
number 用户操作 - 按照命令执行操作。 |
取消关注 |
number 用户操作“取消关注”命令。 |
STREAM_TRANSFER |
number 流式传输命令。 |
歌词 |
number 歌词命令。 |
ContainerType
number
容器元数据的类型。
值 |
|
---|---|
GENERIC_CONTAINER |
number 适合大多数媒体类型的通用模板。 由 cast.framework.messages.ContainerMetadata 使用。 |
AUDIOBOOK_CONTAINER |
number 有声读物的元数据。 由 cast.framework.messages.AudiobookContainerMetadata 使用。 |
- 另请参阅
- cast.framework.messages.QueueData.containerMetadata
ContentFilteringMode
string
表示内容过滤模式。
值 |
|
---|---|
FILTER_EXPLICIT |
string 请勿播放露骨内容。 |
ErrorReason
string
表示媒体错误消息原因。
值 |
|
---|---|
INVALID_COMMAND |
string 当命令无效或未实现时,系统会返回此错误代码。 |
INVALID_PARAMS |
string 当参数无效或缺少必需参数时,系统会返回此错误代码。 |
INVALID_MEDIA_SESSION_ID |
string 当媒体会话不存在时,系统会返回此错误代码。 |
SKIP_LIMIT_REACHED |
string 当因达到跳过限制而无法跳过更多项时返回。 |
NOT_SUPPORTED |
string 当应用不支持请求时,系统会返回此错误代码。 |
LANGUAGE_NOT_SUPPORTED |
string 当请求的语言不受支持时,系统会返回此错误代码。 |
END_OF_QUEUE |
string 当由于返回超出第一项或前进超出队列中的最后一项而无法跳过时,系统会返回此错误代码。 |
DUPLICATE_REQUEST_ID |
string 当请求 ID 不唯一(接收器正在处理具有相同 ID 的请求)时,系统会返回此错误代码。 |
VIDEO_DEVICE_REQUIRED |
string 当因为需要支持视频的设备而无法完成请求时,系统会返回此错误代码。 |
PREMIUM_ACCOUNT_REQUIRED |
string 当请求成功需要使用高级账号时,系统会返回此错误代码。 |
APP_ERROR |
string 当应用状态无效而无法满足请求时,系统会返回此错误代码。 |
AUTHENTICATION_EXPIRED |
string 当身份验证已过期(例如用户更改密码或令牌被撤消)时,系统会返回此错误代码。 |
CONCURRENT_STREAM_LIMIT |
string 当检测到太多并发流时,系统会返回此错误代码。 |
PARENTAL_CONTROL_RESTRICTED |
string 当内容因家长控制而被屏蔽时,系统会返回此错误代码。 |
CONTENT_FILTERED |
string 当内容因过滤而被屏蔽时,系统会返回此值。 |
NOT_AVAILABLE_IN_REGION |
string 当内容因在部分地区不可用而被屏蔽时,系统会返回此值。 |
CONTENT_ALREADY_PLAYING |
string 当请求的内容已经开始播放时返回。 |
INVALID_REQUEST |
string 当请求无效时,系统会返回此错误代码。 |
GENERIC_LOAD_ERROR |
string 当加载请求遇到间歇性问题时,系统会返回此错误代码。 |
ErrorType
string
表示媒体错误消息类型。
值 |
|
---|---|
INVALID_PLAYER_STATE |
string 当播放器的状态无效而无法满足请求时返回。 |
LOAD_FAILED |
string LOAD 请求失败时返回。 |
LOAD_CANCELLED |
string 当 LOAD 请求被第二个传入的 LOAD 请求取消时,系统会返回此错误代码。 |
INVALID_REQUEST |
string 当请求无效时,系统会返回此错误代码。 |
错误 |
string 一般错误,针对任何其他错误情况。 |
ExtendedPlayerState
string
扩展了播放器状态信息。
值 |
|
---|---|
正在加载 |
string 播放器处于“正在加载”状态。 |
FocusState
string
焦点状态。
值 |
|
---|---|
IN_FOCUS |
string 接收者对焦。 |
NOT_IN_FOCUS |
string 接收器未处于焦点,其他活动处于活动状态。 |
GetStatusOptions
number
GetStatusOptions
用于确定在对 GET_STATUS
消息的媒体状态响应中必须包含的数据量。
值 |
|
---|---|
NO_METADATA |
number 请勿包含元数据标志。 |
NO_QUEUE_ITEMS |
number 请勿添加队列项标志。 |
HdrType
string
表示视频高动态范围 (HDR) 类型。
值 |
|
---|---|
SDR |
string 标准动态范围。 |
HDR |
string 高动态范围。 |
DV |
string 杜比视界。 |
HlsSegmentFormat
string
HLS 音频片段的格式。
值 |
|
---|---|
AAC |
string AAC 打包音频基本流。 |
AC3 |
string AC3 打包的音频基本流。 |
MP3 |
string MP3 打包音频基本流。 |
TS |
string MPEG-2 传输流。 |
TS_AAC |
string AAC 低复杂性打包 MPEG-2 传输流 (AAC-LC)。 |
TS_HE_AAC |
string AAC 高效打包 MPEG-2 传输流 (HE-AAC)。 |
E_AC3 |
string E-AC3 打包音频基本流。 |
FMP4 |
string 以 ISO BMFF CMAF 拆分 MP4 格式打包的音频。 |
HlsVideoSegmentFormat
string
HLS 视频片段的格式。
值 |
|
---|---|
MPEG2_TS |
string MPEG-2 传输流。支持 AVC。 |
FMP4 |
string 以 ISO BMFF CMAF 分段 MP4 格式打包的视频。支持 AVC 和 HEVC。 |
IdleReason
string
播放器处于闲置状态的原因。
值 |
|
---|---|
CANCELLED |
string 发送者使用 STOP 命令请求停止播放。 |
INTERRUPTED |
string 发送者请求使用 LOAD 命令播放其他媒体。 |
FINISHED |
string 媒体播放完毕。 |
错误 |
string 媒体因出错而中断。例如,如果播放器因网络错误而无法下载媒体,就可能会发生这种情况。 |
MediaCategory
string
媒体类别。
值 |
|
---|---|
音频 |
string 媒体内容仅包含音频。 |
视频 |
string 媒体为视频和音频(默认)。 |
IMAGE |
string 媒体就是图片。 |
MessageType
string
表示要被 cast.framework.PlayerManager 拦截的媒体消息类型。消息类型分为请求或传出消息。通过请求,应用可以在 Web 接收器 SDK 处理数据之前修改任何数据。外发的消息允许应用在将消息发送到连接的系统和发送者应用之前修改任何数据。
值 |
|
---|---|
MEDIA_STATUS |
string 表示当前媒体状态的传出消息。 消息类型为:cast.framework.messages.MediaStatus。 |
CLOUD_STATUS |
string 向云端发送器发送的媒体状态消息。 消息类型为:cast.framework.messages.CloudMediaStatus。 |
QUEUE_CHANGE |
string 队列更改的传出消息。消息类型为:cast.framework.messages.QueueChange。 |
QUEUE_ITEMS |
string 队列项信息的传出消息。消息类型为:cast.framework.messages.ItemsInfo。 |
QUEUE_ITEM_IDS |
string 队列 ID 列表的传出消息。消息类型为:cast.framework.messages.QueueIds。 |
GET_STATUS |
string 请求当前媒体状态。 消息类型为:cast.framework.messages.GetStatusRequestData。 |
放进 |
string 请求加载媒体。 消息类型为:cast.framework.messages.LoadRequestData。 |
暂停 |
string 请求暂停播放器。 消息类型为:cast.framework.messages.RequestData |
停止 |
string 请求停止播放器。 消息类型为:cast.framework.messages.RequestData。 |
游戏 |
string 请求继续播放。 消息类型为:cast.framework.messages.RequestData。 |
SKIP_AD |
string 请求跳过广告。 消息类型为:cast.framework.messages.RequestData。 |
PLAY_AGAIN |
string 请求再次播放当前媒体。 消息类型为:cast.framework.messages.RequestData。 |
寻找 |
string 请求播放媒体。 消息类型为:cast.framework.messages.SeekRequestData。 |
SET_PLAYBACK_RATE |
string 请求更改播放速率。 消息类型为:cast.framework.messages.SetPlaybackRateRequestData。 |
SET_VOLUME |
string 请求更改当前媒体音量。 消息类型为:cast.framework.messages.VolumeRequestData。 |
EDIT_TRACKS_INFO |
string 请求更改播放文本或音轨。 消息类型为:cast.framework.messages.EditTracksInfoRequestData。 |
EDIT_AUDIO_TRACKS |
string 请求更改播放曲目。 消息类型为:cast.framework.messages.EditAudioTracksRequestData。 |
预缓存 |
string 请求预缓存数据。 消息类型为:cast.framework.messages.PrecacheRequestData。 |
预加载 |
string 请求预加载商品。 消息类型为:cast.framework.messages.PreloadRequestData。 |
QUEUE_LOAD |
string 请求加载队列。 消息类型为:cast.framework.messages.QueueLoadRequestData。 |
QUEUE_INSERT |
string 请求插入队列中。 消息类型为:cast.framework.messages.QueueInsertRequestData。 |
QUEUE_UPDATE |
string 请求更新队列。 消息类型为:cast.framework.messages.QueueUpdateRequestData。 |
QUEUE_REMOVE |
string 请求从队列中移除。 消息类型为:cast.framework.messages.QueueRemoveRequestData。 |
QUEUE_REORDER |
string 请求对队列重新排序。 消息类型为:cast.framework.messages.QueueReorderRequestData。 |
QUEUE_NEXT |
string 请求队列中的下一项。当接收器从发送者收到此信息时,消息会映射到 |
QUEUE_PREV |
string 请求队列中的上一项。当接收器从发送者收到此信息时,消息会映射到 |
QUEUE_GET_ITEM_RANGE |
string 请求提取队列中的项。 消息类型为:cast.framework.messages.FetchItemsRequestData。 |
QUEUE_GET_ITEMS |
string 请求获取内容信息。消息类型为:cast.framework.messages.GetItemsInfoRequestData。 |
QUEUE_GET_ITEM_IDS |
string 请求获取队列 ID。 消息类型为:cast.framework.messages.RequestData。 |
QUEUE_SHUFFLE |
string 请求随机播放队列。 消息类型为:cast.framework.messages.RequestData。 |
SET_CREDENTIALS |
string 设置用户凭据。 消息类型为:cast.framework.messages.SetCredentialsRequestData。 |
LOAD_BY_ENTITY |
string 按实体 ID 加载媒体。 消息类型为:cast.framework.messages.LoadByEntityRequestData。 |
USER_ACTION |
string 按如下方式处理用户操作。 消息类型为:cast.framework.messages.UserActionRequestData。 |
DISPLAY_STATUS |
string 在屏幕上显示媒体状态。 消息类型为:cast.framework.messages.DisplayStatusRequestData。 |
FOCUS_STATE |
string 接收端应用焦点状态已更改。 消息类型为:cast.framework.messages.FocusStateRequestData。 |
CUSTOM_COMMAND |
string 处理自定义应用命令。 消息类型为:cast.framework.messages.CustomCommandRequestData。 |
STORE_SESSION |
string 存储会话命令。 消息类型为:cast.framework.messages.StoreSessionRequestData。 |
RESUME_SESSION |
string 恢复会话命令。 消息类型为:cast.framework.messages.ResumeSessionRequestData。 |
SESSION_STATE |
string StoreSession 的响应类型。 消息类型为:cast.framework.messages.StoreSessionResponseData。 |
MetadataType
number
媒体元数据的类型。
值 |
|
---|---|
常规 |
number 适合大多数媒体类型的通用模板。 由 cast.framework.messages.GenericMediaMetadata 使用。 |
电影 |
number 完整影片。 由 cast.framework.messages.MovieMediaMetadata 使用。 |
TV_SHOW |
number 电视连续剧的剧集。 由 cast.framework.messages.TvShowMediaMetadata 使用。 |
MUSIC_TRACK |
number 音乐曲目。 供 cast.framework.messages.MusicTrackMediaMetadata 使用。 |
照片 |
number |
AUDIOBOOK_CHAPTER |
number 有声读物章节。 由 cast.framework.messages.AudiobookChapterMediaMetadata 使用。 |
- 另请参阅
- cast.framework.messages.MediaInformation.metadata
PlayerState
string
表示播放器状态。
值 |
|
---|---|
空闲 |
string 播放器处于闲置状态。IDLE 状态表示没有正在进行的播放。通常,在 Cast 应用启动后,播放器会在收到 LOAD 请求之前或播放结束后即处于此状态。播放器会根据 cast.framework.messages.MediaStatus 中设置的 cast.framework.messages.IdleReason 转换为此状态。 |
正在播放 |
string 播放器处于“正在播放”状态。 |
已暂停 |
string 播放器处于暂停状态。 |
正在缓冲 |
string 播放器处于“正在缓冲”状态。 |
QueueChangeType
string
QUEUE_CHANGE
传出消息使用的队列更改类型。
值 |
|
---|---|
INSERT |
string 队列中已插入项。 |
移除 (Remove) |
string 队列已移除项目。 |
ITEMS_CHANGE |
string 已更改的内容列表。 |
更新 |
string 队列已更新,并发送一个新的有序列表。 |
NO_CHANGE |
string 队列没有任何变化。当多个发送者最终请求了相同的数据时,这用于回显。 |
QueueType
string
媒体容器/队列的类型。
值 |
|
---|---|
专辑 |
string 音乐专辑。 |
播放列表 |
string 音乐播放列表,例如私享播放列表、公开播放列表或自动生成的播放列表。 |
有声读物 |
string 有声读物。 |
RADIO_STATION |
string 传统电台。 |
PODCAST_SERIES |
string 播客系列。 |
TV_SERIES |
string 电视连续剧。 |
VIDEO_PLAYLIST |
string 视频播放列表。 |
LIVE_TV |
string 直播电视频道。 |
电影 |
string 影片。 |
RepeatMode
string
播放所有项时队列的行为。
值 |
|
---|---|
REPEAT_OFF |
string 队列完成后,媒体会话会终止。 |
REPEAT_ALL |
string 队列中的所有项都将无限播放,当最后一项被播放时,它会再次播放第一项。 |
REPEAT_SINGLE |
string 系统会重复播放当前项。 |
REPEAT_ALL_AND_SHUFFLE |
string 队列中的所有项都将无限播放,当最后一项被播放时,它将再次播放第一项(列表将首先由接收器随机播放)。 |
SeekResumeState
string
表示 SEEK 请求之后的播放状态。
值 |
|
---|---|
PLAYBACK_START |
string 这会强制启动媒体。 |
PLAYBACK_PAUSE |
string 这会强制媒体暂停播放。 |
StreamingProtocolType
number
流式传输协议类型。
值 |
|
---|---|
未知 |
number 未知的流式传输协议类型。 |
MPEG_DASH |
number MPEG-DASH(基于 HTTP 的动态自适应流式传输)协议类型。 |
HLS |
number HLS (HTTP Live Streaming) 协议类型。 |
SMOOTH_STREAMING |
number 流畅流式传输协议类型。 |
StreamType
string
表示流类型。
值 |
|
---|---|
缓冲 |
string VOD 和 DVR 内容。 |
直播 |
string 线性直播内容。 |
无 |
string |
TextTrackEdgeType
string
定义文本轨道边缘(边框)类型。
值 |
|
---|---|
无 |
string 文本周围没有显示边框。 |
大纲 |
string 文本周围会显示一个实心轮廓。 |
DROP_SHADOW |
string 文本周围渲染淡出阴影。 |
已提升 |
string 文字相对于背景有压花或凸起。 |
抑制 |
string 文字的背景似乎有凹痕。 |
TextTrackFontGenericFamily
string
如果文本轨道中未定义相应字体,则要使用的通用字体系列。
值 |
|
---|---|
SANS_SERIF |
string 使用 sans-serif 字体。 |
MONOSPACED_SANS_SERIF |
string 使用等宽的 Sans-serif 字体。 |
Serif |
string 使用 serif 字体。 |
MONOSPACED_SERIF |
string 使用等宽 serif 字体。 |
随机观众 |
string 使用休闲的手写样式字体。 |
游行 |
string 使用手写字体。 |
SMALL_CAPITALS |
string 使用较小的大写字母。 |
TextTrackFontStyle
string
文本轨道字体样式。
值 |
|
---|---|
NORMAL |
string 未经修改的字体。 |
粗体 |
string 粗体样式。 |
BOLD_ITALIC |
string 同时以粗体和斜体显示样式。 |
位置 |
string 斜体样式。 |
TextTrackType
string
文本轨道类型(遵循 HTML5 文本轨道类型定义)。
值 |
|
---|---|
字幕 |
string 对话的转录或翻译,适合在有声音但观看者无法听懂的情况下(例如,因为观看者不理解媒体资源配乐的语言)。 |
字幕 |
string 对话、音效、相关音乐提示和其他相关音频信息的转录或翻译,适合在配乐不可用(例如,由于声音被静音或用户听力受损)时使用。字幕会显示在视频上。 |
说明 |
string 媒体资源的视频组件的文字说明,适用于视觉组件不可用时(例如,因为用户在没有屏幕的情况下与应用互动,或者用户有视力障碍)时进行音频合成。说明将合成为单独的音轨。 |
章节 |
string 章节标题,旨在用于浏览媒体资源。 |
元数据 |
string 旨在通过脚本使用的轨道。 |
TextTrackWindowType
string
文本跟踪窗口类型。
值 |
|
---|---|
无 |
string |
NORMAL |
string |
ROUNDED_CORNERS |
string |
TrackType
string
媒体轨道类型。
值 |
|
---|---|
文字 |
string 文本轨道。 |
音频 |
string 音轨。 |
视频 |
string 视频轨道。 |
UserAction
string
用户操作。
值 |
|
---|---|
LIKE |
string 用户表明对当前正在播放的内容具有类似偏好。 |
踩 |
string 用户表示不喜欢当前正在播放的内容。 |
关注 |
string 用户想要关注当前播放的内容或为其加注星标。 |
取消关注 |
string 用户想要停止关注当前正在播放的内容。 |
举报 |
string 用户标记当前正在播放的内容为不当内容。 |
SKIP_AD |
string 用户想要跳过当前播放的广告。 |
歌词 |
string 用户想显示当前播放的歌曲的歌词。 |
UserActionContext
string
UserAction
的上下文信息。
值 |
|
---|---|
UNKNOWN_CONTEXT |
string |
跟踪 |
string |
专辑 |
string |
音乐人 |
string |
播放列表 |
string |
分集 |
string |
系列 |
string |
电影 |
string |
频道 |
string |
团队 |
string |
播放器 |
string |
教练 |
string |