libvlc_event
[libvlc, libvlc_core]

Collaboration diagram for libvlc_event:

LibVLC Events. More...

Data Structures
struct	libvlc_event_t
	An Event. More...
Typedefs
typedef libvlc_event_manager_t	libvlc_event_manager_t
	Event manager that belongs to a libvlc object, and from whom events can be received.
typedef void(*)	libvlc_callback_t (const libvlc_event_t *, void *)
	Callback function notification.
Enumerations
enum	libvlc_event_type_t {   libvlc_MediaMetaChanged, libvlc_MediaSubItemAdded, libvlc_MediaDurationChanged, libvlc_MediaPreparsedChanged,   libvlc_MediaFreed, libvlc_MediaStateChanged, libvlc_MediaPlayerNothingSpecial, libvlc_MediaPlayerOpening,   libvlc_MediaPlayerBuffering, libvlc_MediaPlayerPlaying, libvlc_MediaPlayerPaused, libvlc_MediaPlayerStopped,   libvlc_MediaPlayerForward, libvlc_MediaPlayerBackward, libvlc_MediaPlayerEndReached, libvlc_MediaPlayerEncounteredError,   libvlc_MediaPlayerTimeChanged, libvlc_MediaPlayerPositionChanged, libvlc_MediaPlayerSeekableChanged, libvlc_MediaPlayerPausableChanged,   libvlc_MediaListItemAdded, libvlc_MediaListWillAddItem, libvlc_MediaListItemDeleted, libvlc_MediaListWillDeleteItem,   libvlc_MediaListViewItemAdded, libvlc_MediaListViewWillAddItem, libvlc_MediaListViewItemDeleted, libvlc_MediaListViewWillDeleteItem,   libvlc_MediaListPlayerPlayed, libvlc_MediaListPlayerNextItemSet, libvlc_MediaListPlayerStopped, libvlc_MediaDiscovererStarted,   libvlc_MediaDiscovererEnded }
Functions
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.
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.
const char *	libvlc_event_type_name (libvlc_event_type_t event_type)
	Get an event's type name.

---

Detailed Description

LibVLC Events.

---

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.

---

Enumeration Type Documentation

enum libvlc_event_type_t

Enumerator:

libvlc_MediaMetaChanged
libvlc_MediaSubItemAdded
libvlc_MediaDurationChanged
libvlc_MediaPreparsedChanged
libvlc_MediaFreed
libvlc_MediaStateChanged
libvlc_MediaPlayerNothingSpecial
libvlc_MediaPlayerOpening
libvlc_MediaPlayerBuffering
libvlc_MediaPlayerPlaying
libvlc_MediaPlayerPaused
libvlc_MediaPlayerStopped
libvlc_MediaPlayerForward
libvlc_MediaPlayerBackward
libvlc_MediaPlayerEndReached
libvlc_MediaPlayerEncounteredError
libvlc_MediaPlayerTimeChanged
libvlc_MediaPlayerPositionChanged
libvlc_MediaPlayerSeekableChanged
libvlc_MediaPlayerPausableChanged
libvlc_MediaListItemAdded
libvlc_MediaListWillAddItem
libvlc_MediaListItemDeleted
libvlc_MediaListWillDeleteItem
libvlc_MediaListViewItemAdded
libvlc_MediaListViewWillAddItem
libvlc_MediaListViewItemDeleted
libvlc_MediaListViewWillDeleteItem
libvlc_MediaListPlayerPlayed
libvlc_MediaListPlayerNextItemSet
libvlc_MediaListPlayerStopped
libvlc_MediaDiscovererStarted
libvlc_MediaDiscovererEnded

---

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

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

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

---