<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >GstElementDetails</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="GStreamer Plugin Writer's Guide" HREF="index.html"><LINK REL="UP" TITLE="Constructing the Boilerplate" HREF="chapter-building-boiler.html"><LINK REL="PREVIOUS" TITLE="Examining the Basic Code" HREF="section-boiler-examine.html"><LINK REL="NEXT" TITLE="GstStaticPadTemplate" HREF="section-boiler-padtemplates.html"></HEAD ><BODY CLASS="sect1" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" ><SPAN CLASS="application" >GStreamer</SPAN > Plugin Writer's Guide</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="section-boiler-examine.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" >Chapter 3. Constructing the Boilerplate</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="section-boiler-padtemplates.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="sect1" ><H1 CLASS="sect1" ><A NAME="section-boiler-details" >3.4. GstElementDetails</A ></H1 ><P > 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: </P ><P ></P ><UL ><LI ><P > A long, english, name for the element. </P ></LI ><LI ><P > 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) </P ></LI ><LI ><P > A brief description of the purpose of the element. </P ></LI ><LI ><P > The name of the author of the element, optionally followed by a contact email address in angle brackets. </P ></LI ></UL ><P > For example: </P ><PRE CLASS="programlisting" > static GstElementDetails example_details = { "An example plugin", "Example/FirstExample", "Shows the basic structure of a plugin", "your name <your.name@your.isp>" }; </PRE ><P > The element details are registered with the plugin during <CODE CLASS="function" >_base_init ()</CODE >. </P ><PRE CLASS="programlisting" > static void gst_my_filter_base_init (GstMyFilterClass *klass) { static GstElementDetails my_filter_details = { [..] }; GstElementClass *element_class = GST_ELEMENT_CLASS (klass); [..] gst_element_class_set_details (element_class, &my_filter_details); } </PRE ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="section-boiler-examine.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="section-boiler-padtemplates.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Examining the Basic Code</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="chapter-building-boiler.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >GstStaticPadTemplate</TD ></TR ></TABLE ></DIV ></BODY ></HTML >