Getting Started
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 지시를 복사하세요.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-youtube-player`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/youtube-player/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
bun add @capgo/capacitor-youtube-playerbunx cap syncimport
설정 제목 “import”import { YoutubePlayer } from '@capgo/capacitor-youtube-player';API 개요
설정 제목 “API 개요”initialize
설정 제목 “초기화”새 YouTube 플레이어 인스턴스를 초기화합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.initialize({ playerId: 'my-player', videoId: 'dQw4w9WgXcQ', playerSize: { width: 640, height: 360 }, privacyEnhanced: true});destroy
'destroy'라는 제목의 섹션플레이어 인스턴스를 삭제하고 자원들을 해제합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.destroy({} as PlayerIdOptions);stopVideo
'stopVideo'라는 제목의 섹션비디오 재생을 중단하고 로딩을 취소합니다. 이 메서드를 사용하는 것을 피하십시오 - pauseVideo()를 사용하는 것이 일반적입니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.stopVideo({} as PlayerIdOptions);playVideo
'playVideo'라는 제목의 섹션현재 큐된 또는 로드된 비디오를 재생합니다. 플레이어의 최종 상태는 PLAYING (1)입니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.playVideo({} as PlayerIdOptions);pauseVideo
'pauseVideo'라는 제목의 섹션현재 재생 중인 비디오를 중단합니다. 플레이어의 최종 상태는 PAUSED (2)입니다. 이미 ENDED (0) 상태라면 예외적으로 PAUSED 상태가 유지됩니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.pauseVideo({} as PlayerIdOptions);seekTo
“seekTo” 제목의 섹션비디오의 특정 시간으로 이동합니다. 플레이어가 일시 정지 상태일 경우 일시 정지 상태가 유지되고, 재생 중일 경우 계속 재생합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.seekTo({} as SeekToOptions);loadVideoById
“loadVideoById” 제목의 섹션YouTube ID로 비디오를 로드하고 재생합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.loadVideoById({} as VideoByIdMethodOptions);cueVideoById
“cueVideoById” 제목의 섹션ID로 비디오를 큐합니다. thumbnail을 로드하고 플레이어를 준비하지만, playVideo()가 호출될 때까지 비디오를 요청하지 않습니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.cueVideoById({} as VideoByIdMethodOptions);loadVideoByUrl
“loadVideoByUrl” 제목의 섹션비디오의 전체 URL로 비디오를 로드하고 재생합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.loadVideoByUrl({} as VideoByUrlMethodOptions);cueVideoByUrl
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.cueVideoByUrl({} as VideoByUrlMethodOptions);cuePlaylist
__CAPGO_KEEP_1____CAPGO_KEEP_3__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.cuePlaylist({} as PlaylistMethodOptions);loadPlaylist
__CAPGO_KEEP_1____CAPGO_KEEP_4__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.loadPlaylist({} as PlaylistMethodOptions);nextVideo
__CAPGO_KEEP_1____CAPGO_KEEP_5__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.nextVideo({} as PlayerIdOptions);previousVideo
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.previousVideo({} as PlayerIdOptions);playVideoAt
__CAPGO_KEEP_1____CAPGO_KEEP_3__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.playVideoAt({} as PlayVideoAtOptions);mute
__CAPGO_KEEP_1____CAPGO_KEEP_4__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.mute({} as PlayerIdOptions);unMute
__CAPGO_KEEP_1____CAPGO_KEEP_5__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.unMute({} as PlayerIdOptions);isMuted
음소거 여부 확인현재 음소거 상태인 플레이어를 확인합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.isMuted({} as PlayerIdOptions);setVolume
볼륨 설정플레이어 볼륨을 설정합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setVolume({} as SetVolumeOptions);getVolume
현재 볼륨 가져오기플레이어의 현재 볼륨을 가져옵니다. (음소거 상태여도 볼륨을 반환합니다.)
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getVolume({} as PlayerIdOptions);setSize
크기 설정플레이어의 크기를 픽셀 단위로 설정합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setSize({} as SetSizeOptions);getPlaybackRate
getPlaybackRate 제목현재 재생 속도 가져오기.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getPlaybackRate({} as PlayerIdOptions);setPlaybackRate
setPlaybackRate 제목재생 속도 설정.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setPlaybackRate({} as SetPlaybackRateOptions);getAvailablePlaybackRates
getAvailablePlaybackRates 제목현재 비디오의 사용 가능한 재생 속도 목록 가져오기.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getAvailablePlaybackRates({} as PlayerIdOptions);setLoop
setLoop 제목재생 목록 반복 설정. 반복이 활성화되면 마지막 비디오 후에 재생 목록은 처음부터 다시 시작합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setLoop({} as SetLoopOptions);setShuffle
셰플 설정재생 목록 셰플을 활성화하거나 비활성화합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setShuffle({} as SetShuffleOptions);getVideoLoadedFraction
비디오 로드된 비율 가져오기비디오가 버퍼링된 비율을 가져옵니다. 더욱 신뢰할 수 있는 getVideoBytesLoaded/getVideoBytesTotal의 대체입니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getVideoLoadedFraction({} as PlayerIdOptions);getPlayerState
플레이어 상태 가져오기현재 플레이어 상태를 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getPlayerState({} as PlayerIdOptions);getAllPlayersEventsState
모든 플레이어 이벤트 상태 가져오기활성화된 모든 플레이어의 이벤트 상태를 가져옵니다. 여러 플레이어 인스턴스를 추적하는 데 유용합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getAllPlayersEventsState();getCurrentTime
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getCurrentTime({} as PlayerIdOptions);toggleFullScreen
__CAPGO_KEEP_1____CAPGO_KEEP_3__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.toggleFullScreen({} as ToggleFullScreenOptions);getPlaybackQuality
__CAPGO_KEEP_1____CAPGO_KEEP_4__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getPlaybackQuality({} as PlayerIdOptions);setPlaybackQuality
__CAPGO_KEEP_1____CAPGO_KEEP_5__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.setPlaybackQuality({} as SetPlaybackQualityOptions);getAvailableQualityLevels
getAvailableQualityLevels 제목현재 비디오의 사용 가능한 품질 수준 목록을 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getAvailableQualityLevels({} as PlayerIdOptions);getDuration
getDuration 제목현재 비디오의 길이를 초 단위로 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getDuration({} as PlayerIdOptions);getVideoUrl
getVideoUrl 제목현재 비디오의 YouTube.com URL을 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getVideoUrl({} as PlayerIdOptions);getVideoEmbedCode
getVideoEmbedCode 제목현재 비디오의 임베드 code를 가져옵니다. HTML iframe 임베드 code를 반환합니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getVideoEmbedCode({} as PlayerIdOptions);getPlaylist
__CAPGO_KEEP_1__ (getPlaylist)현재 플레이리스트의 비디오 ID 목록을 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getPlaylist({} as PlayerIdOptions);getPlaylistIndex
__CAPGO_KEEP_1__ (getPlaylistIndex)현재 재생 중인 비디오의 인덱스를 가져옵니다.
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getPlaylistIndex({} as PlayerIdOptions);getIframe
__CAPGO_KEEP_1__ (getIframe)플레이어의 iframe DOM 요소를 가져옵니다. (웹 플랫폼 전용)
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.getIframe({} as PlayerIdOptions);addEventListener
__CAPGO_KEEP_1__ (addEventListener)이벤트 리스너를 플레이어에 추가합니다. (웹 플랫폼 전용)
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
YoutubePlayer.addEventListener({ playerId: 'my-player', eventName: 'onStateChange', listener: (event) => { console.log('Player state:', event.data); },});removeEventListener
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';
await YoutubePlayer.removeEventListener({} as PlayerEventListenerOptions<TEvent>);__CAPGO_KEEP_3__
__CAPGO_KEEP_1__PlayerIdOptions
__CAPGO_KEEP_4__export interface PlayerIdOptions { playerId: string;}SeekToOptions
__CAPGO_KEEP_5__export interface SeekToOptions extends PlayerIdOptions { playerId: string; seconds: number; allowSeekAhead: boolean;}VideoByIdMethodOptions
__CAPGO_KEEP_6__export interface VideoByIdMethodOptions extends PlayerIdOptions { playerId: string; options: IVideoOptionsById;}VideoByUrlMethodOptions
비디오 URL 메소드 옵션export interface VideoByUrlMethodOptions extends PlayerIdOptions { playerId: string; options: IVideoOptionsByUrl;}PlaylistMethodOptions
플레이리스트 메소드 옵션export interface PlaylistMethodOptions extends PlayerIdOptions { playerId: string; playlistOptions: IPlaylistOptions;}PlayVideoAtOptions
비디오 재생 옵션export interface PlayVideoAtOptions extends PlayerIdOptions { playerId: string; index: number;}SetVolumeOptions
볼륨 설정 옵션export interface SetVolumeOptions extends PlayerIdOptions { playerId: string; volume: number;}SetSizeOptions
크기 설정 옵션export interface SetSizeOptions extends PlayerIdOptions { playerId: string; width: number; height: number;}SetPlaybackRateOptions
재생 속도 설정 옵션export interface SetPlaybackRateOptions extends PlayerIdOptions { playerId: string; suggestedRate: number;}SetLoopOptions
루프 옵션 설정export interface SetLoopOptions extends PlayerIdOptions { playerId: string; loopPlaylists: boolean;}SetShuffleOptions
셔플 옵션 설정export interface SetShuffleOptions extends PlayerIdOptions { playerId: string; shufflePlaylist: boolean;}ToggleFullScreenOptions
전체 화면 토글 옵션export interface ToggleFullScreenOptions extends PlayerIdOptions { playerId: string; isFullScreen: boolean | null | undefined;}진실의 근원
진실의 근원이 페이지는 플러그인의 src/definitions.ts업스트림에서 pubic API이 변경되었을 때 다시 싱크를 실행하세요.
시작부터 계속
시작부터 계속만약에 사용 중이라면 Getting Started API 대시보드와 API 연산을 계획하고 싶다면 capgo/capacitor-youtube-player를 사용하는 방법 native 기능을 사용하는 capgo/capacitor-youtube-player API 개요 API 구현 세부 사항 소개 __CAPGO_KEEP_0__ 구현 세부 사항 API 키 API 구현 세부 사항 장치 __CAPGO_KEEP_0__ 구현 세부 사항.