Démarrage

Copiez un prompt de configuration avec les étapes d'installation et le 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.

Installer

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

Importer

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

API Présentation

`create`

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;
  });

`start`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.start();

`cast`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.cast();

`getCastStatus`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getCastStatus();

`pause`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.pause();

`delete`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.delete();

`getUrl`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getUrl();

`getState`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getState();

`setPlayerPosition`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.setPlayerPosition();

`getPlayerPosition`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getPlayerPosition();

`setAutoQuality`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.setAutoQuality();

`getAutoQuality`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getAutoQuality();

`setPip`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.setPip();

`getPip`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getPip();

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

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getFrame();

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

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getBackgroundState();

`setMute`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.setMute();

`getMute`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getMute();

`setQuality`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.setQuality();

`getQuality`

Voir les définitions de source pour le contrat actuel.

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

await CapacitorIvsPlayer.getQuality();

`getQualities`

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

`CapacitorIvsPlayerState`

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

`CapacitorIvsPlayerBackgroundState`

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-générer la page lorsque le public API change en amont.