mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-01 20:30:41 +00:00
56a79fbfcc
Original commit message from CVS: Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the HTML output somewhere on the website tonight. In order to actually generate the docs, you'll have to install all the DocBook tools, as well as gtk-doc from GNOME cvs. (see http://developer.gnome.org/arch/doc/tools.html) Notes (I'll codify these some day): - Don't believe the Gnome page, always edit the SOURCES when documenting a given function, never the tmpl file. - I'll be re-arranging things a lot, but gtk-doc is smart enough to merge any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are two entirely separate animals. We should probably have a virtual mutex on the entire docs/gst/ directory, over and above what CVS does. - I'm going to try to end up with a book set (docbook terms), where docs/gst/ is only one book. There'd be another called docs/manual/, and another docs/plugins/, etc. If you have any comments as to how these should be done, gstreamer-devel is the place.
51 lines
1.4 KiB
Plaintext
51 lines
1.4 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Gstreamer
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Media library supporting arbitrary formats and filter graphs.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GStreamer is a framework for constructing graphs of various filters
|
|
(termed elements here) that will handly streaming media. Any discreet
|
|
(packetizable) media type is supported, with provisions for automatically
|
|
determining source type. Metadata can be passed with all data to provide
|
|
formatting/framing information. Plugins are heavily used to provide for
|
|
all elements, allowing one to construct plugins outside of the GST
|
|
library, even released binary-only if license require (please don't).
|
|
</para>
|
|
|
|
<para>
|
|
GStreamer borrows heavily from both the <ulink
|
|
url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
|
|
Microsoft's DirectShow, hopefully taking the best of both and leaving the
|
|
cruft behind. Its interface is still very fluid (I've redesigned the
|
|
metadata handling twice already), and thus can be changed to increase the
|
|
sanity/noise ratio.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
|
|
pipeline</ulink> and Microsoft's DirectShow for some background.
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gst_init ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@argc:
|
|
@argv:
|
|
|
|
|
|
<!-- ##### MACRO DEBUG ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@format:
|
|
@args...:
|
|
|
|
|