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
cant @capgo/ivs-player
Instalación
Para instalar el paquete @capgo/ivs-player, necesitas ejecutar el siguiente comando:
[[BLOQUE_CODIGO]]
API
El paquete @capgo/ivs-player proporciona la siguiente API:
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
Este método crea una instancia del reproductor IVS. Toma un objeto de opciones como parámetro, que contiene diversas propiedades como la URL del video, si se debe habilitar el modo de imagen en imagen, el título y el subtítulo del video, y más. Retorna una Promesa que se resuelve a la instancia creada.
start() => Promise
Este método inicia la reproducción del video en el reproductor IVS. Retorna una Promesa.
cast() => Promise
Este método envía el video a un dispositivo conectado. Retorna una Promesa.
getCastStatus() => Promise[[ETIQUETA_HTML]]
Este método recupera el estado de la función de transmisión. Retorna una Promesa que se resuelve a un objeto que contiene la propiedad isActive, que indica si la transmisión está activa.
pause() => Promise
Este método pausa la reproducción del video. Retorna una Promesa.
delete() => Promise
Este método elimina la instancia del reproductor IVS. Retorna una Promesa.
getUrl() => Promise
Este método recupera la URL del video que se está reproduciendo actualmente. Retorna una Promesa.
getState() => Promise
Este método recupera el estado actual del reproductor IVS. Retorna una Promesa.
setPlayerPosition() => Promise
Este método establece la posición del reproductor IVS en la pantalla. Toma coordenadas x e y como parámetros y retorna una Promesa.
getPlayerPosition() => Promise
Este método recupera la posición actual del reproductor IVS en la pantalla. Retorna una Promesa.
setAutoQuality() => Promise
Este método establece el modo de calidad automática del reproductor IVS. Toma un valor booleano como parámetro y retorna una Promesa.
getAutoQuality() => Promise
Este método recupera el modo de calidad automática actual del reproductor IVS. Retorna una Promesa.
setPip() => Promise
Este método establece el modo de imagen en imagen del reproductor IVS. Toma un valor booleano como parámetro y retorna una Promesa.
getPip() => Promise
Este método recupera el modo de imagen en imagen actual del reproductor IVS. Retorna una Promesa.
setFrame() => Promise
Este método establece el marco del reproductor IVS. Toma un valor numérico como parámetro y retorna una Promesa.
getFrame() => Promise
Este método recupera el marco actual del reproductor IVS. Retorna una Promesa.
setMute() => Promise
Este método establece el modo silencio del reproductor IVS. Toma un valor booleano como parámetro y retorna una Promesa.
getMute() => Promise
Este método recupera el modo silencio actual del reproductor IVS. Retorna una Promesa.
setQuality() => Promise
Este método establece la calidad del video en el reproductor IVS. Toma un valor de tipo cadena como parámetro y retorna una Promesa.
getQuality() => Promise
Este método recupera la calidad actual del video en el reproductor IVS. Retorna una Promesa.
getQualities() => Promise
Este método recupera las calidades disponibles del video en el reproductor IVS. Retorna una Promesa.
addListener('expandPip', ) => void
Este método agrega un oyente para el evento expandPip. Toma una función de callback como parámetro y retorna void.
addListener('closePip', ) => void
Este método agrega un oyente para el evento closePip. Toma una función de callback como parámetro y retorna void.
addListener('onState', ) => void
Este método agrega un oyente para el evento onState. Toma una función de callback como parámetro y retorna void.
addListener('onCues', ) => void
Este método agrega un oyente para el evento onCues. Toma una función de callback como parámetro y retorna void.
addListener('onDuration', ) => void
Este método agrega un oyente para el evento onDuration.Prende una funzione di callback come parametro e restituisce void
addListener('onError', ) => void
Questo metodo aggiunge un listener per l'evento onError. Prende una funzione di callback come parametro e restituisce void.
addListener('onRebuffering', ) => void
Questo metodo aggiunge un listener per l'evento onRebuffering. Prende una funzione di callback come parametro e restituisce void.
addListener('onSeekCompleted', ) => void
Questo metodo aggiunge un listener per l'evento onSeekCompleted. Prende una funzione di callback come parametro e restituisce void.
addListener('onVideoSize', ) => void
Questo metodo aggiunge un listener per l'evento onVideoSize. Prende una funzione di callback come parametro e restituisce void.
addListener('onQuality', ) => void
Questo metodo aggiunge un listener per l'evento onQuality. Prende una funzione di callback come parametro e restituisce void.
addListener('onCastStatus', ) => void
Questo metodo aggiunge un listener per l'evento onCastStatus. Prende una funzione di callback come parametro e restituisce void.
removeAllListeners() => void
Questo metodo rimuove tutti i listener di eventi aggiunti. Restituisce void.
Conclusione
Il pacchetto @capgo/ivs-player fornisce un'API completa per integrare un lettore IVS nella tua app Capacitor. Seguendo i passi di installazione e consultando la documentazione API, puoi facilmente iniziare a riprodurre video nella tua app utilizzando il lettore IVS.