Interface

Collaboration diagram for Interface:

These functions and structures are for interface management. More...

Modules
	Interaction
	Interaction between user and modules.
Data Structures
struct	intf_thread_t
	Describe all interface-specific data of the interface thread. More...
struct	intf_dialog_args_t
	Arguments passed to a dialogs provider This describes the arguments passed to the dialogs provider. More...
Defines
#define	intf_Create(a, b)   __intf_Create(VLC_OBJECT(a),b)
#define	intf_ShouldDie(p_intf)   (p_intf->b_die || p_intf->p_libvlc->b_die )
#define	intf_Eject(a, b)   __intf_Eject(VLC_OBJECT(a),b)
Functions
int	__intf_Eject (vlc_object_t *p_this, const char *psz_device)
	Ejects the CD /DVD.
intf_thread_t *	__intf_Create (vlc_object_t *, const char *)
	Create the interface, and prepare it for main loop.
int	intf_RunThread (intf_thread_t *)
	Starts and runs the interface thread.
void	intf_StopThread (intf_thread_t *)
	Stops the interface thread.

---

Detailed Description

These functions and structures are for interface management.

---

Define Documentation

#define intf_Create	(	a,
		b		)	__intf_Create(VLC_OBJECT(a),b)

#define intf_Eject	(	a,
		b		)	__intf_Eject(VLC_OBJECT(a),b)

#define intf_ShouldDie

(

p_intf

)

(p_intf->b_die || p_intf->p_libvlc->b_die )

---

Function Documentation

intf_thread_t* __intf_Create	(	vlc_object_t *	p_this,
		const char *	psz_module
	)

Create the interface, and prepare it for main loop.

Parameters:

	p_this	the calling vlc_object_t
	psz_module	a preferred interface module

Returns:

a pointer to the created interface thread, NULL on error

int __intf_Eject	(	vlc_object_t *	p_this,
		const char *	psz_device
	)

Ejects the CD /DVD.

Parameters:

	p_this	the calling vlc_object_t
	psz_device	the CD/DVD to eject

Returns:

0 on success, 1 on failure, -1 if not implemented

int intf_RunThread

(

intf_thread_t *

p_intf

)

Starts and runs the interface thread.

Parameters:

p_intf

the interface thread

Returns:

VLC_SUCCESS on success, an error number else

void intf_StopThread

(

intf_thread_t *

p_intf

)

Stops the interface thread.

This function asks the interface thread to stop

Parameters:

p_intf

the interface thread

Returns:

nothing

---