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
歌う @capgo/ivs-player
インストール
@capgo/ivs-player パッケージをインストールするには、以下のコマンドを実行する必要があります：
[[コードブロック]]
API
@capgo/ivs-player パッケージは以下の 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
このメソッドは IVS プレーヤーのインスタンスを作成します。URL、ピクチャーインピクチャーモードの有無、ビデオのタイトルと字幕などのさまざまなプロパティを含むオプションオブジェクトをパラメーターとして取ります。作成されたインスタンスに解決する Promise を返します。
start() => Promise
このメソッドは IVS プレーヤーでビデオの再生を開始します。Promise を返します。
cast() => Promise
このメソッドはビデオを接続されたデバイスにキャストします。Promise を返します。
getCastStatus() => Promise
このメソッドはキャスティング機能の状態を取得します。キャスティングがアクティブかどうかを示す isActive プロパティを含むオブジェクトに解決する Promise を返します。
pause() => Promise
このメソッドはビデオの再生を一時停止します。Promise を返します。
delete() => Promise
このメソッドは IVS プレーヤーのインスタンスを削除します。Promise を返します。
getUrl() => Promise
このメソッドは現在再生中のビデオの URL を取得します。Promise を返します。
getState() => Promise
このメソッドは IVS プレーヤーの現在の状態を取得します。Promise を返します。
setPlayerPosition() => Promise
このメソッドは画面上の IVS プレーヤーの位置を設定します。x および y 座標をパラメーターとして取り、Promise を返します。
getPlayerPosition() => Promise
このメソッドは画面上の IVS プレーヤーの現在の位置を取得します。Promise を返します。
setAutoQuality() => Promise
このメソッドは IVS プレーヤーの自動品質モードを設定します。ブール値をパラメーターとして取り、Promise を返します。
getAutoQuality() => Promise
このメソッドは IVS プレーヤーの現在の自動品質モードを取得します。Promise を返します。
setPip() => Promise
このメソッドは IVS プレーヤーのピクチャーインピクチャーモードを設定します。ブール値をパラメーターとして取り、Promise を返します。
getPip() => Promise
このメソッドは IVS プレーヤーの現在のピクチャーインピクチャーモードを取得します。Promise を返します。
setFrame() => Promise
このメソッドは IVS プレーヤーのフレームを設定します。数値をパラメーターとして取り、Promise を返します。
getFrame() => Promise
このメソッドは IVS プレーヤーの現在のフレームを取得します。Promise を返します。
setMute() => Promise
このメソッドは IVS プレーヤーのミュートモードを設定します。ブール値をパラメーターとして取り、Promise を返します。
getMute() => Promise
このメソッドは IVS プレーヤーの現在のミュートモードを取得します。Promise を返します。
setQuality() => Promise
このメソッドは IVS プレーヤーのビデオの品質を設定します。文字列をパラメーターとして取り、Promise を返します。
getQuality() => Promise
このメソッドは IVS プレーヤーのビデオの現在の品質を取得します。Promise を返します。
getQualities() => Promise
このメソッドは IVS プレーヤーのビデオの利用可能な品質を取得します。Promise を返します。
addListener('expandPip', ) => void
このメソッドは expandPip イベントのリスナーを追加します。コールバック関数をパラメーターとして取り、void を返します。
addListener('closePip', ) => void
このメソッドは closePip イベントのリスナーを追加します。コールバック関数をパラメーターとして取り、void を返します。
addListener('onState', ) => void
このメソッドは onState イベントのリスナーを追加します。コールバック関数をパラメーターとして取り、void を返します。
addListener('onCues', ) => void
このメソッドは onCues イベントのリスナーを追加します。コールバック関数をパラメーターとして取り、void を返します。
addListener('onDuration', ) => void
このメソッドは onDuration イベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onError', ) => void
このメソッドはonErrorイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onRebuffering', ) => void
このメソッドはonRebufferingイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onSeekCompleted', ) => void
このメソッドはonSeekCompletedイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onVideoSize', ) => void
このメソッドはonVideoSizeイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onQuality', ) => void
このメソッドはonQualityイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
addListener('onCastStatus', ) => void
このメソッドはonCastStatusイベントのリスナーを追加します。コールバック関数をパラメータとして受け取り、voidを返します
removeAllListeners() => void
このメソッドは追加されたすべてのイベントリスナーを削除します。voidを返します
結論
@capgo/ivs-playerパッケージは、IVSプレーヤーをCapacitorアプリに統合するための包括的なAPIを提供します。インストール手順に従い、APIドキュメントを参照することで、IVSプレーヤーを使用してアプリで簡単に動画を再生できます。