Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください:

bun add @capgo/capacitor-ivs-player
bunx cap sync

インポート

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

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

See the source definitions for the current contract.

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

await CapacitorIvsPlayer.pause();

delete

See the source definitions for the current contract.

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

await CapacitorIvsPlayer.delete();

getUrl

See the source definitions for the current contract.

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

await CapacitorIvsPlayer.getUrl();

getState

See the source definitions for the current contract.

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

現在の契約のソース定義を参照してください。

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

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

CapacitorIvsPlayerBackgroundState

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

真実の源

このページはプラグインの src/definitions.ts再度、パブリック API がアップストリームで変更された場合にsyncを実行してください。

Getting Startedから続けてください

Capgoを使用している場合 Getting Started ダッシュボードとAPIの計画と操作を行う場合に接続してください @capgo/capacitor-ivs-player @capgo/capacitor-ivs-player API の概要 API の実装詳細 導入 __CAPGO_KEEP_0__ のキー API の実装詳細、そして for the implementation detail in API Keys, and __CAPGO_KEEP_0__ の実装詳細 ページを編集