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 패키지를 설치하려면 다음 명령을 실행해야 합니다:
npm install @capgo/ivs-player
npx cap sync
API
@capgo/ivs-player 패키지는 다음 API를 제공합니다:
create(옵션: { url: 문자열; pip?: 부울; 제목?: 문자열; 자막?: 문자열; 표지?: 문자열; autoPlay?: 부울; toBack?: 부울; x?: 숫자; y?: 숫자; 너비?: 숫자; 높이?: 숫자 }) => 약속;
이 메소드는 IVS 플레이어의 인스턴스를 생성합니다. 옵션 객체를 매개변수로 사용하며, 여기에는 비디오 URL, PIP(Picture-in-Picture) 모드 활성화 여부, 비디오 제목 및 자막 등과 같은 다양한 속성이 포함됩니다. 생성된 인스턴스를 해결하는 Promise를 반환합니다.
start() => 약속
이 메소드는 IVS 플레이어에서 비디오 재생을 시작합니다. Promise를 반환합니다.
캐스트() => 약속
이 메서드는 비디오를 연결된 장치로 전송합니다. Promise를 반환합니다.
getCastStatus() => 약속<{ isActive: boolean; }>
이 메소드는 캐스팅 기능의 상태를 검색합니다. 캐스팅이 활성화되었는지 여부를 나타내는 isActive 속성을 포함하는 객체로 확인되는 Promise를 반환합니다.
Pause() => 약속
이 메서드는 비디오 재생을 일시 중지합니다. Promise를 반환합니다.
delete() => 약속
이 메소드는 IVS 플레이어 인스턴스를 삭제하고 Promise를 반환합니다.
getUrl() => 약속
이 메소드는 현재 재생 중인 비디오의 URL을 검색합니다. Promise를 반환합니다.
getState() => 약속
이 메소드는 IVS 플레이어의 현재 상태를 검색합니다. Promise를 반환합니다.
setPlayerPosition() => 약속
이 메소드는 화면에서 IVS 플레이어의 위치를 설정합니다. x 및 y 좌표를 매개변수로 사용하고 Promise를 반환합니다.
getPlayerPosition() => 약속
이 메소드는 화면에서 IVS 플레이어의 현재 위치를 검색합니다. Promise를 반환합니다.
setAutoQuality() => 약속
이 메소드는 IVS 플레이어의 자동 품질 모드를 설정합니다. 부울 값을 매개변수로 사용하고 Promise를 반환합니다.
getAutoQuality() => 약속
이 메소드는 IVS 플레이어의 현재 자동 품질 모드를 검색합니다. Promise를 반환합니다.
setPip() => 약속
이 메소드는 IVS 플레이어의 PIP 모드를 설정합니다. 부울 값을 매개변수로 사용하고 Promise를 반환합니다.
getPip() => 약속
이 메소드는 IVS 플레이어의 현재 PIP 모드를 검색합니다. Promise를 반환합니다.
setFrame() => 약속
이 메소드는 IVS 플레이어의 프레임을 설정합니다. 숫자 값을 매개변수로 사용하고 Promise를 반환합니다.
getFrame() => 약속
이 메소드는 IVS 플레이어의 현재 프레임을 검색합니다. Promise를 반환합니다.
setMute() => 약속
이 메소드는 IVS 플레이어의 음소거 모드를 설정합니다. 부울 값을 매개변수로 사용하고 Promise를 반환합니다.
getMute() => 약속
이 메소드는 IVS 플레이어의 현재 음소거 모드를 검색합니다. Promise를 반환합니다.
setQuality() => 약속
이 메소드는 IVS 플레이어에서 비디오 품질을 설정합니다. 문자열 값을 매개변수로 사용하고 Promise를 반환합니다.
getQuality() => 약속
이 메소드는 IVS 플레이어에서 비디오의 현재 품질을 검색합니다. Promise를 반환합니다.
getQualities() => 약속
이 메소드는 IVS 플레이어에서 사용 가능한 비디오 품질을 검색합니다. Promise를 반환합니다.
addListener('expandPip', ) => 무효
이 메소드는 ExpandPip 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('closePip', ) => 무효
이 메소드는 closePip 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onState', ) => 무효
이 메소드는 onState 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onCues', ) => 무효
이 메소드는 onCues 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onDuration', ) => 무효
이 메소드는 onDuration 이벤트에 대한 리스너를 추가합니다.콜백 함수를 매개변수로 취하고 void를 반환합니다.
addListener('onError', ) => 무효
이 메소드는 onError 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onRebuffering', ) => 무효
이 메소드는 onRebuffering 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onSeekCompleted', ) => 무효
이 메소드는 onSeekCompleted 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onVideoSize', ) => 무효
이 메소드는 onVideoSize 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onQuality', ) => 무효
이 메소드는 onQuality 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
addListener('onCastStatus', ) => 무효
이 메소드는 onCastStatus 이벤트에 대한 리스너를 추가합니다. 콜백 함수를 매개변수로 사용하고 void를 반환합니다.
제거AllListeners() => 무효
이 메소드는 추가된 모든 이벤트 리스너를 제거합니다. void를 반환합니다.
결론
@capgo/ivs-player 패키지는 IVS 플레이어를 Capacitor 앱에 통합하기 위한 포괄적인 API를 제공합니다. 설치 단계를 따르고 API 문서를 참조하면 IVS 플레이어를 사용하여 앱에서 비디오 재생을 쉽게 시작할 수 있습니다.