Anleitung

Installieren

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

Importieren

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

API Übersicht

initPlayer

Ein Video-Player initialisieren

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

await VideoPlayer.initPlayer({} as capVideoPlayerOptions);

isPlaying

Wenn ein Spieler mit der Spielernummer __CAPGO_KEEP_0__ spielt

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

await VideoPlayer.isPlaying({} as capVideoPlayerIdOptions);

play

Mit der Spielernummer __CAPGO_KEEP_0__ das aktuelle Video abspielen

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

await VideoPlayer.play({} as capVideoPlayerIdOptions);

pause

Mit der Spielernummer __CAPGO_KEEP_0__ das aktuelle Video pausieren

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

await VideoPlayer.pause({} as capVideoPlayerIdOptions);

getDuration

Mit der Spielernummer __CAPGO_KEEP_0__ die Länge des aktuellen Videos abrufen

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

await VideoPlayer.getDuration({} as capVideoPlayerIdOptions);

getCurrentTime

Holst du den aktuellen Zeitpunkt des aktuellen Videos von einem gegebenen SpielerId

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

await VideoPlayer.getCurrentTime({} as capVideoPlayerIdOptions);

setCurrentTime

Setze den aktuellen Zeitpunkt, um das aktuelle Video zu suchen, von einem gegebenen SpielerId

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

await VideoPlayer.setCurrentTime({} as capVideoTimeOptions);

getVolume

Holst du den Lautstärke des aktuellen Videos von einem gegebenen SpielerId

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

await VideoPlayer.getVolume({} as capVideoPlayerIdOptions);

setVolume

Setze die Lautstärke des aktuellen Videos zu von einem gegebenen SpielerId

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

await VideoPlayer.setVolume({} as capVideoVolumeOptions);

getMuted

Hol das Mute des aktuellen Videos von einem gegebenen SpielerId

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

await VideoPlayer.getMuted({} as capVideoPlayerIdOptions);

setMuted

Setze das Mute des aktuellen Videos auf von einem gegebenen SpielerId

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

await VideoPlayer.setMuted({} as capVideoMutedOptions);

setRate

Setze die Geschwindigkeit des aktuellen Videos von einem gegebenen SpielerId

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

await VideoPlayer.setRate({} as capVideoRateOptions);

getRate

Hol die Geschwindigkeit des aktuellen Videos von einem gegebenen SpielerId

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

await VideoPlayer.getRate({} as capVideoPlayerIdOptions);

stopAllPlayers

Alle Spieler stoppen

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

await VideoPlayer.stopAllPlayers();

showController

Controller anzeigen

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

await VideoPlayer.showController();

isControllerIsFullyVisible

isControllerIsFullyVisible

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

await VideoPlayer.isControllerIsFullyVisible();

exitPlayer

Spieler beenden

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

await VideoPlayer.exitPlayer();

Typenverweis

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit Getting Started um native Medien und Schnittstellenverhalten zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-video-player für die native Fähigkeit in Verwenden Sie @capgo/capacitor-video-player Mit @capgo/capacitor-live-aktivitäten für die native Fähigkeit in Mit @capgo/capacitor-live-aktivitäten, @capgo/capacitor-live-aktivitäten für die Implementierungsdetails in @capgo/capacitor-live-aktivitäten, @capgo/capacitor-video-player für die Implementierungsdetails in @capgo/capacitor-video-player, und Mit @capgo/capacitor-native-navigations für die native Fähigkeit in Mit @capgo/capacitor-native-navigations.