VLC  2.2.0-git
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions
Interface

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

Collaboration diagram for Interface:

Modules

 Log messages subscription
 These functions deal with log messages.
 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...

Macros

#define pl_CurrentInput(intf)   (playlist_CurrentInput(pl_Get(intf)))
 Retrieves the current input thread from the playlist.
#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;*.wax;*.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

int intf_Create (playlist_t *, const char *)
 Create and start an interface.
void libvlc_Quit (libvlc_int_t *)
 Posts an exit signal to LibVLC instance.
static playlist_tpl_Get (struct intf_thread_t *intf)

Detailed Description

These functions and structures are for interface management.

Macro Definition Documentation

#define CONSOLE_INTRO_MSG   (void)0
#define EXTENSIONS_AUDIO
#define EXTENSIONS_AUDIO_CSV
Value:
"3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
"amr", "aob", "ape", "awb", "caf", "dts", "flac", "it", "kar", \
"m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
"oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "thd", "tta", \
"voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"
#define EXTENSIONS_MEDIA
Value:
EXTENSIONS_PLAYLIST
#define EXTENSIONS_PLAYLIST   "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.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;*.mks;" \
"*.vtt"
#define EXTENSIONS_VIDEO
Value:
"*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
"*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
"*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
"*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
"*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
#define EXTENSIONS_VIDEO_CSV
Value:
"3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "divx", "drc", "dv", \
"f4v", "flv", "gvi", "gxf", "iso", \
"m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
"mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
"mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
"ogg", "ogm", "ogv", "ogx", "ps", \
"rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
"webm", "wm", "wmv", "wtv", "xesc"
#define INTF_ABOUT_MSG   LICENSE_MSG
#define pl_CurrentInput (   intf)    (playlist_CurrentInput(pl_Get(intf)))

Retrieves the current input thread from the playlist.

Note
The returned object must be released with vlc_object_release().

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

int intf_Create ( playlist_t playlist,
const char *  chain 
)

Create and start an interface.

Parameters
playlistplaylist and parent object for the interface
chainconfiguration chain string
Returns
VLC_SUCCESS or an error code

< Not enough memory

< No error

< Unspecified error

References _, AddIntfCallback(), config_ChainCreate(), config_ChainDestroy(), lock, module_need, module_unneed, msg_Err, intf_thread_t::p_cfg, intf_thread_t::p_module, intf_thread_t::p_next, pl_priv, vlc_value_t::psz_string, text, unlikely, var_AddCallback, var_Change, var_Create, vlc_custom_create, VLC_EGENERIC, VLC_ENOMEM, vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_release, VLC_SUCCESS, VLC_VAR_ADDCHOICE, VLC_VAR_HASCHOICE, VLC_VAR_ISCOMMAND, VLC_VAR_SETTEXT, and VLC_VAR_STRING.

Referenced by AddIntfCallback(), and libvlc_InternalAddIntf().

void libvlc_Quit ( libvlc_int_t p_libvlc)

Posts an exit signal to LibVLC instance.

This function should only be called on behalf of the user.

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

Referenced by libvlc_InternalCleanup(), and LoopRequest().

static playlist_t* pl_Get ( struct intf_thread_t intf)
inlinestatic