summaryrefslogtreecommitdiffstats
path: root/libmpv/client.h
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-02-25 23:59:27 +0100
committerwm4 <wm4@nowhere>2014-02-25 23:59:27 +0100
commitf3c933e5d3501c71e7f38dc62b27096a90090d5e (patch)
tree04785087045a348df4e63c8588b3573bfeec51ad /libmpv/client.h
parent279bd8db1f16953d6c99293625440f184967a534 (diff)
downloadmpv-f3c933e5d3501c71e7f38dc62b27096a90090d5e.tar.bz2
mpv-f3c933e5d3501c71e7f38dc62b27096a90090d5e.tar.xz
options: allow changing options at runtime
Allow changing all options at runtime, except some cherry-picked options, which are disabled with M_OPT_FIXED.
Diffstat (limited to 'libmpv/client.h')
-rw-r--r--libmpv/client.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index 606fabbce5..0c0cde7b0f 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -561,11 +561,14 @@ void mpv_free_node_contents(mpv_node *node);
/**
* Set an option. Note that you can't normally set options during runtime. It
- * works in uninitialized state (see mpv_create()), and in some cases in idle
- * mode.
- *
- * You can use mpv_set_property() to change options during playback, but this
- * does not work with all options.
+ * works in uninitialized state (see mpv_create()), and in some cases in at
+ * runtime.
+ *
+ * Changing options at runtime does not always work. For some options, attempts
+ * to change them simply fails. Many other options may require reloading the
+ * file for changes to take effect. In general, you should prefer calling
+ * mpv_set_property() to change settings during playback, because the property
+ * mechanism guarantees that changes take effect immediately.
*
* @param name Option name. This is the same as on the mpv command line, but
* without the leading "--".