快速入门

复制一条配置 prompt，包含安装步骤和该插件的完整 Markdown 指南。

        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.

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-video-player` plugin in my project.

如果你更倾向于手动设置，请运行以下命令安装插件，并参考下文针对各平台的具体说明：

bun add @capgo/capacitor-video-player
bunx cap sync

导入

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

快速入门

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

const result = await VideoPlayer.initPlayer({ mode: 'fullscreen' });
console.log(result);

示例：isPlaying

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

const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);

示例：play

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

const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);

常见坑点

原生同步: 运行 bunx cap sync 在插件升级后。
单一事实来源: 信任 src/definitions.ts 在 GitHub 仓库中。

API 概览

`initPlayer`

初始化视频播放器

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

const result = await VideoPlayer.initPlayer({ mode: 'fullscreen' });
console.log(result);

`isPlaying`

返回指定 playerId 是否正在播放

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

const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);

`play`

从指定 playerId 播放当前视频

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

const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);

`pause`

通过指定的 playerId 暂停当前视频

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

const result = await VideoPlayer.pause({ playerId: 'player-id-123' });
console.log(result);

`getDuration`

通过指定的 playerId 获取当前视频的时长

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

const result = await VideoPlayer.getDuration({ playerId: 'player-id-123' });
console.log(result);

`getCurrentTime`

获取指定 playerId 当前视频的当前播放时间

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

const result = await VideoPlayer.getCurrentTime({ playerId: 'player-id-123' });
console.log(result);

`setCurrentTime`

通过指定的 playerId 设置当前视频的播放进度

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

const result = await VideoPlayer.setCurrentTime({
  playerId: 'player-id-123',
  seektime: 10,
});
console.log(result);

`getVolume`

通过指定的 playerId 获取当前视频的音量

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

const result = await VideoPlayer.getVolume({ playerId: 'player-id-123' });
console.log(result);

`setVolume`

通过指定的 playerId 设置当前视频的音量

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

const result = await VideoPlayer.setVolume({ volume: 0.5 });
console.log(result);

`getMuted`

通过指定的 playerId 获取当前视频是否静音

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

const result = await VideoPlayer.getMuted({ playerId: 'player-id-123' });
console.log(result);

`setMuted`

根据指定的 playerId 设置当前视频的静音状态

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

const result = await VideoPlayer.setMuted({ muted: true });
console.log(result);

`setRate`

根据指定的 playerId 设置当前视频的播放速率

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

const result = await VideoPlayer.setRate({ rate: 1 });
console.log(result);

`getRate`

根据指定的 playerId 获取当前视频的播放速率

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

const result = await VideoPlayer.getRate({ playerId: 'player-id-123' });
console.log(result);

`stopAllPlayers`

停止所有正在播放的播放器

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

const result = await VideoPlayer.stopAllPlayers();
console.log(result);

`showController`

显示控制器

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

const result = await VideoPlayer.showController();
console.log(result);

`isControllerIsFullyVisible`

isControllerIsFullyVisible

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

const result = await VideoPlayer.isControllerIsFullyVisible();
console.log(result);

`exitPlayer`

退出播放器

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

const result = await VideoPlayer.exitPlayer();
console.log(result);

类型参考

`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 发生变化时，请重新运行 sync。

继续阅读入门指南

如果你正在使用 快速入门 来规划原生媒体和界面行为，并将其与使用 @capgo/capacitor-video-player 关于“使用 @capgo/capacitor-video-player”中的原生能力，使用 @capgo/capacitor-live-activities 有关“使用 @capgo/capacitor-live-activities”中的原生能力， @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 的实现细节， @capgo/capacitor-video-player 关于 @capgo/capacitor-video-player 的实现细节，以及使用 @capgo/capacitor-native-navigation 关于“使用 @capgo/capacitor-native-navigation.”中的原生能力