跳转至正文

YouTube Player Capacitor 插件

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

安装

bun add @capgo/capacitor-youtube-player bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-youtube-player
  • pnpm add @capgo/capacitor-youtube-player
  • yarn add @capgo/capacitor-youtube-player

指南

如何在 Capacitor 中使用 YouTube Player

在设备上测试

下载 Capgo App,然后扫描二维码 code。

YouTube Player 插件预览二维码 code

使用 @capgo/capacitor-youtube-player

用于 Capacitor 的 YouTube Player 插件。提供在应用中控制 YouTube 视频播放的方法。

安装

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

插件暴露的内容

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

主 WebView Referer 补丁

启用 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 在未指定时生效。

用法示例

initialize

初始化一个新的 YouTube player 实例。

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

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

destroy

销毁 player 实例并释放资源。

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

const result = await YoutubePlayer.destroy({ playerId: 'player-id-123' });
console.log(result);

stopVideo

停止视频播放并取消加载。请谨慎使用 —— 通常建议使用 pauseVideo()。

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

const result = await YoutubePlayer.stopVideo({ playerId: 'player-id-123' });
console.log(result);

playVideo

播放当前已排队或已加载的视频。最终 player 状态将为 PLAYING (1)。

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

const result = await YoutubePlayer.playVideo({ playerId: 'player-id-123' });
console.log(result);

完整参考

继续阅读:使用 @capgo/capacitor-youtube-player

如果你正在使用 使用 @capgo/capacitor-youtube-player 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-youtube-player 有关 @capgo/capacitor-youtube-player 的实现细节, 快速入门 有关“入门指南”中的实现细节, 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力, @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节,以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力

常见问题

YouTube Player 插件常见问题

如何在 Capacitor 应用中安装 YouTube Player 插件?

运行 "bun add @capgo/capacitor-youtube-player"(或 "npm install @capgo/capacitor-youtube-player"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步原生 code。最后在你的应用 code 中从 "@capgo/capacitor-youtube-player" 导入即可。

@capgo/capacitor-youtube-player 是否支持 React、Vue 和 Angular?

是的。YouTube Player 是一个 Capacitor 包,因此它可以与任何在 Capacitor 中运行的 Web 框架配合使用,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-youtube-player 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-youtube-player 是免费开源的吗?

是的。code 的源代码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-youtube-player/,并且可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在无需经过 App Store 审核的情况下,更新使用了 YouTube Player 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布 YouTube Player 的改动

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo