vlc_vout_osd.h File Reference

Include dependency graph for vlc_vout_osd.h:

Go to the source code of this file.

Enumerations
enum	{   OSD_PLAY_ICON = 1, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON,   OSD_HOR_SLIDER, OSD_VERT_SLIDER }
	OSD menu position and picture type defines. More...

Functions
int	vout_OSDEpg (vout_thread_t *, input_item_t *)
	Show EPG information about the current program of an input item.
void	vout_OSDText (vout_thread_t *vout, int channel, int position, mtime_t duration, const char *text)
	Write an informative message if the OSD option is enabled.
void	vout_OSDMessage (vout_thread_t *, int, const char *,...)
	Write an informative message at the default location, for the default duration and only if the OSD option is enabled.
void	vout_OSDSlider (vout_thread_t *, int, int, short)
	Display a slider on the video output.
void	vout_OSDIcon (vout_thread_t *, int, short)
	Display an Icon on the video output.

Enumeration Type Documentation

anonymous enum

OSD menu position and picture type defines.

Enumerator:

OSD_PLAY_ICON
OSD_PAUSE_ICON
OSD_SPEAKER_ICON
OSD_MUTE_ICON
OSD_HOR_SLIDER
OSD_VERT_SLIDER

Function Documentation

int vout_OSDEpg	(	vout_thread_t *	vout,
		input_item_t *	input
	)

Show EPG information about the current program of an input item.

Parameters

vout	pointer to the vout the information is to be showed on
p_input	pointer to the input item the information is to be showed

< Unspecified error

< Unspecified error

< Unspecified error

< No error

References subpicture_t::b_absolute, subpicture_t::b_ephemer, subpicture_t::b_fade, subpicture_updater_sys_t::epg, subpicture_t::i_channel, input_item_t::i_epg, subpicture_t::i_start, subpicture_t::i_stop, input_item_GetNowPlaying(), input_item_t::lock, mdate(), OSDEpgDestroy(), OSDEpgUpdate(), OSDEpgValidate(), vlc_epg_t::p_current, subpicture_updater_t::pf_validate, input_item_t::pp_epg, vlc_epg_event_t::psz_name, vlc_epg_t::psz_name, SPU_DEFAULT_CHANNEL, subpicture_New(), VLC_EGENERIC, vlc_epg_Delete(), vlc_epg_Merge(), vlc_epg_New(), vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, and vout_PutSubpicture().

void vout_OSDIcon	(	vout_thread_t *	,
		int	,
		short
	)

Display an Icon on the video output.

Parameters

p_this	The object that called the function.
i_channel	Subpicture channel
i_type	Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON

References OSDWidget().

void vout_OSDMessage	(	vout_thread_t *	,
		int	,
		const char *	,
			...
	)

Write an informative message at the default location, for the default duration and only if the OSD option is enabled.

Parameters

vout	The vout on which the message will be displayed
channel	Subpicture channel
format	printf style formatting

Provided for convenience.

References SUBPICTURE_ALIGN_RIGHT, SUBPICTURE_ALIGN_TOP, vasprintf(), and vout_OSDText().

Referenced by VoutOsdSnapshot().

void vout_OSDSlider	(	vout_thread_t *	,
		int	,
		int	,
		short
	)

Display a slider on the video output.

Parameters

p_this	The object that called the function.
i_channel	Subpicture channel
i_postion	Current position in the slider
i_type	Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.

References OSDWidget().

void vout_OSDText	(	vout_thread_t *	vout,
		int	channel,
		int	position,
		mtime_t	duration,
		const char *	text
	)

Write an informative message if the OSD option is enabled.

Parameters

vout	The vout on which the message will be displayed
channel	Subpicture channel
position	Position of the text
duration	Duration of the text being displayed
text	Text to be displayed

< Align the subpicture, but not the text inside

References subpicture_t::b_absolute, subpicture_t::b_ephemer, subpicture_t::b_fade, subpicture_t::i_channel, subpicture_t::i_start, subpicture_t::i_stop, mdate(), OSDTextDestroy(), OSDTextUpdate(), OSDTextValidate(), subpicture_updater_t::pf_validate, subpicture_updater_sys_t::position, strdup(), SUBPICTURE_ALIGN_MASK, subpicture_New(), subpicture_updater_sys_t::text, var_InheritBool, and vout_PutSubpicture().

Referenced by ThreadDisplayOsdTitle(), and vout_OSDMessage().