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-video-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/video-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-video-player
bunx cap sync

수입

import { VideoPlayer } from '@capgo/capacitor-video-player';

API 개요

`initPlayer`

비디오 플레이어 초기화

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.initPlayer({} as capVideoPlayerOptions);

`isPlaying`

지정된 playerId가 재생 중인지 확인

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.isPlaying({} as capVideoPlayerIdOptions);

`play`

지정된 playerId의 현재 비디오 재생

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.play({} as capVideoPlayerIdOptions);

`pause`

지정된 playerId의 현재 비디오 일시정지

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.pause({} as capVideoPlayerIdOptions);

`getDuration`

__CAPGO_KEEP_1__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.getDuration({} as capVideoPlayerIdOptions);

`getCurrentTime`

__CAPGO_KEEP_4__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.getCurrentTime({} as capVideoPlayerIdOptions);

`setCurrentTime`

__CAPGO_KEEP_7__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.setCurrentTime({} as capVideoTimeOptions);

`getVolume`

__CAPGO_KEEP_10__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.getVolume({} as capVideoPlayerIdOptions);

`setVolume`

__CAPGO_KEEP_1__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.setVolume({} as capVideoVolumeOptions);

`getMuted`

__CAPGO_KEEP_4__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.getMuted({} as capVideoPlayerIdOptions);

`setMuted`

__CAPGO_KEEP_7__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.setMuted({} as capVideoMutedOptions);

`setRate`

__CAPGO_KEEP_10__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.setRate({} as capVideoRateOptions);

`getRate`

__CAPGO_KEEP_1__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.getRate({} as capVideoPlayerIdOptions);

`stopAllPlayers`

__CAPGO_KEEP_3__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.stopAllPlayers();

`showController`

__CAPGO_KEEP_4__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.showController();

`isControllerIsFullyVisible`

__CAPGO_KEEP_5__

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.isControllerIsFullyVisible();

`exitPlayer`

exit player를 종료합니다.

import { VideoPlayer } from '@capgo/capacitor-video-player';

await VideoPlayer.exitPlayer();

타입 참조

`capVideoPlayerOptions`

export interface capVideoPlayerOptions {
  /**
   * Player mode
   *  - "fullscreen"
   *  - "embedded" (Web only)
   */
  mode?: string;
  /**
   * The url of the video to play
   */
  url?: string;
  /**
   * The url of subtitle associated with the video
   */
  subtitle?: string;
  /**
   * The language of subtitle
   * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers
   */
  language?: string;
  /**
   * SubTitle Options
   */
  subtitleOptions?: SubTitleOptions;
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
  /**
   * Initial playing rate
   */
  rate?: number;
  /**
   * Exit on VideoEnd (iOS, Android)
   * default: true
   */
  exitOnEnd?: boolean;
  /**
   * Loop on VideoEnd when exitOnEnd false (iOS, Android)
   * default: false
   */
  loopOnEnd?: boolean;
  /**
   * Picture in Picture Enable (iOS, Android)
   * default: true
   */
  pipEnabled?: boolean;
  /**
   * Background Mode Enable (iOS, Android)
   * default: true
   */
  bkmodeEnabled?: boolean;
  /**
   * Show Controls Enable (iOS, Android)
   * default: true
   */
  showControls?: boolean;
  /**
   * Display Mode ["all", "portrait", "landscape"] (iOS, Android)
   * default: "all"
   */
  displayMode?: string;
  /**
   * Component Tag or DOM Element Tag (React app)
   */
  componentTag?: string;
  /**
   * Player Width (mode "embedded" only)
   */
  width?: number;
  /**
   * Player height (mode "embedded" only)
   */
  height?: number;
  /**
   * Headers for the request (iOS, Android)
   * by Manuel García Marín (https://github.com/PhantomPainX)
   */
  headers?: {
    [key: string]: string;
  };
  /**
   * Title shown in the player (Android)
   * by Manuel García Marín (https://github.com/PhantomPainX)
   */
  title?: string;
  /**
   * Subtitle shown below the title in the player (Android)
   * by Manuel García Marín (https://github.com/PhantomPainX)
   */
  smallTitle?: string;
  /**
   * ExoPlayer Progress Bar and Spinner color (Android)
   * by Manuel García Marín (https://github.com/PhantomPainX)
   * Must be a valid hex color code
   * default: #FFFFFF
   */
  accentColor?: string;
  /**
   * Chromecast enable/disable (Android)
   * by Manuel García Marín (https://github.com/PhantomPainX)
   * default: true
   */
  chromecast?: boolean;
  /**
   * Artwork url to be shown in Chromecast player
   * by Manuel García Marín (https://github.com/PhantomPainX)
   * default: ""
   */
  artwork?: string;
  /**
   * DRM configuration for protected content (iOS: FairPlay, Android: Widevine)
   */
  drm?: DrmOptions;
}

`capVideoPlayerResult`

export interface capVideoPlayerResult {
  /**
   * result set to true when successful else false
   */
  result?: boolean;
  /**
   * method name
   */
  method?: string;
  /**
   * value returned
   */
  value?: any;
  /**
   * message string
   */
  message?: string;
}

`capVideoPlayerIdOptions`

export interface capVideoPlayerIdOptions {
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
}

`capVideoTimeOptions`

export interface capVideoTimeOptions {
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
  /**
   * Video time value you want to seek to
   */
  seektime?: number;
}

`capVideoVolumeOptions`

export interface capVideoVolumeOptions {
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
  /**
   * Volume value between [0 - 1]
   */
  volume?: number;
}

`capVideoMutedOptions`

export interface capVideoMutedOptions {
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
  /**
   * Muted value true or false
   */
  muted?: boolean;
}

`capVideoRateOptions`

export interface capVideoRateOptions {
  /**
   * Id of DIV Element parent of the player
   */
  playerId?: string;
  /**
   * Rate value
   */
  rate?: number;
}

`SubTitleOptions`

export interface SubTitleOptions {
  /**
   * Foreground Color in RGBA (default rgba(255,255,255,1)
   */
  foregroundColor?: string;
  /**
   * Background Color in RGBA (default rgba(0,0,0,1)
   */
  backgroundColor?: string;
  /**
   * Font Size in pixels (default 16)
   */
  fontSize?: number;

  /**
   * Get the native Capacitor plugin version
   *
   * @returns {Promise<{ id: string }>} an Promise with version for this device
   * @throws An error if the something went wrong
   */
  getPluginVersion(): Promise<{ version: string }>;
}

`DrmOptions`

export interface DrmOptions {
  /**
   * FairPlay DRM configuration (iOS)
   */
  fairplay?: FairPlayDrmOptions;
  /**
   * PlayReady DRM configuration
   */
  playready?: PlayreadyDrmOptions;
  /**
   * Widevine DRM configuration (Android)
   */
  widevine?: WidevineDrmOptions;
}

`FairPlayDrmOptions`

export interface FairPlayDrmOptions {
  /**
   * The URL to fetch the FairPlay certificate
   */
  certificateUrl?: string;
  /**
   * The URL to send the SPC and receive the CKC license (FairPlay license server URL)
   */
  contentKeySpcUrl?: string;
}

`PlayreadyDrmOptions`

export interface PlayreadyDrmOptions {
  /**
   * The URL to fetch the PlayReady license
   */
  certificateUrl?: string;
}

`WidevineDrmOptions`

export interface WidevineDrmOptions {
  /**
   * The URL to fetch the Widevine license
   */
  certificateUrl?: string;
}

실제 데이터의 원천

이 페이지는 플러그인의 src/definitions.ts API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

Cloudflare, Capacitor, GitHub, Capgo, API, SDK, CLI, npm, bun과 같은 보호된 토큰을 사용하는 경우 Getting Started native 미디어 및 인터페이스 동작을 계획하고 연결하기 위해 @capgo/capacitor-video-player를 사용합니다. @capgo/capacitor-video-player의 native 기능을 사용하기 위해 @capgo/capacitor-live-activities를 사용합니다. @capgo/capacitor-live-activities의 native 기능을 사용하기 위해 @capgo/capacitor-live-activities @capgo/capacitor-live-activities의 구현 세부 정보를 위해 @capgo/capacitor-video-player @capgo/capacitor-video-player의 구현 세부 정보를 위해, 그리고 @capgo/capacitor-native-navigation를 사용합니다. @capgo/capacitor-native-navigation의 native 기능을 사용하기 위해.