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
sing @capgo/ivs-player
Instalasi
Untuk menginstal paket @capgo/ivs-player, Anda perlu menjalankan perintah berikut:
npm install @capgo/ivs-player
npx cap sync
API
Paket @capgo/ivs-player menyediakan API berikut:
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
Metode ini membuat instansi pemain IVS. Ini mengambil objek opsi sebagai parameter, yang berisi berbagai properti seperti URL video, apakah akan mengaktifkan mode picture-in-picture, judul dan subtitle video, dan lainnya. Ini mengembalikan Promise yang teratasi ke instansi yang dibuat.
start() => Promise
Metode ini memulai pemutaran video di pemain IVS. Ini mengembalikan Promise.
cast() => Promise
Metode ini mengalirkan video ke perangkat yang terhubung. Ini mengembalikan Promise.
getCastStatus() => Promise<{ isActive: boolean; }>
Metode ini mengambil status fitur casting. Ini mengembalikan Promise yang teratasi ke objek yang berisi properti isActive, yang menunjukkan apakah casting aktif.
pause() => Promise
Metode ini menjeda pemutaran video. Ini mengembalikan Promise.
delete() => Promise
Metode ini menghapus instansi pemain IVS. Ini mengembalikan Promise.
getUrl() => Promise
Metode ini mengambil URL video yang saat ini sedang diputar. Ini mengembalikan Promise.
getState() => Promise
Metode ini mengambil status saat ini dari pemain IVS. Ini mengembalikan Promise.
setPlayerPosition() => Promise
Metode ini mengatur posisi pemain IVS di layar. Ini mengambil koordina x dan y sebagai parameter dan mengembalikan Promise.
getPlayerPosition() => Promise
Metode ini mengambil posisi saat ini dari pemain IVS di layar. Ini mengembalikan Promise.
setAutoQuality() => Promise
Metode ini mengatur mode kualitas otomatis dari pemain IVS. Ini mengambil nilai boolean sebagai parameter dan mengembalikan Promise.
getAutoQuality() => Promise
Metode ini mengambil mode kualitas otomatis saat ini dari pemain IVS. Ini mengembalikan Promise.
setPip() => Promise
Metode ini mengatur mode picture-in-picture dari pemain IVS. Ini mengambil nilai boolean sebagai parameter dan mengembalikan Promise.
getPip() => Promise
Metode ini mengambil mode picture-in-picture saat ini dari pemain IVS. Ini mengembalikan Promise.
setFrame() => Promise
Metode ini mengatur bingkai dari pemain IVS. Ini mengambil nilai angka sebagai parameter dan mengembalikan Promise.
getFrame() => Promise
Metode ini mengambil bingkai saat ini dari pemain IVS. Ini mengembalikan Promise.
setMute() => Promise
Metode ini mengatur mode senyap dari pemain IVS. Ini mengambil nilai boolean sebagai parameter dan mengembalikan Promise.
getMute() => Promise
Metode ini mengambil mode senyap saat ini dari pemain IVS. Ini mengembalikan Promise.
setQuality() => Promise
Metode ini mengatur kualitas video di pemain IVS. Ini mengambil nilai string sebagai parameter dan mengembalikan Promise.
getQuality() => Promise
Metode ini mengambil kualitas saat ini dari video di pemain IVS. Ini mengembalikan Promise.
getQualities() => Promise
Metode ini mengambil kualitas yang tersedia dari video di pemain IVS. Ini mengembalikan Promise.
addListener('expandPip', ) => void
Metode ini menambahkan pendengar untuk acara expandPip. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void.
addListener('closePip', ) => void
Metode ini menambahkan pendengar untuk acara closePip. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void.
addListener('onState', ) => void
Metode ini menambahkan pendengar untuk acara onState. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void.
addListener('onCues', ) => void
Metode ini menambahkan pendengar untuk acara onCues. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void.
addListener('onDuration', ) => void
Metode ini menambahkan pendengar untuk acara onDuration.Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onError', ) => void
Metode ini menambahkan pendengar untuk acara onError. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onRebuffering', ) => void
Metode ini menambahkan pendengar untuk acara onRebuffering. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onSeekCompleted', ) => void
Metode ini menambahkan pendengar untuk acara onSeekCompleted. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onVideoSize', ) => void
Metode ini menambahkan pendengar untuk acara onVideoSize. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onQuality', ) => void
Metode ini menambahkan pendengar untuk acara onQuality. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
addListener('onCastStatus', ) => void
Metode ini menambahkan pendengar untuk acara onCastStatus. Ini mengambil fungsi callback sebagai parameter dan mengembalikan void
removeAllListeners() => void
Metode ini menghapus semua pendengar acara yang telah ditambahkan. Ini mengembalikan void
Kesimpulan
Paket @capgo/ivs-player menyediakan API yang komprehensif untuk mengintegrasikan pemutar IVS ke dalam aplikasi Capacitor Anda. Dengan mengikuti langkah-langkah instalasi dan merujuk pada dokumentasi API, Anda dapat dengan mudah mulai memutar video di aplikasi Anda menggunakan pemutar IVS.