Saltar al contenido principal
@capgo/reproductor-de-ivs Multimedia De código abierto

Jugador de IVS plugin de Capacitor

Transmítea video en vivo con baja latencia utilizando Amazon Interactive Video Service (IVS)

Instalar

bun add @capgo/ivs-player bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/ivs-player
  • pnpm add @capgo/ivs-player
  • yarn add @capgo/ivs-player

Guía

Cómo usar el reproductor de IVS en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Vista previa del plugin de IVS Player QR code

Usando @capgo/capacitor-ivs-player

Reproductor de IVS para la aplicación capacitor

Instalar

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

bunx cap sync copia el código nativo del plugin code en tus proyectos nativos. Correlo nuevamente después de cada actualización del plugin.

Importar

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

Vista general de API

Método Descripción
create Consulte las definiciones de origen para el comportamiento actual.
start Consulte las definiciones de origen para el comportamiento actual.
cast Consulte las definiciones de origen para el comportamiento actual.
getCastStatus Consulte las definiciones de origen para el comportamiento actual.
pause Consulte las definiciones de origen para el comportamiento actual.
delete Consulte las definiciones de origen para el comportamiento actual.
getUrl Consulte las definiciones de origen para el comportamiento actual.
getState Consulte las definiciones de origen para el comportamiento actual.
setPlayerPosition Consulte las definiciones de origen para el comportamiento actual.
getPlayerPosition Consulte las definiciones de origen para el comportamiento actual.
setAutoQuality Consulte las definiciones de origen para el comportamiento actual.
getAutoQuality Consulte las definiciones de origen para el comportamiento actual.
setPip Consulte las definiciones de origen para el comportamiento actual.
getPip Consulte las definiciones de origen para el comportamiento actual.
setFrame Establezca el marco de la vista del reproductor, todos los números deben ser positivos e enteros.
getFrame Consulte las definiciones de origen para el comportamiento actual.
setBackgroundState Consulte las definiciones de origen para el comportamiento actual.
getBackgroundState Consulte las definiciones de origen para el comportamiento actual.
setMute Consulte las definiciones de origen para el comportamiento actual.
getMute Consulte las definiciones de origen para el comportamiento actual.
setQuality Consulte las definiciones de origen para el comportamiento actual.
getQuality Consulte las definiciones de origen para el comportamiento actual.
getQualities Consulte las definiciones de origen para el comportamiento actual.

Ejemplos

create()

Consulte la referencia de API para el contrato actual.

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

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

start()

Consulte la referencia de API para el contrato actual.

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

await CapacitorIvsPlayer.start();

cast()

Consulte la referencia de API para el contrato actual.

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

await CapacitorIvsPlayer.cast();

getCastStatus()

Consulte la referencia de API para el contrato actual.

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

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

pause()

Consulte la referencia de API para el contrato actual.

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

await CapacitorIvsPlayer.pause();

delete()

Consulte la referencia de API para el contrato actual.

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

await CapacitorIvsPlayer.delete();

La tabla anterior enumera los 23 métodos básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el repositorio de GitHub.

Escuchar eventos

addListener devuelve un manejador. Llame a handle.remove() cuando se desmonte la pantalla, o CapacitorIvsPlayer.removeAllListeners() para eliminar todos los escuchadores.

Referencia completa

Sigue adelante desde el uso de @capgo/capacitor-ivs-player

Si estás utilizando Usando @capgo/capacitor-ivs-player para planificar el trabajo de plugin nativo, conectalo con @capgo/capacitor-ivs-player para los detalles de implementación en @capgo/capacitor-ivs-player Inicio rápido para los detalles de implementación en Inicio rápido, Capgo Directorio de Plugins para el flujo de trabajo del producto en Capgo Directorio de Plugins Capacitor Plugins por Capgo para el detalle de implementación en Capacitor Plugins por Capgo, y Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins.

FAQ

FAQ del plugin de IVS Player

¿Cómo instalo el plugin de IVS Player en una aplicación Capacitor?

Ejecuta "bun add @capgo/ivs-player" (o "npm install @capgo/ivs-player"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el code nativo. Importa desde "@capgo/ivs-player" en tu aplicación code.

¿Funciona @capgo/ivs-player con React, Vue y Angular?

Sí. El jugador de IVS es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor soporta @capgo/ivs-player?

Los plugins de Capgo siguen la versión mayor de Capacitor: utiliza la versión mayor del plugin que coincida con la versión mayor de Capacitor (por ejemplo, plugin v8 con Capacitor 8). La tabla de compatibilidad en el README del GitHub lista las versiones mantenidas.

¿Es @capgo/ivs-player gratuito y de código abierto?

Sí. El código fuente de code está disponible públicamente en GitHub en https://github.com/Cap-go/capacitor-ivs-player/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de extracción.

¿Puedo actualizar code que utiliza IVS Player sin una revisión de la Tienda?

La instalación o actualización del plugin cambia el code nativo, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios en JavaScript, HTML y CSS que llaman al plugin pueden enviar instantáneamente con Capgo actualizaciones en vivo.

Envíe cambios del reproductor IVS sin esperar la revisión de la aplicación

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían cambios en JavaScript, HTML y CSS a los usuarios en minutos.

Inicia con Capgo