client API: be more explicit about how to make libmpv use config files

This commit is contained in:
wm4 2018-01-02 13:35:02 +01:00 committed by Kevin Mitchell
parent 722f9b63c2
commit 08bcf1d92d
1 changed files with 5 additions and 1 deletions

View File

@ -385,10 +385,14 @@ const char *mpv_client_name(mpv_handle *ctx);
* equivalent to setting the --no-terminal option.
* (Technically, this also suppresses C signal handling.)
* - No config files will be loaded. This is roughly equivalent to using
* --no-config. Since libmpv 1.15, you can actually re-enable this option,
* --config=no. Since libmpv 1.15, you can actually re-enable this option,
* which will make libmpv load config files during mpv_initialize(). If you
* do this, you are strongly encouraged to set the "config-dir" option too.
* (Otherwise it will load the mpv command line player's config.)
* For example:
* mpv_set_option_string(mpv, "config-dir", "/my/path"); // set config root
* mpv_set_option_string(mpv, "config", "yes"); // enable config loading
* (call mpv_initialize() _after_ this)
* - Idle mode is enabled, which means the playback core will enter idle mode
* if there are no more files to play on the internal playlist, instead of
* exiting. This is equivalent to the --idle option.