跳转至正文

IVS Player Capacitor 插件

使用 Amazon Interactive Video Service (IVS) 播放超低延迟直播视频

安装

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

指南

如何在 Capacitor 中使用 IVS Player

使用 @capgo/capacitor-ivs-player

适用于 capacitor 应用的 IVS Player

安装

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

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

API 概览

方法 描述
create 查看源码定义以了解当前行为。
start 查看源码定义以了解当前行为。
cast 查看源码定义以了解当前行为。
getCastStatus 查看源码定义以了解当前行为。
pause 查看源码定义以了解当前行为。
delete 查看源码定义以了解当前行为。
getUrl 查看源码定义以了解当前行为。
getState 查看源码定义以了解当前行为。
setPlayerPosition 查看源码定义以了解当前行为。
getPlayerPosition 查看源码定义以了解当前行为。
setAutoQuality 查看源码定义以了解当前行为。
getAutoQuality 查看源码定义以了解当前行为。
setPip 查看源码定义以了解当前行为。
getPip 查看源码定义以了解当前行为。
setFrame 设置播放器视图的 frame,所有数值必须为正整数。
getFrame 查看源码定义以了解当前行为。
setBackgroundState 查看源码定义以了解当前行为。
getBackgroundState 查看源码定义以了解当前行为。
setMute 查看源码定义以了解当前行为。
getMute 查看源码定义以了解当前行为。
setQuality 查看源码定义以了解当前行为。
getQuality 查看源码定义以了解当前行为。
getQualities 查看源码定义以了解当前行为。

示例

create()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.create({ url: 'https://example.com' });

start()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.start();

cast()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.cast();

getCastStatus()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

const result = await CapacitorIvsPlayer.getCastStatus();
console.log(result);

pause()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.pause();

delete()

查看 API 参考文档以了解当前契约。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.delete();

上表列出了 23 个核心方法。监听器与版本辅助函数,以及每个方法的完整契约,均记录在 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时,或者调用 CapacitorIvsPlayer.removeAllListeners() 以清除所有监听器。

完整参考文档

从使用 @capgo/capacitor-ivs-player 继续

如果你正在使用 使用 @capgo/capacitor-ivs-player 要规划原生插件工作,请将其与 @capgo/capacitor-ivs-player 有关 @capgo/capacitor-ivs-player 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

IVS Player 插件常见问题

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

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

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

支持。IVS Player 是一个 Capacitor package,因此它支持任何在 Capacitor 中运行的 web framework,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

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

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

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

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-ivs-player/,你可以直接从 npm 免费安装。欢迎提交 Bug report 和 pull request。

我能否在无需经过 App Store 审核的情况下,更新使用了 IVS Player 的 code?

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

无需等待应用审核,即可上线 IVS Player 变更

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

开始使用 Capgo