some doc fixes

Original commit message from CVS:
some doc fixes
This commit is contained in:
Thomas Vander Stichele 2004-05-19 18:01:34 +00:00
parent 6e01a39feb
commit 3a32067831

View file

@ -2,16 +2,29 @@
gstdataprotocol gstdataprotocol
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
GStreamer Data Protocol, serializes buffers, caps and events.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
This helper library provides serialization of GstBuffer, GstCaps and
GstEvent structures.
</para>
<para>
This serialization can be useful when GStreamer needs to interface with
the outside world to transport data between different GStreamer pipelines.
The connections with the outside world generally don't have mechanisms
to transport properties of these structures.
</para>
<para>
For example, transporting buffers across named pipes doesn't keep the
buffer size. Network elements that transport GStreamer data across
network connections also need a protocol to do this.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
#GstBuffer, #GstCaps, #GstEvent
</para> </para>
<!-- ##### ENUM GstDPHeaderFlag ##### --> <!-- ##### ENUM GstDPHeaderFlag ##### -->