On-screen display

Collaboration diagram for On-screen display:

Files
file	vlc_vout_osd.h
	Overlay text and widgets.

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 *vout, input_item_t *input)
	Show EPG information about the current program of an input item.
void	vout_OSDText (vout_thread_t *vout, int channel, int position, vlc_tick_t duration, const char *text)
	Write an informative message if the OSD option is enabled.
void	vout_OSDMessageVa (vout_thread_t *vout, int channel, const char *format, va_list args)
	Write an informative message at the default location, for the default duration and only if the OSD option is enabled.
static void	vout_OSDMessage (vout_thread_t *vout, int channel, const char *format,...)
void	vout_OSDSlider (vout_thread_t *p_this, int i_channel, int i_position, short i_type)
	Display a slider on the video output.
void	vout_OSDIcon (vout_thread_t *p_this, int i_channel, short i_type)
	Display an Icon on the video output.

Detailed Description

Enumeration Type Documentation

anonymous enum

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

vout_OSDEpg()

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
input	pointer to the input item the information is to be showed

References epg_spu_updater_sys_t::art, subpicture_t::b_ephemer, subpicture_t::b_fade, subpicture_t::b_subtitle, epg_spu_updater_sys_t::epg, GetDefaultArtUri(), subpicture_t::i_channel, vlc_epg_event_t::i_duration, input_item_t::i_epg_time, vlc_epg_t::i_event, vlc_epg_event_t::i_id, vlc_epg_t::i_id, vlc_epg_t::i_source_id, vlc_epg_event_t::i_start, subpicture_t::i_start, subpicture_t::i_stop, input_item_GetMeta(), input_item_t::lock, epg_spu_updater_sys_t::obj, OSDEpgDestroy(), OSDEpgUpdate(), vlc_epg_t::p_current, input_item_t::p_epg_table, vlc_epg_t::pp_event, vlc_epg_t::psz_name, strdup(), subpicture_New(), subpicture_updater_t::sys, epg_spu_updater_sys_t::time, vlc_spu_updater_ops::update, VLC_EGENERIC, vlc_epg_AddEvent(), vlc_epg_Delete(), vlc_epg_event_Delete(), vlc_epg_event_Duplicate(), vlc_epg_New(), vlc_epg_SetCurrent(), vlc_meta_ArtworkURL, vlc_meta_Title, vlc_mutex_lock(), vlc_mutex_unlock(), VLC_OBJECT, VLC_SUCCESS, VLC_TICK_FROM_SEC, vlc_tick_now(), vout_PutSubpicture(), and VOUT_SPU_CHANNEL_OSD.

vout_OSDIcon()

void vout_OSDIcon	(	vout_thread_t *	p_this,
		int	i_channel,
		short	i_type
	)

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().

Referenced by vouts_osd_Icon().

vout_OSDMessage()

static void vout_OSDMessage ( vout_thread_t *  vout, int  channel, const char *  format,   ...  )

inlinestatic

References vout_OSDMessageVa().

Referenced by VoutOsdSnapshot().

vout_OSDMessageVa()

void vout_OSDMessageVa	(	vout_thread_t *	vout,
		int	channel,
		const char *	format,
		va_list	args
	)

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
args	format argument list

Provided for convenience.

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

Referenced by vlc_player_osd_Message(), vout_OSDMessage(), and vouts_osd_Message().

vout_OSDSlider()

void vout_OSDSlider	(	vout_thread_t *	p_this,
		int	i_channel,
		int	i_position,
		short	i_type
	)

Display a slider on the video output.

Parameters

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

References OSDWidget().

Referenced by vouts_osd_Slider().

vout_OSDText()

void vout_OSDText	(	vout_thread_t *	vout,
		int	channel,
		int	position,
		vlc_tick_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

References subpicture_t::b_ephemer, subpicture_t::b_fade, subpicture_t::i_channel, subpicture_t::i_start, subpicture_t::i_stop, OSDTextDestroy(), OSDTextUpdate(), osd_spu_updater_sys_t::position, strdup(), SUBPICTURE_ALIGN_MASK, subpicture_New(), subpicture_updater_t::sys, osd_spu_updater_sys_t::text, vlc_spu_updater_ops::update, var_InheritBool(), vlc_tick_now(), and vout_PutSubpicture().

Referenced by vout_DisplayTitle(), and vout_OSDMessageVa().