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

source code of include/gstreamer-1.0/gst/gstelementmetadata.h