@byomakase/omakase-player
    Preparing search index...

    Interface LocalizationLocalApi

    Public API for player localization.

    interface LocalizationLocalApi {
        destroy(): void;
        get(key: "live" | "markIn" | "markOut"): string;
        restoreLocalization(
            overrides:
                | Partial<Record<"live" | "markIn" | "markOut", string>>
                | undefined,
        ): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    destroy get restoreLocalization

    Methods

    • Fetches the localized string for the given localization key. Falls back to the default localization value for that key if no override was configured.

      Parameters

      • key: "live" | "markIn" | "markOut"

        Localization key

      Returns string

    • Internal method. Restores the localization from the session.

      Parameters

      • overrides: Partial<Record<"live" | "markIn" | "markOut", string>> | undefined

        Localization overrides to restore

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Methods