Doc fixes.
[platform/upstream/gstreamer.git] / gst / gstghostpad.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wim.taymans@chello.be>
4  *                    2005 Andy Wingo <wingo@pobox.com>
5  *
6  * gstghostpad.h: Proxy pads
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24
25 #ifndef __GST_GHOST_PAD_H__
26 #define __GST_GHOST_PAD_H__
27
28
29 #include <gst/gstpad.h>
30
31
32 G_BEGIN_DECLS
33
34 #define GST_TYPE_GHOST_PAD              (gst_ghost_pad_get_type ())
35 #define GST_IS_GHOST_PAD(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_GHOST_PAD))
36 #define GST_IS_GHOST_PAD_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GHOST_PAD))
37 #define GST_GHOST_PAD(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GHOST_PAD, GstGhostPad))
38 #define GST_GHOST_PAD_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GHOST_PAD, GstGhostPadClass))
39
40 /**
41  * GstGhostPad:
42  *
43  * Opaque #GstGhostPad structure.
44  */
45 typedef struct _GstGhostPad GstGhostPad;
46 typedef struct _GstGhostPadClass GstGhostPadClass;
47
48 GType            gst_ghost_pad_get_type         (void);
49
50 GstPad*          gst_ghost_pad_new              (const gchar *name, GstPad *target);
51 GstPad*          gst_ghost_pad_new_no_target    (const gchar *name, GstPadDirection dir);
52
53 GstPad*          gst_ghost_pad_get_target       (GstGhostPad *gpad);
54 gboolean         gst_ghost_pad_set_target       (GstGhostPad *gpad, GstPad *newtarget);
55
56 G_END_DECLS
57
58 #endif /* __GST_GHOST_PAD_H__ */