Erste Schritte

Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.

        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`
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.

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-ivs-player` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

Importieren

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

Quickstart

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

await CapacitorIvsPlayer.create({ url: 'https://example.com' });

Beispiel: start

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

await CapacitorIvsPlayer.start();

Beispiel: cast

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

await CapacitorIvsPlayer.cast();

Häufige Stolperfallen

Listener: Handles beim Unmounten von Screens entfernen.
Nativer Sync: ausführen bunx cap sync nach Plugin-Upgrades.
Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

API Übersicht

`create`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.create({ url: 'https://example.com' });

`start`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.start();

`cast`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.cast();

`getCastStatus`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getCastStatus();
console.log(result);

`pause`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.pause();

`delete`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.delete();

`getUrl`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getUrl();
console.log(result);

`getState`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getState();
console.log(result);

`setPlayerPosition`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setPlayerPosition();

`getPlayerPosition`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getPlayerPosition();
console.log(result);

`setAutoQuality`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setAutoQuality();

`getAutoQuality`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getAutoQuality();
console.log(result);

`setPip`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setPip();

`getPip`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getPip();
console.log(result);

`setFrame`

Legen Sie den Rahmen der Player-Ansicht fest; alle Zahlen müssen positive Ganzzahlen sein.

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

await CapacitorIvsPlayer.setFrame();

`getFrame`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getFrame();
console.log(result);

`setBackgroundState`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setBackgroundState({ backgroundState: 'PAUSED' });

`getBackgroundState`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getBackgroundState();
console.log(result);

`setMute`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setMute();

`getMute`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getMute();
console.log(result);

`setQuality`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setQuality();

`getQuality`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getQuality();
console.log(result);

`getQualities`

Sieh dir die Source-Definitionen für den aktuellen Contract an.

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

const result = await CapacitorIvsPlayer.getQualities();
console.log(result);

Typreferenz

`CapacitorIvsPlayerState`

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

`CapacitorIvsPlayerBackgroundState`

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-ivs-player verwenden für die native Funktion in „@capgo/capacitor-ivs-player verwenden“, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.