Getting Started
このプラグインのインストール手順とフルマークダウンガイドを含むセットアップコマンドをコピーしてください。
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.
インストール
InstallYou can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:
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-playerbunx cap syncコピー
インポートimport { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';コピーをクリップボードにコピーしてください:APIの概要
API の概要create
__CAPGO_KEEP_0__ の作成現在の契約のソース定義を参照してください。
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
__CAPGO_KEEP_0__ の開始現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.start();現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.cast();getCastStatus
__CAPGO_KEEP_0__ のキャスト状態現在の契約のソース定義を参照してください。
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
setPlayerPositionのセクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPlayerPosition();getPlayerPosition
getPlayerPositionのセクション現在の契約のソース定義を参照してください。
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPlayerPosition();setAutoQuality
setAutoQualityのセクション現在の契約のソース定義を参照してください。
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
「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
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';真実の源
真実の源のセクションこのページはプラグインから生成されています。 src/definitions.tsAPIがアップストリームで変更された場合に、再度Syncを実行してください。
Getting Startedから続けてください
Getting Startedから続けてくださいのセクションCapgoを使用している場合 Getting Started ダッシュボードとAPIの作業を計画するには、 Using @capgo/capacitor-ivs-player Using @capgo/capacitor-ivs-playerのネイティブ機能 APIの概要 APIの概要の実装詳細 導入 導入の実装詳細 APIのキー APIのキーに関する実装詳細 デバイス デバイスに関する実装詳細