design: push-pull: fix missing markup

Additionally, fix some grammar issues while at it.
This commit is contained in:
Reynaldo H. Verdejo Pinochet 2016-12-28 22:36:09 -08:00
parent 8f351ae79a
commit ab1684cc62

View file

@ -12,26 +12,26 @@ downstream element is the driving force in the pipeline as it initiates
data transfer. data transfer.
It is important that the elements are in the correct state to handle a It is important that the elements are in the correct state to handle a
push() or a `pull_range()` from the peer element. For push() based `push()` or a `pull_range()` from the peer element. For `push()` based
elements this means that all downstream elements should be in the elements this means that all downstream elements should be in the
correct state and for `pull_range()` based elements this means the correct state and for `pull_range()` based elements this means the
upstream elements should be in the correct state. upstream elements should be in the correct state.
Most sinkpads implement a chain function. This is the most common case. Most sinkpads implement a chain function. This is the most common case.
sinkpads implementing a loop function will be the exception. Likewise sinkpads implementing a loop function will be the exception. Likewise,
srcpads implementing a getrange function will be the exception. srcpads implementing a getrange function will be the exception.
## state changes ## State changes
The GstBin sets the state of all the sink elements. These are the The `GstBin` sets the state of all the sink elements. These are the
elements without source pads. elements without source pads.
Setting the state on an element will first activate all the srcpads and Setting the state on an element will first activate all the srcpads and
then the sinkpads. For each of the sinkpads, then the sinkpads. For each of the sinkpads,
`gst_pad_check_pull_range()` is performed. If the sinkpad supports a `gst_pad_check_pull_range()` is performed. If the sinkpad supports a
loopfunction and the peer pad returns TRUE from the GstPadCheckPullRange loopfunction and the peer pad returns TRUE from the `GstPadCheckPullRange`
function, then the peer pad is activated first as it must be in the function, then the peer pad is activated first as it must be in the
right state to handle a `_pull_range().` Note that the state change of right state to handle a `_pull_range()`. Note that the state change of
the element is not yet performed, just the activate function is called the element is not yet performed, just the activate function is called
on the source pad. This means that elements that implement a getrange on the source pad. This means that elements that implement a getrange
function must be prepared to get their activate function called before function must be prepared to get their activate function called before