Modules | |
| User settings | |
| VLC dialog | |
| Interaction | |
| VLC playlist | |
| VLC renderer discovery | |
| Software updates | |
| VLM | |
Files | |
| file | vlc_interface.h |
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... | |
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... | |
Functions | |
| VLC_EXPORT int | intf_Create (libvlc_int_t *, const char *) |
| Create and start an interface. More... | |
| VLC_EXPORT void | libvlc_Quit (libvlc_int_t *) |
| Posts an exit signal to LibVLC instance. More... | |
| VLC_EXPORT vlc_playlist_t * | vlc_intf_GetMainPlaylist (intf_thread_t *intf) |
| Recover the main playlist from an interface module. More... | |
Detailed Description
VLC user interfaces
Macro Definition Documentation
◆ DIALOG_BLOCKING_ERROR
| #define DIALOG_BLOCKING_ERROR 0x10 |
◆ DIALOG_GOT_ANSWER
| #define DIALOG_GOT_ANSWER 0x01 |
Possible flags .
Dialog types
◆ DIALOG_INTF_PROGRESS
| #define DIALOG_INTF_PROGRESS 0x100 |
◆ DIALOG_LOGIN_PW_OK_CANCEL
| #define DIALOG_LOGIN_PW_OK_CANCEL 0x04 |
◆ DIALOG_NONBLOCKING_ERROR
| #define DIALOG_NONBLOCKING_ERROR 0x20 |
◆ DIALOG_PSZ_INPUT_OK_CANCEL
| #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08 |
◆ DIALOG_USER_PROGRESS
| #define DIALOG_USER_PROGRESS 0x80 |
◆ DIALOG_YES_NO_CANCEL
| #define DIALOG_YES_NO_CANCEL 0x02 |
◆ EXTENSIONS_AUDIO
| #define EXTENSIONS_AUDIO |
◆ EXTENSIONS_AUDIO_CSV
| #define EXTENSIONS_AUDIO_CSV |
◆ EXTENSIONS_MEDIA
| #define EXTENSIONS_MEDIA |
◆ 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 |
◆ EXTENSIONS_VIDEO
| #define EXTENSIONS_VIDEO |
◆ EXTENSIONS_VIDEO_CSV
| #define EXTENSIONS_VIDEO_CSV |
◆ interaction_Register
| #define interaction_Register | ( | t | ) | (t, VLC_EGENERIC) |
◆ interaction_Unregister
| #define interaction_Unregister | ( | t | ) | (t, VLC_EGENERIC) |
◆ INTF_ABOUT_MSG
| #define INTF_ABOUT_MSG LICENSE_MSG |
◆ intf_UserStringInput
| #define intf_UserStringInput | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) | (VLC_OBJECT(a),b,c,d, VLC_EGENERIC) |
Typedef Documentation
◆ interaction_dialog_t
| typedef struct interaction_dialog_t interaction_dialog_t |
This structure describes a piece of interaction with the user.
◆ 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
| typedef enum vlc_intf_dialog vlc_intf_dialog |
Enumeration Type Documentation
◆ anonymous enum
◆ anonymous enum
| anonymous enum |
◆ anonymous enum
| anonymous enum |
◆ vlc_intf_dialog
| enum vlc_intf_dialog |
Function Documentation
◆ intf_Create()
| VLC_EXPORT int intf_Create | ( | libvlc_int_t * | libvlc, |
| const char * | chain | ||
| ) |
Create and start an interface.
- Parameters
-
playlist playlist and parent object for the interface chain configuration chain string
- Returns
- VLC_SUCCESS or an error code
References _, AddIntfCallback(), config_ChainCreate(), config_ChainDestroy(), libvlc_priv_t::interfaces, libvlc_GetMainPlaylist(), libvlc_priv(), libvlc_priv_t::lock, module_need, module_unneed, msg_Err, intf_thread_t::p_cfg, intf_thread_t::p_module, intf_thread_t::p_next, vlc_value_t::psz_string, unlikely, var_AddCallback(), var_Change(), var_Create(), vlc_custom_create, VLC_EGENERIC, VLC_ENOMEM, vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_delete, VLC_SUCCESS, VLC_VAR_ADDCHOICE, VLC_VAR_ISCOMMAND, VLC_VAR_SETTEXT, and VLC_VAR_STRING.
Referenced by AddIntfCallback(), and libvlc_InternalAddIntf().
◆ libvlc_Quit()
| VLC_EXPORT 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_EXPORT 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.
◆ vlc_LogSet()
| VLC_EXPORT void vlc_LogSet | ( | libvlc_int_t * | vlc, |
| const struct vlc_logger_operations * | ops, | ||
| void * | opaque | ||
| ) |
Sets the message logging callback.
- Parameters
-
ops message callback, or NULL to clear data data pointer for the message callback
References discard_log, vlc_object_t::logger, libvlc_int_t::obj, vlc_logger::ops, vlc_LogExternalCreate(), vlc_LogSpam(), vlc_LogSwitch(), and VLC_OBJECT.
Variable Documentation
◆ b_cancelled
| bool interaction_dialog_t::b_cancelled |
was the dialogue cancelled ?
◆ b_multiple
| bool intf_dialog_args_t::b_multiple |
◆ b_save
| bool intf_dialog_args_t::b_save |
◆ i_action
| int interaction_dialog_t::i_action |
Action to perform;.
◆ i_flags
| int interaction_dialog_t::i_flags |
Misc flags.
◆ i_results
| int intf_dialog_args_t::i_results |
◆ i_return
| int interaction_dialog_t::i_return |
Return status.
◆ i_status
| int interaction_dialog_t::i_status |
Dialog status;.
◆ i_timeToGo
| int interaction_dialog_t::i_timeToGo |
time (in sec) until shown progress is finished
◆ i_type
| int interaction_dialog_t::i_type |
Type identifier.
◆ obj
| struct vlc_object_t intf_thread_t::obj |
◆ p_arg
| void* intf_dialog_args_t::p_arg |
◆ p_cfg
| config_chain_t* intf_thread_t::p_cfg |
Referenced by intf_Create(), and intf_DestroyAll().
◆ p_dialog
| struct interaction_dialog_t* intf_dialog_args_t::p_dialog |
◆ p_interface
| intf_thread_t* interaction_dialog_t::p_interface |
◆ p_intf
| intf_thread_t* intf_dialog_args_t::p_intf |
◆ p_lock
| vlc_mutex_t* interaction_dialog_t::p_lock |
◆ p_module
| module_t* intf_thread_t::p_module |
◆ p_next
| struct intf_thread_t* intf_thread_t::p_next |
Referenced by intf_Create(), and intf_DestroyAll().
◆ p_parent
| vlc_object_t* interaction_dialog_t::p_parent |
The vlc object that asked.
◆ p_private
| void* interaction_dialog_t::p_private |
Private interface data.
◆ p_sys
| intf_sys_t* intf_thread_t::p_sys |
LibVLC interfaces book keeping.
◆ pf_callback
| void(* intf_dialog_args_t::pf_callback) (intf_dialog_args_t *) |
◆ pf_show_dialog
| void( * intf_thread_t::pf_show_dialog) (struct intf_thread_t *, int, int, intf_dialog_args_t *) |
Specific for dialogs providers.
◆ psz_alternate_button
| char* interaction_dialog_t::psz_alternate_button |
alternate button title (~NO)
◆ psz_default_button
| char* interaction_dialog_t::psz_default_button |
default button title (~OK)
◆ psz_description
| char* interaction_dialog_t::psz_description |
Descriptor string.
◆ psz_extensions
| char* intf_dialog_args_t::psz_extensions |
◆ psz_other_button
| char* interaction_dialog_t::psz_other_button |
other button title (optional,~Cancel)
◆ psz_results
| char** intf_dialog_args_t::psz_results |
◆ psz_returned
| char* interaction_dialog_t::psz_returned[1] |
returned responses from the user
◆ psz_title [1/2]
| char* intf_dialog_args_t::psz_title |
◆ psz_title [2/2]
| char* interaction_dialog_t::psz_title |
Title.
◆ val
| vlc_value_t interaction_dialog_t::val |
value coming from core for dialogue
