跳过内容

开始

GitHub

您可以使用我们的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-player
bunx cap sync
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

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();

查看当前合约的源定义

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();

查看当前合约的源定义

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPip();

查看当前合约的源定义

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPip();

设置玩家视图的框架,所有数字必须为正整数

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setFrame();

查看当前合约的源定义

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();

查看当前合约的源定义

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setMute();

查看当前合约的源定义

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

CapacitorIvsPlayerState
export type CapacitorIvsPlayerState = 'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN';

CapacitorIvsPlayerBackgroundState

Capacitor与PlayerBackgroundState的部分
export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';

本页面是由插件生成的 src/definitions.ts当公共API在上游发生变化时,重新运行同步。

如果您正在使用 开始 来规划仪表板和API操作,连接它 使用 @capgo/capacitor-ivs-player 使用 @capgo/capacitor-ivs-player API 简介 查看 @API/__CAPGO_KEEP_1__-ivs-player 的实现细节 介绍 查看 Introduction 的实现细节 API 密钥 查看 API Keys 的实现细节 设备 查看 Devices 的实现细节