@elemental/media-player / Function

lmnMediaPlayerSetLabels

Saves custom labels for the helpers and resources in the Docebo Media Player library.

Presentation

function lmnMediaPlayerSetLabels(
  labels: Partial<{
    mediaPlayer: Partial<{
      leftRightShortcut: string;
      upDownShortcut: string;
      settings: string;
      subtitlesCC: string;
      fontSize: string;
      position: string;
      fontColor: string;
      fontBackground: string;
      subtitlesCCOptions: string;
      keyboardShortcuts: string;
      rewindNotPermitted: string;
      forwardNotPermitted: string;
      rewindForwardNotPermitted: string;
      playbackSpeed: string;
      quality: string;
      audioLanguage: string;
      auto: string;
      top: string;
      bottom: string;
      white: string;
      yellow: string;
      green: string;
      cyan: string;
      blue: string;
      magenta: string;
      red: string;
      black: string;
      valueIsDefault: string;
      off: string;
      buffering: string;
      useSettingsButton: string;
      changeSubtitlePositionDisableReason: string;
      spaceKShortcut: string;
      mShortcut: string;
      cShortcut: string;
      iShortcut: string;
      fShortcut: string;
      shortcutMKey: string;
      shortcutCKey: string;
      shortcutIKey: string;
      shortcutFKey: string;
      shortcutSpaceKKey: string;
      audioController: string;
      videoController: string;
      play: string;
      pause: string;
      backward: string;
      forward: string;
      mute: string;
      unmute: string;
      subtitlesClosedCaptions: string;
      pictureInPicture: string;
      fullscreen: string;
      exitFullscreen: string;
      keyboardShortcut: string;
      keyboardShortcutLeft: string;
      keyboardShortcutRight: string;
      volumeAreaLabel: string;
      subtitleAriaDescriptionActive: string;
      subtitleAriaDescriptionInactive: string;
      pipAriaDescription: string;
      pipAriaDescriptionDisabled: string;
      fullscreenAriaDescriptionDisabled: string;
      currentTime: string;
      currentTimeAriaDescription: string;
      totalTimeAriaLabel: string;
      invalidCurrentTime: string;
      shortcutLeftRightAriaLabel: string;
      shortcutUpDownAriaLabel: string;
      shortcutSpaceKAriaLabel: string;
      shortcutMAriaLabel: string;
      shortcutCAriaLabel: string;
      shortcutIAriaLabel: string;
      shortcutFAriaLabel: string;
      hours: string;
      minutes: string;
      seconds: string;
      currentOfMax: string;
      totalTime: string;
    }>;
  }>,
): void;

Returns

void

Parameters

NameTypeDescription
labels
Partial<{ mediaPlayer: Partial<{ leftRightShortcut: string; upDownShortcut: string; settings: string; subtitlesCC: string; fontSize: string; position: string; fontColor: string; fontBackground: string; subtitlesCCOptions: string; keyboardShortcuts: string; rewindNotPermitted: string; forwardNotPermitted: string; rewindForwardNotPermitted: string; playbackSpeed: string; quality: string; audioLanguage: string; auto: string; top: string; bottom: string; white: string; yellow: string; green: string; cyan: string; blue: string; magenta: string; red: string; black: string; valueIsDefault: string; off: string; buffering: string; useSettingsButton: string; changeSubtitlePositionDisableReason: string; spaceKShortcut: string; mShortcut: string; cShortcut: string; iShortcut: string; fShortcut: string; shortcutMKey: string; shortcutCKey: string; shortcutIKey: string; shortcutFKey: string; shortcutSpaceKKey: string; audioController: string; videoController: string; play: string; pause: string; backward: string; forward: string; mute: string; unmute: string; subtitlesClosedCaptions: string; pictureInPicture: string; fullscreen: string; exitFullscreen: string; keyboardShortcut: string; keyboardShortcutLeft: string; keyboardShortcutRight: string; volumeAreaLabel: string; subtitleAriaDescriptionActive: string; subtitleAriaDescriptionInactive: string; pipAriaDescription: string; pipAriaDescriptionDisabled: string; fullscreenAriaDescriptionDisabled: string; currentTime: string; currentTimeAriaDescription: string; totalTimeAriaLabel: string; invalidCurrentTime: string; shortcutLeftRightAriaLabel: string; shortcutUpDownAriaLabel: string; shortcutSpaceKAriaLabel: string; shortcutMAriaLabel: string; shortcutCAriaLabel: string; shortcutIAriaLabel: string; shortcutFAriaLabel: string; hours: string; minutes: string; seconds: string; currentOfMax: string; totalTime: string; }>; }>

@param labels The labels to be customized.