Interface

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

Collaboration diagram for Interface:

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...
Modules
	Log messages subscription
	These functions deal with log messages.
	Interaction
	Interaction between user and modules.
Defines
#define	intf_Create(a, b)   intf_Create(VLC_OBJECT(a),b)
#define	CONSOLE_INTRO_MSG   (void)0
#define	INTF_ABOUT_MSG   LICENSE_MSG
#define	EXTENSIONS_AUDIO_CSV
#define	EXTENSIONS_VIDEO_CSV
#define	EXTENSIONS_AUDIO
#define	EXTENSIONS_VIDEO
#define	EXTENSIONS_PLAYLIST   "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wvx;*.zip;*.conf"
#define	EXTENSIONS_MEDIA
#define	EXTENSIONS_SUBTITLE
Typedefs
typedef struct intf_sys_t	intf_sys_t
typedef struct intf_thread_t	intf_thread_t
	Describe all interface-specific data of the interface thread.
typedef enum vlc_dialog	vlc_dialog_t
Enumerations
enum	vlc_dialog {   INTF_DIALOG_FILE_SIMPLE = 1, INTF_DIALOG_FILE, INTF_DIALOG_DISC, INTF_DIALOG_NET,   INTF_DIALOG_CAPTURE, INTF_DIALOG_SAT, INTF_DIALOG_DIRECTORY, INTF_DIALOG_STREAMWIZARD,   INTF_DIALOG_WIZARD, INTF_DIALOG_PLAYLIST, INTF_DIALOG_MESSAGES, INTF_DIALOG_FILEINFO,   INTF_DIALOG_PREFS, INTF_DIALOG_BOOKMARKS, INTF_DIALOG_EXTENDED, INTF_DIALOG_POPUPMENU = 20,   INTF_DIALOG_AUDIOPOPUPMENU, INTF_DIALOG_VIDEOPOPUPMENU, INTF_DIALOG_MISCPOPUPMENU, INTF_DIALOG_FILE_GENERIC = 30,   INTF_DIALOG_INTERACTION = 50, INTF_DIALOG_UPDATEVLC = 90, INTF_DIALOG_VLM, INTF_DIALOG_EXIT = 99 }
Functions
VLC_API int	intf_Create (vlc_object_t *, const char *)
	Create and start an interface.
VLC_API void	libvlc_Quit (libvlc_int_t *)
	Posts an exit signal to LibVLC instance.

---

Detailed Description

These functions and structures are for interface management.

---

Define Documentation

#define CONSOLE_INTRO_MSG   (void)0

#define EXTENSIONS_AUDIO

#define EXTENSIONS_AUDIO_CSV

Value:

"3ga", "669", "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
                         "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3", "mpc", "mpga", \
                         "oga", "ogg", "oma", "qcp", "ra", "rmi", "s3m", "spx", "thd", "tta", \
                         "wav", "wma", "wv", "xm"

#define EXTENSIONS_MEDIA

Value:

EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

#define EXTENSIONS_PLAYLIST   "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wvx;*.zip;*.conf"

#define EXTENSIONS_SUBTITLE

Value:

"*.cdg;*.idx;*.srt;" \
                            "*.sub;*.utf;*.ass;" \
                            "*.ssa;*.aqt;" \
                            "*.jss;*.psb;" \
                            "*.rt;*.smi;*.txt;" \
                            "*.smil;*.stl;*.usf" \
                            "*.dks;*.pjs;*.mpl2"

#define EXTENSIONS_VIDEO

Value:

"*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
                         "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wm;*.wmv"

#define EXTENSIONS_VIDEO_CSV

Value:

"asf", "avi", "divx", "drc", "dv", "f4v", "flv", "gvi", "gxf", "iso", \
                             "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
                             "mp2", "mp4", "mpeg", "mpeg1", \
                             "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "mxg", "nuv", \
                             "ogg", "ogm", "ogv", "ogx", "ps", \
                             "rec", "rm", "rmvb", "ts", "vob", "wm", "wmv"

#define INTF_ABOUT_MSG   LICENSE_MSG

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

Referenced by AddIntfCallback(), libvlc_InternalAddIntf(), and libvlc_InternalInit().

---

Typedef Documentation

typedef struct intf_sys_t intf_sys_t

typedef struct intf_thread_t intf_thread_t

Describe all interface-specific data of the interface thread.

typedef enum vlc_dialog vlc_dialog_t

---

Enumeration Type Documentation

enum vlc_dialog

Enumerator:

INTF_DIALOG_FILE_SIMPLE
INTF_DIALOG_FILE
INTF_DIALOG_DISC
INTF_DIALOG_NET
INTF_DIALOG_CAPTURE
INTF_DIALOG_SAT
INTF_DIALOG_DIRECTORY
INTF_DIALOG_STREAMWIZARD
INTF_DIALOG_WIZARD
INTF_DIALOG_PLAYLIST
INTF_DIALOG_MESSAGES
INTF_DIALOG_FILEINFO
INTF_DIALOG_PREFS
INTF_DIALOG_BOOKMARKS
INTF_DIALOG_EXTENDED
INTF_DIALOG_POPUPMENU
INTF_DIALOG_AUDIOPOPUPMENU
INTF_DIALOG_VIDEOPOPUPMENU
INTF_DIALOG_MISCPOPUPMENU
INTF_DIALOG_FILE_GENERIC
INTF_DIALOG_INTERACTION
INTF_DIALOG_UPDATEVLC
INTF_DIALOG_VLM
INTF_DIALOG_EXIT

---

Function Documentation

VLC_API int intf_Create	(	vlc_object_t *	p_this,
		const char *	chain
	)

Create and start an interface.

Parameters:

	p_this	the calling vlc_object_t
	chain	configuration chain string

Returns:

VLC_SUCCESS or an error code

References _, AddIntfCallback(), config_ChainCreate(), config_ChainDestroy(), libvlc_priv(), lock, module_need, module_unneed, msg_Err, intf_thread_t::p_cfg, libvlc_priv_t::p_intf, intf_thread_t::p_module, intf_thread_t::p_next, intf_thread_t::pf_run, vlc_value_t::psz_string, RunInterface(), strdup(), text, intf_thread_t::thread, var_AddCallback, var_Change, var_Create, var_CreateGetString, vlc_clone(), vlc_custom_create, vlc_join(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_kill, vlc_object_release, VLC_THREAD_PRIORITY_LOW, VLC_VAR_ADDCHOICE, VLC_VAR_HASCHOICE, VLC_VAR_ISCOMMAND, VLC_VAR_SETTEXT, and VLC_VAR_STRING.

VLC_API void libvlc_Quit

(

libvlc_int_t *

p_libvlc

)

Posts an exit signal to LibVLC instance.

This only emits a notification to the main thread. It might take a while before the actual cleanup occurs. This function should only be called on behalf of the user.

References libvlc_priv_t::exit, vlc_exit::handler, vlc_exit::killed, libvlc_priv(), vlc_exit::lock, msg_Dbg, vlc_exit::opaque, vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by libvlc_InternalCleanup(), and LoopRequest().