はじめに
インストール手順とこのプラグインの完全なマークダウンガイドを含むセットアップ用の質問をコピーする
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-ivs-player`, `@capgo/ivs-player`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ivs-player/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
インストール
「インストール」のセクションbun add @capgo/capacitor-ivs-playerbunx cap syncインポート
「インポート」のセクションimport { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';API の概要
API の概要のセクションcreate
セクションのタイトル “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
セクションのタイトル “start”現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.start();現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.cast();getCastStatus
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
getStateのセクション__CAPGO_KEEP_0__のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getState();setPlayerPosition
setPlayerPositionのセクション__CAPGO_KEEP_0__のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPlayerPosition();getPlayerPosition
getPlayerPositionのセクション__CAPGO_KEEP_0__のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPlayerPosition();setAutoQuality
setAutoQualityのセクション__CAPGO_KEEP_0__のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setAutoQuality();getAutoQuality
getAutoQualityセクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getAutoQuality();setPip
setPipセクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPip();getPip
getPipセクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPip();setFrame
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
「getMute」セクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getMute();setQuality
「setQuality」セクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setQuality();getQuality
「getQuality」セクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getQuality();getQualities
「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';公開された__CAPGO_KEEP_0__がアップストリームで変更された場合に再度同期を実行してください。 src/definitions.ts. Re-run the sync when the public API changes upstream.