Aller au contenu

Prise en main

GitHub

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

Fenêtre de terminal
bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

Fenêtre de terminal
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);
import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);
import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);
  • Sync native : exécuter bunx cap sync après les mises à jour du plugin.
  • Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Initialiser un lecteur vidéo

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.initPlayer({ mode: 'fullscreen' });
console.log(result);

Retourne si un playerId donné est en lecture

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);

Lire la vidéo en cours à partir d'un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);

Mettre en pause la vidéo actuelle à partir d'un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.pause({ playerId: 'player-id-123' });
console.log(result);

Récupérer la durée de la vidéo en cours à partir d'un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.getDuration({ playerId: 'player-id-123' });
console.log(result);

Récupérer le temps actuel de la vidéo en cours à partir d'un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.getCurrentTime({ playerId: 'player-id-123' });
console.log(result);

Définit le temps de lecture pour seek la vidéo via un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.setCurrentTime({
playerId: 'player-id-123',
seektime: 10,
});
console.log(result);

Récupère le volume de la vidéo actuelle via un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.getVolume({ playerId: 'player-id-123' });
console.log(result);

Définit le volume de la vidéo actuelle via un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.setVolume({ volume: 0.5 });
console.log(result);

Récupère l'état muet de la vidéo actuelle via un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.getMuted({ playerId: 'player-id-123' });
console.log(result);

Définir l'état muet de la vidéo en cours pour un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.setMuted({ muted: true });
console.log(result);

Définir la vitesse de lecture de la vidéo en cours pour un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.setRate({ rate: 1 });
console.log(result);

Récupérer la vitesse de lecture de la vidéo en cours pour un playerId donné

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.getRate({ playerId: 'player-id-123' });
console.log(result);

Arrêter la lecture de tous les lecteurs

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.stopAllPlayers();
console.log(result);

Afficher le contrôleur

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.showController();
console.log(result);

isControllerIsFullyVisible

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.isControllerIsFullyVisible();
console.log(result);

Quitter le lecteur

import { VideoPlayer } from '@capgo/capacitor-video-player';
const result = await VideoPlayer.exitPlayer();
console.log(result);
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;
}
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;
}
export interface capVideoPlayerIdOptions {
/**
* Id of DIV Element parent of the player
*/
playerId?: string;
}
export interface capVideoTimeOptions {
/**
* Id of DIV Element parent of the player
*/
playerId?: string;
/**
* Video time value you want to seek to
*/
seektime?: number;
}
export interface capVideoVolumeOptions {
/**
* Id of DIV Element parent of the player
*/
playerId?: string;
/**
* Volume value between [0 - 1]
*/
volume?: number;
}
export interface capVideoMutedOptions {
/**
* Id of DIV Element parent of the player
*/
playerId?: string;
/**
* Muted value true or false
*/
muted?: boolean;
}
export interface capVideoRateOptions {
/**
* Id of DIV Element parent of the player
*/
playerId?: string;
/**
* Rate value
*/
rate?: number;
}
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 }>;
}
export interface DrmOptions {
/**
* FairPlay DRM configuration (iOS)
*/
fairplay?: FairPlayDrmOptions;
/**
* PlayReady DRM configuration
*/
playready?: PlayreadyDrmOptions;
/**
* Widevine DRM configuration (Android)
*/
widevine?: WidevineDrmOptions;
}
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;
}
export interface PlayreadyDrmOptions {
/**
* The URL to fetch the PlayReady license
*/
certificateUrl?: string;
}
export interface WidevineDrmOptions {
/**
* The URL to fetch the Widevine license
*/
certificateUrl?: string;
}

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Si vous utilisez Prise en main pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans la section Utiliser @capgo/capacitor-video-player, Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities @capgo/capacitor-video-player pour les détails d'implémentation dans @capgo/capacitor-video-player, et Utilisation de @capgo/capacitor-native-navigation pour la fonctionnalité native dans Using @capgo/capacitor-native-navigation.