libvlc.h File Reference

Go to the source code of this file.

Data Structures
struct	msg_queue_t
struct	msg_bank_t
	Store all data required by messages interfaces. More...
struct	msg_context_t
	Internal message stack context. More...
struct	libvlc_global_data_t
	libvlc_global_data_t (global variable) More...
struct	vlc_object_internals_t
	Private LibVLC data for each object. More...
struct	libvlc_priv_t
	Private LibVLC instance data. More...
struct	dirent
Defines
#define	LIBVLC_LIBVLC_H   1
#define	vlc_refcheck(obj)   (void)0
#define	vlc_custom_create(o, s, t, n)   __vlc_custom_create(VLC_OBJECT(o), s, t, n)
#define	ZOOM_SECTION   N_("Zoom")
#define	ZOOM_QUARTER_KEY_TEXT   N_("1:4 Quarter")
#define	ZOOM_HALF_KEY_TEXT   N_("1:2 Half")
#define	ZOOM_ORIGINAL_KEY_TEXT   N_("1:1 Original")
#define	ZOOM_DOUBLE_KEY_TEXT   N_("2:1 Double")
#define	vlc_internals(obj)   (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
#define	libvlc_stats(o)   (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
#define	FILENAME_MAX   (260)
#define	opendir   vlc_opendir
#define	readdir   vlc_readdir
#define	closedir   vlc_closedir
#define	rewinddir   vlc_rewindir
Typedefs
typedef void	DIR
Functions
int	vlc_key_to_action (vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void *)
void	system_Init (libvlc_int_t *, int *, const char *[])
void	system_Configure (libvlc_int_t *, int *, const char *[])
void	system_End (libvlc_int_t *)
int	vlc_threads_init (void)
void	vlc_threads_end (void)
vlc_object_t *	vlc_threadobj (void)
uint32_t	CPUCapabilities (void)
void	msg_Create (libvlc_int_t *)
	Initialize messages queues This function initializes all message queues.
void	msg_Flush (libvlc_int_t *)
	Flush all message queues.
void	msg_Destroy (libvlc_int_t *)
	Destroy the message queues.
void	msg_StackSet (int, const char *,...)
void	msg_StackAdd (const char *,...)
const char *	msg_StackMsg (void)
void	msg_StackDestroy (void *)
char *	vlc_fix_readdir (const char *)
void *	__vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type, const char *psz_type)
	Creates a VLC object.
libvlc_global_data_t *	vlc_global (void)
static void	vlc_object_signal_maybe (vlc_object_t *p_this)
static libvlc_priv_t *	libvlc_priv (libvlc_int_t *libvlc)
void	playlist_ServicesDiscoveryKillAll (playlist_t *p_playlist)
void	var_OptionParse (vlc_object_t *, const char *, bool trusted)
	Parse a stringified option This function parse a string option and create the associated object variable The option must be of the form "[no[-]]foo[=bar]" where foo is the option name and bar is the value of the option.
void *	vlc_opendir (const char *)
void *	vlc_readdir (void *)
int	vlc_closedir (void *)
void	vlc_rewinddir (void *)
Variables
const char	vlc_usage []
hotkey	libvlc_hotkeys []
const size_t	libvlc_hotkeys_size
uint32_t	cpu_flags
vlc_threadvar_t	msg_context_global_key
	The global thread var for msg stack context We store this as a static global variable so we don't need a vlc_object_t everywhere.
module_config_t	libvlc_config []
	LibVLC "main module" configuration settings array.
const size_t	libvlc_config_count

---

Define Documentation

#define closedir   vlc_closedir

#define FILENAME_MAX   (260)

#define LIBVLC_LIBVLC_H   1

#define libvlc_stats

(

o

)

(libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)

#define opendir   vlc_opendir

#define readdir   vlc_readdir

#define rewinddir   vlc_rewindir

#define vlc_custom_create	(	o,
		s,
		t,
		n		)	__vlc_custom_create(VLC_OBJECT(o), s, t, n)

#define vlc_internals

(

obj

)

(((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)

#define vlc_refcheck

(

obj

)

(void)0

#define ZOOM_DOUBLE_KEY_TEXT   N_("2:1 Double")

#define ZOOM_HALF_KEY_TEXT   N_("1:2 Half")

#define ZOOM_ORIGINAL_KEY_TEXT   N_("1:1 Original")

#define ZOOM_QUARTER_KEY_TEXT   N_("1:4 Quarter")

#define ZOOM_SECTION   N_("Zoom")

---

Typedef Documentation

typedef void DIR

---

Function Documentation

void* __vlc_custom_create	(	vlc_object_t *	p_this,
		size_t	i_size,
		int	i_type,
		const char *	psz_type
	)

Creates a VLC object.

Note that because the object name pointer must remain valid, potentially even after the destruction of the object (through the message queues), this function CANNOT be exported to plugins as is. In this case, the old vlc_object_create() must be used instead.

Parameters:

	p_this	an existing VLC object
	i_size	byte size of the object structure
	i_type	object type, usually VLC_OBJECT_CUSTOM
	psz_type	object type name

Returns:

the created object, or NULL.

uint32_t CPUCapabilities

(

void

)

static libvlc_priv_t* libvlc_priv

(

libvlc_int_t *

libvlc

)

[inline, static]

void msg_Create

(

libvlc_int_t *

)

Initialize messages queues This function initializes all message queues.

void msg_Destroy

(

libvlc_int_t *

p_libvlc

)

Destroy the message queues.

This functions prints all messages remaining in the queues, then frees all the allocated ressources No other messages interface functions should be called after this one.

void msg_Flush

(

libvlc_int_t *

)

Flush all message queues.

void msg_StackAdd	(	const char *	,
			...
	)

void msg_StackDestroy

(

void *

)

const char* msg_StackMsg

(

void

)

void msg_StackSet	(	int	,
		const char *	,
			...
	)

void playlist_ServicesDiscoveryKillAll

(

playlist_t *

p_playlist

)

void system_Configure	(	libvlc_int_t *	,
		int *	,
		const char *	[]
	)

void system_End

(

libvlc_int_t *

)

void system_Init	(	libvlc_int_t *	,
		int *	,
		const char *	[]
	)

void var_OptionParse	(	vlc_object_t *	p_obj,
		const char *	psz_option,
		bool	trusted
	)

Parse a stringified option This function parse a string option and create the associated object variable The option must be of the form "[no[-]]foo[=bar]" where foo is the option name and bar is the value of the option.

Parameters:

	p_obj	the object in which the variable must be created
	psz_option	the option to parse
	trusted	whether the option is set by a trusted input or not

Returns:

nothing

int vlc_closedir

(

void *

)

char* vlc_fix_readdir

(

const char *

)

libvlc_global_data_t* vlc_global

(

void

)

int vlc_key_to_action	(	vlc_object_t *	,
		const char *	,
		vlc_value_t	,
		vlc_value_t	,
		void *
	)

static void vlc_object_signal_maybe

(

vlc_object_t *

p_this

)

[inline, static]

void* vlc_opendir

(

const char *

)

void* vlc_readdir

(

void *

)

void vlc_rewinddir

(

void *

)

vlc_object_t* vlc_threadobj

(

void

)

void vlc_threads_end

(

void

)

int vlc_threads_init

(

void

)

---

Variable Documentation

uint32_t cpu_flags

module_config_t libvlc_config[]

LibVLC "main module" configuration settings array.

const size_t libvlc_config_count

struct hotkey libvlc_hotkeys[]

const size_t libvlc_hotkeys_size

vlc_threadvar_t msg_context_global_key

The global thread var for msg stack context We store this as a static global variable so we don't need a vlc_object_t everywhere.

This key is created in vlc_threads_init and is therefore ready to use at the very beginning of the universe

const char vlc_usage[]

---