/**
* SECTION:gsttagsetter
+ * @title: GstTagsetter
* @short_description: Element interface that allows setting and retrieval
* of media metadata
*
* Elements that support changing a stream's metadata will implement this
* interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
* 'id3v2mux'.
- *
+ *
* If you just want to retrieve metadata in your application then all you
* need to do is watch for tag messages on your pipeline's bus. This
* interface is only for setting metadata, not for extracting it. To set tags
* setting the #GstTagMergeMode that is used for tag events that arrive at the
* tagsetter element (default mode is to keep existing tags).
* The application should do that before the element goes to %GST_STATE_PAUSED.
- *
+ *
* Elements implementing the #GstTagSetter interface often have to merge
* any tags received from upstream and the tags set by the application via
* the interface. This can be done like this:
*
- * |[
+ * |[<!-- language="C" -->
* GstTagMergeMode merge_mode;
* const GstTagList *application_tags;
* const GstTagList *event_tags;
* GstTagSetter *tagsetter;
* GstTagList *result;
- *
+ *
* tagsetter = GST_TAG_SETTER (element);
- *
+ *
* merge_mode = gst_tag_setter_get_tag_merge_mode (tagsetter);
* application_tags = gst_tag_setter_get_tag_list (tagsetter);
* event_tags = (const GstTagList *) element->event_tags;
- *
+ *
* GST_LOG_OBJECT (tagsetter, "merging tags, merge mode = %d", merge_mode);
* GST_LOG_OBJECT (tagsetter, "event tags: %" GST_PTR_FORMAT, event_tags);
* GST_LOG_OBJECT (tagsetter, "set tags: %" GST_PTR_FORMAT, application_tags);
- *
+ *
* result = gst_tag_list_merge (application_tags, event_tags, merge_mode);
- *
+ *
* GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);
* ]|
- *
- * Last reviewed on 2006-05-18 (0.10.6)
*/
#ifdef HAVE_CONFIG_H
* @...: more tag / value pairs to set
*
* Adds the given tag / value pairs on the setter using the given merge mode.
- * The list must be terminated with NULL.
+ * The list must be terminated with %NULL.
*/
void
gst_tag_setter_add_tags (GstTagSetter * setter, GstTagMergeMode mode,
* @...: more tag / GValue pairs to set
*
* Adds the given tag / GValue pairs on the setter using the given merge mode.
- * The list must be terminated with NULL.
+ * The list must be terminated with %NULL.
*/
void
gst_tag_setter_add_tag_values (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / value pairs to set
*
* Adds the given tag / value pairs on the setter using the given merge mode.
- * The list must be terminated with NULL.
+ * The list must be terminated with %NULL.
*/
void
gst_tag_setter_add_tag_valist (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / GValue pairs to set
*
* Adds the given tag / GValue pairs on the setter using the given merge mode.
- * The list must be terminated with NULL.
+ * The list must be terminated with %NULL.
*/
void
gst_tag_setter_add_tag_valist_values (GstTagSetter * setter,
*
* This function is not thread-safe.
*
- * Returns: (transfer none): a current snapshot of the taglist used in the
- * setter or NULL if none is used.
+ * Returns: (transfer none) (nullable): a current snapshot of the
+ * taglist used in the setter or %NULL if none is used.
*/
const GstTagList *
gst_tag_setter_get_tag_list (GstTagSetter * setter)