Skip to content

@capgo/capacitor-video-player

Native video playback with subtitles, fullscreen, and comprehensive controls

Native video playback with subtitles, fullscreen, and comprehensive controls

Start with initPlayer() and the other core methods listed below.

PlatformSupportNotes
iOSYesNative
AndroidYesNative
WebPartialSee getting started
  • initPlayer - Initialize a video player.
  • isPlaying - Return if a given playerId is playing.
  • play - Play the current video from a given playerId.
  • pause - Pause the current video from a given playerId.
MethodDescription
initPlayerInitialize a video player.
isPlayingReturn if a given playerId is playing.
playPlay the current video from a given playerId.
pausePause the current video from a given playerId.
getDurationGet the duration of the current video from a given playerId.
getCurrentTimeGet the current time of the current video from a given playerId.
setCurrentTimeSet the current time to seek the current video to from a given playerId.
getVolumeGet the volume of the current video from a given playerId.
setVolumeSet the volume of the current video to from a given playerId.
getMutedGet the muted of the current video from a given playerId.
setMutedSet the muted of the current video to from a given playerId.
setRateSet the rate of the current video from a given playerId.
getRateGet the rate of the current video from a given playerId.
stopAllPlayersStop all players playing.
showControllerShow controller.
isControllerIsFullyVisibleisControllerIsFullyVisible.
exitPlayerExit player.

This reference is synced from src/definitions.ts in capacitor-video-player.

Keep going from @capgo/capacitor-video-player

Section titled “Keep going from @capgo/capacitor-video-player”

If you are using @capgo/capacitor-video-player to plan native media and interface behavior, connect it with Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player, 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, Using @capgo/capacitor-native-navigation for the native capability in Using @capgo/capacitor-native-navigation, and @capgo/capacitor-native-navigation for the implementation detail in @capgo/capacitor-native-navigation.