Skip to main content

API Reference

Welcome to the VP Vertical Player API Reference section of this documentation. The VP Vertical Player API allows you to enhance the functionality of your video player and create interactive experiences for users. By using the API, you can customize the behavior of your videos and create unique user experiences using the available methods and properties.

Methods​

VP Vertical Player allows users to use methods for these purposes:

  • Control playback methods
  • Toggle methods
  • State methods
  • Set playback properties methods

Control playback methods​

play()​

The method vpVerticalPlayer().play() plays the video

pause()​

The method vpVerticalPlayer().pause() pauses the video

replay()​

The method vpVerticalPlayer().replay() replays the video from the beginning

seek()​

The vpVerticalPlayer().seek() method allows you to jump to the specified position within the currently playing video. It contains one attribute, which is described below.

ATTRIBUTEDESCRIPTION
position NumberAn attribute that indicates the position (in seconds) to seek to. This is a mandatory attribute.

mute()​

The method vpVerticalPlayer().mute() mutes the audio on the video

unmute()​

The method vpVerticalPlayer().unmute() unmutes the audio on the video

enterFullscreen()​

The method vpVerticalPlayer().enterFullscreen() enters full screen mode for the video

exitFullscreen()​

The method vpVerticalPlayer().exitFullscreen() exits full screen mode for the video

destroy()​

The method vpVerticalPlayer().destroy() destroys the video player instance, removing it from the DOM

Toggle methods​

togglePlay()​

The method vpVerticalPlayer().togglePlay() toggles the play/pause state of the video based on the current state

toggleMute()​

The method vpVerticalPlayer().toggleMute() toggles the mute/unmute state of the audio on the video

State methods​

isMuted()​

The method vpVerticalPlayer().isMuted() returns a boolean indicating if the audio on the video is currently muted

isPlaying()​

The method vpVerticalPlayer().isPlaying() returns a boolean indicating if the video is currently playing

isFullscreen()​

The method vpVerticalPlayer().isFullscreen() returns a boolean indicating if the video is currently in full screen mode

isEnded()​

The method vpVerticalPlayer().isEnded() returns a boolean indicating if the current video has ended

isFocused()​

The method vpVerticalPlayer().isFocused() returns a boolean indicating if the player is in a focused state caused by a user interaction

Set playback properties methods​

setVideo()​

The method vpVerticalPlayer().setVideo() sets the video for the video player

const video = {
    // configuration of video object from config.video
};
vpVerticalPlayer().setVideo(video);