mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 08:46:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

eliminate another tmpl file, fix spelling in the long-description

Browse source 
Original commit message from CVS:
* docs/gst/tmpl/gst.sgml:
* gst/gst.c:
eliminate another tmpl file, fix spelling in the long-description
This commit is contained in:
Stefan Kost 2005-08-19 09:58:42 +00:00
parent ef66449d83
commit 60f5fbb210
3 changed files with 79 additions and 145 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2005-08-19 Stefan Kost <ensonic@users.sf.net>
* docs/gst/tmpl/gst.sgml:
* gst/gst.c:
eliminate another tmpl file, fix spelling in the long-description
2005-08-18 Jan Schmidt <thaytan@mad.scientist.com>
* check/gst/gstevents.c: (GST_START_TEST), (event_probe),

145
docs/gst/tmpl/gst.sgml
View file

@ -1,145 +0,0 @@
<!-- ##### 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 handle streaming media. Any discreet
(packetizable) media type is supported, with provisions for automatically
determining source type. Formatting/framing information is provided with
a powerful negotiation framework. 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 and thus can be changed
to increase the sanity/noise ratio.
</para>
<para>
The <application>GStreamer</application> library should be initialized with gst_init() before
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.
<example>
<title>Initializing the gstreamer library</title>
<programlisting>
int
main (int argc, char *argv[])
{
/* initialize the GStreamer library */
gst_init (&amp;argc, &amp;argv);
...
}
</programlisting>
</example>
</para>
<para>
It's allowed to pass two NULL pointers to gst_init() in case you don't want to pass the command
line args to GStreamer.
</para>
<para>
You can also use a popt table to initialize your own parameters as shown in the next code
fragment:
<example>
<title>Initializing own parameters when initializing gstreamer</title>
<programlisting>
static gboolean stats = FALSE;
...
int
main (int argc, char *argv[])
{
struct poptOption options[] = {
{ "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &amp;stats, 0,
"Show pad stats", NULL},
POPT_TABLEEND
};
/* initialize the GStreamer library */
gst_init_with_popt_table (&amp;argc, &amp;argv, options);
...
}
</programlisting>
</example>
</para>
<para>
Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
to find the version at compile time.
</para>
<para>
gst_main() and gst_main_quit() enter and exit the main loop. GStreamer doesn't currently require
you to us a mainloop but can intergrate with it without problems.
</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>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gst_init ##### -->
<para>
</para>
@argc:
@argv:
<!-- ##### FUNCTION gst_init_check ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### FUNCTION gst_init_with_popt_table ##### -->
<para>
</para>
@argc:
@argv:
@popt_options:
<!-- # Unused Parameters # -->
@Param3:
@Returns:
<!-- ##### FUNCTION gst_init_check_with_popt_table ##### -->
<para>
</para>
@argc:
@argv:
@popt_options:
@Returns:
<!-- # Unused Parameters # -->
@Param3:
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
<para>
</para>
@Returns:

73
gst/gst.c
View file

@ -19,6 +19,79 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gst
* @short_description: Media library supporting arbitrary formats and filter graphs.
* @see_also: Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
* pipeline</ulink> and Microsoft's DirectShow for some background.
*
* GStreamer is a framework for constructing graphs of various filters
* (termed elements here) that will handle streaming media. Any discreet
* (packetizable) media type is supported, with provisions for automatically
* determining source type. Formatting/framing information is provided with
* a powerful negotiation framework. 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).
*
* 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 and thus can be changed
* to increase the sanity/noise ratio.
*
* The <application>GStreamer</application> library should be initialized with
* gst_init() before it can be used. You should pass pointers to the main argc
* and argv variables so that GStreamer can process its own command line
* options, as shown in the following example.
*
* <example>
* <title>Initializing the gstreamer library</title>
* <programlisting>
* int
* main (int argc, char *argv[])
* {
* // initialize the GStreamer library
* gst_init (&amp;argc, &amp;argv);
* ...
* }
* </programlisting>
* </example>
*
* It's allowed to pass two NULL pointers to gst_init() in case you don't want to
* pass the command line args to GStreamer.
*
* You can also use a popt table to initialize your own parameters as shown in
* the next code fragment:
* <example>
* <title>Initializing own parameters when initializing gstreamer</title>
* <programlisting>
* static gboolean stats = FALSE;
* ...
*
* int
* main (int argc, char *argv[])
* {
* struct poptOption options[] = {
* { "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &amp;stats, 0,
* "Show pad stats", NULL},
* POPT_TABLEEND
* };
*
* // initialize the GStreamer library
* gst_init_with_popt_table (&amp;argc, &amp;argv, options);
*
* ...
* }
* </programlisting>
* </example>
*
* Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
* to find the version at compile time.
*
* The functions gst_main() and gst_main_quit() enter and exit the main loop.
* GStreamer doesn't currently require you to use a mainloop but can intergrate
* with it without problems.
*/
#include <stdlib.h>
#include <stdio.h>