Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PlayerParams

Index

Properties

Optional aspectMode

Player's aspect ratio mode

Optional autoplay

autoplay: boolean

Whether player should start playing of video as soon as it is loaded

Optional hideControlsTimeout

hideControlsTimeout: number

If greater than 0, player will hide controls if user is inactive for specified amount of milliseconds.

Optional loop

loop: boolean

Whether player should loop playing of video

Optional muted

muted: boolean

Whether player should mute video

Optional playOnFocus

playOnFocus: boolean

Whether player should start playing of video when video is in the middle of the screen

Optional playbackQuality

playbackQuality: HIGH | MEDIUM | LOW

Preferred video quality that should be used for playback

Optional playlist

playlist: Playlist

Video playlist to play

Optional playlistIndex

playlistIndex: number

Index of video in playlist to play

Optional rate

rate: number

Player playback rate

Optional showControls

showControls: boolean

Whether player should show controls

Optional size

size: string

Player size mode. Available 2 options:

  • 'auto' (default) - player inherits width of container element and height will be calculated in accordance with video ratio.
  • 'parent' - width and height will be inherited from parent container element.

Optional video

video: Video

Video object to play

Optional videoId

videoId: string

Video id to load and play

Optional volume

volume: number

Player volume when it is created

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property

Generated using TypeDoc