Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StyleConfig

Example:

style : {
  width: '100%',
  aspectratio: '16:9',
  ux: false
}

Hierarchy

  • StyleConfig

Index

Properties

Properties

Optional aspectratio

aspectratio: string | number

The aspect ratio of the player, e.g. 16:9, 16:10, 4:3. Not more than two options of width, height, and aspect ratio should be given. Defaults to 16:9.

Optional height

height: string

The height of the player. Can have any value including the unit (e.g. px, %, em, vh) usable in CSS, e.g. 500px or 90%. Not more than two options of width, height, and aspect ratio should be given. If no unit is give, 'px' is assumed. If no height is given, the height is controlled via CSS aspect-ratio classes (default)

Optional ux

ux: boolean

A short hand function to disable/enable controls, playOverlay, subtitles, keyboard, and mouse. It is not possible to override this setting with one of the mentioned attributes.

Optional width

width: string

The width of the player. Can have any value including the unit (e.g. px, %, em, vw) usable in CSS, e.g. 500px or 90%. Not more than two options of width, height, and aspect ratio should be given. If no unit is given, 'px' is assumed. If no width is given, the width is controlled via CSS aspect-ratio classes (default)

Generated using TypeDoc