Player API

属性在 <stream> 标签中添加时不加引号，如下所示：

<stream attribute-added-here src="5d5bc37ffcf54c9b82e996823bffbb81"></stream>

可以组合使用多个属性，依次添加如下：

<stream attribute-1 attribute-2 attribute-3 src="5d5bc37ffcf54c9b82e996823bffbb81"></stream>

• autoplay boolean

  • 指示浏览器立即开始下载视频，并在可以播放时立即播放。请注意，移动浏览器通常不支持此属性，用户必须点击屏幕才能开始视频播放。在使用此属性之前，请考虑移动用户或流量受限的用户，因为部分用户没有无限网络访问。

• controls boolean

  • 显示默认视频控件，如播放/暂停、音量控制等按钮。您也可以构建与播放器配合使用的自定义按钮和控件。查看示例。

• height integer

  • 视频显示区域的高度，以 CSS 像素为单位。

• loop boolean

  • 布尔属性；如果包含在 HTML 标签中，播放器在到达视频末尾时会自动回到开头。

• muted boolean

  • 布尔属性，指示视频中音频的默认设置。如果设置，音频将初始静音。

• preload string | null

  • 此枚举属性旨在向浏览器提供提示，说明作者认为哪种设置能带来最佳用户体验。您可以将其作为无值的布尔属性包含，或指定值 preload="auto" 以预加载视频开头部分。不包含该属性或使用 preload="metadata" 则仅加载开始播放所需的最小元数据。

• poster string

  • 视频开始前或下载过程中显示的图像 URL。如果未指定此属性，将显示视频的缩略图。

• src string

  • 应在此处包含您上传到 Cloudflare Stream 的视频 ID。

• width integer

  • 视频显示区域的宽度，以 CSS 像素为单位。

• play() Promise

  • 开始视频播放。

• pause() null

  • 暂停视频播放。

• autoplay

  • 设置或返回是否设置了 autoplay 属性，允许加载后立即开始播放。

• controls

  • 设置或返回视频是否应显示控件（如播放/暂停等）

• currentTime

  • 返回当前播放时间（秒）。设置此值会将视频定位到新时间点。

• duration readonly

  • 返回视频时长（秒）。

• ended readonly

  • 返回视频是否已结束。

• loop

  • 设置或返回视频到达末尾时是否应从头开始

• muted

  • 设置或返回是否应与视频一起播放音频

• paused readonly

  • 返回视频是否已暂停

• preload

  • 设置或返回元素加载时是否应预加载视频。

• volume

  • 设置或返回音量，范围从 0.0（静音）到 1.0（最大值）

Stream 支持大多数标准化媒体元素事件 ↗。

• abort

  • 播放中止时发送；例如，如果媒体正在播放并从头重新开始，将发送此事件。

• canplay

  • 当有足够数据可以播放媒体时发送，至少可以播放几帧。

• canplaythrough

  • 当整个媒体可以无中断播放时发送，假设下载速率至少保持当前水平。在暂停和播放之间切换时也会触发。注意：在 Firefox 中手动设置 currentTime 最终会触发 canplaythrough 事件。其他浏览器可能不会触发此事件。

• durationchange

  • 元数据已加载或更改，表示媒体时长发生变化。例如，当媒体加载足够以确定时长时发送。

• ended

  • 播放完成时发送。

• error

  • 发生错误时发送。（例如，视频尚未完成编码，或由于签名 URL 不正确导致视频加载失败）

• loadeddata

  • 媒体的第一帧已完成加载。

• loadedmetadata

  • 媒体的元数据已完成加载；所有属性现在都包含尽可能多的有用信息。

• loadstart

  • 开始加载媒体时发送。

• pause

  • 播放状态更改为暂停时发送（paused 属性为 true）。

• play

  • 播放状态不再为暂停时发送，由 play 方法或 autoplay 属性触发。

• playing

  • 当媒体有足够数据开始播放时发送，在 play 事件之后，也在从停滞恢复、循环媒体重新开始以及 seeked 之后（如果 seek 前正在播放）。

• progress

  • 定期发送以通知相关方媒体下载进度。媒体元素 buffered 属性中提供当前已下载媒体量的信息。

• ratechange

  • 播放速度更改时发送。

• seeked

  • seek 操作完成时发送。

• seeking

  • seek 操作开始时发送。

• stalled

  • 用户代理尝试获取媒体数据但数据意外未到达时发送。

• suspend

  • 媒体加载暂停时发送；这可能是因为下载已完成，或出于其他原因暂停。

• timeupdate

  • 元素 currentTime 属性指示的时间已更改。

• volumechange

  • 音频音量更改时发送（设置音量和更改 muted 属性时均会发送）。

• waiting

  • 请求的操作（如播放）因等待另一操作（如 seek）完成而延迟时发送。

非标准事件以 stream- 为前缀，以区别于标准事件。

• stream-adstart

  • 当存在 ad-url 属性且广告开始播放时触发

• stream-adend

  • 当存在 ad-url 属性且广告播放结束时触发

• stream-adtimeout

  • 当存在 ad-url 属性且广告加载时间过长时触发。