gst/gstchildproxy.h

   1 /* GStreamer
   2  * Copyright (C) 2005 Stefan Kost <ensonic@users.sf.net>
   3  *
   4  * gstchildproxy.h: interface header for multi child elements
   5  *
   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.
  10  *
  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.
  15  *
  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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GST_CHILD_PROXY_H__
  23 #define __GST_CHILD_PROXY_H__
  24
  25 #include <glib-object.h>
  26 #include <gst/gst.h>
  27
  28 G_BEGIN_DECLS
  29
  30
  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))
  35
  36 /**
  37  * GstChildProxy:
  38  *
  39  * Opaque #GstChildProxy data structure.
  40  */
  41 typedef struct _GstChildProxy GstChildProxy;    /* dummy object */
  42 typedef struct _GstChildProxyInterface GstChildProxyInterface;
  43
  44 /**
  45  * GstChildProxyInterface:
  46  * @parent: parent interface type.
  47  * @get_child_by_index: virtual method to fetch the child
  48  * @get_children_count: virtual method to get the children count
  49  *
  50  * #GstChildProxy interface.
  51  */
  52 struct _GstChildProxyInterface
  53 {
  54   GTypeInterface parent;
  55
  56   /* methods */
  57   GstObject * (*get_child_by_index) (GstChildProxy * parent, guint index);
  58   guint       (*get_children_count) (GstChildProxy * parent);
  59   /*< private >*/
  60   /* signals */
  61   void        (*child_added)        (GstChildProxy * parent, GstObject * child);
  62   void        (*child_removed)      (GstChildProxy * parent, GstObject * child);
  63
  64   /*< private >*/
  65   gpointer _gst_reserved[GST_PADDING];
  66 };
  67
  68 GType gst_child_proxy_get_type (void);
  69
  70 GstObject *  gst_child_proxy_get_child_by_name   (GstChildProxy * parent, const gchar * name);
  71
  72 guint        gst_child_proxy_get_children_count  (GstChildProxy * parent);
  73 GstObject *  gst_child_proxy_get_child_by_index  (GstChildProxy * parent, guint index);
  74
  75 gboolean     gst_child_proxy_lookup              (GstObject *object, const gchar *name,
  76                                                   GstObject **target, GParamSpec **pspec);
  77
  78 void         gst_child_proxy_get_property        (GstObject * object, const gchar *name,
  79                                                   GValue *value);
  80 void         gst_child_proxy_get_valist          (GstObject * object,
  81                                                   const gchar * first_property_name,
  82                                                   va_list var_args);
  83 void         gst_child_proxy_get                 (GstObject * object,
  84                                                   const gchar * first_property_name,
  85                                                   ...) G_GNUC_NULL_TERMINATED;
  86
  87 void         gst_child_proxy_set_property        (GstObject * object, const gchar *name,
  88                                                   const GValue *value);
  89 void         gst_child_proxy_set_valist          (GstObject* object,
  90                                                   const gchar * first_property_name,
  91                                                   va_list var_args);
  92 void         gst_child_proxy_set                 (GstObject * object,
  93                                                   const gchar * first_property_name,
  94                                                   ...) G_GNUC_NULL_TERMINATED;
  95
  96 void         gst_child_proxy_child_added         (GstObject * object, GstObject *  child);
  97 void         gst_child_proxy_child_removed       (GstObject * object, GstObject *  child);
  98
  99 G_END_DECLS
 100
 101 #endif /* __GST_CHILD_PROXY_H__ */