GStreamer Plugin Writer's Guide | ||
---|---|---|
<<< Previous | Constructing the Boilerplate | Next >>> |
The GstElementDetails structure gives a heirarchical type for the element, a human-readable description of the element, as well as author and version data. The entries are:
A long, english, name for the element.
The type of the element, as a heirarchy. The heirarchy is defined by specifying the top level category, followed by a "/", followed by the next level category, etc. The type should be defined according to the guidelines elsewhere in this document. (FIXME: write the guidelines, and give a better reference to them)
A brief description of the purpose of the element.
The version number of the element. For elements in the main GStreamer source code, this will often simply be VERSION, which is a macro defined to be the version number of the current GStreamer version. The only requirement, however, is that the version number should increase monotonically.
Version numbers should be stored in major.minor.patch form: ie, 3 (decimal) numbers, separated by periods (.).
The name of the author of the element, optionally followed by a contact email address in angle brackets.
The copyright details for the element.
For example:
static GstElementDetails example_details = { "An example plugin", "Example/FirstExample", "Shows the basic structure of a plugin", VERSION, "your name <your.name@your.isp>", "(C) 2001", }; |
<<< Previous | Home | Next >>> |
Creating a Filter With FilterFactory (Future) | Up | Constructor Functions |