Interface Locale

The localized strings used in the player's user interface.

interface Locale {
    adClickThroughButton: string;
    adCountdown: ((remainingDuration) => string);
    adProgress: ((__namedParameters) => string);
    adSkip: string;
    adSkipCounter: ((seconds) => string);
    audioTitle: string;
    automaticQualitySelectionLabel: string;
    backButton: string;
    castConnected: ((target) => string);
    castConnecting: ((target) => string);
    errorMessage: ((error) => string);
    liveLabel: string;
    playbackRateLabel: ((rate) => string);
    playbackRateTitle: string;
    qualityLabel: ((params) => string);
    qualityLabelExtended: ((params) => string);
    qualityTitle: string;
    settingsTitle: string;
    subtitleTitle: string;
}

Properties

adClickThroughButton adCountdown adProgress adSkip adSkipCounter audioTitle automaticQualitySelectionLabel backButton castConnected castConnecting errorMessage liveLabel playbackRateLabel playbackRateTitle qualityLabel qualityLabelExtended qualityTitle settingsTitle subtitleTitle

Properties

adClickThroughButton

adClickThroughButton: string

The text on the click through button, potentially shown during advertisements.

adCountdown

adCountdown: ((remainingDuration) => string)

The countdown text shown during advertisements.

Type declaration

    • (remainingDuration): string

    • Parameters

      • remainingDuration: {
            remainingDuration: number;
        }

        The remaining duration in seconds

        • remainingDuration: number

      Returns string

adProgress

adProgress: ((__namedParameters) => string)

The label showing advertisement progress.

Type declaration

    • (__namedParameters): string

    • Parameters

      • __namedParameters: {
            currentAd: number;
            totalAds: number;
        }
        • currentAd: number
        • totalAds: number

      Returns string

adSkip

adSkip: string

The text on the button to skip advertisements.

adSkipCounter

adSkipCounter: ((seconds) => string)

The label during the countdown, when it can be skipped.

Type declaration

    • (seconds): string

    • Parameters

      • seconds: {
            seconds: number;
        }

        The amount of remaining seconds

        • seconds: number

      Returns string

audioTitle

audioTitle: string

The title of the audio track selection menu.

automaticQualitySelectionLabel

automaticQualitySelectionLabel: string

The label shown when ABR is enabled.

backButton

backButton: string

The text used in the back button, on all menus.

castConnected

castConnected: ((target) => string)

The text shown on the player while connected to a cast target.

Type declaration

    • (target): string

    • Parameters

      • target: {
            target: "Chromecast" | "Airplay";
        }

        Chromecast or Airplay

        • target: "Chromecast" | "Airplay"

      Returns string

castConnecting

castConnecting: ((target) => string)

The text shown on the player while connecting to a cast target.

Type declaration

    • (target): string

    • Parameters

      • target: {
            target: "Chromecast" | "Airplay";
        }

        Chromecast or Airplay

        • target: "Chromecast" | "Airplay"

      Returns string

errorMessage

errorMessage: ((error) => string)

The error message shown on the player when the player has errored.

Type declaration

    • (error): string

    • Parameters

      Returns string

liveLabel

liveLabel: string

The label used to indicate the player is playing a live steam.

playbackRateLabel

playbackRateLabel: ((rate) => string)

The label of the selectable playback speed.

Type declaration

    • (rate): string

    • Parameters

      • rate: {
            rate: number;
        }

        The playback speed value

        • rate: number

      Returns string

playbackRateTitle

playbackRateTitle: string

The title of the playback speed menu.

qualityLabel

qualityLabel: ((params) => string)

The label of a video quality.

Type declaration

qualityLabelExtended

qualityLabelExtended: ((params) => string)

The extended label of a video quality.

Type declaration

qualityTitle

qualityTitle: string

The title of the video quality selection menu.

settingsTitle

settingsTitle: string

The title at the top of the settings menu.

subtitleTitle

subtitleTitle: string

The title of the subtitle track selection menu.

Settings

Member Visibility

Theme

On This Page

adClickThroughButtonadCountdownadProgressadSkipadSkipCounteraudioTitleautomaticQualitySelectionLabelbackButtoncastConnectedcastConnectingerrorMessageliveLabelplaybackRateLabelplaybackRateTitlequalityLabelqualityLabelExtendedqualityTitlesettingsTitlesubtitleTitle