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 deinem KI-Tool die Capgo Skills mit folgendem Befehl hinzu:

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

Nutze anschließend 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 bevorziehst, 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 Fehlerquellen

Listener: Handles entfernen, wenn Screens unmounten.
Native Sync: ausführen bunx cap sync nach Plugin-Upgrades.
Single Source of Truth: vertraue src/definitions.ts im GitHub Repo.

API Übersicht

`create`

Sieh dir die Definitionen im Quellcode für den aktuellen Contract an.

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

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

`start`

Sieh dir die Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.start();

`cast`

Sieh dir die Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.cast();

`getCastStatus`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.pause();

`delete`

Sieh dir die Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.delete();

`getUrl`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setPlayerPosition();

`getPlayerPosition`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setAutoQuality();

`getAutoQuality`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setPip();

`getPip`

Sieh dir die Definitionen im Quellcode für den aktuellen Contract an.

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

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

`setFrame`

Legt den Frame 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 Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

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

`getBackgroundState`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setMute();

`getMute`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

await CapacitorIvsPlayer.setQuality();

`getQuality`

Sieh dir die Definitionen im Quellcode 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 Definitionen im Quellcode für den aktuellen Contract an.

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

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

Typ-Referenz

`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- src/definitions.ts. Führe den Sync erneut aus, wenn sich der öffentliche API upstream ändert.

Weiter mit Getting Started

Wenn Sie ... verwenden Erste Schritte Um Dashboard- und API-Operationen zu planen, verbinde es mit Nutzung von @capgo/capacitor-ivs-player für die native Funktion in Nutzung von @capgo/capacitor-ivs-player, API Übersicht für Details zur Implementierung in der Übersicht zu API, Einführung für das Implementierungsdetail in der Einleitung, API Keys für die Implementierungsdetails in den API Keys und Geräte für die Implementierungsdetails bei Devices.