Skip to content
This repository was archived by the owner on Apr 30, 2022. It is now read-only.

api.md

Latest commit

 

History

History
26 lines (23 loc) · 1.32 KB

api.md

File metadata and controls

26 lines (23 loc) · 1.32 KB

API

The video-player provides the following public interface for accessing and manipulating its state.

Properties

  • configuration The configuration of the video-player. Configuration needs to be reloaded manually after edits (see below).
  • state The current state of the video-player. Must not be modified directly, but via the methods below.

Methods

  • play() Plays the video.
  • pause() Pauses the video.
  • seek(seconds) Seeks to the specified position.
  • setPlaybackRate(playbackRate) Sets the playback rate.
  • setQuality(quality) Sets the quality of the stream.
  • setVolume(volume) Sets the volume of the playback (0.0-1.0).
  • mute() Enables muting.
  • unmute() Disables muting.
  • showCaptions(language[, type]) Shows captions in the specified language and type (optional).
  • hideCaptions() Hides captions.
  • showInteractiveTranscript(language[, type]) Shows interactive transcript in the specified language (optional).
  • hideInteractiveTranscript() Hides interactive transcript.
  • setResizerRatio(ratio, index) Sets the ratio of a single resizer. If index is omitted, first resizer is affected.
  • setResizerRatios(ratios) Sets the ratios of all resizers.
  • enterFullscreen() Enters the fullscreen mode.
  • exitFullscreen() Exits the fullscreen mode.
  • reloadConfiguration() Reloads the configuration.