Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / gst / gstelementmetadata.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *               2000,2004 Wim Taymans <wim@fluendo.com>
4  *
5  * gstelementmetadata.h: Metadata for GstElement classes
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_ELEMENT_METADATA_H__
24 #define __GST_ELEMENT_METADATA_H__
25
26 G_BEGIN_DECLS
27
28 /**
29  * GST_ELEMENT_METADATA_LONGNAME:
30  *
31  * The long English name of the element. E.g. "File Sink"
32  */
33 #define GST_ELEMENT_METADATA_LONGNAME      "long-name"
34 /**
35  * GST_ELEMENT_METADATA_KLASS:
36  *
37  * String describing the type of element, as an unordered list
38  * separated with slashes ('/'). See draft-klass.txt of the design docs
39  * for more details and common types. E.g: "Sink/File"
40  */
41 #define GST_ELEMENT_METADATA_KLASS         "klass"
42
43 /**
44  * GST_ELEMENT_METADATA_DESCRIPTION:
45  *
46  * Sentence describing the purpose of the element.
47  * E.g: "Write stream to a file"
48  */
49 #define GST_ELEMENT_METADATA_DESCRIPTION   "description"
50 /**
51  * GST_ELEMENT_METADATA_AUTHOR:
52  *
53  * Name and contact details of the author(s). Use \n to separate
54  * multiple author details.
55  * E.g: "Joe Bloggs &lt;joe.blogs at foo.com&gt;"
56  */
57 #define GST_ELEMENT_METADATA_AUTHOR        "author"
58
59 /**
60  * GST_ELEMENT_METADATA_DOC_URI:
61  *
62  * Set uri pointing to user documentation. Applications can use this to show
63  * help for e.g. effects to users.
64  */
65 #define GST_ELEMENT_METADATA_DOC_URI       "doc-uri"
66 /**
67  * GST_ELEMENT_METADATA_ICON_NAME:
68  *
69  * Elements that bridge to certain other products can include an icon of that
70  * used product. Application can show the icon in menus/selectors to help
71  * identifying specific elements.
72  */
73 #define GST_ELEMENT_METADATA_ICON_NAME     "icon-name"
74
75 G_END_DECLS
76
77 #endif /* __GST_ELEMENT_METADATA_H__ */