mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-30 12:49:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve event docs

Browse source 
Rephrase first paragraph of section docs. Add detail to eos event docs.
This commit is contained in:
Stefan Kost 2010-04-04 15:21:16 +03:00
parent 5f3d98f29f
commit d29c31f9cd
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
gst/gstevent.c
View file

@ -27,8 +27,8 @@
* a pipeline * a pipeline
* @see_also: #GstPad, #GstElement * @see_also: #GstPad, #GstElement
* *
* The event class provides factory methods to construct and functions query * The event class provides factory methods to construct event for sending
* (parse) events. * and functions to query (parse) received events.
* *
* Events are usually created with gst_event_new_*() which takes event-type * Events are usually created with gst_event_new_*() which takes event-type
* specific parameters as arguments. * specific parameters as arguments.
@ -476,6 +476,8 @@ gst_event_new_flush_stop (void)
* When all sinks have posted an EOS message, an EOS message is * When all sinks have posted an EOS message, an EOS message is
* forwarded to the application. * forwarded to the application.
* *
* The EOS event itself will no cause any state transitions of the pipeline.
*
* Returns: The new EOS event. * Returns: The new EOS event.
*/ */
GstEvent * GstEvent *