GESTrackTextOverlay

GESTrackTextOverlay — render text onto another video stream in a GESTimelineLayer

Synopsis

#include <ges/ges.h>

                    GESTrackTextOverlay;
GESTrackTextOverlay * ges_track_text_overlay_new        (void);
void                ges_track_text_overlay_set_font_desc
                                                        (GESTrackTextOverlay *self,
                                                         const gchar *font_desc);
void                ges_track_text_overlay_set_halignment
                                                        (GESTrackTextOverlay *self,
                                                         GESTextHAlign halign);
void                ges_track_text_overlay_set_text     (GESTrackTextOverlay *self,
                                                         const gchar *text);
void                ges_track_text_overlay_set_valignment
                                                        (GESTrackTextOverlay *self,
                                                         GESTextVAlign valign);
const char *        ges_track_text_overlay_get_font_desc
                                                        (GESTrackTextOverlay *self);
GESTextHAlign       ges_track_text_overlay_get_halignment
                                                        (GESTrackTextOverlay *self);
const gchar *       ges_track_text_overlay_get_text     (GESTrackTextOverlay *self);
GESTextVAlign       ges_track_text_overlay_get_valignment
                                                        (GESTrackTextOverlay *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GESTrackObject
               +----GESTrackOperation
                     +----GESTrackTextOverlay

Description

Details

GESTrackTextOverlay

typedef struct _GESTrackTextOverlay GESTrackTextOverlay;

ges_track_text_overlay_new ()

GESTrackTextOverlay * ges_track_text_overlay_new        (void);

Creates a new GESTrackTextOverlay.

Returns :

The newly created GESTrackTextOverlay or NULL if something went wrong.

ges_track_text_overlay_set_font_desc ()

void                ges_track_text_overlay_set_font_desc
                                                        (GESTrackTextOverlay *self,
                                                         const gchar *font_desc);

Sets the pango font description of the text this track object will render.

self :

the GESTrackTextOverlay

font_desc :

the pango font description

ges_track_text_overlay_set_halignment ()

void                ges_track_text_overlay_set_halignment
                                                        (GESTrackTextOverlay *self,
                                                         GESTextHAlign halign);

Sets the horizontal aligment of the text.

self :

the GESTrackTextOverlay* to set text on

halign :

The GESTextHAlign defining the horizontal alignment of the text render by self.

ges_track_text_overlay_set_text ()

void                ges_track_text_overlay_set_text     (GESTrackTextOverlay *self,
                                                         const gchar *text);

Sets the text this track object will render.

self :

the GESTrackTextOverlay* to set text on

text :

the text to render. an internal copy of this text will be made.

ges_track_text_overlay_set_valignment ()

void                ges_track_text_overlay_set_valignment
                                                        (GESTrackTextOverlay *self,
                                                         GESTextVAlign valign);

Sets the vertical aligment of the text.

self :

the GESTrackTextOverlay* to set text on

valign :

The GESTextVAlign defining the vertical alignment of the text render by self.

ges_track_text_overlay_get_font_desc ()

const char *        ges_track_text_overlay_get_font_desc
                                                        (GESTrackTextOverlay *self);

Get the pango font description currently set on source.

self :

a GESTrackTextOverlay

Returns :

The pango font description currently set on source.

ges_track_text_overlay_get_halignment ()

GESTextHAlign       ges_track_text_overlay_get_halignment
                                                        (GESTrackTextOverlay *self);

Get the horizontal aligment used by source.

self :

a GESTrackTextOverlay

Returns :

The horizontal aligment used by source.

ges_track_text_overlay_get_text ()

const gchar *       ges_track_text_overlay_get_text     (GESTrackTextOverlay *self);

Get the text currently set on source.

self :

a GESTrackTextOverlay

Returns :

The text currently set on source.

ges_track_text_overlay_get_valignment ()

GESTextVAlign       ges_track_text_overlay_get_valignment
                                                        (GESTrackTextOverlay *self);

Get the vertical aligment used by source.

self :

a GESTrackTextOverlay

Returns :

The vertical aligment used by source.