Commit graph

283 commits

Author SHA1 Message Date
Tim-Philipp Müller
77120a04a5 manual: add minimal tag reading example
Should probably put that into tests/examples and figure out how to
get it included automatically, but can't be bothered right now.
2010-05-02 19:31:20 +01:00
Stefan Kost
92fb25f593 docs: improve communication picture and section
Indicate that only messages go via bus. Also add queries between elements.
2010-03-31 11:32:38 +03:00
Stefan Kost
5799aa28e3 docs: add communication overview to docs
Add a section to the basics that show buffers, events, messages and queries
together and describe the basics.
2010-03-31 10:41:49 +03:00
Thiago Santos
69e23983a4 docs: Fix basics-bus docs
Fix wrong information about bus watch functions in the
application development manual.

Fixes #608127
2010-01-26 08:52:16 -03:00
Wim Taymans
9ea9f9a816 docs: fix another typo 2009-11-28 17:02:17 +01:00
Wim Taymans
c5291d5c21 docs: fix typo 2009-11-28 15:40:30 +01:00
Tim-Philipp Müller
5a1c788d9a docs: improve GstMixer and GstTuner docs
Mention that elements implementing GstMixer and GstTuner need to be
in the right state before they can be used. Also mention GLib
functions for converting filenames to and from URIs.

Fixes #602877.
2009-11-25 15:53:04 +00:00
Wim Taymans
2ffbb1a374 docs: don't forget to unref the pad 2009-11-09 12:42:35 +01:00
Stefan Kost
cfb4aa4627 build: sprintf, sscanf need stdio.h 2009-10-07 10:59:54 +03:00
Sebastian Dröge
9f0e832c6c docs: Don't talk about the deprecated libgnome and GNOME-VFS
Instead talk about GIO and change the option parsing example to
not initialize libgnome but only GTK.

Fixes bug #592233.
2009-08-19 16:24:39 +02:00
Jan Schmidt
29170a4cfa docs: Bump common, fix the upload logic inclusion
Update the common submodule, and fix the docs upload rules to include
the right makefile snippet from common.
2009-06-11 13:16:29 +01:00
Tim-Philipp Müller
df851d54ef docs: fix up reference to gst-launch-0.8
Also mention decodebin2, uridecodebin, and playbin2
2009-06-03 09:49:59 +01:00
Wim Taymans
72101e3b14 docs: reword stuff about custom mainloops
Fixes #574229.
2009-03-09 16:10:37 +01:00
Wim Taymans
c6cc3bbca8 docs/manual/: Some Application Development Manual fixes thanks to
Original commit message from CVS:
* docs/manual/advanced-position.xml:
* docs/manual/basics-bins.xml:
* docs/manual/basics-bus.xml:
* docs/manual/basics-pads.xml:
* docs/manual/intro-gstreamer.xml:
* docs/manual/intro-preface.xml:
Some Application Development Manual fixes thanks to
Andrew Feren. Fixes #558459.
2008-11-04 11:55:08 +00:00
Stefan Kost
62f71ce302 docs/manual/basics-data.xml: Change "event-event interaction" to "element-element interaction".
Original commit message from CVS:
* docs/manual/basics-data.xml:
Change "event-event interaction" to "element-element interaction".
Fixes #552448. Also fix sample code for seeking and do more 0.8->0.10
updates.
2008-10-06 07:13:02 +00:00
Tim-Philipp Müller
e769a7a0e4 docs/manual/intro-motivation.xml: Remove some bits that no longer apply, update others (#551642).
Original commit message from CVS:
* docs/manual/intro-motivation.xml::
Remove some bits that no longer apply, update others (#551642).
2008-09-11 16:56:48 +00:00
Luc Pionchon
bbe50ec6c1 docs/manual/: Add one more image showing different times together with a describing paragraph. Fixes #547729.
Original commit message from CVS:
patch by: Luc Pionchon <luc.pionchon@nokia.com>
* docs/manual/advanced-clocks.xml:
* docs/manual/clocks.png:
* docs/manual/diagrams-clocks.svg:
Add one more image showing different times together with a describing
paragraph. Fixes #547729.
2008-08-14 14:26:20 +00:00
Stefan Kost
b85a3e4afc docs/manual/advanced-interfaces.xml: Turn thoughts about HAL into a note-tag. Remove mentioning that is only used to ...
Original commit message from CVS:
* docs/manual/advanced-interfaces.xml:
Turn thoughts about HAL into a note-tag. Remove mentioning that is
only used to discover devices.
2008-08-11 07:07:45 +00:00
Luc Pionchon
4f90d4dfe4 docs/manual/: Replace one diagram with two separate ones and updates others.
Original commit message from CVS:
patch by: Luc Pionchon <luc.pionchon@nokia.com>
* docs/manual/advanced-threads.xml:
* docs/manual/diagrams-pipelines.svg:
* docs/manual/hello-world.png:
* docs/manual/linked-elements.png:
* docs/manual/mime-world.png:
* docs/manual/queue.png:
* docs/manual/thread-buffering.png:
* docs/manual/thread-synchronizing.png:
Replace one diagram with two separate ones and updates others.
Fixes #542401.
2008-07-26 12:00:36 +00:00
Rene Stadler
4abe96918a docs/manual/advanced-autoplugging.xml: Add fakesink to example code to close the pipeline graph. This prevents the p...
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml: Add fakesink to example
code to close the pipeline graph.  This prevents the program from
printing internal data flow errors.
2008-07-24 12:36:20 +00:00
Sebastian Dröge
51a07413d0 docs/manual/basics-bus.xml: Correct typo. Fixes bug #544320.
Original commit message from CVS:
* docs/manual/basics-bus.xml:
Correct typo. Fixes bug #544320.
2008-07-23 15:44:04 +00:00
Luc Pionchon
4f92facc79 docs/manual/: Add scale factor for pdf output.
Original commit message from CVS:
patch by: Luc Pionchon  <luc.pionchon@nokia.com>
* docs/manual/advanced-autoplugging.xml:
* docs/manual/advanced-threads.xml:
* docs/manual/basics-bins.xml:
* docs/manual/basics-elements.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-pads.xml:
Add scale factor for pdf output.
* docs/manual/intro-basics.xml:
Switched sections "pads" and "bins" and added a pipeline diagram.
* docs/manual/intro-gstreamer.xml:
Added more info on gstreamer.
* docs/manual/intro-motivation.xml:
Commented out the whole section "current problem", which sounds
historical and somehow osolete; it could be turned in a positive
way and reused to improve the design principles.
* docs/manual/intro-preface.xml:
- Update URLs to library.gnome.org.
- Do not mention GTK+ in preliminary reading (irrelevant).
- Mention Plugin Writer's Manual and further reading only in the
previous section.
- Added a list of most relevant GObject/glib topics.
* docs/manual/Makefile.am:
* docs/manual/bin-element-ghost.fig:
* docs/manual/bin-element-ghost.png:
* docs/manual/bin-element-noghost.fig:
* docs/manual/bin-element-noghost.png:
* docs/manual/bin-element.fig:
* docs/manual/bin-element.png:
* docs/manual/filter-element-multi.fig:
* docs/manual/filter-element-multi.png:
* docs/manual/filter-element.fig:
* docs/manual/filter-element.png:
* docs/manual/gstreamer-overview.png:
* docs/manual/hello-world.fig:
* docs/manual/hello-world.png:
* docs/manual/linked-elements.fig:
* docs/manual/linked-elements.png:
* docs/manual/mime-world.fig:
* docs/manual/mime-world.png:
* docs/manual/queue.fig:
* docs/manual/queue.png:
* docs/manual/simple-player.png:
* docs/manual/sink-element.fig:
* docs/manual/sink-element.png:
* docs/manual/src-element.fig:
* docs/manual/src-element.png:
* docs/manual/diagrams-general.svg:
* docs/manual/diagrams-pipelines.svg:
Removed .fig, added .png counterpart.
Fixes: #539137
2008-06-27 07:03:05 +00:00
Luc Pionchon
498cda94b5 docs/manual/manual.xml: - Reorganised the previous "introduction" bundle into Foreword,
Original commit message from CVS:
patch by: Luc Pionchon  <luc.pionchon@nokia.com>
* docs/manual/manual.xml:
- Reorganised the previous "introduction" bundle into Foreword,
Introduction, and About GStreamer. The two first are <preface>
docbook elements. The later is the first part of the book.
- added intro-gstreamer.xml (content partially from
intro-preface.xml)
- moved appendix-win32.xml into appendix-integration.xml
* docs/manual/intro-preface.xml: gstreamer section moved...
* docs/manual/intro-gstreamer.xml: ...here. new file.
* docs/manual/appendix-win32.xml: removed file. Content moved...
* docs/manual/appendix-integration.xml: ...here.
* docs/manual/highlevel-components.xml: section about GstEditor moved...
* docs/manual/appendix-checklist.xml: ...here.
2008-06-25 14:44:52 +00:00
Luc Pionchon
4302aa48c2 docs/manual/: - Explicitely include glib.h.
Original commit message from CVS:
patch by: Luc Pionchon  <luc.pionchon@nokia.com>
* docs/manual/basics-helloworld.xml:
* docs/manual/hello-world.fig:
- Explicitely include glib.h.
- Do not use global variables.
- Use g_printerr() instead of g_print().
- Minor formating/renaming to increase readibility.
- Renamed new_pad() to on_pad_added()
- Improved explenatory comments.
- renamed ogg parser to ogg demuxer
- Use "autoaudiosink" instead of "alsasink".
Fixes: #538619
2008-06-25 14:32:53 +00:00
Stefan Kost
bc82d5536c docs/README: Document that for plgin-docs we extraxt he short-desc from the element details.
Original commit message from CVS:
* docs/README:
Document that for plgin-docs we extraxt he short-desc from the element
details.
* docs/design/part-states.txt:
Tell that devices should be closed in PAUSED -> READY.
* docs/manual/README:
Document how tests in the manual are handled.
* docs/manuals.mak:
Typo in comment.
2008-06-25 14:25:49 +00:00
Luc Pionchon
7dd35f98f7 docs/manual/: Typo and formatting fixes (#538594).
Original commit message from CVS:
Patch by: Luc Pionchon  <luc.pionchon@nokia.com>
* docs/manual/appendix-integration.xml:
* docs/manual/appendix-licensing.xml:
* docs/manual/basics-elements.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-pads.xml:
* docs/manual/highlevel-components.xml:
* docs/manual/highlevel-xml.xml:
* docs/manual/intro-basics.xml:
* docs/manual/intro-preface.xml:
Typo and formatting fixes (#538594).
2008-06-24 19:56:51 +00:00
Wim Taymans
e52bc83dd2 docs/manual/: Avoid using a bad function in the example code.
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/basics-pads.xml:
* docs/manual/highlevel-components.xml:
Avoid using a bad function in the example code.
2008-05-21 15:51:25 +00:00
Tim-Philipp Müller
c3a2e0699f docs/manual/advanced-dataaccess.xml: Don't imply that it's okay to unconditionally change buffer data or buffer metad...
Original commit message from CVS:
* docs/manual/advanced-dataaccess.xml:
Don't imply that it's okay to unconditionally change
buffer data or buffer metadata in a pad probe callback,
and a bunch of other comments. Fixes #430031.
2007-10-09 10:41:41 +00:00
Tim-Philipp Müller
fe6deca584 docs/manual/advanced-autoplugging.xml: Prefix section with broken code with a warning (see #342432).
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml:
Prefix section with broken code with a warning (see #342432).
2007-10-08 17:59:35 +00:00
Tim-Philipp Müller
26d3fa8946 docs/manual/: Call g_thread_init() before g_option_context_new() to avoid warnings. Spotted by Ritesh Khadgaray. Fixe...
Original commit message from CVS:
* docs/manual/appendix-integration.xml:
* docs/manual/basics-init.xml:
Call g_thread_init() before g_option_context_new() to
avoid warnings. Spotted by Ritesh Khadgaray. Fixes #484225.
2007-10-08 17:26:09 +00:00
Steve Fink
922617a0e0 docs/manual/appendix-checklist.xml: Mention less -R switch in the section about debug output (#474055).
Original commit message from CVS:
Patch by: Steve Fink  <sphink gmail com>
* docs/manual/appendix-checklist.xml:
Mention less -R switch in the section about debug output (#474055).
2007-09-13 19:27:53 +00:00
Wim Taymans
d845f192ae docs/manual/highlevel-xml.xml: Fix XML example code. Fixes #472714.
Original commit message from CVS:
* docs/manual/highlevel-xml.xml:
Fix XML example code. Fixes #472714.
2007-09-05 22:29:58 +00:00
Thomas Vander Stichele
2f0f37ee73 add quote
Original commit message from CVS:
add quote
2007-05-22 10:21:31 +00:00
Tim-Philipp Müller
0b60f83664 docs/: Fix typo (#400987).
Original commit message from CVS:
* docs/manual/manual.xml:
* docs/pwg/pwg.xml:
Fix typo (#400987).
2007-01-26 13:07:36 +00:00
Carlos Sanmartin Dominguez
7c4dc118f6 docs/manual/basics-bus.xml: Fix example code, gst_element_unref() doesn't exist any longer.
Original commit message from CVS:
Patch by: Carlos Sanmartin Dominguez <csanmartin@igalia.com>
* docs/manual/basics-bus.xml:
Fix example code, gst_element_unref() doesn't exist any longer.
2007-01-22 14:30:27 +00:00
Tim-Philipp Müller
48f12a676d docs/manual/advanced-dparams.xml: Fix typo (g_object_control_properties() doesn't exist).
Original commit message from CVS:
* docs/manual/advanced-dparams.xml:
Fix typo (g_object_control_properties() doesn't exist).
2006-12-19 15:06:42 +00:00
Edward Hervey
5a5bda554c docs/manual/basics-bus.xml: No, gst_main_loop does not exist. Its g_main_loop.
Original commit message from CVS:
* docs/manual/basics-bus.xml:
No, gst_main_loop does not exist. Its g_main_loop.
Discovered by somebody who abused the copy-paste technique of coding :)
2006-12-13 12:46:28 +00:00
Stefan Kost
14da85cf94 docs/manual/basics-helloworld.xml: Add a cast in example to fix compile warning
Original commit message from CVS:
* docs/manual/basics-helloworld.xml:
Add a cast in example to fix compile warning
2006-10-18 19:43:46 +00:00
Thomas Vander Stichele
6be1935ae0 audiotestsrc is not part of core, fakesrc is
Original commit message from CVS:
audiotestsrc is not part of core, fakesrc is
2006-09-22 14:30:49 +00:00
Thomas Vander Stichele
147373d4a7 Extract the manual examples again like we used to do.
Original commit message from CVS:
* configure.ac:
* docs/manual/advanced-autoplugging.xml:
* tests/examples/Makefile.am:
* tests/examples/manual/.cvsignore:
* tests/examples/manual/Makefile.am:
* tests/examples/manual/extract.pl:
Extract the manual examples again like we used to do.
Fix one of them.
2006-09-16 10:49:47 +00:00
Tim-Philipp Müller
422f85898c docs/manual/advanced-position.xml: Fix typo in sample code.
Original commit message from CVS:
* docs/manual/advanced-position.xml:
Fix typo in sample code.
2006-09-05 14:11:06 +00:00
Tim-Philipp Müller
16b6310ae8 docs/manual/appendix-win32.xml: Remove mention of popt, we don't depend on that any longer (#353136). Add some commen...
Original commit message from CVS:
* docs/manual/appendix-win32.xml:
Remove mention of popt, we don't depend on that any
longer (#353136). Add some comments pointing out that
this section is slightly outdated.
2006-08-28 11:06:05 +00:00
Tim-Philipp Müller
4ff1d20852 docs/manual/basics-bus.xml: Docs update: fix wrong callback return value explanation; add some lines about the implic...
Original commit message from CVS:
* docs/manual/basics-bus.xml:
Docs update: fix wrong callback return value explanation; add
some lines about the implicit relationship between main loop
and main context; remove duplicate main loop variable declaration.
2006-08-25 16:46:09 +00:00
Tim-Philipp Müller
f0879c8e68 docs/manual/basics-elements.xml: Fix gst_element_link() example.
Original commit message from CVS:
* docs/manual/basics-elements.xml:
Fix gst_element_link() example.
* gst/gstutils.c:
Mention in API docs that one should usually gst_bin_add()
elements to a bin or pipeline before doing the linking.
2006-07-26 11:43:23 +00:00
Tim-Philipp Müller
f4ff8137ad docs/manual/advanced-dataaccess.xml: Fix buffer probe example compilation in
Original commit message from CVS:
* docs/manual/advanced-dataaccess.xml:
Fix buffer probe example compilation in
ADM (#345708).
2006-06-23 10:30:09 +00:00
Philip Jägenstedt
33d4367def docs/manual/advanced-dataaccess.xml: Fix 'Embedding static elements' section to use
Original commit message from CVS:
Patch by: Philip Jägenstedt  <philip at lysator liu se>
* docs/manual/advanced-dataaccess.xml:
Fix 'Embedding static elements' section to use
GST_PLUGIN_DEFINE_STATIC (#345607).
2006-06-22 08:53:40 +00:00
Tim-Philipp Müller
49c923d8f6 docs/manual/: Don't leak bus reference in sample code.
Original commit message from CVS:
* docs/manual/advanced-autoplugging.xml:
* docs/manual/basics-helloworld.xml:
* docs/manual/highlevel-components.xml:
Don't leak bus reference in sample code.
2006-06-16 09:39:54 +00:00
Thomas Vander Stichele
0734eb921c docs/: add a gdp image
Original commit message from CVS:

* docs/README:
* docs/images/gdp-header.svg:
add a gdp image
* docs/libs/Makefile.am:
* docs/libs/gdp-header.png:
* libs/gst/dataprotocol/dataprotocol.c:
add it to the API docs
* docs/manual/intro-motivation.xml:
fix typo
2006-06-13 19:24:34 +00:00
Wim Taymans
569f8862d8 docs/manual/advanced-dataaccess.xml: Fix wrong PluginDesc. Fixes #344755.
Original commit message from CVS:
* docs/manual/advanced-dataaccess.xml:
Fix wrong PluginDesc. Fixes #344755.
2006-06-13 16:24:43 +00:00
Tim-Philipp Müller
aeca9dda7b docs/manual/: Fix typos and minor errors in sample code (#341856).
Original commit message from CVS:
* docs/manual/basics-bins.xml:
* docs/manual/basics-init.xml:
Fix typos and minor errors in sample code (#341856).
2006-05-16 16:10:38 +00:00