Welcome to the IINA Plugin API documentation!

If you are new to IINA's plugin system, please read the Getting Started page first. Click the links in the sidebar (or the drop-down menu) to see more tutorials and guides.

Quick links to the documentation of each API module:

Control the player

• iina.core: open files, get and set various status, display OSD messages, etc.
• iina.event: listen to IINA and mpv events.
• iina.mpv: call mpv API, get and set mpv properties, run mpv commands, add hooks.

Extend functionalities

• iina.menu: add menu items.
• iina.subtitle: register custom subtitle downloaders.
• iina.playlist: manipulate playlist items, add custom actions to the playlist's context menu.
• iina.input: capture keyboard and mouse events.

Display custom user interfaces

• iina.overlay: display contents on top of the video.
• iina.standaloneWindow: create a standalone window to display additional contents.
• iina.sidebar: display additional contents in the sidebar.

Access the system and the network

• iina.file: access the file system.
• iina.utils: run shell commands, present dialogs, etc.
• iina.http: make HTTP requests.
• iina.ws: create WebSocket connections.

Control player instances

• iina.global: create and control player instances.

Logging and preferences

• iina.console: log messages.
• iina.preferences: get and set plugin's preferences.

iina-plugin-definition

To use this package in a Typescript project, simply install it from npm:

yarn add iina-plugin-definition

or

npm i iina-plugin-definition

Then add it to typeRoots in tsconfig.json:

{
    "typeRoots": [
        "./node_modules/@types",
        "./node_modules/iina-plugin-definition"
    ],
}