Interface UIConfiguration

Describes the UI configuration of the player.

interface UIConfiguration {
    fluid?: boolean;
    fullscreenOptions?: FullscreenOptions;
    height?: string | number;
    language?: string | UILanguage;
    languages?: Record<string, UILanguage>;
    userActions?: UserActions;
    width?: string | number;
}

Properties

fluid? fullscreenOptions? height? language? languages? userActions? width?

Properties

Optional fluid

fluid?: boolean

Whether the UI of the player is responsive.

Default Value

false

Optional fullscreenOptions

fullscreenOptions?: FullscreenOptions

Options to control transitions to fullscreen mode.

Remarks


- Available since v2.90.0.

Optional height

height?: string | number

The height of the player.

Remarks

Possible formats
- A number as the amount of pixels.
- A percentage string (XX%).

Optional language

language?: string | UILanguage

The language which is used for localization.

Remarks


- This can be a language map.
- Otherwise it can be a language code which is the key to a language map in UIConfiguration.languages.

Example

Localize statically to one language.

ui: {
  language: {
    "Play": "Reproducir",
    "Pause": "Pausa",
    "Current Time": "Tiempo actual",
    // [...]
  }
}

Example

Localize dynamically to one of multiple languages.

ui: {
  language: 'es',
  languages: {
    "es": {
      "Play": "Reproducir",
      "Pause": "Pausa",
      "Current Time": "Tiempo actual",
      // [...]
    },
    "fr": {
      // [...]
    }
  }
}

Optional languages

languages?: Record<string, UILanguage>

A record used to localize to multiple languages. Each entry contains a language code with associated language map.

Optional userActions

userActions?: UserActions

Actions that define the behavior of the player.

Remarks


- Available since v4.3.0

Optional width

width?: string | number

The width of the player.

Remarks

Possible formats
- A number as the amount of pixels.
- A percentage string (XX%).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc