libvlc.h File Reference

LibVLC core external API. More...

Include dependency graph for libvlc.h:

Go to the source code of this file.

Data Structures
struct	libvlc_module_description_t
	Description of a module. More...

Macros
#define	LIBVLC_API
#define	LIBVLC_DEPRECATED

Typedefs
typedef struct libvlc_instance_t	libvlc_instance_t
	This structure is opaque.
typedef int64_t	libvlc_time_t
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 *p_event, void *p_data)
	Callback function notification.
typedef struct vlc_log_t	libvlc_log_t
typedef void(*	libvlc_log_cb) (void *data, int level, const libvlc_log_t *ctx, const char *fmt, va_list args)
	Callback prototype for LibVLC log message handler.
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_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.
libvlc_instance_t *	libvlc_retain (libvlc_instance_t *p_instance)
	Increments the reference count of a libvlc instance.
int	libvlc_abi_version (void)
	Get the ABI version of the libvlc library.
void	libvlc_set_user_agent (libvlc_instance_t *p_instance, const char *name, const char *http)
	Sets the application name.
void	libvlc_set_app_id (libvlc_instance_t *p_instance, const char *id, const char *version, const char *icon)
	Sets some meta-information about the application.
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.
void	libvlc_log_get_context (const libvlc_log_t *ctx, const char **module, const char **file, unsigned *line)
	Gets log message debug infos.
void	libvlc_log_get_object (const libvlc_log_t *ctx, const char **name, const char **header, uintptr_t *id)
	Gets log message info.
void	libvlc_log_unset (libvlc_instance_t *p_instance)
	Unsets the logging callback.
void	libvlc_log_set (libvlc_instance_t *p_instance, libvlc_log_cb cb, void *data)
	Sets the logging callback for a LibVLC instance.
void	libvlc_log_set_file (libvlc_instance_t *p_instance, FILE *stream)
	Sets up logging to a file.
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

LibVLC core external API.