VLC  4.0.0-dev
Modules | Files | Data Structures | Macros | Typedefs | Enumerations | Functions

VLC user interfaces. More...

Collaboration diagram for Interface:

Modules

 User settings
 VLC provides a simple name-value dictionary for user settings.
 
 VLC dialog
 
 Interaction
 Interaction between user and modules.
 
 VLC playlist
 A VLC playlist contains a list of "playlist items".
 
 VLC renderer discovery
 
 Software updates
 Over-the-air VLC software updates.
 
 VLM
 VLC stream manager.
 

Files

file  vlc_interface.h
 VLC user interface 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 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;*.wpl;*.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. More...
 
typedef enum vlc_intf_dialog vlc_intf_dialog
 

Enumerations

enum  vlc_intf_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_PLAYLISTS , INTF_DIALOG_MESSAGES ,
  INTF_DIALOG_FILEINFO , INTF_DIALOG_PREFS , INTF_DIALOG_BOOKMARKS , INTF_DIALOG_EXTENDED ,
  INTF_DIALOG_RENDERER , INTF_DIALOG_POPUPMENU = 20 , INTF_DIALOG_AUDIOPOPUPMENU , INTF_DIALOG_VIDEOPOPUPMENU ,
  INTF_DIALOG_MISCPOPUPMENU , INTF_DIALOG_FILE_GENERIC = 30 , INTF_DIALOG_INTERACTION = 50 , INTF_DIALOG_SENDKEY = 51 ,
  INTF_DIALOG_UPDATEVLC = 90 , INTF_DIALOG_VLM , INTF_DIALOG_EXIT = 99
}
 

Functions

int intf_Create (libvlc_int_t *, const char *)
 Create and start an interface. More...
 
void libvlc_Quit (libvlc_int_t *)
 Posts an exit signal to LibVLC instance. More...
 
vlc_playlist_tvlc_intf_GetMainPlaylist (intf_thread_t *intf)
 Recover the main playlist from an interface module. More...
 

Detailed Description

VLC user interfaces.

Macro Definition Documentation

◆ EXTENSIONS_AUDIO

#define EXTENSIONS_AUDIO

◆ EXTENSIONS_AUDIO_CSV

#define EXTENSIONS_AUDIO_CSV
Value:
"3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
"amb", "amr", "aob", "ape", "au", "awb", "caf", "dts", "dsf", "dff", "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", "tak", "thd", "tta", \
"voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"

◆ EXTENSIONS_MEDIA

#define EXTENSIONS_MEDIA
Value:
EXTENSIONS_PLAYLIST
#define EXTENSIONS_VIDEO
Definition: vlc_interface.h:229
#define EXTENSIONS_AUDIO
Definition: vlc_interface.h:168

◆ EXTENSIONS_PLAYLIST

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

◆ EXTENSIONS_SUBTITLE

#define EXTENSIONS_SUBTITLE
Value:
"*.cdg;*.idx;*.srt;" \
"*.sub;*.utf;*.ass;" \
"*.ssa;*.aqt;" \
"*.jss;*.psb;" \
"*.rt;*.sami;*.smi;*.txt;" \
"*.smil;*.stl;*.usf;" \
"*.dks;*.pjs;*.mpl2;*.mks;" \
"*.vtt;*.tt;*.ttml;*.dfxp;" \
"*.scc"

◆ EXTENSIONS_VIDEO

#define EXTENSIONS_VIDEO
Value:
"*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.crf;*.dav;*.divx;*.drc;*.dv;*.dvr-ms;*.evo;*.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;*.tp;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"

◆ EXTENSIONS_VIDEO_CSV

#define EXTENSIONS_VIDEO_CSV
Value:
"3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "crf", "dav", "divx", "drc", "dv", "dvr-ms" \
"evo", "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"

◆ INTF_ABOUT_MSG

#define INTF_ABOUT_MSG   LICENSE_MSG

Typedef Documentation

◆ intf_sys_t

typedef struct intf_sys_t intf_sys_t

◆ intf_thread_t

typedef struct intf_thread_t intf_thread_t

Describe all interface-specific data of the interface thread.

◆ vlc_intf_dialog

Enumeration Type Documentation

◆ vlc_intf_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_PLAYLISTS 
INTF_DIALOG_MESSAGES 
INTF_DIALOG_FILEINFO 
INTF_DIALOG_PREFS 
INTF_DIALOG_BOOKMARKS 
INTF_DIALOG_EXTENDED 
INTF_DIALOG_RENDERER 
INTF_DIALOG_POPUPMENU 
INTF_DIALOG_AUDIOPOPUPMENU 
INTF_DIALOG_VIDEOPOPUPMENU 
INTF_DIALOG_MISCPOPUPMENU 
INTF_DIALOG_FILE_GENERIC 
INTF_DIALOG_INTERACTION 
INTF_DIALOG_SENDKEY 
INTF_DIALOG_UPDATEVLC 
INTF_DIALOG_VLM 
INTF_DIALOG_EXIT 

Function Documentation

◆ intf_Create()

int intf_Create ( libvlc_int_t libvlc,
const char *  chain 
)

◆ libvlc_Quit()

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 update_DownloadReal(), and vlc_player_input_HandleState().

◆ vlc_intf_GetMainPlaylist()

vlc_playlist_t* vlc_intf_GetMainPlaylist ( intf_thread_t intf)

Recover the main playlist from an interface module.

Returns
the main playlist (can't be NULL)

References libvlc_GetMainPlaylist(), and vlc_object_instance.