Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.streamlink.enable

Whether to enable streamlink.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.streamlink.package

The streamlink package to use.

Type: null or package

Default:

pkgs.streamlink

Declared by:

programs.streamlink.plugins

Streamlink plugins.

If a source is set, the custom plugin will be linked to the data directory.

Additional configuration specific to the plugin, if defined, will be written to the config directory, and override global settings.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  custom_plugin = {
    src = ./custom_plugin.py;
    settings = {
      quiet = true;
    };
  };
}

Declared by:

programs.streamlink.plugins.<name>.settings

Configuration for the specific plugin, written to $XDG_CONFIG_HOME/streamlink/config.<name> (linux) or Library/Application Support/streamlink/config.<name> (darwin).

Type: attribute set of (boolean or signed integer or floating point number or string or list of (signed integer or floating point number or string))

Default:

{ }

Example:

{
  quiet = true;
}

Declared by:

programs.streamlink.plugins.<name>.src

Source of the custom plugin. The value should be a path to the plugin file, or the text of the plugin code. Will be linked to $XDG_DATA_HOME/streamlink/plugins/<name>.py (linux) or Library/Application Support/streamlink/plugins/<name>.py (darwin).

Type: null or absolute path or strings concatenated with ā€œ\nā€

Default:

null

Example:

./custom_plugin.py

Declared by:

programs.streamlink.settings

Global configuration options for streamlink. It will be written to $XDG_CONFIG_HOME/streamlink/config (linux) or Library/Application Support/streamlink/config (darwin).

Type: attribute set of (boolean or signed integer or floating point number or string or list of (signed integer or floating point number or string))

Default:

{ }

Example:

{
  player = "${pkgs.mpv}/bin/mpv";
  player-args = "--cache 2048";
  player-no-close = true;
}

Declared by: