Interface Preferences

The Preference module provides a user settings system. The user can set preferences of the plugin in IINA's Preference (Settings) window, which can be read by the plugin. See Plugin Preferences for details.

Available In Entry

Main and Global entry

Hierarchy

  • Preferences

Methods

Methods

  • Get the preference value corresponding to the key.

    Parameters

    • key: string

      The preference key.

    Returns any

  • Set the value for a preference key.

    Parameters

    • key: string

      The preference key.

    • value: any

      The value.

    Returns void

  • Persist the preference changes to disk. By default, the preferences are persisted to disk only when the plugin's preferences page (in IINA's Settings window) is closed. Therefore, it's recommended to call this method after invoking set programmatically.

    Returns void

Generated using TypeDoc