libvlc_event
[libvlc, libvlc_core]
|
Detailed Description
LibVLC Events.LibVLC Available Events.
Define Documentation
| #define DEFINE_LIBVLC_EVENT_TYPES |
Typedef Documentation
| typedef void( * libvlc_callback_t)(const libvlc_event_t *, void *) |
Callback function notification.
- Parameters:
-
p_event the event triggering the callback
| typedef struct libvlc_event_manager_t libvlc_event_manager_t |
Event manager that belongs to a libvlc object, and from whom events can be received.
| typedef struct libvlc_event_t libvlc_event_t |
| typedef uint32_t libvlc_event_type_t |
Enumeration Type Documentation
| enum libvlc_event_type_t |
- Enumerator:
Function Documentation
| void libvlc_event_attach | ( | libvlc_event_manager_t * | p_event_manager, | |
| libvlc_event_type_t | i_event_type, | |||
| libvlc_callback_t | f_callback, | |||
| void * | user_data, | |||
| libvlc_exception_t * | p_e | |||
| ) |
Register for an event notification.
- Parameters:
-
p_event_manager the event manager to which you want to attach to. Generally it is obtained by vlc_my_object_event_manager() where my_object is the object you want to listen to. i_event_type the desired event to which we want to listen f_callback the function to call when i_event_type occurs user_data user provided data to carry with the event p_e an initialized exception pointer
References event_attach().
Referenced by install_md_listener(), install_playlist_observer(), libvlc_media_list_hierarchical_node_view(), libvlc_media_list_hierarchical_view(), libvlc_media_list_view_set_ml_notification_callback(), media_list_item_added(), and media_list_subitem_added().
| void libvlc_event_detach | ( | libvlc_event_manager_t * | p_event_manager, | |
| libvlc_event_type_t | i_event_type, | |||
| libvlc_callback_t | f_callback, | |||
| void * | p_user_data, | |||
| libvlc_exception_t * | p_e | |||
| ) |
Unregister an event notification.
- Parameters:
-
p_event_manager the event manager i_event_type the desired event to which we want to unregister f_callback the function to call when i_event_type occurs p_user_data user provided data to carry with the event p_e an initialized exception pointer
References libvlc_event_listeners_group_t::b_sublistener_removed, libvlc_event_manager_t::event_sending_lock, libvlc_event_listener_t::event_type, libvlc_event_listeners_group_t::event_type, i, libvlc_event_listener_t::is_asynchronous, libvlc_event_async_ensure_listener_removal(), libvlc_event_listeners_group_t::listeners, libvlc_event_manager_t::listeners_groups, libvlc_event_manager_t::object_lock, libvlc_event_listener_t::p_user_data, libvlc_event_listener_t::pf_callback, vlc_array_count(), vlc_array_item_at_index(), vlc_array_remove(), vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_UNUSED.
Referenced by hierarch_media_list_view_release(), hierarch_node_media_list_view_release(), libvlc_media_list_view_release(), media_list_item_deleted(), media_list_subitem_added(), uninstall_md_listener(), uninstall_media_player_observer(), and uninstall_playlist_observer().
| const char* libvlc_event_type_name | ( | libvlc_event_type_t | event_type | ) |
Get an event's type name.
- Parameters:
-
i_event_type the desired event
References event_type_to_name, libvlc_num_event_types, and unknown_event_name.
Referenced by event_attach().
