And 2% more doc coverage.
[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 /**
41  * GstParseError:
42  * @GST_PARSE_ERROR_SYNTAX: A syntax error occured.
43  * @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
44  * @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
45  * @GST_PARSE_ERROR_LINK: There was an error linking two pads.
46  * @GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: There was an error setting a property
47  * @GST_PARSE_ERROR_EMPTY_BIN: An empty bin was specified.
48  * @GST_PARSE_ERROR_EMPTY: An empty description was specified
49  *
50  * The different parsing errors that can occur.
51  */
52 typedef enum
53 {
54   GST_PARSE_ERROR_SYNTAX,
55   GST_PARSE_ERROR_NO_SUCH_ELEMENT,
56   GST_PARSE_ERROR_NO_SUCH_PROPERTY,
57   GST_PARSE_ERROR_LINK,
58   GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY,
59   GST_PARSE_ERROR_EMPTY_BIN,
60   GST_PARSE_ERROR_EMPTY
61 } GstParseError;
62
63
64 GstElement*     gst_parse_launch        (const gchar *pipeline_description, GError **error);
65 GstElement*     gst_parse_launchv       (const gchar **argv, GError **error);
66
67 #else /* GST_DISABLE_PARSE */
68
69 #if defined _GNUC_ && _GNUC_ >= 3
70 #pragma GCC poison gst_parse_launch
71 #pragma GCC poison gst_parse_launchv
72 #endif
73
74 #endif /* GST_DISABLE_PARSE */
75
76 G_END_DECLS
77
78 #endif /* __GST_PARSE_H__ */