vlc_interface.h File Reference

This file contains structures and function prototypes for interface management in vlc. More...

Go to the source code of this file.

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...
struct	interaction_dialog_t
	This structure describes a piece of interaction with the user. More...
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;*.zip;*.conf"
#define	EXTENSIONS_MEDIA
#define	EXTENSIONS_SUBTITLE
#define	DIALOG_GOT_ANSWER   0x01
	Possible flags .
#define	DIALOG_YES_NO_CANCEL   0x02
#define	DIALOG_LOGIN_PW_OK_CANCEL   0x04
#define	DIALOG_PSZ_INPUT_OK_CANCEL   0x08
#define	DIALOG_BLOCKING_ERROR   0x10
#define	DIALOG_NONBLOCKING_ERROR   0x20
#define	DIALOG_USER_PROGRESS   0x80
#define	DIALOG_INTF_PROGRESS   0x100
#define	intf_UserStringInput(a, b, c, d)   (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
#define	interaction_Register(t)   (t, VLC_EGENERIC)
#define	interaction_Unregister(t)   (t, VLC_EGENERIC)
Typedefs
typedef struct intf_dialog_args_t	intf_dialog_args_t
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
typedef struct interaction_dialog_t	interaction_dialog_t
	This structure describes a piece of interaction with the user.
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 }
enum	{ DIALOG_OK_YES, DIALOG_NO, DIALOG_CANCELLED }
	Possible return codes. More...
enum	{ ANSWERED_DIALOG, DESTROYED_DIALOG }
	Possible status. More...
enum	{ INTERACT_NEW, INTERACT_UPDATE, INTERACT_HIDE, INTERACT_DESTROY }
	Possible actions. More...
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

This file contains structures and function prototypes for interface management in vlc.

---

Define Documentation

#define CONSOLE_INTRO_MSG   (void)0

#define EXTENSIONS_AUDIO

#define EXTENSIONS_AUDIO_CSV

Value:

"a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
                         "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3",\
                         "oga", "ogg", "oma", "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;*.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;*.dv;*f4v;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.nsv;*.nuv;" \
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
                         "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv"

#define EXTENSIONS_VIDEO_CSV

Value:

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

#define INTF_ABOUT_MSG   LICENSE_MSG

---

Typedef Documentation

typedef struct intf_dialog_args_t intf_dialog_args_t

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