From 537ac1a15fbc02619ebe8c7b97823d06937c8107 Mon Sep 17 00:00:00 2001 From: wm4 Date: Sun, 18 May 2014 18:58:36 +0200 Subject: client API: add mpv_load_config_file() This is probably a good idea, because it would make it easier for software embedding mpv to configure the mpv parts, without requiring the host program to provide explicit mechanisms for this (other than calling mpv_load_config_file()). --- libmpv/client.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'libmpv/client.h') diff --git a/libmpv/client.h b/libmpv/client.h index 3b43c2f383..673586e169 100644 --- a/libmpv/client.h +++ b/libmpv/client.h @@ -311,6 +311,30 @@ int mpv_initialize(mpv_handle *ctx); */ void mpv_destroy(mpv_handle *ctx); +/** + * Load a config file. This loads and parses the file, and sets every entry in + * the config file's default section as if mpv_set_option_string() is called. + * + * The filename should be an absolute path. If it isn't, the actual path used + * is unspecified. (Note: an absolute path starts with '/' on UNIX.) If the + * file wasn't found, MPV_ERROR_INVALID_PARAMETER is returned. + * + * If a fatal error happens when parsing a config file, MPV_ERROR_OPTION_ERROR + * is returned. Errors when setting options as well as other types or errors + * are ignored (even if options do not exist). You can still try to capture + * the resulting error messages with mpv_request_log_messages(). Note that it's + * possible that some options were successfully set even if any of these errors + * happen. + * + * The same restrictions as with mpv_set_option() apply: some options can't + * be set outside of idle or uninitialized state, and many options don't + * take effect immediately. + * + * @param filename absolute path to the config file on the local filesystem + * @return error code + */ +int mpv_load_config_file(mpv_handle *ctx, const char *filename); + /** * Stop the playback thread. Normally, the client API stops the playback thread * automatically in order to process requests. However, the playback thread is -- cgit v1.2.3