summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2020-02-24 00:09:51 +0100
committerwm4 <wm4@nowhere>2020-02-24 00:09:51 +0100
commita9e6b9ea36ddb430f8d7a45cf85df1dc01e5acca (patch)
tree9a07670e63c43249b075fb8d86fd61edad6b8473
parent0ec036bfd8b82339ea65278302a3b771648d7aff (diff)
downloadmpv-a9e6b9ea36ddb430f8d7a45cf85df1dc01e5acca.tar.bz2
mpv-a9e6b9ea36ddb430f8d7a45cf85df1dc01e5acca.tar.xz
client API: minor clarification when asynchronous commands send events
-rw-r--r--libmpv/client.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index 2700ad70d9..ce880e1012 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -1011,6 +1011,11 @@ int mpv_command_string(mpv_handle *ctx, const char *args);
* error code set if running the command failed. For commands that
* return data, the data is put into mpv_event_command.result.
*
+ * The only case when you do not receive an event is when the function call
+ * itself fails. This happens only if parsing the command itself (or otherwise
+ * validating it) fails, i.e. the return code of the API call is not 0 or
+ * positive.
+ *
* Safe to be called from mpv render API threads.
*
* @param reply_userdata the value mpv_event.reply_userdata of the reply will