libvlc_core
[libvlc]

Collaboration diagram for libvlc_core:

LibVLC Core. More...

Modules
	libvlc_exception
	LibVLC Exceptions handling.
	libvlc_event
	LibVLC Events.
	libvlc_log
	LibVLC Message Logging.
	libvlc_time
	LibVLC Time support in libvlc.
Functions
libvlc_instance_t *	libvlc_new (int, const char *const *, libvlc_exception_t *)
	Create and initialize a libvlc instance.
int	libvlc_get_vlc_id (libvlc_instance_t *p_instance)
	Return a libvlc instance identifier for legacy APIs.
void	libvlc_release (libvlc_instance_t *)
	Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.
void	libvlc_retain (libvlc_instance_t *)
	Increments the reference count of a libvlc instance.
void	libvlc_add_intf (libvlc_instance_t *p_instance, const char *name, libvlc_exception_t *p_exception)
	Try to start a user interface for the libvlc instance, and wait until the user exits.
void	libvlc_wait (libvlc_instance_t *p_instance)
	Waits until an interface causes the instance to exit.
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.

---

Detailed Description

LibVLC Core.

---

Function Documentation

void libvlc_add_intf	(	libvlc_instance_t *	p_instance,
		const char *	name,
		libvlc_exception_t *	p_exception
	)

Try to start a user interface for the libvlc instance, and wait until the user exits.

Parameters:

	p_instance	the instance
	name	interface name, or NULL for default
	p_exception	an initialized exception pointer

const char* libvlc_get_changeset

(

void

)

Retrieve libvlc changeset.

Example: "aa9bce0bc4"

Returns:

a string containing the libvlc changeset

const char* libvlc_get_compiler

(

void

)

Retrieve libvlc compiler version.

Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"

Returns:

a string containing the libvlc compiler version

const char* libvlc_get_version

(

void

)

Retrieve libvlc version.

Example: "0.9.0-git Grishenko"

Returns:

a string containing the libvlc version

int libvlc_get_vlc_id

(

libvlc_instance_t *

p_instance

)

Return a libvlc instance identifier for legacy APIs.

Use of this function is discouraged, you should convert your program to use the new API.

Parameters:

p_instance

the instance

Returns:

the instance identifier

libvlc_instance_t* libvlc_new	(	int	,
		const char *const *	,
		libvlc_exception_t *
	)

Create and initialize a libvlc instance.

Parameters:

	argc	the number of arguments
	argv	command-line-type arguments. argv[0] must be the path of the calling program.
	p_e	an initialized exception pointer

Returns:

the libvlc instance

Todo:

Look for interface settings. If we don't have any, add -I dummy

void libvlc_release

(

libvlc_instance_t *

)

Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.

Parameters:

p_instance

the instance to destroy

void libvlc_retain

(

libvlc_instance_t *

)

Increments the reference count of a libvlc instance.

The initial reference count is 1 after libvlc_new() returns.

Parameters:

p_instance

the instance to reference

void libvlc_wait

(

libvlc_instance_t *

p_instance

)

Waits until an interface causes the instance to exit.

You should start at least one interface first, using libvlc_add_intf().

Parameters:

p_instance

the instance

---