bitmovin-player-ui
    Preparing search index...

    Interface LocalizationConfig

    interface LocalizationConfig {
        adaptLocalizationToSubtitleLanguage?: boolean;
        events?: {
            onLanguageChanged: EventDispatcher<I18n, LanguageChangedArgument>;
        };
        language?: string;
        vocabularies?: Vocabularies;
    }
    Index

    Properties

    adaptLocalizationToSubtitleLanguage? events? language? vocabularies?

    Properties

    adaptLocalizationToSubtitleLanguage?: boolean

    Specifies if the UI localization should automatically adapt to the selected subtitle language. When enabled, the UI language will change to match the subtitle track's language, falling back to the configured default UI language (English unless configured otherwise) if the language is not available.

    Default: false

    events?: { onLanguageChanged: EventDispatcher<I18n, LanguageChangedArgument> }

    Type Declaration

    • onLanguageChanged: EventDispatcher<I18n, LanguageChangedArgument>

      Fires when the UI language has been changed during the lifetime of the UI.

    language?: string

    Sets the desired language, and falls back to 'en' if there is no vocabulary for the desired language. Setting it to "auto" will enable language detection from the browser's locale.

    vocabularies?: Vocabularies

    A map of language to CustomVocabulary definitions. Can be used to overwrite default translations and add custom strings or additional languages.

    Settings

    Member Visibility

    On This Page

    Properties