diff options
author | wm4 <wm4@nowhere> | 2018-05-10 14:33:10 +0200 |
---|---|---|
committer | wm4 <wm4@nowhere> | 2018-05-24 19:56:34 +0200 |
commit | f0678afba010cfd13418641036309b3724cb9f66 (patch) | |
tree | c6cd5b463adfb2f2a43f1d7aae39c1ecb4684ec5 /libmpv | |
parent | 005d3bc81a86dddf458c0d19142815687a303877 (diff) | |
download | mpv-f0678afba010cfd13418641036309b3724cb9f66.tar.bz2 mpv-f0678afba010cfd13418641036309b3724cb9f66.tar.xz |
client API: add returning of data from async commands
This was not done sooner out of laziness.
Diffstat (limited to 'libmpv')
-rw-r--r-- | libmpv/client.h | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/libmpv/client.h b/libmpv/client.h index b276c54390..f9c9f3686b 100644 --- a/libmpv/client.h +++ b/libmpv/client.h @@ -223,7 +223,7 @@ extern "C" { * relational operators (<, >, <=, >=). */ #define MPV_MAKE_VERSION(major, minor) (((major) << 16) | (minor) | 0UL) -#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(1, 101) +#define MPV_CLIENT_API_VERSION MPV_MAKE_VERSION(1, 102) /** * The API user is allowed to "#define MPV_ENABLE_DEPRECATED 0" before @@ -967,10 +967,11 @@ int mpv_command_string(mpv_handle *ctx, const char *args); * Same as mpv_command, but run the command asynchronously. * * Commands are executed asynchronously. You will receive a - * MPV_EVENT_COMMAND_REPLY event. (This event will also have an - * error code set if running the command failed.) + * MPV_EVENT_COMMAND_REPLY event. This event will also have an + * error code set if running the command failed. For commands that + * return data, the data is put into mpv_event_command.result. * - * * Safe to be called from mpv render API threads. + * Safe to be called from mpv render API threads. * * @param reply_userdata the value mpv_event.reply_userdata of the reply will * be set to (see section about asynchronous calls) @@ -985,8 +986,7 @@ int mpv_command_async(mpv_handle *ctx, uint64_t reply_userdata, * function is to mpv_command_node() what mpv_command_async() is to * mpv_command(). * - * See mpv_command_async() for details. Retrieving the result is not - * supported yet. + * See mpv_command_async() for details. * * Safe to be called from mpv render API threads. * @@ -1211,7 +1211,8 @@ typedef enum mpv_event_id { */ MPV_EVENT_SET_PROPERTY_REPLY = 4, /** - * Reply to a mpv_command_async() request. + * Reply to a mpv_command_async() or mpv_command_node_async() request. + * See also mpv_event and mpv_event_command. */ MPV_EVENT_COMMAND_REPLY = 5, /** @@ -1558,6 +1559,17 @@ typedef struct mpv_event_hook { uint64_t id; } mpv_event_hook; +// Since API version 1.102. +typedef struct mpv_event_command { + /** + * Result data of the command. Note that success/failure is signaled + * separately via mpv_event.error. This field is only for result data + * in case of success. Most commands leave it at MPV_FORMAT_NONE. Set + * to MPV_FORMAT_NONE on failure. + */ + mpv_node result; +} mpv_event_command; + typedef struct mpv_event { /** * One of mpv_event. Keep in mind that later ABI compatible releases might @@ -1595,6 +1607,7 @@ typedef struct mpv_event { * MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* * MPV_EVENT_END_FILE: mpv_event_end_file* * MPV_EVENT_HOOK: mpv_event_hook* + * MPV_EVENT_COMMAND_REPLY* mpv_event_command* * other: NULL * * Note: future enhancements might add new event structs for existing or new |