mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-01 12:20:42 +00:00
audio/video: update documentation for vfunc's that require chaining up
This commit is contained in:
parent
d9279b1304
commit
8a5cf5ef4d
|
@ -215,12 +215,18 @@ struct _GstAudioDecoder
|
||||||
* Allows closing external resources.
|
* Allows closing external resources.
|
||||||
* @negotiate: Optional.
|
* @negotiate: Optional.
|
||||||
* Negotiate with downstream and configure buffer pools, etc.
|
* Negotiate with downstream and configure buffer pools, etc.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @decide_allocation: Optional.
|
* @decide_allocation: Optional.
|
||||||
* Setup the allocation parameters for allocating output
|
* Setup the allocation parameters for allocating output
|
||||||
* buffers. The passed in query contains the result of the
|
* buffers. The passed in query contains the result of the
|
||||||
* downstream allocation query.
|
* downstream allocation query.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @propose_allocation: Optional.
|
* @propose_allocation: Optional.
|
||||||
* Propose buffer allocation parameters for upstream elements.
|
* Propose buffer allocation parameters for upstream elements.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
*
|
*
|
||||||
* Subclasses can override any of the available virtual methods or not, as
|
* Subclasses can override any of the available virtual methods or not, as
|
||||||
* needed. At minimum @handle_frame (and likely @set_format) needs to be
|
* needed. At minimum @handle_frame (and likely @set_format) needs to be
|
||||||
|
|
|
@ -159,12 +159,18 @@ struct _GstAudioEncoder {
|
||||||
* Allows closing external resources.
|
* Allows closing external resources.
|
||||||
* @negotiate: Optional.
|
* @negotiate: Optional.
|
||||||
* Negotiate with downstream and configure buffer pools, etc.
|
* Negotiate with downstream and configure buffer pools, etc.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @decide_allocation: Optional.
|
* @decide_allocation: Optional.
|
||||||
* Setup the allocation parameters for allocating output
|
* Setup the allocation parameters for allocating output
|
||||||
* buffers. The passed in query contains the result of the
|
* buffers. The passed in query contains the result of the
|
||||||
* downstream allocation query.
|
* downstream allocation query.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @propose_allocation: Optional.
|
* @propose_allocation: Optional.
|
||||||
* Propose buffer allocation parameters for upstream elements.
|
* Propose buffer allocation parameters for upstream elements.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
*
|
*
|
||||||
* Subclasses can override any of the available virtual methods or not, as
|
* Subclasses can override any of the available virtual methods or not, as
|
||||||
* needed. At minimum @set_format and @handle_frame needs to be overridden.
|
* needed. At minimum @set_format and @handle_frame needs to be overridden.
|
||||||
|
|
|
@ -219,18 +219,28 @@ struct _GstVideoDecoder
|
||||||
* Event handler on the sink pad. This function should return
|
* Event handler on the sink pad. This function should return
|
||||||
* TRUE if the event was handled and should be discarded
|
* TRUE if the event was handled and should be discarded
|
||||||
* (i.e. not unref'ed).
|
* (i.e. not unref'ed).
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @src_event: Optional.
|
* @src_event: Optional.
|
||||||
* Event handler on the source pad. This function should return
|
* Event handler on the source pad. This function should return
|
||||||
* TRUE if the event was handled and should be discarded
|
* TRUE if the event was handled and should be discarded
|
||||||
* (i.e. not unref'ed).
|
* (i.e. not unref'ed).
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @negotiate: Optional.
|
* @negotiate: Optional.
|
||||||
* Negotiate with downstream and configure buffer pools, etc.
|
* Negotiate with downstream and configure buffer pools, etc.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @decide_allocation: Optional.
|
* @decide_allocation: Optional.
|
||||||
* Setup the allocation parameters for allocating output
|
* Setup the allocation parameters for allocating output
|
||||||
* buffers. The passed in query contains the result of the
|
* buffers. The passed in query contains the result of the
|
||||||
* downstream allocation query.
|
* downstream allocation query.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @propose_allocation: Optional.
|
* @propose_allocation: Optional.
|
||||||
* Propose buffer allocation parameters for upstream elements.
|
* Propose buffer allocation parameters for upstream elements.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
*
|
*
|
||||||
* Subclasses can override any of the available virtual methods or not, as
|
* Subclasses can override any of the available virtual methods or not, as
|
||||||
* needed. At minimum @handle_frame needs to be overridden, and @set_format
|
* needed. At minimum @handle_frame needs to be overridden, and @set_format
|
||||||
|
|
|
@ -188,18 +188,28 @@ struct _GstVideoEncoder
|
||||||
* Event handler on the sink pad. This function should return
|
* Event handler on the sink pad. This function should return
|
||||||
* TRUE if the event was handled and should be discarded
|
* TRUE if the event was handled and should be discarded
|
||||||
* (i.e. not unref'ed).
|
* (i.e. not unref'ed).
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @src_event: Optional.
|
* @src_event: Optional.
|
||||||
* Event handler on the source pad. This function should return
|
* Event handler on the source pad. This function should return
|
||||||
* TRUE if the event was handled and should be discarded
|
* TRUE if the event was handled and should be discarded
|
||||||
* (i.e. not unref'ed).
|
* (i.e. not unref'ed).
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @negotiate: Optional.
|
* @negotiate: Optional.
|
||||||
* Negotiate with downstream and configure buffer pools, etc.
|
* Negotiate with downstream and configure buffer pools, etc.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @decide_allocation: Optional.
|
* @decide_allocation: Optional.
|
||||||
* Setup the allocation parameters for allocating output
|
* Setup the allocation parameters for allocating output
|
||||||
* buffers. The passed in query contains the result of the
|
* buffers. The passed in query contains the result of the
|
||||||
* downstream allocation query.
|
* downstream allocation query.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
* @propose_allocation: Optional.
|
* @propose_allocation: Optional.
|
||||||
* Propose buffer allocation parameters for upstream elements.
|
* Propose buffer allocation parameters for upstream elements.
|
||||||
|
* Subclasses should chain up to the parent implementation to
|
||||||
|
* invoke the default handler.
|
||||||
*
|
*
|
||||||
* Subclasses can override any of the available virtual methods or not, as
|
* Subclasses can override any of the available virtual methods or not, as
|
||||||
* needed. At minimum @handle_frame needs to be overridden, and @set_format
|
* needed. At minimum @handle_frame needs to be overridden, and @set_format
|
||||||
|
|
Loading…
Reference in a new issue