跳过内容
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

标题：获取播发状态

查看当前合同的源定义

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

复制到剪贴板

获取状态

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

标题：设置pip

查看当前合同的源定义。

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


await CapacitorIvsPlayer.setPip();

getPip

标题：获取pip

查看当前合同的源定义。

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

获取静音状态

查看当前协议的源定义

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

CapacitorIvsPlayerBackgroundState
export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';

真实来源

真实来源

本页面是根据插件的 src/definitions.ts重新同步公共API时，重新运行上游的同步。

继续从开始

继续从开始

如果您正在使用 开始使用 为计划仪表板和API操作，连接它 使用@capgo/capacitor-ivs-player 使用@capgo/capacitor-ivs-player的原生能力 API概述 API概述的实现细节 介绍 介绍的实现细节 API密钥 API密钥的实现细节 设备 设备的实现细节