From dc7d71fc8e3b418f73a07ab46869850279587351 Mon Sep 17 00:00:00 2001 From: wm4 Date: Sat, 1 Apr 2017 21:47:19 +0200 Subject: manpage, client API: add some clarifications when commands use OSD The APIs that run commands in a more API-like manner disable OSD and string expansion by default. --- libmpv/client.h | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'libmpv') diff --git a/libmpv/client.h b/libmpv/client.h index ee4290e22b..c6d67094d3 100644 --- a/libmpv/client.h +++ b/libmpv/client.h @@ -840,6 +840,9 @@ int mpv_set_option_string(mpv_handle *ctx, const char *name, const char *data); * * The commands and their parameters are documented in input.rst. * + * Does not use OSD and string expansion by default (unlike mpv_command_string() + * and input.conf). + * * @param[in] args NULL-terminated list of strings. Usually, the first item * is the command, and the following items are arguments. * @return error code @@ -852,6 +855,8 @@ int mpv_command(mpv_handle *ctx, const char **args); * mpv_command_node() with the format set to MPV_FORMAT_NODE_ARRAY, and * every arg passed in order as MPV_FORMAT_STRING. * + * Does not use OSD and string expansion by default. + * * @param[in] args mpv_node with format set to MPV_FORMAT_NODE_ARRAY; each entry * is an argument using an arbitrary format (the format must be * compatible to the used command). Usually, the first item is @@ -869,6 +874,8 @@ int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); * Same as mpv_command, but use input.conf parsing for splitting arguments. * This is slightly simpler, but also more error prone, since arguments may * need quoting/escaping. + * + * This also has OSD and string expansion enabled by default. */ int mpv_command_string(mpv_handle *ctx, const char *args); -- cgit v1.2.3