readme.md

Video Player

capacitor-video-player

CAPACITOR 6

Special note from Jean Pierre Quéau the original founder of this project.

Capacitor Video Player Plugin is a custom Native Capacitor plugin to play a video
fullscreen on IOS, Android, Web and Electron platforms
embedded on Web and Electron platforms

Maintainers

Maintainer	GitHub	Social	Active
Harmon Wood	harmonwood		✅
Quéau Jean Pierre	jepiqueau		❌

LATEST FOR CAPACITOR 6 (main)

Browser Support

The plugin follows the guidelines from the Capacitor Team,

• Capacitor Browser Support

meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with Babel.

Installation

npm install --save capacitor-video-player
npx cap sync
npx cap sync @capacitor-community/electron

Build

Then build YOUR_APPLICATION

npm run build
npx cap copy
npx cap copy web
npx cap copy @capacitor-community/electron
npx cap open android
npx cap open ios
npx cap open @capacitor-community/electron
npx cap serve

Configuration

No configuration required for this plugin

Supported methods

Name	Android	iOS	Electron	Web
initPlayer (mode fullscreen)	✅	✅	✅	✅
initPlayer (mode embedded)	❌	❌	✅	✅
initPlayer (url assets)	✅	✅	✅	✅
initPlayer (url internal)	✅	✅	❌	❌
initPlayer (url application/files)	✅	✅	❌	❌
initPlayer (subtitles)	✅	✅	❌	❌
initPlayer (headers)	✅	✅	❌	❌
initPlayer (title)	✅	✅	❌	❌
initPlayer (smallTitle)	✅	✅	❌	❌
initPlayer (accentColor)	✅	❌	❌	❌
initPlayer (chromecast)	✅	❌	❌	❌
initPlayer (artwork)	✅	✅	❌	❌
isPlaying	✅	✅	✅	✅
play	✅	✅	✅	✅
pause	✅	✅	✅	✅
getCurrentTime	✅	✅	✅	✅
setCurrentTime	✅	✅	✅	✅
getDuration	✅	✅	✅	✅
getMuted	✅	✅	✅	✅
setMuted	✅	✅	✅	✅
getVolume	✅	✅	✅	✅
setVolume	✅	✅	✅	✅
stopAllPlayers	✅	✅	✅	✅
getRate	✅	✅	✅	✅
setRate	✅	✅	✅	✅
showController	✅	❌	❌	❌
isControllerIsFullyVisible	✅	❌	❌	❌
exitPlayer	✅	❌	❌	❌

Supported listeners

Name	Android	iOS	Electron	Web
jeepCapVideoPlayerReady	✅	✅	✅	✅
jeepCapVideoPlayerPlay	✅	✅	✅	✅
jeepCapVideoPlayerPause	✅	✅	✅	✅
jeepCapVideoPlayerEnded	✅	✅	✅	✅
jeepCapVideoPlayerExit	✅	✅	✅	✅

Documentation

API_Documentation

Tutorials Blog

• JeepQ Capacitor Plugin Tutorials

Applications demonstrating the use of the plugin

Capacitor 5 Apps

• ionic7-angular-videoplayer-app

• vant-nuxt-videoplayer-app

Application Starter (Not yet updated to 5.0.0)

• angular-video-player-app-starter

• react-video-player-app-starter

• vite-react-videoplayer-app

• vue-videoplayer-app

Usage 2.4.7

• see capacitor documentation

• see usage 2.4.7

Usage > 3.0.0

• see capacitor documentation

• see usage > 3.0.0

Dependencies

• hls.js for HLS videos on Web and Electron platforms
• ExoPlayer for HLS, DASH, SmoothStreaming videos on Android platform

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jean Pierre Quéau 💻	Yelhouti 💻	Mamane10 💻	Пронин Андрей KANekT 💻	Michael Rieger 💻	Manuel García Marín 💻	Jelle Oppenhuis 💻	fegauthier 💻
Harmon Wood 💻	Eduardo Roth 💻

This project follows the all-contributors specification. Contributions of any kind welcome!