Data Structures | Defines | Functions

vlc_osd.h File Reference

This file defines SPU subpicture and OSD functions and object types. More...

Include dependency graph for vlc_osd.h:

Go to the source code of this file.

Data Structures

struct  osd_state_t
 OSD State object. More...
struct  osd_button_t
 OSD Button object. More...
struct  osd_menu_state_t
 OSD Menu State object. More...
struct  osd_menu_t
 OSD Menu object. More...

Defines

#define OSD_BUTTON_UNSELECT   0
 The OSD Menu configuration file format.
#define OSD_BUTTON_SELECT   1
#define OSD_BUTTON_PRESSED   2
#define OSD_MENU_STYLE_SIMPLE   0x0
 OSD Menu Style.
#define OSD_MENU_STYLE_CONCAT   0x1
#define osd_MenuCreate(object, file)   osd_MenuCreate( VLC_OBJECT(object), file )
#define osd_MenuDelete(object, osd)   osd_MenuDelete( VLC_OBJECT(object), osd )
#define osd_ButtonFind(object, x, y, h, w, sh, sw)   osd_ButtonFind(object,x,y,h,w,sh,sw)
#define osd_ButtonSelect(object, button)   osd_ButtonSelect(object,button)
#define osd_MenuShow(object)   osd_MenuShow( VLC_OBJECT(object) )
#define osd_MenuHide(object)   osd_MenuHide( VLC_OBJECT(object) )
#define osd_MenuActivate(object)   osd_MenuActivate( VLC_OBJECT(object) )
#define osd_MenuNext(object)   osd_MenuNext( VLC_OBJECT(object) )
#define osd_MenuPrev(object)   osd_MenuPrev( VLC_OBJECT(object) )
#define osd_MenuUp(object)   osd_MenuUp( VLC_OBJECT(object) )
#define osd_MenuDown(object)   osd_MenuDown( VLC_OBJECT(object) )
#define osd_Volume(object)   osd_Volume( VLC_OBJECT(object) )

Functions

osd_menu_tosd_MenuCreate (vlc_object_t *, const char *)
 Initialize an osd_menu_t object.
void osd_MenuDelete (vlc_object_t *, osd_menu_t *)
 Delete the osd_menu_t object.
osd_button_tosd_ButtonFind (vlc_object_t *p_this, int, int, int, int, int, int)
 Find OSD Menu button at position x,y.
void osd_ButtonSelect (vlc_object_t *, osd_button_t *)
 Select the button provided as the new active button.
void osd_MenuShow (vlc_object_t *)
 Show the OSD menu.
void osd_MenuHide (vlc_object_t *)
 Hide the OSD menu.
void osd_MenuActivate (vlc_object_t *)
 Activate the action of this OSD menu item.
void osd_MenuNext (vlc_object_t *)
 Next OSD menu item.
void osd_MenuPrev (vlc_object_t *)
 Previous OSD menu item.
void osd_MenuUp (vlc_object_t *)
 OSD menu item above.
void osd_MenuDown (vlc_object_t *)
 OSD menu item below.
void osd_Volume (vlc_object_t *)
 Display the audio volume bitmap.
static const osd_menu_state_tosd_GetMenuState (osd_menu_t *p_osd)
 Retrieve a non modifyable pointer to the OSD Menu state.
static bool osd_GetKeyPressed (osd_menu_t *p_osd)
 Get the last key press received by the OSD Menu.
static void osd_SetKeyPressed (vlc_object_t *p_this, int i_value)
 Set the key pressed to a value.
static void osd_SetMenuVisible (osd_menu_t *p_osd, bool b_value)
 Update the OSD Menu visibility flag.
static void osd_SetMenuUpdate (osd_menu_t *p_osd, bool b_value)
 Update the OSD Menu update flag.
int osd_ShowTextRelative (spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t)
 Textual feedback.
int osd_ShowTextAbsolute (spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t)
 Show text on the video from a given start date to a given end date.
void osd_Message (spu_t *, int, char *,...)
 Write an informative message at the default location, for the default duration and only if the OSD option is enabled.

Detailed Description

This file defines SPU subpicture and OSD functions and object types.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines