Getting Started

Configuración

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el plugin ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

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

Importar

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

API Resumen

create

Consulte las definiciones de origen para el contrato actual.

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

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.start();

cast

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.cast();

getCastStatus

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getCastStatus();

pause

Ver las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.pause();

delete

Ver las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.delete();

getUrl

Ver las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getUrl();

getState

Ver las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getState();

setPlayerPosition

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setPlayerPosition();

getPlayerPosition

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getPlayerPosition();

setAutoQuality

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setAutoQuality();

getAutoQuality

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getAutoQuality();

setPip

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setPip();

getPip

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getPip();

setFrame

Establezca el marco de la vista del jugador, todos los números deben ser positivos e enteros.

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

await CapacitorIvsPlayer.setFrame();

getFrame

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getFrame();

setBackgroundState

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setBackgroundState({} as { backgroundState: CapacitorIvsPlayerBackgroundState });

getBackgroundState

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getBackgroundState();

setMute

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setMute();

getMute

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getMute();

setQuality

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.setQuality();

getQuality

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getQuality();

getQualities

Consulte las definiciones de origen para el contrato actual.

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

await CapacitorIvsPlayer.getQualities();

Referencia de tipo

CapacitorIvsPlayerState

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

CapacitorIvsPlayerBackgroundState

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y API operaciones, conectarla con Usando @capgo/capacitor-ivs-player para la capacidad nativa en Usando @capgo/capacitor-ivs-player, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.