diff options
author | wm4 <wm4@nowhere> | 2014-06-07 10:44:21 +0200 |
---|---|---|
committer | wm4 <wm4@nowhere> | 2014-06-07 15:57:47 +0200 |
commit | a1000962e3ef3e4cf3f6ade8702ce055b38872a9 (patch) | |
tree | da8050c203f0744dfac71f32f170c85c7659d95f /libmpv/client.h | |
parent | 60e0833f1fe976b0bbb74aa60980bfb36d828dee (diff) | |
download | mpv-a1000962e3ef3e4cf3f6ade8702ce055b38872a9.tar.bz2 mpv-a1000962e3ef3e4cf3f6ade8702ce055b38872a9.tar.xz |
client API: change mpv_wait_event() timeout semantics
Now a negative timeout mean an infinite timeout. This is similar to the
poll() system call. Apparently this is more intuitive and less confusing
than specifying a "very high" value as timeout if you want to wait
forever.
For callers that never pass negative timeouts, nothing changes.
Diffstat (limited to 'libmpv/client.h')
-rw-r--r-- | libmpv/client.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/libmpv/client.h b/libmpv/client.h index 7e2dc1b98a..58512f9586 100644 --- a/libmpv/client.h +++ b/libmpv/client.h @@ -1122,7 +1122,8 @@ int mpv_request_log_messages(mpv_handle *ctx, const char *min_level); * * @param timeout Timeout in seconds, after which the function returns even if * no event was received. A MPV_EVENT_NONE is returned on - * timeout. Values <= 0 will disable waiting. + * timeout. A value of 0 will disable waiting. Negative values + * will wait with an infinite timeout. * @return A struct containing the event ID and other data. The pointer (and * fields in the struct) stay valid until the next mpv_wait_event() * call, or until mpv_destroy() is called. You must not write to |