@capgo/capacitor-ivs-player

Overview

Ivs player for capacitor app.

Core Capabilities

• create
• start
• cast
• getCastStatus

Public API

Method	Description
create	See the source definitions for current behavior.
start	See the source definitions for current behavior.
cast	See the source definitions for current behavior.
getCastStatus	See the source definitions for current behavior.
pause	See the source definitions for current behavior.
delete	See the source definitions for current behavior.
getUrl	See the source definitions for current behavior.
getState	See the source definitions for current behavior.
setPlayerPosition	See the source definitions for current behavior.
getPlayerPosition	See the source definitions for current behavior.
setAutoQuality	See the source definitions for current behavior.
getAutoQuality	See the source definitions for current behavior.
setPip	See the source definitions for current behavior.
getPip	See the source definitions for current behavior.
setFrame	Set the frame of the player view, all number have to be positive and integers.
getFrame	See the source definitions for current behavior.
setBackgroundState	See the source definitions for current behavior.
getBackgroundState	See the source definitions for current behavior.
setMute	See the source definitions for current behavior.
getMute	See the source definitions for current behavior.
setQuality	See the source definitions for current behavior.
getQuality	See the source definitions for current behavior.
getQualities	See the source definitions for current behavior.
getPluginVersion	Get the native Capacitor plugin version.
addListener	Listen for start pip.
addListener	Listen for stop pip.
addListener	Listen for expend pip.
addListener	Listen for close pip.
addListener	Listen for state changes.
addListener	Listen for cue changes.
addListener	Listen for duration changes.
addListener	Listen for errors.
addListener	Listen for rebuffering.
addListener	Listen for position changes.
addListener	Listen for video size changes.
addListener	Listen for quality changes.
addListener	Listen for cast status changes.
removeAllListeners	Remove all listeners for this plugin.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-ivs-player.