Prise en main

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

Ensuite, 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 à la plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

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

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

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

await CapacitorIvsPlayer.getCastStatus();

pause

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

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

await CapacitorIvsPlayer.pause();

delete

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

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

await CapacitorIvsPlayer.delete();

getUrl

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

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

await CapacitorIvsPlayer.getUrl();

getState

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

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

await CapacitorIvsPlayer.getState();

setPlayerPosition

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

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

await CapacitorIvsPlayer.setPlayerPosition();

getPlayerPosition

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

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

await CapacitorIvsPlayer.getPlayerPosition();

setAutoQuality

Consultez 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 player, 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-run la synchronisation lorsque le public API change en amont.

Continuez de la section « Getting Started »

Si vous utilisez Prise en main pour planifier votre tableau de bord et les opérations API, connectez-l’avec En utilisant @capgo/capacitor-ivs-player pour la capacité native en utilisant @capgo/capacitor-ivs-player, API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans les appareils.