Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas para cada plataforma a continuación:

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

Importar

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

Inicio rápido

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

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

Ejemplo: inicio

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

await CapacitorIvsPlayer.start();

Ejemplo: cast

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

await CapacitorIvsPlayer.cast();

Errores comunes

• Listeners: eliminar los handles al desmontar las pantallas.
• Sync nativo: ejecutar bunx cap sync tras actualizar los plugins.
• Fuente de verdad: confiar src/definitions.ts en el repo de GitHub.

Resumen de API

create

Consulta las definiciones de la fuente para el contrato actual.

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

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

start

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.start();

cast

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.cast();

getCastStatus

Consulta las definiciones de la fuente para el contrato actual.

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

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

pause

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.pause();

delete

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.delete();

getUrl

Consulta las definiciones de la fuente para el contrato actual.

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

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

getState

Consulta las definiciones de la fuente para el contrato actual.

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

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

setPlayerPosition

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.setPlayerPosition();

getPlayerPosition

Consulta las definiciones de la fuente para el contrato actual.

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

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

setAutoQuality

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.setAutoQuality();

getAutoQuality

Consulta las definiciones de la fuente para el contrato actual.

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

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

setPip

Consulta las definiciones de la fuente para el contrato actual.

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

await CapacitorIvsPlayer.setPip();

getPip

Consulta las definiciones de la fuente para el contrato actual.

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

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

setFrame

Establece el frame de la vista del player; todos los números deben ser enteros positivos

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

await CapacitorIvsPlayer.setFrame();

getFrame

Consulta las definiciones en el código fuente para el contrato actual.

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

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

setBackgroundState

Consulta las definiciones en el código fuente para el contrato actual.

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

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

getBackgroundState

Consulta las definiciones en el código fuente para el contrato actual.

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

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

setMute

Consulta las definiciones en el código fuente para el contrato actual.

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

await CapacitorIvsPlayer.setMute();

getMute

Consulta las definiciones en el código fuente para el contrato actual.

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

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

setQuality

Consulta las definiciones en el código fuente para el contrato actual.

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

await CapacitorIvsPlayer.setQuality();

getQuality

Consulta las definiciones en el código fuente para el contrato actual.

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

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

getQualities

Consulta las definiciones en el código fuente para el contrato actual.

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

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

Referencia de tipos

CapacitorIvsPlayerState

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

CapacitorIvsPlayerBackgroundState

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

Fuente de verdad

Esta página se genera desde el src/definitions.tsVuelve a ejecutar la sincronización cuando cambie el API público en el upstream.

Continúa desde Primeros pasos

Si estás usando Primeros pasos para planificar el dashboard y las operaciones de API, conéctalo con Uso de @capgo/capacitor-ivs-player para la capacidad nativa en Uso de @capgo/capacitor-ivs-player, Resumen de API para el detalle de implementación en Resumen de API Overview, Introducción para el detalle de implementación en Introducción, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.