Iniziare

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo abilità al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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

Importa

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

Panoramica di API

initPlayer

Inizializza un player video

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

await VideoPlayer.initPlayer({} as capVideoPlayerOptions);

isPlaying

Restituisci se un playerId specificato sta giocando

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

await VideoPlayer.isPlaying({} as capVideoPlayerIdOptions);

play

Gioca il video corrente da un playerId specificato

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

await VideoPlayer.play({} as capVideoPlayerIdOptions);

pause

Pausa il video corrente da un playerId specificato

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

await VideoPlayer.pause({} as capVideoPlayerIdOptions);

getDuration

Otterra il durata del video corrente da un playerId specificato

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

await VideoPlayer.getDuration({} as capVideoPlayerIdOptions);

getCurrentTime

Ottieni l'ora corrente del video corrente da un playerId specifico

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

await VideoPlayer.getCurrentTime({} as capVideoPlayerIdOptions);

setCurrentTime

Imposta l'ora corrente per cercare il video corrente da un playerId specifico

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

await VideoPlayer.setCurrentTime({} as capVideoTimeOptions);

getVolume

Ottieni il volume del video corrente da un playerId specifico

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

await VideoPlayer.getVolume({} as capVideoPlayerIdOptions);

setVolume

Imposta il volume del video corrente da un playerId specifico

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

await VideoPlayer.setVolume({} as capVideoVolumeOptions);

getMuted

Ottieni il silenzio attuale del video da un playerId specifico

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

await VideoPlayer.getMuted({} as capVideoPlayerIdOptions);

setMuted

Imposta il silenzio attuale del video a un playerId specifico

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

await VideoPlayer.setMuted({} as capVideoMutedOptions);

setRate

Imposta il tasso di riproduzione del video attuale da un playerId specifico

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

await VideoPlayer.setRate({} as capVideoRateOptions);

getRate

Ottieni il tasso di riproduzione del video attuale da un playerId specifico

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

await VideoPlayer.getRate({} as capVideoPlayerIdOptions);

stopAllPlayers

Fermare tutti i giocatori in corso

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

await VideoPlayer.stopAllPlayers();

showController

Mostra il controller

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

await VideoPlayer.showController();

isControllerIsFullyVisible

isControllerIsFullyVisible

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

await VideoPlayer.isControllerIsFullyVisible();

exitPlayer

Esci dal gioco

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

await VideoPlayer.exitPlayer();

Riferimento ai tipi

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;
}

Fonte di Verità

Questa pagina è generata dal plugin src/definitions.tsRiepiloga quando le modifiche pubbliche API sono state apportate in fase di sviluppo.

Continua da Inizia con l'installazione

Se stai utilizzando Inizia con l'installazione per pianificare il comportamento dei media nativi e dell'interfaccia, collegalo con Utilizza @capgo/capacitor-video-player per la capacità nativa in Utilizzare @capgo/capacitor-player-video, Utilizzare @capgo/capacitor-attività-viva, per la capacità nativa in Utilizzare @capgo/capacitor-attività-viva, @capgo/capacitor-attività-viva per il dettaglio di implementazione in @capgo/capacitor-attività-viva, @capgo/capacitor-player-video per il dettaglio di implementazione in @capgo/capacitor-player-video, e Utilizzare @capgo/capacitor-navigazione-nativa per la capacità nativa in Utilizzare @capgo/capacitor-navigazione-nativa.