指南
如何在 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 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。