GESTimelineTitleSource

GESTimelineTitleSource — Render stand-alone titles in GESTimelineLayer.

Synopsis

#include <ges/ges.h>

                    GESTimelineTitleSource;
GESTimelineTitleSource *  ges_timeline_title_source_new (void);
void                ges_timeline_title_source_set_text  (GESTimelineTitleSource *self,
                                                         const gchar *text);
void                ges_timeline_title_source_set_font_desc
                                                        (GESTimelineTitleSource *self,
                                                         const gchar *font_desc);
void                ges_timeline_title_source_set_halignment
                                                        (GESTimelineTitleSource *self,
                                                         GESTextHAlign halign);
void                ges_timeline_title_source_set_valignment
                                                        (GESTimelineTitleSource *self,
                                                         GESTextVAlign valign);
void                ges_timeline_title_source_set_mute  (GESTimelineTitleSource *self,
                                                         gboolean mute);
void                ges_timeline_title_source_set_color (GESTimelineTitleSource *self,
                                                         guint32 color);
void                ges_timeline_title_source_set_xpos  (GESTimelineTitleSource *self,
                                                         gdouble position);
void                ges_timeline_title_source_set_ypos  (GESTimelineTitleSource *self,
                                                         gdouble position);
const gchar *       ges_timeline_title_source_get_text  (GESTimelineTitleSource *self);
const gchar *       ges_timeline_title_source_get_font_desc
                                                        (GESTimelineTitleSource *self);
GESTextVAlign       ges_timeline_title_source_get_valignment
                                                        (GESTimelineTitleSource *self);
GESTextHAlign       ges_timeline_title_source_get_halignment
                                                        (GESTimelineTitleSource *self);
gboolean            ges_timeline_title_source_is_muted  (GESTimelineTitleSource *self);
const guint32       ges_timeline_title_source_get_color (GESTimelineTitleSource *self);
const gdouble       ges_timeline_title_source_get_xpos  (GESTimelineTitleSource *self);
const gdouble       ges_timeline_title_source_get_ypos  (GESTimelineTitleSource *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GESTimelineObject
               +----GESTimelineSource
                     +----GESTimelineTitleSource

Properties

  "color"                    guint                 : Read / Write / Construct
  "font-desc"                gchar*                : Read / Write / Construct
  "halignment"               GESTextHAlign         : Read / Write / Construct
  "mute"                     gboolean              : Read / Write / Construct
  "text"                     gchar*                : Read / Write / Construct
  "valignment"               GESTextVAlign         : Read / Write / Construct
  "xpos"                     gdouble               : Read / Write / Construct
  "ypos"                     gdouble               : Read / Write / Construct

Description

Renders the given text in the specified font, at specified position, and with the specified background pattern.

Note: creates a silent GESTrackAudioTestSource to fill audio tracks

Details

GESTimelineTitleSource

typedef struct _GESTimelineTitleSource GESTimelineTitleSource;

Render stand-alone titles in GESTimelineLayer.

ges_timeline_title_source_new ()

GESTimelineTitleSource *  ges_timeline_title_source_new (void);

Creates a new GESTimelineTitleSource

Returns :

 The newly created GESTimelineTitleSource, or NULL if there was an error.

ges_timeline_title_source_set_text ()

void                ges_timeline_title_source_set_text  (GESTimelineTitleSource *self,
                                                         const gchar *text);

Sets the text this timeline object will render.

self :

 the GESTimelineTitleSource* to set text on

text :

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

ges_timeline_title_source_set_font_desc ()

void                ges_timeline_title_source_set_font_desc
                                                        (GESTimelineTitleSource *self,
                                                         const gchar *font_desc);

Sets the pango font description of the text.

self :

 the GESTimelineTitleSource*

font_desc :

 the pango font description

ges_timeline_title_source_set_halignment ()

void                ges_timeline_title_source_set_halignment
                                                        (GESTimelineTitleSource *self,
                                                         GESTextHAlign halign);

Sets the horizontal aligment of the text.

self :

 the GESTimelineTitleSource* to set horizontal alignement of text on

halign :

 GESTextHAlign

ges_timeline_title_source_set_valignment ()

void                ges_timeline_title_source_set_valignment
                                                        (GESTimelineTitleSource *self,
                                                         GESTextVAlign valign);

Sets the vertical aligment of the text.

self :

 the GESTimelineTitleSource* to set vertical alignement of text on

valign :

 GESTextVAlign

ges_timeline_title_source_set_mute ()

void                ges_timeline_title_source_set_mute  (GESTimelineTitleSource *self,
                                                         gboolean mute);

Sets whether the audio track of this timeline object is muted or not

self :

 the GESTimelineTitleSource on which to mute or unmute the audio track

mute :

 TRUE to mute the audio track, FALSE to unmute it

ges_timeline_title_source_set_color ()

void                ges_timeline_title_source_set_color (GESTimelineTitleSource *self,
                                                         guint32 color);

Sets the color of the text.

self :

 the GESTimelineTitleSource* to set

color :

 The color self is being set to

Since 0.10.2

ges_timeline_title_source_set_xpos ()

void                ges_timeline_title_source_set_xpos  (GESTimelineTitleSource *self,
                                                         gdouble position);

Sets the horizontal position of the text.

self :

 the GESTimelineTitleSource* to set

position :

 The horizontal position self is being set to

Since 0.10.2

ges_timeline_title_source_set_ypos ()

void                ges_timeline_title_source_set_ypos  (GESTimelineTitleSource *self,
                                                         gdouble position);

Sets the vertical position of the text.

self :

 the GESTimelineTitleSource* to set

position :

 The vertical position self is being set to

Since 0.10.2

ges_timeline_title_source_get_text ()

const gchar *       ges_timeline_title_source_get_text  (GESTimelineTitleSource *self);

Get the text currently set on self.

self :

 a GESTimelineTitleSource

Returns :

 The text currently set on self.

ges_timeline_title_source_get_font_desc ()

const gchar *       ges_timeline_title_source_get_font_desc
                                                        (GESTimelineTitleSource *self);

Get the pango font description used by self.

self :

 a GESTimelineTitleSource

Returns :

 The pango font description used by self.

ges_timeline_title_source_get_valignment ()

GESTextVAlign       ges_timeline_title_source_get_valignment
                                                        (GESTimelineTitleSource *self);

Get the vertical aligment used by self.

self :

 a GESTimelineTitleSource

Returns :

 The vertical aligment used by self.

ges_timeline_title_source_get_halignment ()

GESTextHAlign       ges_timeline_title_source_get_halignment
                                                        (GESTimelineTitleSource *self);

Get the horizontal aligment used by self.

self :

 a GESTimelineTitleSource

Returns :

 The horizontal aligment used by self.

ges_timeline_title_source_is_muted ()

gboolean            ges_timeline_title_source_is_muted  (GESTimelineTitleSource *self);

Let you know if the audio track of self is muted or not.

self :

 a GESTimelineTitleSource

Returns :

 Whether the audio track of self is muted or not.

ges_timeline_title_source_get_color ()

const guint32       ges_timeline_title_source_get_color (GESTimelineTitleSource *self);

Get the color used by self.

self :

 a GESTimelineTitleSource

Returns :

 The color used by self.

Since 0.10.2

ges_timeline_title_source_get_xpos ()

const gdouble       ges_timeline_title_source_get_xpos  (GESTimelineTitleSource *self);

Get the horizontal position used by self.

self :

 a GESTimelineTitleSource

Returns :

 The horizontal position used by self.

Since 0.10.2

ges_timeline_title_source_get_ypos ()

const gdouble       ges_timeline_title_source_get_ypos  (GESTimelineTitleSource *self);

Get the vertical position used by self.

self :

 a GESTimelineTitleSource

Returns :

 The vertical position used by self.

Since 0.10.2

Property Details

The "color" property

  "color"                    guint                 : Read / Write / Construct

The color of the text

Default value: 4294967295

The "font-desc" property

  "font-desc"                gchar*                : Read / Write / Construct

Pango font description string

Default value: "Serif 36"

The "halignment" property

  "halignment"               GESTextHAlign         : Read / Write / Construct

Horizontal alignment of the text

Default value: center

The "mute" property

  "mute"                     gboolean              : Read / Write / Construct

Whether the sound will be played or not.

Default value: FALSE

The "text" property

  "text"                     gchar*                : Read / Write / Construct

The text to diplay

Default value: ""

The "valignment" property

  "valignment"               GESTextVAlign         : Read / Write / Construct

Vertical alignent of the text

Default value: baseline

The "xpos" property

  "xpos"                     gdouble               : Read / Write / Construct

The horizontal position of the text

Allowed values: [0,1]

Default value: 0.5

The "ypos" property

  "ypos"                     gdouble               : Read / Write / Construct

The vertical position of the text

Allowed values: [0,1]

Default value: 0.5

Generated by GTK-Doc V1.17