@capgo/capacitor-youtube-player

概览

嵌入 YouTube 视频，支持完整的播放器 API 控制和事件处理

从 initialize() 以及下方列出的其他核心方法。

平台支持

平台	支持	备注
iOS	是	原生
Android	是	原生
Web 端	否	使用 Capacitor.getPlatform() 做保护

核心功能

• initialize - 初始化一个新的 YouTube player 实例。
• destroy - 销毁 player 实例并释放资源。
• stopVideo - 停止视频播放并取消加载。请谨慎使用——通常更推荐 pauseVideo()。
• playVideo - 播放当前已排队或已加载的视频。最终 player 状态将为 PLAYING (1)。

公开 API

方法	描述
initialize	初始化一个新的 YouTube player 实例。
destroy	销毁 player 实例并释放资源。
stopVideo	停止视频播放并取消加载。请谨慎使用 —— 通常建议使用 pauseVideo()。
playVideo	播放当前已排队或已加载的视频。最终 player 状态将为 PLAYING (1)。
pauseVideo	暂停当前正在播放的视频。最终 player 状态将为 PAUSED (2)，除非当前已处于 ENDED (0) 状态。
seekTo	跳转到视频中的特定时间点。如果 player 处于暂停状态，则保持暂停；如果正在播放，则继续播放。
loadVideoById	通过 YouTube ID 加载并播放视频。
cueVideoById	通过 ID 将视频加入队列但不播放。会加载缩略图并准备 player，但直到调用 playVideo() 才会请求视频。
loadVideoByUrl	通过完整 URL 加载并播放视频。
cueVideoByUrl	通过 URL 将视频加入队列但不播放。
cuePlaylist	预加载播放列表但不播放。加载播放列表并准备第一个视频。
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.

继续了解 @capgo/capacitor-youtube-player

如果你正在使用 @capgo/capacitor-youtube-player 要规划原生插件工作，请将其与 使用 @capgo/capacitor-youtube-player 在“使用 @capgo/capacitor-youtube-player”中了解原生功能， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 关于“添加或更新插件”中的实现细节，以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。