VLC  3.0.0-git
Files | Enumerations | Functions
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 *, input_item_t *)
 Show EPG information about the current program of an input item. More...
 
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. More...
 
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. More...
 
void vout_OSDSlider (vout_thread_t *, int, int, short)
 Display a slider on the video output. More...
 
void vout_OSDIcon (vout_thread_t *, int, short)
 Display an Icon on the video output. More...
 

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 
)

◆ vout_OSDIcon()

void vout_OSDIcon ( vout_thread_t ,
int  ,
short   
)

Display an Icon on the video output.

Parameters
p_thisThe object that called the function.
i_channelSubpicture channel
i_typeTypes are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON

References OSDWidget().

◆ vout_OSDMessage()

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
voutThe vout on which the message will be displayed
channelSubpicture channel
formatprintf style formatting

Provided for convenience.

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

Referenced by input_AddSubtitleOSD(), and VoutOsdSnapshot().

◆ vout_OSDSlider()

void vout_OSDSlider ( vout_thread_t ,
int  ,
int  ,
short   
)

Display a slider on the video output.

Parameters
p_thisThe object that called the function.
i_channelSubpicture channel
i_postionCurrent position in the slider
i_typeTypes are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.

References OSDWidget().

◆ vout_OSDText()

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
voutThe vout on which the message will be displayed
channelSubpicture channel
positionPosition of the text
durationDuration of the text being displayed
textText 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().