libmpv  20200718-git-96cdf53
development library for the MPV media player
Looking for a C++ dev?
I'm looking for work. Hire me!
mpv_event Struct Reference

#include <client.h>

Public Attributes

mpv_event_id event_id
 One of mpv_event. More...
 
int error
 This is mainly used for events that are replies to (asynchronous) requests. More...
 
uint64_t reply_userdata
 If the event is in reply to a request (made with this API and this API handle), this is set to the reply_userdata parameter of the request call. More...
 
void * data
 The meaning and contents of the data member depend on the event_id: MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) MPV_EVENT_END_FILE: mpv_event_end_file* MPV_EVENT_HOOK: mpv_event_hook* MPV_EVENT_COMMAND_REPLY* mpv_event_command* other: NULL. More...
 

Detailed Description

Definition at line 1713 of file client.h.

Member Data Documentation

◆ data

void* mpv_event::data

The meaning and contents of the data member depend on the event_id: MPV_EVENT_GET_PROPERTY_REPLY: mpv_event_property* MPV_EVENT_PROPERTY_CHANGE: mpv_event_property* MPV_EVENT_LOG_MESSAGE: mpv_event_log_message* MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message* MPV_EVENT_START_FILE: mpv_event_start_file* (since v1.108) 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 event types.

Definition at line 1757 of file client.h.

◆ error

int mpv_event::error

This is mainly used for events that are replies to (asynchronous) 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. Used for: MPV_EVENT_GET_PROPERTY_REPLY MPV_EVENT_SET_PROPERTY_REPLY MPV_EVENT_COMMAND_REPLY

Definition at line 1729 of file client.h.

◆ event_id

mpv_event_id mpv_event::event_id

One of mpv_event.

Keep in mind that later ABI compatible releases might add new event types. These should be ignored by the API user.

Definition at line 1718 of file client.h.

◆ reply_userdata

uint64_t mpv_event::reply_userdata

If the event is in reply to a request (made with this API and this API handle), this is set to the reply_userdata parameter of the request call.

Otherwise, this field is 0. Used for: MPV_EVENT_GET_PROPERTY_REPLY MPV_EVENT_SET_PROPERTY_REPLY MPV_EVENT_COMMAND_REPLY MPV_EVENT_PROPERTY_CHANGE MPV_EVENT_HOOK

Definition at line 1741 of file client.h.


The documentation for this struct was generated from the following file: