Fluid Player documentation

Fluid Player documentation

  • Homepage
  • GitHub

›API

Overview

  • Overview

Integration

  • Quick setup
  • Vue.js
  • React
  • Angular
  • Wordpress

Configuration

  • Layout
  • Advertisements
  • Previews
  • Subtitles
  • VR (experimental)
  • Suggested videos
  • Advanced

API

  • Controls API
  • Utility API
  • Event API

Streaming

  • Streaming support
  • HTTP Live Streaming (HLS)
  • MPEG-DASH

About

  • Help
  • Changelog
  • License

Controls API

You can use functions documented here to manage user controls of Fluid Player after initialisation.

Play

To play the Fluid Player use the play() function on our player object

player.play();

Pause

To play the Fluid Player use the pause() function on our player object

player.pause();

SkipTo

The skipTo(seconds) function takes in a parameter of the time (in seconds) to move the video to. In our below example we'll skip to 30 seconds into the video.

player.skipTo(30);

SetPlaybackSpeed

The setPlaybackSpeed(speed) function takes in a speed parameter. The default speed is 1, and the speeds are relative to this. If we wanted to double the speed we'd use 2, and half speed would be 0.5. The below example will double the speed of the video.

player.setPlaybackSpeed(2);

SetVolume

The setVolume(volume) function takes in a volume parameter. The max volume is 1, and the volumes to set are relative to this. To half the volume we would use setVolume(0.5), and to mute the player we would use setVolume(0). The below example will mute the video.

player.setVolume(0);

toggleControlBar

We can show and hide the control bar when necessary. This function takes in a true or false value.

If we pass true the control bar will show and remain showing at all times.

if we pass false we hide the control bar and it returns to it's standard behaviour, showing on hover or pause.

player.toggleControlBar(true);

toggleFullScreen

Using toggleFullScreen(boolean) we can set the video to fullscreen. true will set the player to fullscreen, and false will set the player back to normal.

player.toggleFullScreen(true);

toggleMiniPlayer

Using toggleMiniPlayer(boolean) we can toggle the player to Mini Player mode. true will set the player to Mini Player, and false will set the player back to normal.

player.toggleMiniPlayer(true);
Last updated on 6/14/2023
← AdvancedUtility API →
  • Play
  • Pause
  • SkipTo
  • SetPlaybackSpeed
  • SetVolume
  • toggleControlBar
  • toggleFullScreen
  • toggleMiniPlayer
Fluid Player documentation
Docs
OverviewQuick setup
More
HomepageGitHubStar
Copyright © 2025 Fluid Player and contributors