概述
标题为“概述”YouTube Player 插件接口为 Capacitor。提供方法来控制 YouTube 视频播放在您的应用中。
核心功能
标题为“核心功能”initialize- 初始化一个新的 YouTube 播放器实例。destroy- 销毁一个玩家实例并释放资源。stopVideo- 停止视频播放并取消加载。尽量少用 - pauseVideo() 通常更合适。playVideo- 播放当前缓冲或已加载的视频。最终播放器状态将为 PLAYING (1)。
Public API
标题:Public API| 方法 | 描述 |
|---|---|
initialize | 初始化一个新的 YouTube 播放器实例。 |
destroy | 销毁一个播放器实例并释放资源。 |
stopVideo | 停止视频播放并取消加载。尽量少用 - pauseVideo() 通常更合适。 |
playVideo | 播放当前缓冲或已加载的视频。最终播放器状态将为 PLAYING (1)。 |
pauseVideo | 暂停当前播放的视频。最终播放器状态将为 PAUSED (2),除非已经结束 (0)。 |
seekTo | 跳转到视频的特定时间。如果播放器暂停,播放器将保持暂停状态。如果正在播放,继续播放。 |
loadVideoById | 通过 YouTube ID 加载并播放视频。 |
cueVideoById | 通过 ID 引用视频而不播放。加载缩略图并准备播放器,但直到调用 playVideo() 才请求视频。 |
loadVideoByUrl | 通过视频的完整 URL 加载并播放视频。 |
cueVideoByUrl | 通过 URL 引用视频而不播放。 |
cuePlaylist | 通过 ID 引用播放列表而不播放。加载播放列表并准备第一视频。 |
loadPlaylist | 加载并播放播放列表。 |
nextVideo | 播放播放列表中的下一个视频。 |
previousVideo | 播放播放列表中的前一个视频。 |
playVideoAt | 通过播放列表索引播放特定视频。 |
mute | 静音播放器音频。 |
unMute | 取消静音播放器音频。 |
isMuted | 检查当前是否静音。 |
setVolume | 设置播放器音量。 |
getVolume | 获取当前播放器音量。即使播放器静音,也会返回音量。 |
setSize | 设置播放器尺寸(像素)。 |
getPlaybackRate | 获取当前播放速率。 |
setPlaybackRate | 设置播放速率。 |
getAvailablePlaybackRates | 获取当前视频可用的播放速率列表。 |
setLoop | 启用或禁用播放列表循环。当启用时,播放列表将在最后一个视频后重新开始。 |
setShuffle | 启用或禁用播放列表随机播放。 |
getVideoLoadedFraction | 获取缓冲的视频比例。比过时的getVideoBytesLoaded/getVideoBytesTotal更可靠。 |
getPlayerState | 获取播放器当前状态。 |
getAllPlayersEventsState | 获取所有活动播放器的事件状态。对于跟踪多个播放器实例非常有用。 |
getCurrentTime | 获取当前播放位置(秒数)。 |
toggleFullScreen | 切换全屏模式开关。 |
getPlaybackQuality | 获取当前播放质量。 |
setPlaybackQuality | 设置建议的播放质量。实际质量可能根据网络条件而有所不同。 |
getAvailableQualityLevels | 获取当前视频可用的质量等级列表。 |
getDuration | 获取当前视频的持续时间(秒数)。 |
getVideoUrl | 获取当前视频的 YouTube.com URL。 |
getVideoEmbedCode | 获取当前视频的嵌入 code。返回 HTML iframe 嵌入 code。 |
getPlaylist | 获取当前播放列表中的视频 ID 数组。 |
getPlaylistIndex | 获取当前播放列表中正在播放的视频的索引。 |
getIframe | 获取播放器的 iframe DOM 元素。仅限 Web 平台。 |
addEventListener | 在播放器上添加事件监听器。仅限 Web 平台。 |
removeEventListener | 从播放器中移除事件监听器。仅限Web平台。 |
getPluginVersion | 获取插件版本号。返回平台特定的版本信息。 |
真实数据来源
标题:真实数据来源此参考资料是从 src/definitions.ts 在 capacitor-youtube-player.