跳过主要内容
返回到插件
@capgo/capacitor-youtube-player
教程
@capgo/capacitor-youtube-player

YouTube Player

使用 YouTube 视频并且具有完整的播放器API控制和事件处理

指南

YouTube播放器教程

在设备上测试

Download the Capgo app, then scan the QR code.

YouTube Player插件预览二维码code

使用@capgo/capacitor-youtube-player

YouTube Player插件接口为Capacitor。 提供方法来控制YouTube视频播放在您的应用中。

安装

bun add @capgo/capacitor-youtube-player
bunx cap sync

此插件暴露的内容

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

主WebView来源修补

启用 patchRefererHeader 当 YouTube 内容在插件中正常工作,但在 Capacitor 的主 WebView 中失败,因为 YouTube 期望浏览器样式的 Referer 头部。

{
  "plugins": {
    "YoutubePlayer": {
      "patchRefererHeader": true,
      "refererHeader": "https://www.youtube.com"
    }
  }
}

该补丁仅适用于 youtube.com, youtube-nocookie.com,和 youtu.be 请求。现有的请求级别 Referer 头部被保留, refererHeader 当省略时默认为 https://www.youtube.com 示例用法

初始化一个新的 YouTube 播放器实例。

initialize

销毁一个播放器实例并释放资源。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';

await YoutubePlayer.initialize({
  playerId: 'my-player',
  videoId: 'dQw4w9WgXcQ',
  playerSize: { width: 640, height: 360 },
  privacyEnhanced: true
});

destroy

停止视频播放并取消加载。请谨慎使用 - 使用 pauseVideo() 通常更好。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';

await YoutubePlayer.destroy({} as PlayerIdOptions);

stopVideo

请求级别

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';

await YoutubePlayer.stopVideo({} as PlayerIdOptions);

playVideo

播放当前缓冲或已加载的视频。最终播放器状态将为PLAYING (1)。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';

await YoutubePlayer.playVideo({} as PlayerIdOptions);

全局参考

继续使用@capgo/capacitor-youtube-player

如果您正在使用 使用@capgo/capacitor-youtube-player 来规划原生媒体和界面行为,连接它与 @capgo/capacitor-youtube-player 以获取@capgo/capacitor-youtube-player的实现细节 开始使用 为 Getting Started 中的实现细节, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.