From: Stefan Kost Date: Fri, 19 Aug 2005 09:58:42 +0000 (+0000) Subject: eliminate another tmpl file, fix spelling in the long-description X-Git-Tag: RELEASE-0_9_2~123 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=60f5fbb210d59f7687322ecb2f235e0fe87fab97;p=platform%2Fupstream%2Fgstreamer.git eliminate another tmpl file, fix spelling in the long-description Original commit message from CVS: * docs/gst/tmpl/gst.sgml: * gst/gst.c: eliminate another tmpl file, fix spelling in the long-description --- diff --git a/ChangeLog b/ChangeLog index ee99990..495f07a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2005-08-19 Stefan Kost + + * docs/gst/tmpl/gst.sgml: + * gst/gst.c: + eliminate another tmpl file, fix spelling in the long-description + 2005-08-18 Jan Schmidt * check/gst/gstevents.c: (GST_START_TEST), (event_probe), diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml deleted file mode 100644 index fc6631a..0000000 --- a/docs/gst/tmpl/gst.sgml +++ /dev/null @@ -1,145 +0,0 @@ - -GStreamer - - -Media library supporting arbitrary formats and filter graphs. - - - -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 OGI media pipeline 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 GStreamer 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. - - -Initializing the gstreamer library - - int - main (int argc, char *argv[]) - { - /* initialize the GStreamer library */ - gst_init (&argc, &argv); - ... - } - - - - -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: - -Initializing own parameters when initializing gstreamer - - static gboolean stats = FALSE; - ... - - int - main (int argc, char *argv[]) - { - struct poptOption options[] = { - { "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &stats, 0, - "Show pad stats", NULL}, - POPT_TABLEEND - }; - - /* initialize the GStreamer library */ - gst_init_with_popt_table (&argc, &argv, options); - - ... - } - - - - - Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros - to find the version at compile time. - - -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. - - - - -Check out both OGI's -pipeline and Microsoft's DirectShow for some background. - - - - - - - - - - -@argc: -@argv: - - - - - - - -@argc: -@argv: -@Returns: - - - - - - - -@argc: -@argv: -@popt_options: - -@Param3: -@Returns: - - - - - - - -@argc: -@argv: -@popt_options: -@Returns: - -@Param3: - - - - - - - -@Returns: - - diff --git a/gst/gst.c b/gst/gst.c index bdd705d..7f278cf 100644 --- a/gst/gst.c +++ b/gst/gst.c @@ -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 OGI's + * pipeline 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 OGI media pipeline 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 GStreamer 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. + * + * + * Initializing the gstreamer library + * + * int + * main (int argc, char *argv[]) + * { + * // initialize the GStreamer library + * gst_init (&argc, &argv); + * ... + * } + * + * + * + * 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: + * + * Initializing own parameters when initializing gstreamer + * + * static gboolean stats = FALSE; + * ... + * + * int + * main (int argc, char *argv[]) + * { + * struct poptOption options[] = { + * { "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &stats, 0, + * "Show pad stats", NULL}, + * POPT_TABLEEND + * }; + * + * // initialize the GStreamer library + * gst_init_with_popt_table (&argc, &argv, options); + * + * ... + * } + * + * + * + * 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 #include