跳过主要内容

IVS播放器 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播放器

使用@capgo/capacitor-ivs-player

capacitor应用的IVS播放器

安装

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 设置播放器视图的框架,所有数字必须为正整数。
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个核心方法。监听器和版本帮助,以及每个方法的完整协议,均在__CAPGO_KEEP_0__仓库中进行了文档化。 GitHub仓库.

监听事件

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

完整参考

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

如果您正在使用 使用@capgo/capacitor-ivs-player 为了计划原生插件工作,连接它与 @capgo/capacitor-ivs-player 查看@capgo/capacitor-ivs-player中的实现细节 开始 查看开始中的实现细节 Capgo插件目录 查看Capgo插件目录中的产品工作流程 Capacitor由Capgo提供的插件 为 Capacitor 插件的实现细节提供 Capgo 的插件。 添加或更新插件 为添加或更新插件的实现细节提供细节。

常见问题

IVS Player 插件常见问题

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

Run "bun add @capgo/capacitor-ivs-player" (or "npm install @capgo/capacitor-ivs-player"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-ivs-player" in your app code.

是否@capgo/capacitor-ivs-player与React、Vue和Angular兼容?

是。IVS Player 是一个 Capacitor 包,因此它可以与任何在 Capacitor 内部运行的 Web 框架一起使用,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

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

Capgo 插件遵循 Capacitor 的主要版本:使用与 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格中列出了维护的版本。

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

是。源代码 code 在 GitHub 上公开可用,地址为 https://github.com/Cap-go/capacitor-ivs-player/,并且该包可以从 npm 免费安装。欢迎 bug 报告和 pull 请求。

是否可以在不经过 App Store 审核的情况下更新使用 IVS Player 的 code?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

不必等待应用程序审查就可以将IVS播放器更改推送到商店

一旦插件在您的商店构建中,Capgo实时更新将将您的JavaScript、HTML和CSS更改推送给用户几分钟内。

开始使用Capgo