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

开始

GitHub

安装

安装
终端窗口
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

获取 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

设置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. Re-run the sync when the public API changes upstream.

继续从入门

继续从入门

如果您正在使用 入门 to plan dashboard and API operations, connect it with 使用@capgo/capacitor-ivs-player 使用@capgo/capacitor-ivs-player API Overview 为API概述的实现细节， 简介 为简介的实现细节， API密钥 为API密钥的实现细节，和 设备 为设备的实现细节。