Include dependency graph for vlc_extensions.h:

Data Structures
struct	extension_t
	Extension descriptor: name, title, author, ... More...
struct	extensions_manager_t
	Extensions manager object. More...
struct	extension_dialog_command_t
	Command to pass to the extension dialog owner. More...
struct	extension_dialog_t
	Dialog descriptor for extensions. More...
struct	extension_widget_t
	Widget descriptor for extensions. More...
struct	extension_widget_t::extension_widget_value_t
Defines
#define	extension_Activate(mgr, ext) extension_Control( mgr, EXTENSION_ACTIVATE, ext )
	Activate or trigger an extension.
#define	extension_Trigger(mgr, ext) extension_Control( mgr, EXTENSION_TRIGGER, ext )
	Trigger the extension.
#define	extension_Deactivate(mgr, ext) extension_Control( mgr, EXTENSION_DEACTIVATE, ext )
	Deactivate an extension.
#define	extension_IsActivated(mgr, ext) __extension_GetBool( mgr, ext, EXTENSION_IS_ACTIVATED, false )
	Is this extension activated?
#define	extension_HasMenu(mgr, ext) __extension_GetBool( mgr, ext, EXTENSION_HAS_MENU, false )
	Does this extension have a sub-menu?
#define	extension_TriggerOnly(mgr, ext) __extension_GetBool( mgr, ext, EXTENSION_TRIGGER_ONLY, false )
	Can this extension only be triggered but not activated? Not compatible with HasMenu.
#define	extension_DialogClosed(dlg) extension_DialogCommand( dlg, EXTENSION_EVENT_CLOSE, NULL )
	Close the dialog.
#define	extension_WidgetClicked(dlg, wdg) extension_DialogCommand( dlg, EXTENSION_EVENT_CLICK, wdg )
	Forward a click on a widget.
#define	dialog_ExtensionUpdate(o, d) dialog_ExtensionUpdate(VLC_OBJECT(o), d)
Typedefs
typedef struct extensions_manager_sys_t	extensions_manager_sys_t
typedef struct extensions_manager_t	extensions_manager_t
typedef struct extension_sys_t	extension_sys_t
typedef struct extension_t	extension_t
	Extension descriptor: name, title, author, ...
typedef struct extension_dialog_t	extension_dialog_t
typedef struct extension_widget_t	extension_widget_t
Enumerations
enum	{ EXTENSION_ACTIVATE, EXTENSION_DEACTIVATE, EXTENSION_IS_ACTIVATED, EXTENSION_HAS_MENU, EXTENSION_GET_MENU, EXTENSION_TRIGGER_ONLY, EXTENSION_TRIGGER, EXTENSION_TRIGGER_MENU, EXTENSION_SET_INPUT, EXTENSION_PLAYING_CHANGED, EXTENSION_META_CHANGED }
enum	extension_dialog_event_e { EXTENSION_EVENT_CLICK, EXTENSION_EVENT_CLOSE }
	User interface event types. More...
enum	extension_widget_type_e { EXTENSION_WIDGET_LABEL, EXTENSION_WIDGET_BUTTON, EXTENSION_WIDGET_IMAGE, EXTENSION_WIDGET_HTML, EXTENSION_WIDGET_TEXT_FIELD, EXTENSION_WIDGET_PASSWORD, EXTENSION_WIDGET_DROPDOWN, EXTENSION_WIDGET_LIST, EXTENSION_WIDGET_CHECK_BOX, EXTENSION_WIDGET_SPIN_ICON }
	Widget types. More...
Functions
static int	extension_Control (extensions_manager_t *p_mgr, int i_control,...)
	Control function for extensions.
static bool	__extension_GetBool (extensions_manager_t p_mgr, extension_t p_ext, int i_flag, bool b_default)
	Helper for extension_HasMenu, extension_IsActivated...
static int	extension_GetMenu (extensions_manager_t p_mgr, extension_t p_ext, char *pppsz, uint16_t ppi)
	Get this extension's sub-menu.
static int	extension_TriggerMenu (extensions_manager_t p_mgr, extension_t p_ext, uint16_t i)
	Trigger an entry of the extension menu.
static int	extension_SetInput (extensions_manager_t p_mgr, extension_t p_ext, struct input_thread_t *p_input)
	Trigger an entry of the extension menu.
static int	extension_PlayingChanged (extensions_manager_t p_mgr, extension_t p_ext, int state)
static int	extension_MetaChanged (extensions_manager_t p_mgr, extension_t p_ext)
static int	extension_DialogCommand (extension_dialog_t p_dialog, extension_dialog_event_e event, void data)
	Send a command to an Extension dialog.
int	dialog_ExtensionUpdate (vlc_object_t , extension_dialog_t )

Define Documentation

#define dialog_ExtensionUpdate	(	o,
		d
	)		dialog_ExtensionUpdate(VLC_OBJECT(o), d)

#define extension_Activate	(	mgr,
		ext
	)		extension_Control( mgr, EXTENSION_ACTIVATE, ext )

Activate or trigger an extension.

#define extension_Deactivate	(	mgr,
		ext
	)		extension_Control( mgr, EXTENSION_DEACTIVATE, ext )

Deactivate an extension.

#define extension_DialogClosed ( dlg ) extension_DialogCommand( dlg, EXTENSION_EVENT_CLOSE, NULL )

Close the dialog.

Parameters:

dlg

The dialog

#define extension_HasMenu	(	mgr,
		ext
	)		__extension_GetBool( mgr, ext, EXTENSION_HAS_MENU, false )

Does this extension have a sub-menu?

#define extension_IsActivated	(	mgr,
		ext
	)		__extension_GetBool( mgr, ext, EXTENSION_IS_ACTIVATED, false )

Is this extension activated?

#define extension_Trigger	(	mgr,
		ext
	)		extension_Control( mgr, EXTENSION_TRIGGER, ext )

Trigger the extension.

Attention: NOT multithreaded!

#define extension_TriggerOnly	(	mgr,
		ext
	)		__extension_GetBool( mgr, ext, EXTENSION_TRIGGER_ONLY, false )

Can this extension only be triggered but not activated? Not compatible with HasMenu.

#define extension_WidgetClicked	(	dlg,
		wdg
	)		extension_DialogCommand( dlg, EXTENSION_EVENT_CLICK, wdg )

Forward a click on a widget.

Parameters:

	dlg	The dialog
	wdg	The widget (button, ...)

Typedef Documentation

typedef struct extension_dialog_t extension_dialog_t

typedef struct extension_sys_t extension_sys_t

typedef struct extension_t extension_t

Extension descriptor: name, title, author, ...

typedef struct extension_widget_t extension_widget_t

typedef struct extensions_manager_sys_t extensions_manager_sys_t

typedef struct extensions_manager_t extensions_manager_t

Enumeration Type Documentation

anonymous enum

Enumerator:

EXTENSION_ACTIVATE	arg1: extension_t*
EXTENSION_DEACTIVATE	arg1: extension_t*
EXTENSION_IS_ACTIVATED	arg1: extension_t, arg2: bool
EXTENSION_HAS_MENU	arg1: extension_t*
EXTENSION_GET_MENU	arg1: extension_t, arg2: char, arg3: uint16_t
EXTENSION_TRIGGER_ONLY	arg1: extension_t, arg2: bool
EXTENSION_TRIGGER	arg1: extension_t*
EXTENSION_TRIGGER_MENU	arg1: extension_t*, int (uint16_t)
EXTENSION_SET_INPUT	arg1: extension_t, arg2 (input_thread_t)
EXTENSION_PLAYING_CHANGED	arg1: extension_t*, arg2 int( playing status )
EXTENSION_META_CHANGED	arg1: extension_t, arg2 (input_item_t)

enum extension_dialog_event_e

User interface event types.

Enumerator:

EXTENSION_EVENT_CLICK	Click on a widget: data = widget.
EXTENSION_EVENT_CLOSE	Close the dialog: no data.

enum extension_widget_type_e

Widget types.

Enumerator:

EXTENSION_WIDGET_LABEL	Text label.
EXTENSION_WIDGET_BUTTON	Clickable button.
EXTENSION_WIDGET_IMAGE	Image label (psz_text is local URI).
EXTENSION_WIDGET_HTML	HTML or rich text area (non editable).
EXTENSION_WIDGET_TEXT_FIELD	Editable text line for user input.
EXTENSION_WIDGET_PASSWORD	Editable password input (******).
EXTENSION_WIDGET_DROPDOWN	Drop-down box.
EXTENSION_WIDGET_LIST	Vertical list box (of strings).
EXTENSION_WIDGET_CHECK_BOX	Checkable box with label.
EXTENSION_WIDGET_SPIN_ICON	A "loading..." spinning icon.

Function Documentation

static bool __extension_GetBool	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext,
		int	i_flag,
		bool	b_default
	)			`[inline, static]`

Helper for extension_HasMenu, extension_IsActivated...

Do not use.

References extension_Control(), and VLC_SUCCESS.

int dialog_ExtensionUpdate	(	vlc_object_t *	,
		extension_dialog_t *
	)

References dialog_GetProvider(), msg_Warn, extension_dialog_t::psz_title, var_SetAddress, and vlc_object_release.

static int extension_Control	(	extensions_manager_t *	p_mgr,
		int	i_control,
			...
	)			`[inline, static]`

Control function for extensions.

Every GUI -> extension command will go through this function.

References extensions_manager_t::pf_control, va_end(), and va_start().

Referenced by __extension_GetBool(), extension_GetMenu(), extension_MetaChanged(), extension_PlayingChanged(), extension_SetInput(), and extension_TriggerMenu().

static int extension_DialogCommand	(	extension_dialog_t *	p_dialog,
		extension_dialog_event_e	event,
		void *	data
	)			`[inline, static]`

Send a command to an Extension dialog.

Parameters:

	p_dialog	The dialog
	event

See also:: extension_dialog_event_e for a list of possible events

Parameters:

data

Optional opaque data,

See also:: extension_dialog_event_e

Returns:: VLC error code

References extension_dialog_command_t::event, extension_dialog_command_t::p_data, extension_dialog_command_t::p_dlg, and var_SetAddress.

static int extension_GetMenu	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext,
		char ***	pppsz,
		uint16_t **	ppi
	)			`[inline, static]`

Get this extension's sub-menu.

References extension_Control(), and EXTENSION_GET_MENU.

static int extension_MetaChanged	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext
	)			`[inline, static]`

References extension_Control(), and EXTENSION_META_CHANGED.

static int extension_PlayingChanged	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext,
		int	state
	)			`[inline, static]`

References extension_Control(), and EXTENSION_PLAYING_CHANGED.

static int extension_SetInput	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext,
		struct input_thread_t *	p_input
	)			`[inline, static]`

Trigger an entry of the extension menu.

References extension_Control(), and EXTENSION_SET_INPUT.

static int extension_TriggerMenu	(	extensions_manager_t *	p_mgr,
		extension_t *	p_ext,
		uint16_t	i
	)			`[inline, static]`

Trigger an entry of the extension menu.

References extension_Control(), and EXTENSION_TRIGGER_MENU.

vlc_extensions.h File Reference

Data Structures

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation