Guía
Cómo usar IVS Player en Capacitor
Uso de @capgo/capacitor-ivs-player
Ivs player para la app capacitor.
Instalar
bun add @capgo/capacitor-ivs-player
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
API de un vistazo
| Método | Descripción |
|---|---|
create |
Consulta las definiciones de origen para ver el comportamiento actual. |
start |
Consulta las definiciones de origen para ver el comportamiento actual. |
cast |
Consulta las definiciones de origen para ver el comportamiento actual. |
getCastStatus |
Consulta las definiciones de origen para ver el comportamiento actual. |
pause |
Consulta las definiciones de origen para ver el comportamiento actual. |
delete |
Consulta las definiciones de origen para ver el comportamiento actual. |
getUrl |
Consulta las definiciones de origen para ver el comportamiento actual. |
getState |
Consulta las definiciones de origen para ver el comportamiento actual. |
setPlayerPosition |
Consulta las definiciones de origen para ver el comportamiento actual. |
getPlayerPosition |
Consulta las definiciones de origen para ver el comportamiento actual. |
setAutoQuality |
Consulta las definiciones de origen para ver el comportamiento actual. |
getAutoQuality |
Consulta las definiciones de origen para ver el comportamiento actual. |
setPip |
Consulta las definiciones de origen para ver el comportamiento actual. |
getPip |
Consulta las definiciones de origen para ver el comportamiento actual. |
setFrame |
Define el marco de la vista del reproductor; todos los números deben ser enteros positivos. |
getFrame |
Consulta las definiciones de origen para ver el comportamiento actual. |
setBackgroundState |
Consulta las definiciones de origen para ver el comportamiento actual. |
getBackgroundState |
Consulta las definiciones de origen para ver el comportamiento actual. |
setMute |
Consulta las definiciones de origen para ver el comportamiento actual. |
getMute |
Consulta las definiciones de origen para ver el comportamiento actual. |
setQuality |
Consulta las definiciones de origen para ver el comportamiento actual. |
getQuality |
Consulta las definiciones de origen para ver el comportamiento actual. |
getQualities |
Consulta las definiciones de origen para ver el comportamiento actual. |
Ejemplos
create()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.create({ url: 'https://example.com' });
start()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.start();
cast()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.cast();
getCastStatus()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
const result = await CapacitorIvsPlayer.getCastStatus();
console.log(result);
pause()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.pause();
delete()
Consulta la referencia de API para conocer el contrato actual.
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';
await CapacitorIvsPlayer.delete();
La tabla anterior enumera los 23 métodos principales. Los helpers de versión y listeners, junto con el contrato completo de cada método, están documentados en la repositorio GitHub.
Escuchar eventos
addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o CapacitorIvsPlayer.removeAllListeners() para limpiar todos los listeners.
Referencia completa
Continuar desde Uso de @capgo/capacitor-ivs-player
Si estás usando Uso de @capgo/capacitor-ivs-player para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-ivs-player para los detalles de implementación en @capgo/capacitor-ivs-player, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.