跳过内容
Capgo - 为 Capacitor 应用程序提供实时更新 Capgo

开始使用

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';

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

Section titled “获取 cast 状态”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.getCastStatus();

pause

Section titled “暂停”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.pause();

delete

Section titled “删除”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.delete();

getUrl

Section titled “获取 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

设置分屏

查看当前合同的源定义

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


await CapacitorIvsPlayer.setPip();

getPip

获取分屏

查看当前合同的源定义

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


await CapacitorIvsPlayer.getPip();

setFrame

设置播放器视图的帧

请将所有数字设置为正整数

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


await CapacitorIvsPlayer.setFrame();

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

Section titled “静音”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.getMute();

setQuality

Section titled “设置质量”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.setQuality();

getQuality

Section titled “获取质量”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.getQuality();

getQualities

Section titled “获取质量列表”

查看当前合同的源定义。

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


await CapacitorIvsPlayer.getQualities();

类型参考

类型参考

CapacitorIvsPlayerState

CapacitorIvsPlayerState类型参考
export type CapacitorIvsPlayerState = 'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN';

CapacitorIvsPlayerBackgroundState

CapacitorIvsPlayerBackgroundState类型参考
export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';

真实来源

类型参考

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

继续从开始

继续从开始

如果您正在使用 开始使用 以规划仪表板和API操作，连接它 使用@capgo/capacitor-ivs-player 使用@capgo/capacitor-ivs-player的本机能力 API概述 API概述的实现细节 介绍 介绍的实现细节 API密钥 API密钥的实现细节 设备 了解设备的实现细节。