IVS Player
Ivs player for capacitor app
@capgo/ivs-player
➡️ Get Instant updates for your App with Capgo 🚀
Fix your annoying bug now, Hire a Capacitor expert 💪
Ivs player for Capacitor app Android and IOS.
Install
npm install @capgo/ivs-player
npx cap sync
API
create(...)start()cast()getCastStatus()pause()delete()getUrl()getState()setPlayerPosition(...)getPlayerPosition()setAutoQuality(...)getAutoQuality()setPip(...)getPip()setFrame(...)getFrame()setBackgroundState(...)getBackgroundState()setMute(...)getMute()setQuality(...)getQuality()getQualities()getPluginVersion()addListener('startPip', ...)addListener('stopPip', ...)addListener('expandPip', ...)addListener('closePip', ...)addListener('onState', ...)addListener('onCues', ...)addListener('onDuration', ...)addListener('onError', ...)addListener('onRebuffering', ...)addListener('onSeekCompleted', ...)addListener('onVideoSize', ...)addListener('onQuality', ...)addListener('onCastStatus', ...)removeAllListeners()- Interfaces
- Type Aliases
create(...)
create(options: { url: string; pip?: boolean; title?: string; subtitle?: string; cover?: string; autoPlay?: boolean; toBack?: boolean; x?: number; y?: number; width?: number; height?: number; }) => Promise<void>
| Param | Type |
|---|---|
options |
{ url: string; pip?: boolean; title?: string; subtitle?: string; cover?: string; autoPlay?: boolean; toBack?: boolean; x?: number; y?: number; width?: number; height?: number; } |
start()
start() => Promise<void>
cast()
cast() => Promise<void>
getCastStatus()
getCastStatus() => Promise<{ isActive: boolean; }>
Returns: Promise<{ isActive: boolean; }>
pause()
pause() => Promise<void>
delete()
delete() => Promise<void>
getUrl()
getUrl() => Promise<{ url: string; }>
Returns: Promise<{ url: string; }>
getState()
getState() => Promise<{ state: CapacitorIvsPlayerState; }>
Returns: Promise<{ state: CapacitorIvsPlayerState; }>
setPlayerPosition(...)
setPlayerPosition(options?: { toBack: boolean; } | undefined) => Promise<void>
| Param | Type |
|---|---|
options |
{ toBack: boolean; } |
getPlayerPosition()
getPlayerPosition() => Promise<{ toBack: boolean; }>
Returns: Promise<{ toBack: boolean; }>
setAutoQuality(...)
setAutoQuality(options?: { autoQuality?: boolean | undefined; } | undefined) => Promise<void>
| Param | Type |
|---|---|
options |
{ autoQuality?: boolean; } |
getAutoQuality()
getAutoQuality() => Promise<{ autoQuality: boolean; }>
Returns: Promise<{ autoQuality: boolean; }>
setPip(...)
setPip(options?: { pip?: boolean | undefined; } | undefined) => Promise<void>
| Param | Type |
|---|---|
options |
{ pip?: boolean; } |
getPip()
getPip() => Promise<{ pip: boolean; }>
Returns: Promise<{ pip: boolean; }>
setFrame(...)
setFrame(options?: { x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; } | undefined) => Promise<void>
Set the frame of the player view, all number have to be positive and integers
| Param | Type | Description |
|---|---|---|
options |
{ x?: number; y?: number; width?: number; height?: number; } |
: number, y: number, width: number, height: number} |
Since: 1.0.0
getFrame()
getFrame() => Promise<CapacitorFrame>
Returns: Promise<CapacitorFrame>
setBackgroundState(...)
setBackgroundState(options: { backgroundState: CapacitorIvsPlayerBackgroundState; }) => Promise<void>
| Param | Type |
|---|---|
options |
{ backgroundState: CapacitorIvsPlayerBackgroundState; } |
getBackgroundState()
getBackgroundState() => Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>
Returns: Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>
setMute(...)
setMute(options?: { muted?: boolean | undefined; } | undefined) => Promise<void>
| Param | Type |
|---|---|
options |
{ muted?: boolean; } |
getMute()
getMute() => Promise<{ mute: boolean; }>
Returns: Promise<{ mute: boolean; }>
setQuality(...)
setQuality(options?: { quality: string; } | undefined) => Promise<void>
| Param | Type |
|---|---|
options |
{ quality: string; } |
getQuality()
getQuality() => Promise<{ quality: string; }>
Returns: Promise<{ quality: string; }>
getQualities()
getQualities() => Promise<{ qualities: string[]; }>
Returns: Promise<{ qualities: string[]; }>
getPluginVersion()
getPluginVersion() => Promise<{ version: string; }>
Get the native Capacitor plugin version
Returns: Promise<{ version: string; }>
addListener('startPip', ...)
addListener(eventName: "startPip", listenerFunc: () => void) => Promise<PluginListenerHandle>
Listen for start pip
| Param | Type |
|---|---|
eventName |
'startPip' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('stopPip', ...)
addListener(eventName: "stopPip", listenerFunc: () => void) => Promise<PluginListenerHandle>
Listen for stop pip
| Param | Type |
|---|---|
eventName |
'stopPip' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('expandPip', ...)
addListener(eventName: "expandPip", listenerFunc: () => void) => Promise<PluginListenerHandle>
Listen for expend pip
| Param | Type |
|---|---|
eventName |
'expandPip' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('closePip', ...)
addListener(eventName: "closePip", listenerFunc: () => void) => Promise<PluginListenerHandle>
Listen for close pip
| Param | Type |
|---|---|
eventName |
'closePip' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onState', ...)
addListener(eventName: "onState", listenerFunc: (data: { state: CapacitorIvsPlayerState; }) => void) => Promise<PluginListenerHandle>
Listen for state changes
| Param | Type |
|---|---|
eventName |
'onState' |
listenerFunc |
(data: { state: CapacitorIvsPlayerState; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onCues', ...)
addListener(eventName: "onCues", listenerFunc: (data: { cues: string; }) => void) => Promise<PluginListenerHandle>
Listen for cue changes
| Param | Type |
|---|---|
eventName |
'onCues' |
listenerFunc |
(data: { cues: string; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onDuration', ...)
addListener(eventName: "onDuration", listenerFunc: (data: { duration: number; }) => void) => Promise<PluginListenerHandle>
Listen for duration changes
| Param | Type |
|---|---|
eventName |
'onDuration' |
listenerFunc |
(data: { duration: number; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onError', ...)
addListener(eventName: "onError", listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle>
Listen for errors
| Param | Type |
|---|---|
eventName |
'onError' |
listenerFunc |
(data: { error: string; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onRebuffering', ...)
addListener(eventName: "onRebuffering", listenerFunc: () => void) => Promise<PluginListenerHandle>
Listen for rebuffering
| Param | Type |
|---|---|
eventName |
'onRebuffering' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onSeekCompleted', ...)
addListener(eventName: "onSeekCompleted", listenerFunc: (data: { position: number; }) => void) => Promise<PluginListenerHandle>
Listen for position changes
| Param | Type |
|---|---|
eventName |
'onSeekCompleted' |
listenerFunc |
(data: { position: number; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onVideoSize', ...)
addListener(eventName: "onVideoSize", listenerFunc: (data: { width: number; height: number; }) => void) => Promise<PluginListenerHandle>
Listen for video size changes
| Param | Type |
|---|---|
eventName |
'onVideoSize' |
listenerFunc |
(data: { width: number; height: number; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onQuality', ...)
addListener(eventName: "onQuality", listenerFunc: (data: { quality: string; }) => void) => Promise<PluginListenerHandle>
Listen for quality changes
| Param | Type |
|---|---|
eventName |
'onQuality' |
listenerFunc |
(data: { quality: string; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('onCastStatus', ...)
addListener(eventName: "onCastStatus", listenerFunc: (data: { isActive: boolean; }) => void) => Promise<PluginListenerHandle>
Listen for cast status changes
| Param | Type |
|---|---|
eventName |
'onCastStatus' |
listenerFunc |
(data: { isActive: boolean; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
removeAllListeners()
removeAllListeners() => Promise<void>
Remove all listeners for this plugin.
Since: 1.0.0
Interfaces
CapacitorFrame
| Prop | Type |
|---|---|
x |
number |
y |
number |
width |
number |
height |
number |
PluginListenerHandle
| Prop | Type |
|---|---|
remove |
() => Promise<void> |
Type Aliases
CapacitorIvsPlayerState
"IDLE" | "BUFFERING" | "READY" | "PLAYING" | "ENDED" | "UNKNOWN"
CapacitorIvsPlayerBackgroundState
"PAUSED" | "PLAYING"
Credits
cantar @capgo/ivs-player
Instalación
Para instalar el paquete @capgo/ivs-player, necesitas ejecutar el siguiente comando:
[[BLOQUE_DE_CÓDIGO]]
API
El paquete @capgo/ivs-player proporciona la siguiente API:
crear(opciones: { url: string; pip?: boolean; título?: string; subtítulo?: string; portada?: string; autoReproducir?: boolean; aAtrás?: boolean; x?: number; y?: number; ancho?: number; altura?: number; }) => Promesa
Este método crea una instancia del reproductor IVS. Toma un objeto de opciones como parámetro, que contiene varias propiedades como la URL del video, si se debe habilitar el modo de imagen en imagen, el título y subtítulo del video, y más. Devuelve una Promesa que se resuelve a la instancia creada.
iniciar() => Promesa
Este método comienza a reproducir el video en el reproductor IVS. Devuelve una Promesa.
lanzar() => Promesa
Este método lanza el video a un dispositivo conectado. Devuelve una Promesa.
obtenerEstadoDeLanzamiento() => Promesa[[ETIQUETA_HTML]]
Este método recupera el estado de la función de lanzamiento. Devuelve una Promesa que se resuelve a un objeto que contiene la propiedad isActive, que indica si el lanzamiento está activo.
pausar() => Promesa
Este método pausa la reproducción del video. Devuelve una Promesa.
eliminar() => Promesa
Este método elimina la instancia del reproductor IVS. Devuelve una Promesa.
obtenerUrl() => Promesa
Este método recupera la URL del video que se está reproduciendo actualmente. Devuelve una Promesa.
obtenerEstado() => Promesa
Este método recupera el estado actual del reproductor IVS. Devuelve una Promesa.
establecerPosiciónDelReproductor() => Promesa
Este método establece la posición del reproductor IVS en la pantalla. Toma coordenadas x e y como parámetros y devuelve una Promesa.
obtenerPosiciónDelReproductor() => Promesa
Este método recupera la posición actual del reproductor IVS en la pantalla. Devuelve una Promesa.
establecerCalidadAutomática() => Promesa
Este método establece el modo de calidad automática del reproductor IVS. Toma un valor booleano como parámetro y devuelve una Promesa.
obtenerCalidadAutomática() => Promesa
Este método recupera el modo de calidad automática actual del reproductor IVS. Devuelve una Promesa.
establecerPip() => Promesa
Este método establece el modo de imagen en imagen del reproductor IVS. Toma un valor booleano como parámetro y devuelve una Promesa.
obtenerPip() => Promesa
Este método recupera el modo de imagen en imagen actual del reproductor IVS. Devuelve una Promesa.
establecerMarco() => Promesa
Este método establece el marco del reproductor IVS. Toma un valor numérico como parámetro y devuelve una Promesa.
obtenerMarco() => Promesa
Este método recupera el marco actual del reproductor IVS. Devuelve una Promesa.
establecerSilencio() => Promesa
Este método establece el modo de silencio del reproductor IVS. Toma un valor booleano como parámetro y devuelve una Promesa.
obtenerSilencio() => Promesa
Este método recupera el modo de silencio actual del reproductor IVS. Devuelve una Promesa.
establecerCalidad() => Promesa
Este método establece la calidad del video en el reproductor IVS. Toma un valor de cadena como parámetro y devuelve una Promesa.
obtenerCalidad() => Promesa
Este método recupera la calidad actual del video en el reproductor IVS. Devuelve una Promesa.
obtenerCalidades() => Promesa
Este método recupera las calidades disponibles del video en el reproductor IVS. Devuelve una Promesa.
agregarListener('expandirPip', ) => void
Este método agrega un listener para el evento expandirPip. Toma una función de callback como parámetro y devuelve void.
agregarListener('cerrarPip', ) => void
Este método agrega un listener para el evento cerrarPip. Toma una función de callback como parámetro y devuelve void.
agregarListener('enEstado', ) => void
Este método agrega un listener para el evento enEstado. Toma una función de callback como parámetro y devuelve void.
agregarListener('enCues', ) => void
Este método agrega un listener para el evento enCues. Toma una función de callback como parámetro y devuelve void.
agregarListener('enDuración', ) => void
Este método agrega un listener para el evento enDuración.Toma una función de callback como parámetro y devuelve void
addListener('onError', ) => void
Este método agrega un listener para el evento onError. Toma una función de callback como parámetro y devuelve void.
addListener('onRebuffering', ) => void
Este método agrega un listener para el evento onRebuffering. Toma una función de callback como parámetro y devuelve void.
addListener('onSeekCompleted', ) => void
Este método agrega un listener para el evento onSeekCompleted. Toma una función de callback como parámetro y devuelve void.
addListener('onVideoSize', ) => void
Este método agrega un listener para el evento onVideoSize. Toma una función de callback como parámetro y devuelve void.
addListener('onQuality', ) => void
Este método agrega un listener para el evento onQuality. Toma una función de callback como parámetro y devuelve void.
addListener('onCastStatus', ) => void
Este método agrega un listener para el evento onCastStatus. Toma una función de callback como parámetro y devuelve void.
removeAllListeners() => void
Este método elimina todos los listeners de eventos añadidos. Devuelve void.
Conclusión
El paquete @capgo/ivs-player proporciona una API completa para integrar un reproductor IVS en tu aplicación Capacitor. Siguiendo los pasos de instalación y consultando la documentación de la API, puedes comenzar a reproducir videos en tu aplicación utilizando el reproductor IVS.