Options

The element where player should be generated.
For more info see how to generate player.

Adds media source files to the player. For more information see set source files page.

Adds width attribute of the <video> element with provided integer value. It is not necessary for <audio> element. Default value is false.

Adds HTML height attribute of the <video> element with provided integer value. It is not necessary for <audio> element. Default value is false.

Adds class name or names to the player media (<video> or <audio>) element. Set string (for example outerClass: 'foo bar john') to add class/classes. Default value is false.

Adds id to the media (<video> or <audio>) element with provided string value. Default value is false.

Adds class name or class names to the player outer container element. Set string (for example outerClass: 'foo bar john') to add class/classes. Default value is false.

Adds id to the player outer container element with provided string value. Default value is false.

Makes aspect ratio of player. set ratio: false to disable aspect ratio, or set custom ratio as string (for example ratio: '12/5'). Default value is '5.5/3'.

Availability to control volume and time using top, left, bottom, right keyboard keys. top and bottom keys are for setting volume up and down. left and right keys are for setting time - next or back. Value should be an object with two required properties, see an example below:

keyEvents: {
    volumeStep: 0.12, // volume step on per key press. It should be integer from 0 to 1.
    timeStep: 10 // time step on per key press in seconds. It should be integer.
}
//also object above is the default value

Set keyEvents: false to disable key events.

Start auto playback immediately, after several time, or do not auto playback. Set autoplay: false to disable auto playback. Set autoplay: true to start playback immediately. Set time integer in seconds (for example autoplay: 8) to start playback in provided seconds. Default value is false.

Sets the player default volume. Set integer from 0 to 1 (for example startVolume: 0.4). Default value is 0.8.

Sets the player time to start playback from. Set time integer in seconds (for example startTime: 120). Default value is 0.

Sets whether is player default muted or not. The value must be boolean. Set muted: true to setup player as default muted. Set muted: false for not muted. Default value is false.

Whether player toggles playback on click player itself or not. The value must be boolean. Set playToggleOnClickPlayer: true to make player sensitive on click - play and pause the playback. Set playToggleOnClickPlayer: false to disable toggle playback on player click. Default value is true.

Adds custom context menu with items and click callback. Please see context menu page for more details.

Adds text tracks to the player. For more information see text tracks page.

Whether generate big play button or not. The value must be boolean. Set bigPlayButton: true for generate, set bigPlayButton: false for do not generate. Default value is true.

Whether generate main waiting/loading indicator or not. The value must be boolean. Set waitingIndicator: true for generate, or set waitingIndicator: false for do not generate. Default value is true.

Whether generate waiting indicator over time progress bar (like vimeo does) or not. The value must be boolean. Set waitingIndicatorInTimeProgressBar: true for generate, or set waitingIndicatorInTimeProgressBar: false for do not generate. Default value is false.

When player opens on mobile or tablet device its volume can be controlled with phone/tablet volume up and down buttons without player volume bar. If you want so set mobileAndTabletAutoVolume: true and thisPlayer will not generate volume bar for mobile/tablet devices and it lets default volume of device, set mobileAndTabletAutoVolume: false to generate volume bar anyway. The value must be boolean and default is true.

Whether generate or not mute button for mobile and tablet devices. The value must be boolean. Set mobileAndTabletMuteButton: true for generate, or set mobileAndTabletMuteButton: false for do not generate. Default value is true.

Whether generate player controls bar or not. The value must be boolean. Set controls: true for generate, or set controls: false for do not generate. Default value is true.

After what time hide the controls bar of the player in case of no actions. Set time integer in seconds (for example controlsHideTime: 3) to hide in certain period. Set boolean controlsHideTime: false to never hide controls bar. Default value is 3.

Whether generate small play button in player controls bar or not. The value must be boolean. Set smallPlayButton: true for generate, or set smallPlayButton: false for do not generate. Default value is true.

Whether generate full screen button in player controls bar or not. The value must be boolean. Set fullscreenButton: true for generate, or set fullscreenButton: false for do not generate. Default value is true.

Set dblClickFullscreen: true if you want to make player fullscreen on double click. Set dblClickFullscreen: false if you want to disable this function. The value must be boolean and default value is true.

Whether generate time progress bar in player controls bar or not. The value must be boolean. Set timeProgressBar: true for generate, set timeProgressBar: false for do not generate. Default value is true.

Whether generate seek pointer for player time progress bar or not. The value must be boolean. Set timeSeekPointer: true for generate, or set timeSeekPointer: false for do not generate. Default value is false.

Whether generate current time shower in time progress bar or not. The value must be boolean. Set floatingTimeInTimeProgressBar: true for generate, or floatingTimeInTimeProgressBar: false for do not generate. Default value is false.

Whether generate mouseover highlighter of time progress bar or not. The value must be boolean. Set timeProgressBarHighlighter: true for generate, or timeProgressBarHighlighter: false for do not generate. Default value is false.

Whether generate the mute button in player controls bar or not. The value must be boolean. Set muteButton: true for generate, or set muteButton: false for do not generate. Default value is true.

Whether generate volume bar in player controls bar or not. The value must be boolean. Set volumeBar: true for generate, or set volumeBar: false for do not generate. Default value is true.

Whether generate seek pointer for player volume bar or not. The value must be boolean. Set volumeSeekPointer: true for generate, or set volumeSeekPointer: false for do not generate. Default value is false.

Whether generate current volume indicator in volume bar or not. The value must be boolean. Set floatingVolumeInVolumeBar: true for generate, set floatingVolumeInVolumeBar: false for do not generate. Default value is false.

Whether generate mouseover highlighter of volume bar or not. The value must be boolean. Set volumeBarHighlighter: true for generate, or volumeBarHighlighter: false for do not generate. Default value is false.

Whether generate current time shower in controls bar or not. The value must be boolean. Set currentTimeLog: true for generate, or set currentTimeLog: false for do not generate. Default value is true.

Whether generate remaining time in controls bar or not. The value must be boolean. Set timeRemainingLog: true for generate, set timeRemainingLog: false for do not generate. Default value is false.

Whether generate media time duration in controls bar or not. The value must be boolean. Set durationLog: true for generate, or set durationLog: false for do not generate. Default value is true.

Set poster image URL string to show the poster instead of video while it loads (for example poster: 'images/img.png'). Set poster: false to disable poster. Default value is false.

Set markup string (html, css) which will be shown over player before media plays back and when it is stopped, see an example below:

builtin: '<div class="player-builtin">Hi! <span style="#cc0000">Click me</span> to play</div>'

Or set builtin: false to disable it. Default value is false.

Here you can set custom markup string (html, css) which will be shown in case of player error, see an example below:

errorBuiltin: '<div class="error-message">Sorry! <span style="#cc0000">Media</span> is broken</div>'

Or set errorBuiltin: false to use player default error message. Default value is false.

Set integer (for example loop: 5) to loop video several times. Set boolean loop: true to loop video forever. Set boolean loop: false to disable loop. Default value is false.

Use this property to set how to load media file. The value must be string. Set preload: 'metadata' to load just metadata (duration, volume etc...) of media until it starts playback. Set preload: 'auto' if you do not care - browser does its best to load media. Set preload: 'load' to start media loading immediately. Set preload: 'none' to do not load media until request playback. Default value is 'metadata'.

This property is to set player type. The value must be string. Set playerType: 'video' to generate video player, set playerType: 'audio' to generate audio player. Default value is 'video'.