adding a title to some examples so that they appear in the example index disabled the global index, as this does not ...

Original commit message from CVS:
adding a title to some examples so that they appear in the example index
disabled the global index, as this does not yet fully work
This commit is contained in:
Stefan Kost 2004-07-14 15:06:31 +00:00
parent 77767e0cb7
commit 1312d71475
4 changed files with 18 additions and 7 deletions

View file

@ -162,6 +162,8 @@ with some more specialized elements.</para>
&gstreamer-tree-index; &gstreamer-tree-index;
</chapter> </chapter>
<!-- this seems to be broken with current gtk-doc and the xml toolchain
<index id="index"/> <index id="index"/>
-->
</book> </book>

View file

@ -28,6 +28,8 @@ The <application>GStreamer</application> library should be initialized with gst_
it can be used. You should pass a pointer to the main argc and argv variables so that GStreamer can it can be used. You should pass a pointer to the main argc and argv variables so that GStreamer can
process its own command line options, as shown in the following example. process its own command line options, as shown in the following example.
<example>
<title>Initializing the gstreamer libarary</title>
<programlisting> <programlisting>
int int
main (int argc, char *argv[]) main (int argc, char *argv[])
@ -37,6 +39,7 @@ process its own command line options, as shown in the following example.
... ...
} }
</programlisting> </programlisting>
</example>
</para> </para>
<para> <para>
It's allowed to pass two NULL pointers to gst_init() in case you don't want to pass the command It's allowed to pass two NULL pointers to gst_init() in case you don't want to pass the command
@ -46,6 +49,8 @@ line args to GStreamer.
<para> <para>
You can also use a popt table to initialize your own parameters as shown in the next code You can also use a popt table to initialize your own parameters as shown in the next code
fragment: fragment:
<example>
<title>Initializing own parameters when initializing gstreamer</title>
<programlisting> <programlisting>
static gboolean stats = FALSE; static gboolean stats = FALSE;
... ...
@ -65,6 +70,7 @@ fragment:
... ...
} }
</programlisting> </programlisting>
</example>
</para> </para>
<para> <para>
Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros

View file

@ -17,6 +17,8 @@ Buffers are usually created with gst_buffer_new(). After a buffer has been
created one will typically allocate memory for it and set the size of the created one will typically allocate memory for it and set the size of the
buffer data. The following example creates a buffer that can hold a given buffer data. The following example creates a buffer that can hold a given
video frame with a given width, height and bits per plane. video frame with a given width, height and bits per plane.
<example>
<title>Creating a buffer for a video frame</title>
<programlisting> <programlisting>
GstBuffer *buffer; GstBuffer *buffer;
gint size, width, height, bpp; gint size, width, height, bpp;
@ -30,6 +32,7 @@ video frame with a given width, height and bits per plane.
GST_BUFFER_DATA (buffer) = g_alloc (size); GST_BUFFER_DATA (buffer) = g_alloc (size);
... ...
</programlisting> </programlisting>
</example>
</para> </para>
<para> <para>
Alternatively, use gst_buffer_new_and_alloc() Alternatively, use gst_buffer_new_and_alloc()

View file

@ -162,10 +162,10 @@ The different types of seek events. When constructing a seek event a format,
a seek method and optional flags are OR-ed together. The seek event is then a seek method and optional flags are OR-ed together. The seek event is then
inserted into the graph with #gst_pad_send_event() or #gst_element_send_event(). inserted into the graph with #gst_pad_send_event() or #gst_element_send_event().
<informalexample>
Following example illustrates how to insert a seek event (1 second in the stream) Following example illustrates how to insert a seek event (1 second in the stream)
in a pipeline. in a pipeline.
<example>
<title>Insertion of a seek event into a pipeline</title>
<programlisting> <programlisting>
gboolean res; gboolean res;
GstEvent *event; GstEvent *event;
@ -181,7 +181,7 @@ inserted into the graph with #gst_pad_send_event() or #gst_element_send_event().
g_warning ("seek failed"); g_warning ("seek failed");
} }
</programlisting> </programlisting>
</informalexample> </example>
</para> </para>
@GST_SEEK_METHOD_CUR: Seek to an relative position @GST_SEEK_METHOD_CUR: Seek to an relative position