Skip to content

Cap-go/capacitor-ivs-player

BranchesTags

Repository files navigation

@capgo/capacitor-ivs-player

Capgo - Instant updates for Capacitor

Ivs player for Capacitor app Android and IOS.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/ivs-player/

Compatibility

Plugin version Capacitor compatibility Maintained
v8.*.* v8.*.* ✅
v7.*.* v7.*.* On demand
v6.*.* v6.*.* ❌
v5.*.* v5.*.* ❌

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-ivs-player
npx cap sync

API

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

This plugin was created originally for Kick.com by Capgo

About

Capacitor plugin Native Ivs player Android and IOS.

capgo.app/docs/plugins/ivs-player/

Topics

capacitor capacitor-plugin

Resources

Readme

License

MPL-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

8 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 29

8.0.18 Latest
May 11, 2026
+ 28 releases

Sponsor this project

 
Learn more about GitHub Sponsors

Contributors

Languages