* activate function that puts the pad in push mode but elements can
* override this function to activate the pad in pull mode if they wish.
*
- * Returns: TRUE if the pad could be activated.
+ * Returns: %TRUE if the pad could be activated.
*/
typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstObject *parent);
/**
*
* The prototype of the push and pull activate functions.
*
- * Returns: TRUE if the pad could be activated or deactivated.
+ * Returns: %TRUE if the pad could be activated or deactivated.
*/
typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, GstObject *parent,
GstPadMode mode, gboolean active);
* GstPadChainFunction:
* @pad: the sink #GstPad that performed the chain.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @buffer: the #GstBuffer that is chained, not %NULL.
*
* GstPadChainListFunction:
* @pad: the sink #GstPad that performed the chain.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @list: the #GstBufferList that is chained, not %NULL.
*
* GstPadGetRangeFunction:
* @pad: the src #GstPad to perform the getrange on.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @offset: the offset of the range
* @length: the length of the range
- * @buffer: a memory location to hold the result buffer, cannot be NULL.
+ * @buffer: a memory location to hold the result buffer, cannot be %NULL.
*
* This function will be called on source pads when a peer element
* request a buffer at the specified @offset and @length. If this function
* GstPadEventFunction:
* @pad: the #GstPad to handle the event.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @event: the #GstEvent to handle.
*
* Function signature to handle an event for the pad.
*
- * Returns: TRUE if the pad could handle the event.
+ * Returns: %TRUE if the pad could handle the event.
*/
typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstObject *parent,
GstEvent *event);
* GstPadIterIntLinkFunction:
* @pad: The #GstPad to query.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
*
* The signature of the internal pad link iterator function.
* GstPadQueryFunction:
* @pad: the #GstPad to query.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @query: the #GstQuery object to execute
*
* The signature of the query function.
*
- * Returns: TRUE if the query could be performed.
+ * Returns: %TRUE if the query could be performed.
*/
typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent,
GstQuery *query);
* GstPadLinkFunction:
* @pad: the #GstPad that is linked.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
* @peer: the peer #GstPad of the link
*
* GstPadUnlinkFunction:
* @pad: the #GstPad that is linked.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
- * @parent is guaranteed to be not-NULL and remain valid during the
+ * @parent is guaranteed to be not-%NULL and remain valid during the
* execution of this function.
*
* Function signature to handle a unlinking the pad prom its peer.
* A forward function is called for all internally linked pads, see
* gst_pad_forward().
*
- * Returns: TRUE if the dispatching procedure has to be stopped.
+ * Returns: %TRUE if the dispatching procedure has to be stopped.
*/
typedef gboolean (*GstPadForwardFunction) (GstPad *pad, gpointer user_data);
* @type: the current probe type
* @id: the id of the probe
* @data: type specific data, check the @type field to know the datatype.
- * This field can be NULL.
+ * This field can be %NULL.
* @offset: offset of pull probe, this field is valid when @type contains
* #GST_PAD_PROBE_TYPE_PULL
* @size: size of pull probe, this field is valid when @type contains
* When this function returns %TRUE, the next event will be
* returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return.
*
- * When @event is set to NULL, the item will be removed from the list of sticky events.
+ * When @event is set to %NULL, the item will be removed from the list of sticky events.
* @event can be replaced by assigning a new reference to it.
* This function is responsible for unreffing the old event when
* removing or modifying.
* GST_PAD_IS_SRC:
* @pad: a #GstPad
*
- * Returns: TRUE if the pad is a source pad (i.e. produces data).
+ * Returns: %TRUE if the pad is a source pad (i.e. produces data).
*/
#define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
/**
* GST_PAD_IS_SINK:
* @pad: a #GstPad
*
- * Returns: TRUE if the pad is a sink pad (i.e. consumes data).
+ * Returns: %TRUE if the pad is a sink pad (i.e. consumes data).
*/
#define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
/**
* GST_PAD_IS_LINKED:
* @pad: a #GstPad
*
- * Returns: TRUE if the pad is linked to another pad. Use gst_pad_is_linked()
+ * Returns: %TRUE if the pad is linked to another pad. Use gst_pad_is_linked()
* instead.
*/
#define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
* GST_PAD_IS_ACTIVE:
* @pad: a #GstPad
*
- * Returns: TRUE if the pad has been activated.
+ * Returns: %TRUE if the pad has been activated.
*/
#define GST_PAD_IS_ACTIVE(pad) (GST_PAD_MODE(pad) != GST_PAD_MODE_NONE)
/**
* GST_PAD_STREAM_TRYLOCK:
* @pad: a #GstPad
*
- * Try to take the pad's stream lock, and return TRUE if the lock could be
- * taken, and otherwise FALSE.
+ * Try to take the pad's stream lock, and return %TRUE if the lock could be
+ * taken, and otherwise %FALSE.
*/
#define GST_PAD_STREAM_TRYLOCK(pad) g_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad))
/**
*
* Get the parent of @pad. This function increases the refcount
* of the parent object so you should gst_object_unref() it after usage.
- * Can return NULL if the pad did not have a parent.
+ * Can return %NULL if the pad did not have a parent.
*
* MT safe.
*/
projects / platform / upstream / gstreamer.git / blobdiff