docs: fix some more docs

This commit is contained in:
Wim Taymans 2011-09-28 11:16:33 +02:00
parent 8a1f401dfd
commit 947276484f
4 changed files with 14 additions and 13 deletions

View file

@ -280,7 +280,7 @@ gst_base_src_get_do_timestamp
gst_base_src_set_do_timestamp gst_base_src_set_do_timestamp
gst_base_src_set_dynamic_size gst_base_src_set_dynamic_size
gst_base_src_new_seamless_segment gst_base_src_new_seamless_segment
gst_base_src_set_dynamic_size gst_base_src_set_caps
GST_BASE_SRC_PAD GST_BASE_SRC_PAD
<SUBSECTION Standard> <SUBSECTION Standard>

View file

@ -787,7 +787,7 @@ gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
/** /**
* gst_base_src_set_caps: * gst_base_src_set_caps:
* @bsrc: a #GstBaseSrc * @src: a #GstBaseSrc
* @caps: a #GstCaps * @caps: a #GstCaps
* *
* Set new caps on the basesrc source pad. * Set new caps on the basesrc source pad.
@ -795,17 +795,17 @@ gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
* Returns: %TRUE if the caps could be set * Returns: %TRUE if the caps could be set
*/ */
gboolean gboolean
gst_base_src_set_caps (GstBaseSrc * bsrc, GstCaps * caps) gst_base_src_set_caps (GstBaseSrc * src, GstCaps * caps)
{ {
GstBaseSrcClass *bclass; GstBaseSrcClass *bclass;
gboolean res = TRUE; gboolean res = TRUE;
bclass = GST_BASE_SRC_GET_CLASS (bsrc); bclass = GST_BASE_SRC_GET_CLASS (src);
gst_pad_push_event (bsrc->srcpad, gst_event_new_caps (caps)); gst_pad_push_event (src->srcpad, gst_event_new_caps (caps));
if (bclass->set_caps) if (bclass->set_caps)
res = bclass->set_caps (bsrc, caps); res = bclass->set_caps (src, caps);
return res; return res;
} }

View file

@ -143,8 +143,10 @@ struct _GstBaseSrc {
* requested size unless fewer bytes are available because an EOS condition * requested size unless fewer bytes are available because an EOS condition
* is near. No buffer should be returned when the return value is different * is near. No buffer should be returned when the return value is different
* from GST_FLOW_OK. A return value of GST_FLOW_UNEXPECTED signifies that the * from GST_FLOW_OK. A return value of GST_FLOW_UNEXPECTED signifies that the
* end of stream is reached. The default implementation will create a new * end of stream is reached. The default implementation will call @alloc and
* buffer from the negotiated allocator and will call @fill. * then call @fill.
* @alloc: Ask the subclass to allocate a buffer with for offset and size. The
* default implementation will create a new buffer from the negotiated allocator.
* @fill: Ask the subclass to fill the buffer with data for offset and size. The * @fill: Ask the subclass to fill the buffer with data for offset and size. The
* passed buffer is guaranteed to hold the requested amount of bytes. * passed buffer is guaranteed to hold the requested amount of bytes.
* *

View file

@ -158,11 +158,10 @@ struct _GstBaseTransform {
* Handle a requested query. Subclasses that implement this * Handle a requested query. Subclasses that implement this
* should must chain up to the parent if they didn't handle the * should must chain up to the parent if they didn't handle the
* query * query
* @decide_allocation: Decide what parameters you want upstream elements to use * @propose_allocation: Propose buffer allocation parameters for upstream elements.
* for the allocation of buffers. This function is only * This function is only called when not operating in
* called when not operating in passthrough mode. The * passthrough mode. The default implementation is NULL.
* default implementation is NULL. * @decide_allocation: Setup the allocation parameters for allocating output
* @setup_allocation: 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. This function is only called * downstream allocation query. This function is only called
* when not operating in passthrough mode. The default * when not operating in passthrough mode. The default