Video Player Capacitor plugin

Using @capgo/capacitor-video-player

Capacitor plugin to play video in native player.

Install

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

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

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

API at a glance

Examples

initPlayer()

Initialize a video player.

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

const result = await VideoPlayer.initPlayer({ mode: 'fullscreen' });
console.log(result);

isPlaying()

Return if a given playerId is playing.

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

const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);

play()

Play the current video from a given playerId.

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

const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);

pause()

Pause the current video from a given playerId.

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

const result = await VideoPlayer.pause({ playerId: 'player-id-123' });
console.log(result);

getDuration()

Get the duration of the current video from a given playerId.

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

const result = await VideoPlayer.getDuration({ playerId: 'player-id-123' });
console.log(result);

getCurrentTime()

Get the current time of the current video from a given playerId.

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

const result = await VideoPlayer.getCurrentTime({ playerId: 'player-id-123' });
console.log(result);

The table above lists the 19 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-video-player

If you are using Using @capgo/capacitor-video-player to plan native media and interface behavior, connect it with @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-native-navigation for the native capability in Using @capgo/capacitor-native-navigation.