Démarrage
Copiez une commande de configuration avec les étapes d'installation et la guide markdown complet pour ce 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`, `@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.
Installation
Section intitulée « Installation »Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsEnsuite, utilisez la prompt suivante :
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-ivs-player` plugin in my project.Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :
bun add @capgo/capacitor-ivs-playerbunx cap syncImporter
Section intitulée « Importer »import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';API Vue d'ensemble
Section intitulée “API Aperçu”Voir les définitions de source pour le contrat actuel.
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; });Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.start();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.cast();getCastStatus
Section intitulée “obtenir l’état de casting”Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getCastStatus();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.pause();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.delete();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getUrl();getState
Section intitulée “getState”Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getState();setPlayerPosition
Section intitulée « setPlayerPosition »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPlayerPosition();getPlayerPosition
Section intitulée « getPlayerPosition »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPlayerPosition();setAutoQuality
Section intitulée « setAutoQuality »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setAutoQuality();getAutoQuality
Section intitulée « getAutoQuality »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getAutoQuality();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setPip();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getPip();setFrame
Section intitulée « setFrame »Définir la fenêtre du joueur, tous les nombres doivent être positifs et entiers.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setFrame();getFrame
Section intitulée « getFrame »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getFrame();setBackgroundState
Section intitulée « setBackgroundState »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setBackgroundState({} as { backgroundState: CapacitorIvsPlayerBackgroundState });getBackgroundState
Section intitulée « getBackgroundState »Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getBackgroundState();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setMute();Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getMute();setQuality
Section intitulée “setQuality”Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.setQuality();getQuality
Section intitulée “getQuality”Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getQuality();getQualities
Section intitulée “getQualités”Voir les définitions de source pour le contrat actuel.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.getQualities();Référence de type
Section intitulée “Référence de type”CapacitorIvsPlayerState
Section intitulée « CapacitorIvsPlayerState »export type CapacitorIvsPlayerState = 'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN';CapacitorIvsPlayerBackgroundState
Section intitulée « CapacitorIvsPlayerBackgroundState »export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';Source De Vérité
Section intitulée « Source De Vérité »Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque le public API change en amont.
Continuer depuis Getting Started
Section intitulée « Continuer depuis Getting Started »Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-le à Utilisation de @capgo/capacitor-ivs-joueur pour la capacité native dans l'utilisation de @capgo/capacitor-ivs-joueur, Vue d'ensemble de API pour le détail d'implémentation dans la Vue d'ensemble de API, Introduction pour le détail d'implémentation dans l'Introduction, Clés de API pour le détail d'implémentation dans les Clés de API, et Appareils pour le détail d'implémentation dans Appareils.