mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-25 17:50:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

doc: Fix some doctsing making GI happy

Browse source
This commit is contained in:
Thibault Saunier 2017-04-21 10:51:59 -03:00
parent e6db45a8af
commit b15d59b53c
1 changed files with 0 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
gst/gstelement.h
View file

@ -177,14 +177,11 @@ typedef enum {
/** /**
* GstStateChange: * GstStateChange:
* @GST_STATE_CHANGE_NULL_TO_READY : state change from NULL to READY. * @GST_STATE_CHANGE_NULL_TO_READY : state change from NULL to READY.
*
* * The element must check if the resources it needs are available. Device * * The element must check if the resources it needs are available. Device
* sinks and -sources typically try to probe the device to constrain their * sinks and -sources typically try to probe the device to constrain their
* caps. * caps.
* * The element opens the device (in case feature need to be probed). * * The element opens the device (in case feature need to be probed).
*
* @GST_STATE_CHANGE_READY_TO_PAUSED : state change from READY to PAUSED. * @GST_STATE_CHANGE_READY_TO_PAUSED : state change from READY to PAUSED.
*
* * The element pads are activated in order to receive data in PAUSED. * * The element pads are activated in order to receive data in PAUSED.
* Streaming threads are started. * Streaming threads are started.
* * Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete * * Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete
@ -193,11 +190,8 @@ typedef enum {
* when they receive the first buffer or %GST_EVENT_EOS (preroll). * when they receive the first buffer or %GST_EVENT_EOS (preroll).
* Sinks also block the dataflow when in PAUSED. * Sinks also block the dataflow when in PAUSED.
* * A pipeline resets the running_time to 0. * * A pipeline resets the running_time to 0.
*
* * Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data. * * Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data.
*
* @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING. * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING.
*
* * Most elements ignore this state change. * * Most elements ignore this state change.
* * The pipeline selects a #GstClock and distributes this to all the children * * The pipeline selects a #GstClock and distributes this to all the children
* before setting them to PLAYING. This means that it is only allowed to * before setting them to PLAYING. This means that it is only allowed to
@ -212,14 +206,11 @@ typedef enum {
* * While streaming in PAUSED or PLAYING elements can create and remove * * While streaming in PAUSED or PLAYING elements can create and remove
* sometimes pads. * sometimes pads.
* * Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS. * * Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS.
*
* @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED. * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED.
*
* * Most elements ignore this state change. * * Most elements ignore this state change.
* * The pipeline calculates the running_time based on the last selected * * The pipeline calculates the running_time based on the last selected
* #GstClock and the base_time. It stores this information to continue * #GstClock and the base_time. It stores this information to continue
* playback when going back to the PLAYING state. * playback when going back to the PLAYING state.
*
* * Sinks unblock any #GstClock wait calls. * * Sinks unblock any #GstClock wait calls.
* * When a sink does not have a pending buffer to play, it returns * * When a sink does not have a pending buffer to play, it returns
* #GST_STATE_CHANGE_ASYNC from this state change and completes the state * #GST_STATE_CHANGE_ASYNC from this state change and completes the state
@ -227,11 +218,8 @@ typedef enum {
* * Any queued %GST_MESSAGE_EOS items are removed since they will be reposted * * Any queued %GST_MESSAGE_EOS items are removed since they will be reposted
* when going back to the PLAYING state. The EOS messages are queued in * when going back to the PLAYING state. The EOS messages are queued in
* #GstBin containers. * #GstBin containers.
*
* * Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL. * * Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL.
*
* @GST_STATE_CHANGE_PAUSED_TO_READY : state change from PAUSED to READY. * @GST_STATE_CHANGE_PAUSED_TO_READY : state change from PAUSED to READY.
*
* * Sinks unblock any waits in the preroll. * * Sinks unblock any waits in the preroll.
* * Elements unblock any waits on devices * * Elements unblock any waits on devices
* * Chain or get_range functions return %GST_FLOW_FLUSHING. * * Chain or get_range functions return %GST_FLOW_FLUSHING.
@ -239,9 +227,7 @@ typedef enum {
* all streaming threads are stopped. * all streaming threads are stopped.
* * The sink forgets all negotiated formats * * The sink forgets all negotiated formats
* * Elements remove all sometimes pads * * Elements remove all sometimes pads
*
* @GST_STATE_CHANGE_READY_TO_NULL : state change from READY to NULL. * @GST_STATE_CHANGE_READY_TO_NULL : state change from READY to NULL.
*
* * Elements close devices * * Elements close devices
* * Elements reset any internal state. * * Elements reset any internal state.
* *