开始
复制一个包含安装步骤和本插件的完整Markdown指南的设置命令.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-ivs-player`, `@capgo/ivs-player`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ivs-player/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-ivs-player` plugin in my project.如果您更喜欢手动设置,请按照以下命令安装插件并遵循以下平台特定的说明:
bun add @capgo/capacitor-ivs-playerbunx cap sync导入
导入部分import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';API概述
导入部分API概述create
创建查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.create({} as { url: string; pip?: boolean; title?: string; subtitle?: string; cover?: string; autoPlay?: boolean; toBack?: boolean; x?: number; y?: number; width?: number;
height?: number; });start
启动查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.start();cast
投射查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.cast();getCastStatus
获取投射状态查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getCastStatus();pause
暂停查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.pause();delete
删除查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.delete();getUrl
获取 URL查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getUrl();getState
获取状态查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getState();setPlayerPosition
设置玩家位置查看当前合同的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPlayerPosition();getPlayerPosition
获取玩家位置查看当前合同的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPlayerPosition();setAutoQuality
设置自动质量查看当前合同的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setAutoQuality();getAutoQuality
获取自动质量查看当前合同的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getAutoQuality();setPip
Section titled “setPip”查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPip();getPip
Section titled “getPip”查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPip();setFrame
Section titled “setFrame”设置玩家视图的框架,所有数字必须为正整数
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setFrame();getFrame
Section titled “getFrame”查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getFrame();setBackgroundState
背景设置查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setBackgroundState({} as { backgroundState: CapacitorIvsPlayerBackgroundState });getBackgroundState
获取背景设置查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getBackgroundState();setMute
设置静音查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setMute();getMute
获取静音状态查看当前合约的源定义
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getMute();setQuality
设置质量查看当前合约的源定义。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setQuality();getQuality
获取质量查看当前合约的源定义。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getQuality();getQualities
获取质量列表查看当前合约的源定义。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getQualities();类型参考
类型参考CapacitorIvsPlayerState
CapacitorIvsPlayerStateexport type CapacitorIvsPlayerState = 'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN';CapacitorIvsPlayerBackgroundState
Capacitor与PlayerBackgroundState的部分export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';本页面是由插件生成的 src/definitions.ts当公共API在上游发生变化时,重新运行同步。
从开始就继续
Capacitor与继续从开始的部分如果您正在使用 开始 来规划仪表板和API操作,连接它 使用 @capgo/capacitor-ivs-player 使用 @capgo/capacitor-ivs-player API 简介 查看 @API/__CAPGO_KEEP_1__-ivs-player 的实现细节 介绍 查看 Introduction 的实现细节 API 密钥 查看 API Keys 的实现细节 设备 查看 Devices 的实现细节