@capgo/capacitor-ivs-player

Play Amazon IVS live streams in your Capacitor app with the native IVS player on iOS and Android, including picture in picture and playback events.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-ivs-player in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-ivs-player to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Player: create() with a stream URL, then start(), pause() and delete().
• Layout: setFrame() and setPlayerPosition() place the native player in front of or behind your web UI.
• Picture in picture: setPip() with startPip, stopPip and closePip events.
• Quality: setAutoQuality() and quality change events.
• Playback events: state, duration, cues, rebuffering, seek and error listeners.
• Platforms: iOS and Android. Uses the Amazon IVS player SDKs. Not available on web.

Documentation

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

Compatibility

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

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-ivs-player` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-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>

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>

getPlayerPosition()

getPlayerPosition() => Promise<{ toBack: boolean; }>

Returns: Promise<{ toBack: boolean; }>

setAutoQuality(...)

setAutoQuality(options?: { autoQuality?: boolean | undefined; } | undefined) => Promise<void>

getAutoQuality()

getAutoQuality() => Promise<{ autoQuality: boolean; }>

Returns: Promise<{ autoQuality: boolean; }>

setPip(...)

setPip(options?: { pip?: boolean | undefined; } | undefined) => Promise<void>

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

Since: 1.0.0

getFrame()

getFrame() => Promise<CapacitorFrame>

Returns: Promise<CapacitorFrame>

setBackgroundState(...)

setBackgroundState(options: { backgroundState: CapacitorIvsPlayerBackgroundState; }) => Promise<void>

getBackgroundState()

getBackgroundState() => Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>

Returns: Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>

setMute(...)

setMute(options?: { muted?: boolean | undefined; } | undefined) => Promise<void>

getMute()

getMute() => Promise<{ mute: boolean; }>

Returns: Promise<{ mute: boolean; }>

setQuality(...)

setQuality(options?: { quality: string; } | undefined) => Promise<void>

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

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('stopPip', ...)

addListener(eventName: 'stopPip', listenerFunc: () => void) => Promise<PluginListenerHandle>

Listen for stop pip

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('expandPip', ...)

addListener(eventName: 'expandPip', listenerFunc: () => void) => Promise<PluginListenerHandle>

Listen for expend pip

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('closePip', ...)

addListener(eventName: 'closePip', listenerFunc: () => void) => Promise<PluginListenerHandle>

Listen for close pip

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onState', ...)

addListener(eventName: 'onState', listenerFunc: (data: { state: CapacitorIvsPlayerState; }) => void) => Promise<PluginListenerHandle>

Listen for state changes

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onCues', ...)

addListener(eventName: 'onCues', listenerFunc: (data: { cues: string; }) => void) => Promise<PluginListenerHandle>

Listen for cue changes

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onDuration', ...)

addListener(eventName: 'onDuration', listenerFunc: (data: { duration: number; }) => void) => Promise<PluginListenerHandle>

Listen for duration changes

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onError', ...)

addListener(eventName: 'onError', listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle>

Listen for errors

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onRebuffering', ...)

addListener(eventName: 'onRebuffering', listenerFunc: () => void) => Promise<PluginListenerHandle>

Listen for rebuffering

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onSeekCompleted', ...)

addListener(eventName: 'onSeekCompleted', listenerFunc: (data: { position: number; }) => void) => Promise<PluginListenerHandle>

Listen for position changes

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

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onQuality', ...)

addListener(eventName: 'onQuality', listenerFunc: (data: { quality: string; }) => void) => Promise<PluginListenerHandle>

Listen for quality changes

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('onCastStatus', ...)

addListener(eventName: 'onCastStatus', listenerFunc: (data: { isActive: boolean; }) => void) => Promise<PluginListenerHandle>

Listen for cast status changes

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0

Interfaces

CapacitorFrame

PluginListenerHandle

Type Aliases

CapacitorIvsPlayerState

'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN'

CapacitorIvsPlayerBackgroundState

'PAUSED' | 'PLAYING'

Credits

This plugin was created originally for Kick.com by Capgo