はじめに

このプラグインのインストール手順と完全な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アシストセットアップを使ってプラグインをインストールできます。以下のコマンドで、お使いのAIツールに Capgo スキルを追加してください：

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

次に、以下のプロンプトを使用します：

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 を再実行してください。

Getting Started から続ける

以下を使用している場合： はじめに ネイティブのメディアとインターフェースの挙動を計画するには、これを次と連携させてください： @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. の使い方におけるネイティブ機能について