cast. framework. events
这是 cast.framework.events 命名空间。
类
BitrateChangedEvent
cast.framework.events.EventType.BITRATE_CHANGED 事件的事件数据。
BreaksEvent
与广告插播时间点相关的所有事件的事件数据:cast.framework.events.EventType.BREAK_ENDED、cast.framework.events.EventType.BREAK_STARTED、cast.framework.events.EventType.BREAK_CLIP_ENDED、cast.framework.events.EventType.BREAK_CLIP_LOADING 和 cast.framework.events.EventType.BREAK_CLIP_STARTED
BufferingEvent
cast.framework.events.EventType.BUFFERING 事件的事件数据。
CacheItemEvent
cast.framework.events.EventType.CACHE_HIT 事件或 cast.framework.events.EventType.CACHE_INSERTED 事件的事件数据。
CacheLoadedEvent
cast.framework.events.EventType.CACHE_LOADED 事件的事件数据。
ClipEndedEvent
cast.framework.events.EventType.CLIP_ENDED 事件的事件数据。
CustomStateEvent
cast.framework.events.EventType.CUSTOM_STATE 事件的事件数据。
EmsgEvent
cast.framework.events.EventType.EMSG 事件的事件数据。
ErrorEvent
cast.framework.events.EventType.ERROR 事件的事件数据。
事件
cast.framework.PlayerManager 调度的所有事件的事件数据父类。
Id3Event
cast.framework.events.EventType.ID3 事件的事件数据。
此处提供的 ID3 元数据遵循 ID3 v2 格式。
ID3 消息中的每个帧都会触发一个事件。
此事件不包含完整的原始 ID3 消息。假设 ID3 消息包含以下子部分:
- ID3v2/文件标识符
- ID3v2 版本
- ID3v2 标志
- ID3v2 大小
- 帧类型(即
TXXX) - 帧大小
- 帧标志
- 帧编码
- 框架说明
- 帧数据
此事件中仅提供商品 5 (frameType)、9 (frameDescription) 和 10 (segmentData)。
LiveStatusEvent
cast.framework.events.EventType.LIVE_IS_MOVING_WINDOW_CHANGED 事件或 cast.framework.events.EventType.LIVE_ENDED 事件的事件数据。
LoadEvent
与处理加载或预加载请求相关的所有事件的事件数据。 对播放器所做的更改。
MediaElementEvent
从 MediaElement 转发的所有事件的事件数据。
MediaFinishedEvent
cast.framework.events.EventType.MEDIA_FINISHED 事件的事件数据。
MediaInformationChangedEvent
cast.framework.events.EventType.MEDIA_INFORMATION_CHANGED 事件的事件数据。
MediaPauseEvent
从 MediaElement 转发的 pause 事件的事件数据。
MediaStatusEvent
cast.framework.events.EventType.MEDIA_STATUS 事件的事件数据。
RequestEvent
所有代表向接收器发出的请求的事件的事件数据。
SegmentDownloadedEvent
cast.framework.events.EventType.SEGMENT_DOWNLOADED 事件的事件数据。
SessionDataEvent
cast.framework.events.EventType.SESSION_DATA 事件的事件数据。
针对 HLS EXT-X-SESSION-DATA 标记触发,且仅在使用 Shaka Player 时触发。
TimedMetadataEvent
定时元数据事件的事件数据父类。这与 Id3Event 的不同之处在于,元数据保存在清单中,而不是片段内部。
TracksChangedEvent
cast.framework.events.EventType.TRACKS_CHANGED 事件的事件数据。
命名空间
category
枚举
DetailedErrorCode
数值
由接收端 SDK 分配的代码,用于描述发生的错误。
值 |
|
|---|---|
|
MEDIA_UNKNOWN |
数值 当 HTMLMediaElement 抛出错误,但 CAF 无法识别特定错误时返回。 |
|
MEDIA_ABORTED |
数值 当用户代理应用户请求中止媒体资源的提取过程时返回。 |
|
MEDIA_DECODE |
数值 在确定媒体资源可用后,如果解码该资源时出错,则返回此错误。 |
|
MEDIA_NETWORK |
数值 在确定媒体资源可用后,如果网络连接错误导致用户代理停止提取该资源,则返回此错误。 |
|
MEDIA_SRC_NOT_SUPPORTED |
数值 当 src 属性指示的媒体资源不合适时返回。 |
|
SOURCE_BUFFER_FAILURE |
数值 在无法将来源缓冲区添加到 MediaSource 时返回。 |
|
MEDIAKEYS_UNKNOWN |
数值 在媒体密钥出现未知错误时返回。 |
|
MEDIAKEYS_NETWORK |
数值 当因网络问题导致媒体密钥失败时返回。 |
|
MEDIAKEYS_UNSUPPORTED |
数值 在无法创建 MediaKeySession 对象时返回。 |
|
MEDIAKEYS_WEBCRYPTO |
数值 在加密失败时返回。 |
|
NETWORK_UNKNOWN |
数值 在出现未知网络问题时返回。 |
|
SEGMENT_NETWORK |
数值 在片段下载失败时返回。 |
|
HLS_NETWORK_MASTER_PLAYLIST |
数值 在 HLS 主播放列表下载失败时返回。 |
|
HLS_NETWORK_PLAYLIST |
数值 在 HLS 播放列表下载失败时返回。 |
|
HLS_NETWORK_NO_KEY_RESPONSE |
数值 在 HLS 密钥下载失败时返回。 |
|
HLS_NETWORK_KEY_LOAD |
数值 在 HLS 密钥请求发送之前失败时返回。 |
|
HLS_NETWORK_INVALID_SEGMENT |
数值 在 HLS 片段无效时返回。 |
|
HLS_SEGMENT_PARSING |
数值 在 HLS 片段无法解析时返回。 |
|
DASH_NETWORK |
数值 在处理 DASH 流时发生未知网络连接错误时返回。 |
|
DASH_NO_INIT |
数值 在 DASH 视频流缺少初始化时返回。 |
|
SMOOTH_NETWORK |
数值 在处理 Smooth 流时发生未知网络连接错误时返回。 |
|
SMOOTH_NO_MEDIA_DATA |
数值 在 Smooth 流缺少媒体数据时返回。 |
|
MANIFEST_UNKNOWN |
数值 在解析清单时发生未知错误时返回。 |
|
HLS_MANIFEST_MASTER |
数值 在解析 HLS 主清单时发生错误时返回。 |
|
HLS_MANIFEST_PLAYLIST |
数值 在解析 HLS 播放列表时发生错误时返回。 |
|
DASH_MANIFEST_UNKNOWN |
数值 在解析 DASH 清单时发生未知错误时返回。 |
|
DASH_MANIFEST_NO_PERIODS |
数值 当 DASH 清单缺少时段时返回。 |
|
DASH_MANIFEST_NO_MIMETYPE |
数值 在 DASH 清单缺少 MimeType 时返回。 |
|
DASH_INVALID_SEGMENT_INFO |
数值 当 DASH 清单包含无效的片段信息时返回。 |
|
SMOOTH_MANIFEST |
数值 在解析 Smooth 清单时出错时返回。 |
|
SEGMENT_UNKNOWN |
数值 在发生未知细分错误时返回。 |
|
TEXT_UNKNOWN |
数值 文本流发生未知错误。 |
|
应用 |
数值 在框架外部发生错误时返回(例如,如果事件处理脚本抛出错误)。 |
|
BREAK_CLIP_LOADING_ERROR |
数值 在广告插播片段加载拦截器失败时返回。 |
|
BREAK_SEEK_INTERCEPTOR_ERROR |
数值 在广告插播时间点跳转拦截器失败时返回。 |
|
IMAGE_ERROR |
数值 在图片加载失败时返回。 |
|
LOAD_INTERRUPTED |
数值 加载被卸载或另一个加载中断。 |
|
LOAD_FAILED |
数值 加载命令失败。 |
|
MEDIA_ERROR_MESSAGE |
数值 系统已向发件人发送出错提示。 |
|
GENERIC |
数值 在发生未知错误时返回。 |
EndedReason
字符串
播放结束的原因。
值 |
|
|---|---|
|
END_OF_STREAM |
字符串 由于当前直播已结束,播放已停止。 |
|
错误 |
字符串 由于出现错误,播放已结束。 |
|
已停止 |
字符串 播放已结束,因为某项操作强制我们停止了当前直播。 |
|
INTERRUPTED |
字符串 由于加载了新内容,播放已结束。 |
|
SKIPPED |
字符串 由于跳过广告操作,播放已结束。 |
|
BREAK_SWITCH |
字符串 由于切换了拼接的广告插播时间点,播放已结束。 |
|
PRELOAD_INTERRUPTED |
字符串 由于现有预加载播放器被中断或取代,播放已结束。这可将预加载取消与活跃播放器取消 (STOPPED) 区分开来。 |
|
LOAD_CANCELLED |
字符串 由于并发加载请求在完成之前被取消,播放已结束。这可将待处理的加载中止与活跃流中断 (INTERRUPTED) 区分开来。 |
|
SENDER_STOPPED |
字符串 由于发送端发出了明确的 STOP 请求,因此播放结束。这比一般 STOPPED 原因提供了更精细的信息。 |
|
LOAD_INTERRUPTED |
字符串 播放结束,具体原因是新的媒体加载中断了活跃播放器。这比活动流的通用 INTERRUPTED 原因更精细。 |
|
BREAK_INTERRUPTED |
字符串 由于插播广告播放器被中断(例如,通过跳转跳过广告插播时间点),播放已结束。这会将广告插播时间点中断与标准媒体中断 (INTERRUPTED) 区分开来。 |
|
BREAK_RESOLVED |
字符串 播放已结束,因为插播广告播放器已成功完成主要内容时长的解析。这与一般广告边界切换 (BREAK_SWITCH) 不同。 |
ErrorSeverity
数值
错误的严重程度。遵循与 Shaka Player 相同的命名方案和编号。
值 |
|
|---|---|
|
未知 |
数值 错误严重程度未知。 |
|
RECOVERABLE |
数值 发生错误,但播放器正在尝试从错误中恢复。 如果播放器最终无法恢复,它可能仍不会抛出 CRITICAL 错误。例如,重试媒体片段绝不会导致 CRITICAL 错误(播放器只会一直重试)。 |
|
危急 |
数值 播放器无法恢复的严重错误。这些错误会导致播放器停止播放当前媒体文件。 |
EventType
字符串
播放器事件类型。对于从 MediaElement 代理的事件,请参阅 https://dev.w3.org/html5/spec-preview/media-elements.html#mediaevents 了解详情。
值 |
|
|---|---|
|
全部 |
字符串 这是一个特殊标识符,可用于监听所有事件(主要用于调试目的)。该事件将是 cast.framework.events.Event 的子类。 |
|
中止 |
字符串 当浏览器在媒体完全下载之前停止提取媒体(但不是由于错误)时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
CAN_PLAY |
字符串 当浏览器可以继续播放片段,但估计加载的数据不足以播放到片段结束而无需停止缓冲时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
CAN_PLAY_THROUGH |
字符串 当浏览器估计可以播放完片段而无需停止缓冲时触发。请注意,浏览器估算值仅与当前播放的片段有关(例如:如果当前播放的是广告片段,则浏览器仅会估算广告片段,而不会估算完整内容)。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
DURATION_CHANGE |
字符串 在 MediaElement 的时长属性发生更改时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
已清空 |
字符串 在媒体内容变为空时触发。例如,当调用 load() 来重置 MediaElement 时,就会发生这种情况。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
已结束 |
字符串 在媒体片段完整播放后触发。这不包括剪辑因错误或停止请求而停止播放的情况。
如果存在广告,则每个广告最多触发一次,主要内容最多触发一次。此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。如果您想知道媒体何时播放完毕,则很可能需要使用 |
|
LOADED_DATA |
字符串 在浏览器加载完媒体片段的第一帧时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
LOADED_METADATA |
字符串 在浏览器加载完剪辑的元数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
LOAD_START |
字符串 在浏览器开始查找剪辑的媒体数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
暂停 |
字符串 在播放暂停时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaPauseEvent 中。 |
|
游戏 |
字符串 在准备好开始播放时(即暂停后)触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
正在播放 |
字符串 在播放开始时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
进度 |
字符串 在浏览器提取媒体数据时触发。如果您使用的是自适应比特率流式传输(例如 HLS、DASH、SMOOTH),则很可能需要改用 |
|
RATE_CHANGE |
字符串 播放速度更新时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
SEEKED |
字符串 在跳转完成时触发。如果媒体暂停时跳转结束,则不会触发此事件。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
SEEKING |
字符串 在媒体内容被跳转时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
STALLED |
字符串 在浏览器尝试提取媒体数据但未收到响应时触发。
|
|
TIME_UPDATE |
字符串 在媒体播放期间定期触发。每当 currentTime 属性发生变化时,就会触发此事件。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
暂停 |
字符串 在浏览器有意不提取媒体数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
正在等待 |
字符串 当浏览器等待下一帧可用而导致播放停止时触发。 |
|
BITRATE_CHANGED |
字符串 在播放媒体的比特率发生变化时(例如,当活动曲目发生变化时,或当根据网络状况选择不同的比特率时)触发。 事件为 cast.framework.events.BitrateChangedEvent。 |
|
BREAK_STARTED |
字符串 在广告插播时间点中的第一个广告片段开始加载时触发。 事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_ENDED |
字符串 在广告插播时间点中的最后一个广告片段结束时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_LOADING |
字符串 在广告片段开始加载时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_STARTED |
字符串 在广告插播时间点开始时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_ENDED |
字符串 在广告插播片段结束时触发。事件为 cast.framework.events.BreaksEvent。 |
|
正在缓冲 |
字符串 在播放因缓冲而停止或在缓冲完成后再次开始时触发。事件为 cast.framework.events.BufferingEvent。 |
|
TIME_DRIFTED |
字符串 当播放器报告的当前时间与根据播放器状态和播放速率估算的当前时间不一致时触发。 事件为 cast.framework.events.TimeDriftedEvent。 |
|
CACHE_LOADED |
字符串 当由 fastplay 预缓存的内容加载完毕时触发。事件为 cast.framework.events.CacheLoadedEvent。 |
|
CACHE_HIT |
字符串 当使用由 FastPlay 预缓存的内容时触发。事件为 cast.framework.events.CacheItemEvent。 |
|
CACHE_INSERTED |
字符串 当 Fastplay 缓存单个网址时触发。事件为 cast.framework.events.CacheItemEvent。 |
|
CLIP_STARTED |
字符串 在任何片段首次开始播放时触发。这包括广告插播片段和广告插播片段之间的主要内容片段。如果您想查看广告插播片段何时开始,应使用事件为 {@link cast.framework.events.Event. |
|
CLIP_ENDED |
字符串 在任何剪辑结束时触发。这包括广告插播片段和广告插播片段之间的主要内容片段。如果您想查看广告片段何时结束,应使用 |
|
EMSG |
字符串 在片段中发现 emsg 时触发。事件为 cast.framework.events.EmsgEvent。 |
|
错误 |
字符串 在发生错误时触发。事件是 cast.framework.events.ErrorEvent。 |
|
ID3 |
字符串 在遇到 ID3 代码时触发。此事件仅针对 HLS 内容触发。事件为 cast.framework.events.Id3Event。 |
|
MEDIA_STATUS |
字符串 在发送包含当前媒体状态的外发消息之前触发。 事件为 cast.framework.events.MediaStatusEvent。 |
|
CUSTOM_STATE |
字符串 在发送传出自定义状态消息时触发。 事件为 cast.framework.events.CustomStateEvent。 |
|
MEDIA_INFORMATION_CHANGED |
字符串 如果媒体信息在播放期间发生更改,则会触发。 例如,在播放直播电台且曲目元数据发生变化时。 事件为 cast.framework.events.MediaInformationChangedEvent |
|
MEDIA_FINISHED |
字符串 在媒体完全播放完毕时触发。这包括以下情况:直播中没有可播放的内容、用户请求停止或发生错误。使用排队时,每个队列项完成时,此事件都会触发一次。事件为 cast.framework.events.MediaFinishedEvent。 |
|
PLAYER_PRELOADING |
字符串 在播放器开始处理预加载请求时触发。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_PRELOADING_CANCELLED |
字符串 如果播放器取消预加载,则会触发此事件。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_LOAD_COMPLETE |
字符串 在播放器处理完加载请求并准备好播放时触发。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_LOADING |
字符串 在播放器开始处理加载请求时触发。由于播放器尚未请求媒体数据,因此该事件会在 |
|
SEGMENT_DOWNLOADED |
字符串 在片段下载完成时触发。此事件仅针对自适应流式传输内容(HLS、DASH 或 Smooth)触发。事件为 cast.framework.events.SegmentDownloadedEvent。 |
|
SESSION_DATA |
字符串 使用 Shaka Player 时,针对 HLS EXT-X-SESSION-DATA 标记触发。事件为 cast.framework.events.SessionDataEvent。 |
|
REQUEST_GET_STATUS |
字符串 在收到 |
|
REQUEST_SEEK |
字符串 在收到 |
|
REQUEST_LOAD |
字符串 在收到 |
|
REQUEST_PRELOAD |
字符串 在收到 |
|
REQUEST_STOP |
字符串 在收到 |
|
REQUEST_PAUSE |
字符串 在收到 |
|
REQUEST_PRECACHE |
字符串 在收到 |
|
REQUEST_PLAY |
字符串 在收到 |
|
REQUEST_SKIP_AD |
字符串 在收到 |
|
REQUEST_PLAY_AGAIN |
字符串 在收到 |
|
REQUEST_PLAYBACK_RATE_CHANGE |
字符串 在收到 |
|
REQUEST_VOLUME_CHANGE |
字符串 在收到 |
|
REQUEST_EDIT_TRACKS_INFO |
字符串 在收到 EDIT_TRACKS_INFO 消息时触发。事件为 cast.framework.events.RequestEvent。 |
|
REQUEST_EDIT_AUDIO_TRACKS |
字符串 在收到 EDIT_AUDIO_TRACKS 消息时触发。事件为 cast.framework.events.RequestEvent。 |
|
REQUEST_SET_CREDENTIALS |
字符串 在收到 |
|
REQUEST_LOAD_BY_ENTITY |
字符串 在收到 |
|
REQUEST_USER_ACTION |
字符串 在收到 |
|
REQUEST_DISPLAY_STATUS |
字符串 在收到 |
|
REQUEST_CUSTOM_COMMAND |
字符串 在收到 |
|
REQUEST_FOCUS_STATE |
字符串 在收到 |
|
REQUEST_QUEUE_LOAD |
字符串 在收到 |
|
REQUEST_QUEUE_INSERT |
字符串 在收到 |
|
REQUEST_QUEUE_UPDATE |
字符串 在收到 |
|
REQUEST_QUEUE_REMOVE |
字符串 在收到 |
|
REQUEST_QUEUE_REORDER |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEM_RANGE |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEMS |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEM_IDS |
字符串 在收到 |
|
TRACKS_CHANGED |
字符串 如果可用曲目在加载完成后发生更改,则会触发。 |
|
LIVE_IS_MOVING_WINDOW_CHANGED |
字符串 当直播可跳转范围 isMovingWindow 发生变化时触发,更具体地说,当移动窗口变为扩展窗口时触发,反之亦然。事件为 cast.framework.events.LiveStatusEvent。 |
|
LIVE_ENDED |
字符串 在直播刚刚结束时触发。事件为 cast.framework.events.LiveStatusEvent。 |
|
TIMED_METADATA_CHANGED |
字符串 在 DASH (EventStream) 或 HLS (EXT-X-DATERANGE) 中找到定时元数据时,如果在直播内容中遇到新的定时元数据,则会在 PLAYER_LOAD_COMPLETE 之后触发此事件。事件为 cast.framework.events.TimedMetadataEvent。 |
|
TIMED_METADATA_ENTER |
字符串 当播放指针进入 DASH 中的时间轴区域或到达 EXT-X-DATERANGE 标记时触发。事件为 cast.framework.events.TimedMetadataEvent。 |
|
TIMED_METADATA_EXIT |
字符串 当播放指针退出 DASH 中的时间轴区域或离开 EXT-X-DATERANGE 标记时触发。事件为 cast.framework.events.TimedMetadataEvent。 |
属性
DetailedErrorCode
数值
由接收端 SDK 分配的代码,用于描述发生的错误。
值 |
|
|---|---|
|
MEDIA_UNKNOWN |
数值 当 HTMLMediaElement 抛出错误,但 CAF 无法识别特定错误时返回。 |
|
MEDIA_ABORTED |
数值 当用户代理应用户请求中止媒体资源的提取过程时返回。 |
|
MEDIA_DECODE |
数值 在确定媒体资源可用后,如果解码该资源时出错,则返回此错误。 |
|
MEDIA_NETWORK |
数值 在确定媒体资源可用后,如果网络连接错误导致用户代理停止提取该资源,则返回此错误。 |
|
MEDIA_SRC_NOT_SUPPORTED |
数值 当 src 属性指示的媒体资源不合适时返回。 |
|
SOURCE_BUFFER_FAILURE |
数值 在无法将来源缓冲区添加到 MediaSource 时返回。 |
|
MEDIAKEYS_UNKNOWN |
数值 在媒体密钥出现未知错误时返回。 |
|
MEDIAKEYS_NETWORK |
数值 当因网络问题导致媒体密钥失败时返回。 |
|
MEDIAKEYS_UNSUPPORTED |
数值 在无法创建 MediaKeySession 对象时返回。 |
|
MEDIAKEYS_WEBCRYPTO |
数值 在加密失败时返回。 |
|
NETWORK_UNKNOWN |
数值 在出现未知网络问题时返回。 |
|
SEGMENT_NETWORK |
数值 在片段下载失败时返回。 |
|
HLS_NETWORK_MASTER_PLAYLIST |
数值 在 HLS 主播放列表下载失败时返回。 |
|
HLS_NETWORK_PLAYLIST |
数值 在 HLS 播放列表下载失败时返回。 |
|
HLS_NETWORK_NO_KEY_RESPONSE |
数值 在 HLS 密钥下载失败时返回。 |
|
HLS_NETWORK_KEY_LOAD |
数值 在 HLS 密钥请求发送之前失败时返回。 |
|
HLS_NETWORK_INVALID_SEGMENT |
数值 在 HLS 片段无效时返回。 |
|
HLS_SEGMENT_PARSING |
数值 在 HLS 片段无法解析时返回。 |
|
DASH_NETWORK |
数值 在处理 DASH 流时发生未知网络连接错误时返回。 |
|
DASH_NO_INIT |
数值 在 DASH 视频流缺少初始化时返回。 |
|
SMOOTH_NETWORK |
数值 在处理 Smooth 流时发生未知网络连接错误时返回。 |
|
SMOOTH_NO_MEDIA_DATA |
数值 在 Smooth 流缺少媒体数据时返回。 |
|
MANIFEST_UNKNOWN |
数值 在解析清单时发生未知错误时返回。 |
|
HLS_MANIFEST_MASTER |
数值 在解析 HLS 主清单时发生错误时返回。 |
|
HLS_MANIFEST_PLAYLIST |
数值 在解析 HLS 播放列表时发生错误时返回。 |
|
DASH_MANIFEST_UNKNOWN |
数值 在解析 DASH 清单时发生未知错误时返回。 |
|
DASH_MANIFEST_NO_PERIODS |
数值 当 DASH 清单缺少时段时返回。 |
|
DASH_MANIFEST_NO_MIMETYPE |
数值 在 DASH 清单缺少 MimeType 时返回。 |
|
DASH_INVALID_SEGMENT_INFO |
数值 当 DASH 清单包含无效的片段信息时返回。 |
|
SMOOTH_MANIFEST |
数值 在解析 Smooth 清单时出错时返回。 |
|
SEGMENT_UNKNOWN |
数值 在发生未知细分错误时返回。 |
|
TEXT_UNKNOWN |
数值 文本流发生未知错误。 |
|
应用 |
数值 在框架外部发生错误时返回(例如,如果事件处理脚本抛出错误)。 |
|
BREAK_CLIP_LOADING_ERROR |
数值 在广告插播片段加载拦截器失败时返回。 |
|
BREAK_SEEK_INTERCEPTOR_ERROR |
数值 在广告插播时间点跳转拦截器失败时返回。 |
|
IMAGE_ERROR |
数值 在图片加载失败时返回。 |
|
LOAD_INTERRUPTED |
数值 加载被卸载或另一个加载中断。 |
|
LOAD_FAILED |
数值 加载命令失败。 |
|
MEDIA_ERROR_MESSAGE |
数值 系统已向发件人发送出错提示。 |
|
GENERIC |
数值 在发生未知错误时返回。 |
EndedReason
字符串
播放结束的原因。
值 |
|
|---|---|
|
END_OF_STREAM |
字符串 由于当前直播已结束,播放已停止。 |
|
错误 |
字符串 由于出现错误,播放已结束。 |
|
已停止 |
字符串 播放已结束,因为某项操作强制我们停止了当前直播。 |
|
INTERRUPTED |
字符串 由于加载了新内容,播放已结束。 |
|
SKIPPED |
字符串 由于跳过广告操作,播放已结束。 |
|
BREAK_SWITCH |
字符串 由于切换了拼接的广告插播时间点,播放已结束。 |
|
PRELOAD_INTERRUPTED |
字符串 由于现有预加载播放器被中断或取代,播放已结束。这可将预加载取消与活跃播放器取消 (STOPPED) 区分开来。 |
|
LOAD_CANCELLED |
字符串 由于并发加载请求在完成之前被取消,播放已结束。这可将待处理的加载中止与活跃流中断 (INTERRUPTED) 区分开来。 |
|
SENDER_STOPPED |
字符串 由于发送端发出了明确的 STOP 请求,因此播放结束。这比一般 STOPPED 原因提供了更精细的信息。 |
|
LOAD_INTERRUPTED |
字符串 播放结束,具体原因是新的媒体加载中断了活跃播放器。这比活动流的通用 INTERRUPTED 原因更精细。 |
|
BREAK_INTERRUPTED |
字符串 由于插播广告播放器被中断(例如,通过跳转跳过广告插播时间点),播放已结束。这会将广告插播时间点中断与标准媒体中断 (INTERRUPTED) 区分开来。 |
|
BREAK_RESOLVED |
字符串 播放已结束,因为插播广告播放器已成功完成主要内容时长的解析。这与一般广告边界切换 (BREAK_SWITCH) 不同。 |
ErrorSeverity
数值
错误的严重程度。遵循与 Shaka Player 相同的命名方案和编号。
值 |
|
|---|---|
|
未知 |
数值 错误严重程度未知。 |
|
RECOVERABLE |
数值 发生错误,但播放器正在尝试从错误中恢复。 如果播放器最终无法恢复,它可能仍不会抛出 CRITICAL 错误。例如,重试媒体片段绝不会导致 CRITICAL 错误(播放器只会一直重试)。 |
|
危急 |
数值 播放器无法恢复的严重错误。这些错误会导致播放器停止播放当前媒体文件。 |
EventType
字符串
播放器事件类型。对于从 MediaElement 代理的事件,请参阅 https://dev.w3.org/html5/spec-preview/media-elements.html#mediaevents 了解详情。
值 |
|
|---|---|
|
全部 |
字符串 这是一个特殊标识符,可用于监听所有事件(主要用于调试目的)。该事件将是 cast.framework.events.Event 的子类。 |
|
中止 |
字符串 当浏览器在媒体完全下载之前停止提取媒体(但不是由于错误)时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
CAN_PLAY |
字符串 当浏览器可以继续播放片段,但估计加载的数据不足以播放到片段结束而无需停止缓冲时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
CAN_PLAY_THROUGH |
字符串 当浏览器估计可以播放完片段而无需停止缓冲时触发。请注意,浏览器估算值仅与当前播放的片段有关(例如:如果当前播放的是广告片段,则浏览器仅会估算广告片段,而不会估算完整内容)。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
DURATION_CHANGE |
字符串 在 MediaElement 的时长属性发生更改时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
已清空 |
字符串 在媒体内容变为空时触发。例如,当调用 load() 来重置 MediaElement 时,就会发生这种情况。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
已结束 |
字符串 在媒体片段完整播放后触发。这不包括剪辑因错误或停止请求而停止播放的情况。
如果存在广告,则每个广告最多触发一次,主要内容最多触发一次。此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。如果您想知道媒体何时播放完毕,则很可能需要使用 |
|
LOADED_DATA |
字符串 在浏览器加载完媒体剪辑的第一帧时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
LOADED_METADATA |
字符串 在浏览器加载完剪辑的元数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
LOAD_START |
字符串 在浏览器开始查找剪辑的媒体数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
暂停 |
字符串 在播放暂停时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaPauseEvent 中。 |
|
游戏 |
字符串 在准备好开始播放时(即暂停后)触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
正在播放 |
字符串 在播放开始时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
进度 |
字符串 在浏览器提取媒体数据时触发。如果您使用的是自适应比特率流式传输(例如 HLS、DASH、SMOOTH),则很可能需要改用 |
|
RATE_CHANGE |
字符串 播放速度更新时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
SEEKED |
字符串 在跳转完成时触发。如果媒体暂停时跳转结束,则不会触发此事件。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
SEEKING |
字符串 在媒体内容被跳转时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
STALLED |
字符串 在浏览器尝试提取媒体数据但未收到响应时触发。
|
|
TIME_UPDATE |
字符串 在媒体播放期间定期触发。每当 currentTime 属性发生变化时,就会触发此事件。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
暂停 |
字符串 在浏览器有意不提取媒体数据时触发。 此事件从 MediaElement 转发,并已封装在 cast.framework.events.MediaElementEvent 中。 |
|
正在等待 |
字符串 当浏览器等待下一帧可用而导致播放停止时触发。 |
|
BITRATE_CHANGED |
字符串 在播放媒体的比特率发生变化时(例如,当活动曲目发生变化时,或当根据网络状况选择不同的比特率时)触发。 事件为 cast.framework.events.BitrateChangedEvent。 |
|
BREAK_STARTED |
字符串 在广告插播时间点中的第一个广告片段开始加载时触发。 事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_ENDED |
字符串 在广告插播时间点中的最后一个广告片段结束时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_LOADING |
字符串 在广告片段开始加载时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_STARTED |
字符串 在广告插播时间点开始时触发。事件为 cast.framework.events.BreaksEvent。 |
|
BREAK_CLIP_ENDED |
字符串 在广告插播片段结束时触发。事件为 cast.framework.events.BreaksEvent。 |
|
正在缓冲 |
字符串 在播放因缓冲而停止或在缓冲完成后再次开始时触发。事件为 cast.framework.events.BufferingEvent。 |
|
TIME_DRIFTED |
字符串 当播放器报告的当前时间与根据播放器状态和播放速率估算的当前时间不一致时触发。 事件为 cast.framework.events.TimeDriftedEvent。 |
|
CACHE_LOADED |
字符串 当由 fastplay 预缓存的内容加载完毕时触发。事件为 cast.framework.events.CacheLoadedEvent。 |
|
CACHE_HIT |
字符串 当使用由 FastPlay 预缓存的内容时触发。事件为 cast.framework.events.CacheItemEvent。 |
|
CACHE_INSERTED |
字符串 当 Fastplay 缓存单个网址时触发。事件为 cast.framework.events.CacheItemEvent。 |
|
CLIP_STARTED |
字符串 在任何片段首次开始播放时触发。这包括广告插播片段和广告插播片段之间的主要内容片段。如果您想查看广告插播片段何时开始,应使用事件为 {@link cast.framework.events.Event. |
|
CLIP_ENDED |
字符串 在任何剪辑结束时触发。这包括广告插播片段和广告插播片段之间的主要内容片段。如果您想查看广告片段何时结束,应使用 |
|
EMSG |
字符串 在片段中发现 emsg 时触发。事件为 cast.framework.events.EmsgEvent。 |
|
错误 |
字符串 在发生错误时触发。事件是 cast.framework.events.ErrorEvent。 |
|
ID3 |
字符串 在遇到 ID3 代码时触发。此事件仅针对 HLS 内容触发。事件为 cast.framework.events.Id3Event。 |
|
MEDIA_STATUS |
字符串 在发送包含当前媒体状态的外发消息之前触发。 事件为 cast.framework.events.MediaStatusEvent。 |
|
CUSTOM_STATE |
字符串 在发送传出自定义状态消息时触发。 事件为 cast.framework.events.CustomStateEvent。 |
|
MEDIA_INFORMATION_CHANGED |
字符串 如果媒体信息在播放期间发生更改,则会触发。 例如,在播放直播电台且曲目元数据发生变化时。 事件为 cast.framework.events.MediaInformationChangedEvent |
|
MEDIA_FINISHED |
字符串 在媒体完全播放完毕时触发。这包括以下情况:直播中没有可播放的内容、用户请求停止或发生错误。使用排队时,每个队列项完成时,此事件都会触发一次。事件为 cast.framework.events.MediaFinishedEvent。 |
|
PLAYER_PRELOADING |
字符串 在播放器开始处理预加载请求时触发。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_PRELOADING_CANCELLED |
字符串 如果播放器取消预加载,则会触发此事件。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_LOAD_COMPLETE |
字符串 在播放器处理完加载请求并准备好播放时触发。事件为 cast.framework.events.LoadEvent。 |
|
PLAYER_LOADING |
字符串 在播放器开始处理加载请求时触发。由于播放器尚未请求媒体数据,因此该事件会在 |
|
SEGMENT_DOWNLOADED |
字符串 在片段下载完成时触发。此事件仅针对自适应流式传输内容(HLS、DASH 或 Smooth)触发。事件为 cast.framework.events.SegmentDownloadedEvent。 |
|
SESSION_DATA |
字符串 使用 Shaka Player 时,针对 HLS EXT-X-SESSION-DATA 标记触发。事件为 cast.framework.events.SessionDataEvent。 |
|
REQUEST_GET_STATUS |
字符串 在收到 |
|
REQUEST_SEEK |
字符串 在收到 |
|
REQUEST_LOAD |
字符串 在收到 |
|
REQUEST_PRELOAD |
字符串 在收到 |
|
REQUEST_STOP |
字符串 在收到 |
|
REQUEST_PAUSE |
字符串 在收到 |
|
REQUEST_PRECACHE |
字符串 在收到 |
|
REQUEST_PLAY |
字符串 在收到 |
|
REQUEST_SKIP_AD |
字符串 在收到 |
|
REQUEST_PLAY_AGAIN |
字符串 在收到 |
|
REQUEST_PLAYBACK_RATE_CHANGE |
字符串 在收到 |
|
REQUEST_VOLUME_CHANGE |
字符串 在收到 |
|
REQUEST_EDIT_TRACKS_INFO |
字符串 在收到 EDIT_TRACKS_INFO 消息时触发。事件为 cast.framework.events.RequestEvent。 |
|
REQUEST_EDIT_AUDIO_TRACKS |
字符串 在收到 EDIT_AUDIO_TRACKS 消息时触发。事件为 cast.framework.events.RequestEvent。 |
|
REQUEST_SET_CREDENTIALS |
字符串 在收到 |
|
REQUEST_LOAD_BY_ENTITY |
字符串 在收到 |
|
REQUEST_USER_ACTION |
字符串 在收到 |
|
REQUEST_DISPLAY_STATUS |
字符串 在收到 |
|
REQUEST_CUSTOM_COMMAND |
字符串 在收到 |
|
REQUEST_FOCUS_STATE |
字符串 在收到 |
|
REQUEST_QUEUE_LOAD |
字符串 在收到 |
|
REQUEST_QUEUE_INSERT |
字符串 在收到 |
|
REQUEST_QUEUE_UPDATE |
字符串 在收到 |
|
REQUEST_QUEUE_REMOVE |
字符串 在收到 |
|
REQUEST_QUEUE_REORDER |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEM_RANGE |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEMS |
字符串 在收到 |
|
REQUEST_QUEUE_GET_ITEM_IDS |
字符串 在收到 |
|
TRACKS_CHANGED |
字符串 如果可用曲目在加载完成后发生更改,则会触发。 |
|
LIVE_IS_MOVING_WINDOW_CHANGED |
字符串 当直播可跳转范围 isMovingWindow 发生变化时触发,更具体地说,当移动窗口变为扩展窗口时触发,反之亦然。事件为 cast.framework.events.LiveStatusEvent。 |
|
LIVE_ENDED |
字符串 在直播刚刚结束时触发。事件为 cast.framework.events.LiveStatusEvent。 |
|
TIMED_METADATA_CHANGED |
字符串 在 DASH (EventStream) 或 HLS (EXT-X-DATERANGE) 中找到定时元数据时,如果在直播内容中遇到新的定时元数据,则会在 PLAYER_LOAD_COMPLETE 之后触发此事件。事件为 cast.framework.events.TimedMetadataEvent。 |
|
TIMED_METADATA_ENTER |
字符串 当播放指针进入 DASH 中的时间轴区域或到达 EXT-X-DATERANGE 标记时触发。事件为 cast.framework.events.TimedMetadataEvent。 |
|
TIMED_METADATA_EXIT |
字符串 当播放指针退出 DASH 中的时间轴区域或离开 EXT-X-DATERANGE 标记时触发。事件为 cast.framework.events.TimedMetadataEvent。 |