RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2025-04-11 04:01:31 +00:00
Code Issues Releases Wiki Activity

client API: fix description of mpv_event.error field

Browse Source 
The description was a left over from an earlier iteration of the API.
This commit is contained in:
wm4 2014-02-12 19:44:14 +01:00
parent 3abbe31d6b
commit 5af8070a97
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
libmpv/client.h
View File

@ -476,8 +476,8 @@ int mpv_set_property_string(mpv_handle *ctx, const char *name, const char *data)
/** /**
* Set a property asynchronously. You will receive the result of the operation * Set a property asynchronously. You will receive the result of the operation
* as MPV_EVENT_PROPERTY_SET_REPLY event. The mpv.error field will contain the * as MPV_EVENT_PROPERTY_SET_REPLY event. The mpv_event.error field will contain
* result status of the operation. Otherwise, this function is similar to * the result status of the operation. Otherwise, this function is similar to
* mpv_set_property(). * mpv_set_property().
* *
* @param reply_userdata see section about asynchronous calls * @param reply_userdata see section about asynchronous calls
@ -527,6 +527,7 @@ char *mpv_get_property_osd_string(mpv_handle *ctx, const char *name);
/** /**
* Get a property asynchronously. You will receive the result of the operation * Get a property asynchronously. You will receive the result of the operation
* as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event. * as well as the property data with the MPV_EVENT_GET_PROPERTY_REPLY event.
* You should check the mpv_event.error field on the reply event.
* *
* @param reply_userdata see section about asynchronous calls * @param reply_userdata see section about asynchronous calls
* @param name The property name. * @param name The property name.
@ -693,8 +694,10 @@ typedef struct mpv_event {
*/ */
mpv_event_id event_id; mpv_event_id event_id;
/** /**
* This is used for MPV_EVENT_ERROR only, and contains the error code. * This is mainly used for events that are replies to (asynchronous)
* It is set to 0 for all other events. * requests. It contains a status code, which is >= 0 on success, or < 0
* on error (a mpv_error value). Usually, this will be set if an
* asynchronous request fails.
*/ */
int error; int error;
/** /**