vlc_interface.h File Reference

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

Include dependency graph for vlc_interface.h:

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...
struct  interaction_t
 This structure contains the active interaction dialogs, and is used by the manager. 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)
#define CONSOLE_INTRO_MSG
#define INTF_ABOUT_MSG   LICENSE_MSG
#define EXTENSIONS_AUDIO
#define EXTENSIONS_VIDEO
#define EXTENSIONS_PLAYLIST   "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
#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_WARNING   0x40
#define DIALOG_USER_PROGRESS   0x80
#define DIALOG_INTF_PROGRESS   0x100
#define intf_UserFatal(a, b, c, d, e...)   __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
#define intf_UserWarn(a, c, d, e...)   __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
#define intf_UserLoginPassword(a, b, c, d, e...)   __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
#define intf_UserYesNo(a, b, c, d, e, f)   __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
#define intf_UserStringInput(a, b, c, d)   __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
#define intf_IntfProgress(a, b, c)   __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
#define intf_UserProgress(a, b, c, d, e)   __intf_Progress( VLC_OBJECT(a),b,c,d,e )
#define intf_ProgressUpdate(a, b, c, d, e)   __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
#define intf_ProgressIsCancelled(a, b)   __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
#define intf_UserHide(a, b)   __intf_UserHide( VLC_OBJECT(a), b )

Typedefs

typedef intf_dialog_args_t intf_dialog_args_t
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
}
enum  { DIALOG_DEFAULT, DIALOG_OK_YES, DIALOG_NO, DIALOG_CANCELLED }
 Possible return codes. More...
enum  {
  NEW_DIALOG, SENT_DIALOG, UPDATED_DIALOG, ANSWERED_DIALOG,
  HIDING_DIALOG, HIDDEN_DIALOG, DESTROYED_DIALOG
}
 Possible status. More...
enum  { INTERACT_DIALOG_ONEWAY, INTERACT_DIALOG_TWOWAY }
 Possible interaction types. More...
enum  { INTERACT_NEW, INTERACT_UPDATE, INTERACT_HIDE, INTERACT_DESTROY }
 Possible actions. More...

Functions

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.
int __intf_Eject (vlc_object_t *p_this, const char *psz_device)
 Ejects the CD /DVD.
int __intf_UserFatal (vlc_object_t *, bool, const char *, const char *,...)
 Send an error message, both in a blocking and non-blocking way.
int __intf_UserWarn (vlc_object_t *, const char *, const char *,...)
 Helper function to send a warning, which is always shown non-blocking.
int __intf_UserLoginPassword (vlc_object_t *, const char *, const char *, char **, char **)
 Helper function to make a login/password dialogue.
int __intf_UserYesNo (vlc_object_t *, const char *, const char *, const char *, const char *, const char *)
 Helper function to ask a yes-no-cancel question.
int __intf_UserStringInput (vlc_object_t *, const char *, const char *, char **)
 Helper function to make a dialogue asking the user for !password string.
int __intf_Progress (vlc_object_t *, const char *, const char *, float, int)
 Helper function to create a dialogue showing a progress-bar with some info.
void __intf_ProgressUpdate (vlc_object_t *, int, const char *, float, int)
 Update a progress bar in a dialogue.
bool __intf_UserProgressIsCancelled (vlc_object_t *, int)
 Helper function to communicate dialogue cancellations between the interface module and the caller.
void __intf_UserHide (vlc_object_t *, int)
 Hide an interaction dialog.


Detailed Description

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


Define Documentation

#define CONSOLE_INTRO_MSG

#define EXTENSIONS_AUDIO

Value:

"*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
                         "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.oma;*.spx;" \
                         "*.wav;*.wma;*.xm"

#define EXTENSIONS_MEDIA

Value:

#define EXTENSIONS_PLAYLIST   "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"

#define EXTENSIONS_SUBTITLE

Value:

"*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
                            "*.jss;*.psb;*.rt;*.smi"

#define EXTENSIONS_VIDEO

Value:

"*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
                         "*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
                         "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.ogg;*.ogm;" \
                         "*.ps;*.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 


Generated on Wed Aug 13 08:02:43 2008 for VLC by  doxygen 1.5.1