vlc_vout_osd.h 3.21 KB
 Laurent Aimar committed May 04, 2010 1 2 3 ``````/***************************************************************************** * vlc_vout_osd.h: vout OSD ***************************************************************************** `````` Jean-Baptiste Kempf committed Nov 27, 2011 4 `````` * Copyright (C) 1999-2010 VLC authors and VideoLAN `````` Laurent Aimar committed May 04, 2010 5 6 7 8 9 10 `````` * Copyright (C) 2004-2005 M2X * \$Id\$ * * Authors: Jean-Paul Saman * Gildas Bazin * `````` Jean-Baptiste Kempf committed Nov 27, 2011 11 12 13 `````` * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 of the License, or `````` Laurent Aimar committed May 04, 2010 14 15 16 17 `````` * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of `````` Jean-Baptiste Kempf committed Nov 27, 2011 18 19 `````` * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. `````` Laurent Aimar committed May 04, 2010 20 `````` * `````` Jean-Baptiste Kempf committed Nov 27, 2011 21 22 23 `````` * You should have received a copy of the GNU Lesser General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. `````` Laurent Aimar committed May 04, 2010 24 25 26 27 28 29 30 31 32 `````` *****************************************************************************/ #ifndef VLC_VOUT_OSD_H #define VLC_VOUT_OSD_H 1 #ifdef __cplusplus extern "C" { #endif `````` Rémi Denis-Courmont committed Jun 14, 2015 33 34 35 36 37 38 39 40 ``````/** * \defgroup osd On-screen display * \ingroup spu * @{ * \file * Overlay text and widgets */ `````` Rémi Denis-Courmont committed Jun 24, 2015 41 42 43 ``````//* Default subpicture channel ID */ #define SPU_DEFAULT_CHANNEL (1) `````` Laurent Aimar committed May 04, 2010 44 45 46 ``````/** * OSD menu position and picture type defines */ `````` Laurent Aimar committed May 10, 2010 47 48 49 50 51 52 53 54 55 56 57 ``````enum { /* Icons */ OSD_PLAY_ICON = 1, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON, /* Sliders */ OSD_HOR_SLIDER, OSD_VERT_SLIDER, }; `````` Laurent Aimar committed May 04, 2010 58 `````` `````` Rémi Denis-Courmont committed May 07, 2011 59 ``````VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * ); `````` Laurent Aimar committed May 04, 2010 60 61 `````` /** `````` Laurent Aimar committed May 10, 2010 62 63 64 65 66 67 68 `````` * \brief Write an informative message if the OSD option is enabled. * \param vout The vout on which the message will be displayed * \param channel Subpicture channel * \param position Position of the text * \param duration Duration of the text being displayed * \param text Text to be displayed */ `````` Rémi Denis-Courmont committed May 07, 2011 69 ``````VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, mtime_t duration, const char *text ); `````` Laurent Aimar committed May 10, 2010 70 71 72 73 74 75 76 77 78 79 `````` /** * \brief Write an informative message at the default location, * for the default duration and only if the OSD option is enabled. * \param vout The vout on which the message will be displayed * \param channel Subpicture channel * \param format printf style formatting * * Provided for convenience. */ `````` Rémi Denis-Courmont committed May 07, 2011 80 ``````VLC_API void vout_OSDMessage( vout_thread_t *, int, const char *, ... ) VLC_FORMAT( 3, 4 ); `````` Laurent Aimar committed May 04, 2010 81 82 83 84 85 86 87 88 `````` /** * Display a slider on the video output. * \param p_this The object that called the function. * \param i_channel Subpicture channel * \param i_postion Current position in the slider * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER. */ `````` Rémi Denis-Courmont committed May 07, 2011 89 ``````VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short ); `````` Laurent Aimar committed May 04, 2010 90 91 92 93 94 95 96 `````` /** * Display an Icon on the video output. * \param p_this The object that called the function. * \param i_channel Subpicture channel * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON */ `````` Rémi Denis-Courmont committed May 07, 2011 97 ``````VLC_API void vout_OSDIcon( vout_thread_t *, int, short ); `````` Laurent Aimar committed May 04, 2010 98 `````` `````` Rémi Denis-Courmont committed Jun 14, 2015 99 ``````/** @} */ `````` Laurent Aimar committed May 04, 2010 100 101 102 103 104 105 ``````#ifdef __cplusplus } #endif #endif /* VLC_VOUT_OSD_H */ ``````