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](https://github.com/harmonwood) | | ✅ |
| Quéau Jean Pierre | [jepiqueau](https://github.com/jepiqueau) | | ❌ |
## LATEST FOR CAPACITOR 6 (main)
## Browser Support
The plugin follows the guidelines from the `Capacitor Team`,
- [Capacitor Browser Support](https://capacitorjs.com/docs/v3/web#browser-support)
meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with [Babel](https://babeljs.io/).
## Installation
```bash
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](https://www.capacitorvideoplayer.com/API/)
## Tutorials Blog
- [JeepQ Capacitor Plugin Tutorials](https://jepiqueau.github.io/)
## Applications demonstrating the use of the plugin
### Capacitor 5 Apps
- [ionic7-angular-videoplayer-app](https://github.com/jepiqueau/blog-tutorials-apps/tree/main/Videoplayer/ionic7-angular-videoplayer-app)
- [vant-nuxt-videoplayer-app](https://github.com/jepiqueau/blog-tutorials-apps/tree/main/Videoplayer/vant-nuxt-videoplayer-app)
### Application Starter (Not yet updated to 5.0.0)
- [angular-video-player-app-starter](https://github.com/jepiqueau/angular-videoplayer-app-starter)
- [react-video-player-app-starter](https://github.com/jepiqueau/react-video-player-app-starter)
- [vite-react-videoplayer-app](https://github.com/jepiqueau/vite-react-videoplayer-app)
- [vue-videoplayer-app](https://github.com/jepiqueau/vue-videoplayer-app-starter)
## Usage 2.4.7
- [see capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)
- [see usage 2.4.7](https://github.com/jepiqueau/capacitor-video-player/blob/master/docs/Usage_2.4.7.md)
## Usage > 3.0.0
- [see capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)
- [see usage > 3.0.0](https://github.com/jepiqueau/capacitor-video-player/blob/master/docs/Usage_3.0.0.md)
## 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](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
