gst/: More docs.
[platform/upstream/gstreamer.git] / gst / gstparse.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstparse.h: get a pipeline from a text pipeline description
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #ifndef __GST_PARSE_H__
24 #define __GST_PARSE_H__
25
26 #include <gst/gstelement.h>
27
28 G_BEGIN_DECLS
29
30 #ifndef GST_DISABLE_PARSE
31
32 GQuark gst_parse_error_quark (void);
33 /**
34  * GST_PARSE_ERROR:
35  *
36  * Get access to the error quark of the parse subsystem.
37  */
38 #define GST_PARSE_ERROR gst_parse_error_quark ()
39
40 typedef enum
41 {
42   GST_PARSE_ERROR_SYNTAX,
43   GST_PARSE_ERROR_NO_SUCH_ELEMENT,
44   GST_PARSE_ERROR_NO_SUCH_PROPERTY,
45   GST_PARSE_ERROR_LINK,
46   GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY,
47   GST_PARSE_ERROR_EMPTY_BIN,
48   GST_PARSE_ERROR_EMPTY
49 } GstParseError;
50
51
52 GstElement*     gst_parse_launch        (const gchar *pipeline_description, GError **error);
53 GstElement*     gst_parse_launchv       (const gchar **argv, GError **error);
54
55 #else /* GST_DISABLE_PARSE */
56
57 #if defined _GNUC_ && _GNUC_ >= 3
58 #pragma GCC poison gst_parse_launch
59 #pragma GCC poison gst_parse_launchv
60 #endif
61
62 #endif /* GST_DISABLE_PARSE */
63
64 G_END_DECLS
65
66 #endif /* __GST_PARSE_H__ */