Video Subpictures
[Video Output, Subpicture Unit]

Classes
struct	subpicture_region_t
struct	subpicture_t
Defines
#define	vout_CopyPicture(a, b, c)   __vout_CopyPicture(VLC_OBJECT(a),b,c)
#define	vout_InitPicture(a, b, c, d, e, f)   __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
#define	vout_AllocatePicture(a, b, c, d, e, f)   __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
#define	vout_OSDMessage   __vout_OSDMessage
Functions
void	spu_Attach (spu_t *, vlc_object_t *, vlc_bool_t)
	VLC_EXPORT (int, vout_ShowTextRelative,(vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t))
	VLC_EXPORT (int, vout_ShowTextAbsolute,(vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t))
	VLC_EXPORT (void, __vout_OSDMessage,(vlc_object_t *, int, char *,...))
	VLC_EXPORT (void, vout_OSDSlider,(vlc_object_t *, int, int, short))
	VLC_EXPORT (void, vout_OSDIcon,(vlc_object_t *, int, short))

---

Detailed Description

Subpictures are pictures that should be displayed on top of the video, like subtitles and OSD

---

Define Documentation

#define vout_AllocatePicture (  a, b, c, d, e, f   )     __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)

vout_AllocatePicture Initialise different fields of a picture_t and allocates the picture buffer. Parameters: p_this  a vlc object p_pic  pointer to the picture structure. i_chroma  the wanted chroma for the picture. i_width  the wanted width for the picture. i_height  the wanted height for the picture. i_aspect  the wanted aspect ratio for the picture. Definition at line 346 of file vlc_video.h. Referenced by vout_RenderPicture().

#define vout_CopyPicture (  a, b, c   )     __vout_CopyPicture(VLC_OBJECT(a),b,c)

vout_CopyPicture Copy the source picture onto the destination picture. Parameters: p_this  a vlc object p_dst  pointer to the destination picture. p_src  pointer to the source picture. Definition at line 317 of file vlc_video.h. Referenced by vout_RenderPicture().

#define vout_InitPicture (  a, b, c, d, e, f   )     __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)

vout_InitPicture Initialise different fields of a picture_t (but does not allocate memory). Parameters: p_this  a vlc object p_pic  pointer to the picture structure. i_chroma  the wanted chroma for the picture. i_width  the wanted width for the picture. i_height  the wanted height for the picture. i_aspect  the wanted aspect ratio for the picture. Definition at line 331 of file vlc_video.h.

#define vout_OSDMessage   __vout_OSDMessage

Same as __vlc_OSDMessage() but with automatic casting Definition at line 400 of file vlc_video.h.

---

Function Documentation

void spu_Attach (  spu_t *  p_spu, vlc_object_t *  p_this, vlc_bool_t  b_attach )

Attach/Detach the SPU from any input Parameters: p_this  the object in which to destroy the subpicture unit b_attach  to select attach or detach Definition at line 219 of file vout_subpictures.c. References var_AddCallback, and var_DelCallback.

VLC_EXPORT (  void  , vout_OSDIcon  , (vlc_object_t *, int, short)  )

vout_OSDIcon 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 See also: vlc_osd.h

VLC_EXPORT (  void  , vout_OSDSlider  , (vlc_object_t *, int, int, short)  )

vout_OSDSlider 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. See also: vlc_osd.h

VLC_EXPORT (  void  , __vout_OSDMessage  , (vlc_object_t *, int, char *,...)  )

vout_OSDMessage Write an informative message at the default location, for the default duration and only if the OSD option is enabled. Parameters: p_caller  The object that called the function. i_channel  Subpicture channel psz_format  printf style formatting

VLC_EXPORT (  int  , vout_ShowTextAbsolute  , (vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t)  )

vout_ShowTextAbsolute Show text on the video from a given start date to a given end date Parameters: p_vout  pointer to the vout the text is to be showed on i_channel  Subpicture channel psz_string  The text to be shown p_style  Pointer to a struct with text style info i_flags  flags for alignment and such i_hmargin  horizontal margin in pixels i_vmargin  vertical margin in pixels i_start  the time when this string is to appear on the video i_stop  the time when this string should stop to be displayed if this is 0 the string will be shown untill the next string is about to be shown

VLC_EXPORT (  int  , vout_ShowTextRelative  , (vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t)  )

vout_ShowTextRelative Show text on the video for some time Parameters: p_vout  pointer to the vout the text is to be showed on i_channel  Subpicture channel psz_string  The text to be shown p_style  Pointer to a struct with text style info i_flags  flags for alignment and such i_hmargin  horizontal margin in pixels i_vmargin  vertical margin in pixels i_duration  Amount of time the text is to be shown.

---