GESTimelineTitleSource

GESTimelineTitleSource — Render stand-alone titles in GESTimelineLayer.

Functions

Properties

gchar * font-desc Read / Write / Construct
GESTextHAlign halignment Read / Write / Construct
gboolean mute Read / Write / Construct
gchar * text Read / Write / Construct
GESTextVAlign valignment Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GESTimelineObject
            ╰── GESTimelineSource
                ╰── GESTimelineTitleSource

Includes

#include <ges/ges.h>

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

Functions

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_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

Parameters

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_text ()

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

Sets the text this timeline object will render.

Parameters

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.

Parameters

self

the GESTimelineTitleSource*

 

font_desc

the pango font description

 

ges_timeline_title_source_set_valignment ()

void
ges_timeline_title_source_set_valignment
                               (GESTimelineTitleSource *self,
                                GESTextVAlign valign);

Sets the vertical aligment of the text.

Parameters

self

the GESTimelineTitleSource* to set vertical alignement of text on

 

valign

GESTextVAlign

 

ges_timeline_title_source_set_halignment ()

void
ges_timeline_title_source_set_halignment
                               (GESTimelineTitleSource *self,
                                GESTextHAlign halign);

Sets the horizontal aligment of the text.

Parameters

self

the GESTimelineTitleSource* to set horizontal alignement of text on

 

halign

GESTextHAlign

 

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.

Parameters

Returns

Whether the audio track of self is muted or not.


ges_timeline_title_source_get_text ()

const gchar *
ges_timeline_title_source_get_text (GESTimelineTitleSource *self);

Get the text currently set on self .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

Returns

The horizontal aligment used by self .

Types and Values

GESTimelineTitleSource

typedef struct _GESTimelineTitleSource GESTimelineTitleSource;

Render stand-alone titles in GESTimelineLayer.

Property Details

The “font-desc” property

  “font-desc”                gchar *

Pango font description string

Flags: Read / Write / Construct

Default value: "Serif 36"


The “halignment” property

  “halignment”               GESTextHAlign

Horizontal alignment of the text

Flags: Read / Write / Construct

Default value: center


The “mute” property

  “mute”                     gboolean

Whether the sound will be played or not.

Flags: Read / Write / Construct

Default value: FALSE


The “text” property

  “text”                     gchar *

The text to diplay

Flags: Read / Write / Construct

Default value: ""


The “valignment” property

  “valignment”               GESTextVAlign

Vertical alignent of the text

Flags: Read / Write / Construct

Default value: baseline