2 * Copyright (C) 2005 Stefan Kost <ensonic@users.sf.net>
4 * gstchildproxy.h: interface header for multi child elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
22 #ifndef __GST_CHILD_PROXY_H__
23 #define __GST_CHILD_PROXY_H__
25 #include <glib-object.h>
31 #define GST_TYPE_CHILD_PROXY (gst_child_proxy_get_type ())
32 #define GST_CHILD_PROXY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_CHILD_PROXY, GstChildProxy))
33 #define GST_IS_CHILD_PROXY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_CHILD_PROXY))
34 #define GST_CHILD_PROXY_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_CHILD_PROXY, GstChildProxyInterface))
39 * Opaque #GstChildProxy data structure.
41 typedef struct _GstChildProxy GstChildProxy; /* dummy object */
42 typedef struct _GstChildProxyInterface GstChildProxyInterface;
45 * GstChildProxyInterface:
46 * @parent: parent interface type.
48 * #GstChildProxy interface.
50 struct _GstChildProxyInterface
52 GTypeInterface parent;
57 * GstChildProxyInterface.get_child_by_name:
58 * @parent: the #GstChildProxy
59 * @name: the name of the child to fetch
61 * Fetch a child object by name
63 * Returns: (transfer full) (nullable): the child object
65 GObject * (*get_child_by_name) (GstChildProxy * parent, const gchar * name);
68 * GstChildProxyInterface.get_child_by_index:
69 * @parent: the #GstChildProxy
70 * @index: the index of the child to fetch
72 * Fetch a child object by index
74 * Returns: (transfer full) (nullable): the child object
76 GObject * (*get_child_by_index) (GstChildProxy * parent, guint index);
79 * GstChildProxyInterface.get_children_count:
80 * @parent: the #GstChildProxy
82 * Get the number of children in @parent
84 * Returns: the number of children
86 guint (*get_children_count) (GstChildProxy * parent);
92 * GstChildProxyInterface.child_added:
93 * @parent: the #GstChildProxy
94 * @child: the child object
95 * @name: the name of the child object
97 * Called when @child is added to @parent
99 void (*child_added) (GstChildProxy * parent, GObject * child, const gchar * name);
102 * GstChildProxyInterface.child_removed:
103 * @parent: the #GstChildProxy
104 * @child: the child object
105 * @name: the name of the child object
107 * Called when @child is removed from @parent
109 void (*child_removed) (GstChildProxy * parent, GObject * child, const gchar * name);
112 gpointer _gst_reserved[GST_PADDING];
116 GType gst_child_proxy_get_type (void);
119 GObject * gst_child_proxy_get_child_by_name (GstChildProxy * parent, const gchar * name);
122 GObject * gst_child_proxy_get_child_by_name_recurse (GstChildProxy * child_proxy,
126 guint gst_child_proxy_get_children_count (GstChildProxy * parent);
129 GObject * gst_child_proxy_get_child_by_index (GstChildProxy * parent, guint index);
132 gboolean gst_child_proxy_lookup (GstChildProxy *object, const gchar *name,
133 GObject **target, GParamSpec **pspec);
135 void gst_child_proxy_get_property (GstChildProxy * object, const gchar *name,
138 void gst_child_proxy_get_valist (GstChildProxy * object,
139 const gchar * first_property_name,
142 void gst_child_proxy_get (GstChildProxy * object,
143 const gchar * first_property_name,
144 ...) G_GNUC_NULL_TERMINATED;
146 void gst_child_proxy_set_property (GstChildProxy * object, const gchar *name,
147 const GValue *value);
150 void gst_child_proxy_set_valist (GstChildProxy* object,
151 const gchar * first_property_name,
154 void gst_child_proxy_set (GstChildProxy * object,
155 const gchar * first_property_name,
156 ...) G_GNUC_NULL_TERMINATED;
158 void gst_child_proxy_child_added (GstChildProxy * parent, GObject * child,
161 void gst_child_proxy_child_removed (GstChildProxy * parent, GObject * child,
166 #endif /* __GST_CHILD_PROXY_H__ */