GStreamer : Element metadata

- Element metadata -

the element metadata provides extra element information. It is configured with gst_element_class_set_metadata or gst_element_class_set_static_metadata which takes the following parameters:

• A Long, English, name of the element.
• The type of the element, see the docs/designe/draft-klass.txt document in the GStreamer core source tree for details and example.
• A brief description of the purpose of the element.
• The name of the author of the element, optionally followed by a contact email address in angle brackets.

For example:

gst_element_class_set_static_metadata(klass,

"An example plugin",

"Example/FirstExample",

"Shows the basic structure of a plugin",

"your name <your.name@your.isp>");

gst_element_class_set_metadata ()

void
gst_element_class_set_metadata (GstElementClass *klass,
                                const gchar *longname,
                                const gchar *classification,
                                const gchar *description,
                                const gchar *author);

Sets the detailed information for a GstElementClass.

This function is for use in _class_init functions only.

Parameters

klass	class to set metadata for
longname	The long English name of the element. E.g. "File Sink"
classification	String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"
description	Sentence describing the purpose of the element. E.g: "Write stream to a file"
author	Name and contact details of the author(s). Use \n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"

---

gst_element_class_set_static_metadata ()

void
gst_element_class_set_static_metadata (GstElementClass *klass,
                                       const gchar *longname,
                                       const gchar *classification,
                                       const gchar *description,
                                       const gchar *author);

Sets the detailed information for a GstElementClass.

This function is for use in _class_init functions only.

Same as gst_element_class_set_metadata(), but longname , classification , description , and author must be static strings or inlined strings, as they will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

Parameters

klass	class to set metadata for
longname	The long English name of the element. E.g. "File Sink"
classification	String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"
description	Sentence describing the purpose of the element. E.g: "Write stream to a file"
author	Name and contact details of the author(s). Use \n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"