structured: Enhance error message when no clip duration set
[platform/upstream/gst-editing-services.git] / ges / ges-text-overlay-clip.h
1 /* GStreamer Editing Services
2  * Copyright (C) 2009 Brandon Lewis <brandon.lewis@collabora.co.uk>
3  *               2009 Nokia Corporation
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef _GES_OVERLAY_TEXT_CLIP
22 #define _GES_OVERLAY_TEXT_CLIP
23
24 #include <glib-object.h>
25 #include <ges/ges-types.h>
26 #include <ges/ges-overlay-clip.h>
27 #include <ges/ges-track.h>
28
29 G_BEGIN_DECLS
30 #define GES_TYPE_OVERLAY_TEXT_CLIP ges_text_overlay_clip_get_type()
31 #define GES_OVERLAY_TEXT_CLIP(obj) \
32   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_OVERLAY_TEXT_CLIP, GESTextOverlayClip))
33 #define GES_OVERLAY_TEXT_CLIP_CLASS(klass) \
34   (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_OVERLAY_TEXT_CLIP, GESTextOverlayClipClass))
35 #define GES_IS_OVERLAY_TEXT_CLIP(obj) \
36   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_OVERLAY_TEXT_CLIP))
37 #define GES_IS_OVERLAY_TEXT_CLIP_CLASS(klass) \
38   (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_OVERLAY_TEXT_CLIP))
39 #define GES_OVERLAY_TEXT_CLIP_GET_CLASS(obj) \
40   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_OVERLAY_TEXT_CLIP, GESTextOverlayClipClass))
41 typedef struct _GESTextOverlayClipPrivate GESTextOverlayClipPrivate;
42
43 /**
44  * GESTextOverlayClip:
45  */
46
47 struct _GESTextOverlayClip
48 {
49   GESOverlayClip parent;
50
51   /*< private > */
52   GESTextOverlayClipPrivate *priv;
53
54   /* Padding for API extension */
55   gpointer _ges_reserved[GES_PADDING];
56 };
57
58 /**
59  * GESTextOverlayClipClass:
60  */
61
62 struct _GESTextOverlayClipClass
63 {
64   /*< private > */
65
66   GESOverlayClipClass parent_class;
67
68   /* Padding for API extension */
69   gpointer _ges_reserved[GES_PADDING];
70 };
71
72 GES_API
73 GType ges_text_overlay_clip_get_type (void);
74
75 GES_API void
76 ges_text_overlay_clip_set_text (GESTextOverlayClip * self,
77     const gchar * text);
78
79 GES_API void
80 ges_text_overlay_clip_set_font_desc (GESTextOverlayClip * self,
81     const gchar * font_desc);
82
83 GES_API void
84 ges_text_overlay_clip_set_valign (GESTextOverlayClip * self,
85     GESTextVAlign valign);
86
87 GES_API void
88 ges_text_overlay_clip_set_halign (GESTextOverlayClip * self,
89     GESTextHAlign halign);
90
91 GES_API void
92 ges_text_overlay_clip_set_color (GESTextOverlayClip * self,
93     guint32 color);
94
95 GES_API void
96 ges_text_overlay_clip_set_xpos (GESTextOverlayClip * self,
97     gdouble position);
98
99 GES_API void
100 ges_text_overlay_clip_set_ypos (GESTextOverlayClip * self,
101     gdouble position);
102
103 GES_API
104 const gchar *ges_text_overlay_clip_get_text (GESTextOverlayClip * self);
105
106 GES_API
107 const gchar *ges_text_overlay_clip_get_font_desc (GESTextOverlayClip *
108     self);
109
110 GES_API GESTextVAlign
111 ges_text_overlay_clip_get_valignment (GESTextOverlayClip * self);
112
113 GES_API const guint32
114 ges_text_overlay_clip_get_color (GESTextOverlayClip * self);
115
116 GES_API const gdouble
117 ges_text_overlay_clip_get_xpos (GESTextOverlayClip * self);
118
119 GES_API const gdouble
120 ges_text_overlay_clip_get_ypos (GESTextOverlayClip * self);
121
122 GES_API GESTextHAlign
123 ges_text_overlay_clip_get_halignment (GESTextOverlayClip * self);
124
125 GES_API
126 GESTextOverlayClip *ges_text_overlay_clip_new (void);
127
128 G_END_DECLS
129 #endif /* _GES_TL_OVERLAY */