libvlc.h File Reference

This file defines libvlc external API. More...

Include dependency graph for libvlc.h:

Go to the source code of this file.

Data Structures
struct	libvlc_log_subscriber
	Data structure for a LibVLC logging callbacks. More...
struct	libvlc_module_description_t
	Description of a module. More...

Macros
#define	LIBVLC_API
#define	LIBVLC_DEPRECATED

Typedefs
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 int	libvlc_event_type_t
	Type of a LibVLC event.
typedef void(*	libvlc_callback_t )(const struct libvlc_event_t *, void *)
	Callback function notification.
typedef void(*	libvlc_log_cb )(void *data, int level, const char *fmt, va_list args)
	Callback prototype for LibVLC log message handler.
typedef struct libvlc_log_subscriber	libvlc_log_subscriber_t
	Data structure for a LibVLC logging callbacks.
typedef struct libvlc_module_description_t	libvlc_module_description_t
	Description of a module.

Enumerations
enum	libvlc_log_level { LIBVLC_DEBUG = 0, LIBVLC_NOTICE = 2, LIBVLC_WARNING = 3, LIBVLC_ERROR = 4 }
	Logging messages level. More...

Functions
const char *	libvlc_errmsg (void)
	A human-readable error message for the last LibVLC error in the calling thread.
void	libvlc_clearerr (void)
	Clears the LibVLC error status for the current thread.
const char *	libvlc_vprinterr (const char *fmt, va_list ap)
	Sets the LibVLC error status and message for the current thread.
const char *	libvlc_printerr (const char *fmt,...)
	Sets the LibVLC error status and message for the current thread.
libvlc_instance_t *	libvlc_new (int argc, const char *const *argv)
	Create and initialize a libvlc instance.
void	libvlc_release (libvlc_instance_t *p_instance)
	Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.
void	libvlc_retain (libvlc_instance_t *p_instance)
	Increments the reference count of a libvlc instance.
int	libvlc_add_intf (libvlc_instance_t *p_instance, const char *name)
	Try to start a user interface for the libvlc instance.
void	libvlc_set_exit_handler (libvlc_instance_t *p_instance, void(*cb)(void *), void *opaque)
	Registers a callback for the LibVLC exit event.
void	libvlc_wait (libvlc_instance_t *p_instance)
	Waits until an interface causes the instance to exit.
void	libvlc_set_user_agent (libvlc_instance_t *p_instance, const char *name, const char *http)
	Sets the application name.
const char *	libvlc_get_version (void)
	Retrieve libvlc version.
const char *	libvlc_get_compiler (void)
	Retrieve libvlc compiler version.
const char *	libvlc_get_changeset (void)
	Retrieve libvlc changeset.
void	libvlc_free (void *ptr)
	Frees an heap allocation returned by a LibVLC function.
int	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)
	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)
	Unregister an event notification.
const char *	libvlc_event_type_name (libvlc_event_type_t event_type)
	Get an event's type name.
void	libvlc_log_subscribe (libvlc_log_subscriber_t *sub, libvlc_log_cb cb, void *data)
	Registers a logging callback to LibVLC.
void	libvlc_log_subscribe_file (libvlc_log_subscriber_t *sub, FILE *stream)
	Registers a logging callback to a file.
void	libvlc_log_unsubscribe (libvlc_log_subscriber_t *sub)
	Deregisters a logging callback from LibVLC.
unsigned	libvlc_get_log_verbosity (const libvlc_instance_t *p_instance)
	Always returns minus one.
void	libvlc_set_log_verbosity (libvlc_instance_t *p_instance, unsigned level)
	This function does nothing.
libvlc_log_t *	libvlc_log_open (libvlc_instance_t *p_instance)
	This function does nothing useful.
void	libvlc_log_close (libvlc_log_t *p_log)
	Frees memory allocated by libvlc_log_open().
unsigned	libvlc_log_count (const libvlc_log_t *p_log)
	Always returns zero.
void	libvlc_log_clear (libvlc_log_t *p_log)
	This function does nothing.
libvlc_log_iterator_t *	libvlc_log_get_iterator (const libvlc_log_t *p_log)
	This function does nothing useful.
void	libvlc_log_iterator_free (libvlc_log_iterator_t *p_iter)
	Frees memory allocated by libvlc_log_get_iterator().
int	libvlc_log_iterator_has_next (const libvlc_log_iterator_t *p_iter)
	Always returns zero.
libvlc_log_message_t *	libvlc_log_iterator_next (libvlc_log_iterator_t *p_iter, libvlc_log_message_t *p_buf)
	Always returns NULL.
void	libvlc_module_description_list_release (libvlc_module_description_t *p_list)
	Release a list of module descriptions.
libvlc_module_description_t *	libvlc_audio_filter_list_get (libvlc_instance_t *p_instance)
	Returns a list of audio filters that are available.
libvlc_module_description_t *	libvlc_video_filter_list_get (libvlc_instance_t *p_instance)
	Returns a list of video filters that are available.
int64_t	libvlc_clock (void)
	Return the current time as defined by LibVLC.
static int64_t	libvlc_delay (int64_t pts)
	Return the delay (in microseconds) until a certain timestamp.

Detailed Description

This file defines libvlc external API.