1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gstreamer.TagSetterT;
26 
27 public  import glib.Str;
28 public  import gobject.ObjectG;
29 public  import gobject.Value;
30 public  import gstreamer.TagList;
31 public  import gstreamerc.gstreamer;
32 public  import gstreamerc.gstreamertypes;
33 
34 
35 /**
36  * Element interface that allows setting of media metadata.
37  * 
38  * Elements that support changing a stream's metadata will implement this
39  * interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
40  * 'id3v2mux'.
41  * 
42  * If you just want to retrieve metadata in your application then all you
43  * need to do is watch for tag messages on your pipeline's bus. This
44  * interface is only for setting metadata, not for extracting it. To set tags
45  * from the application, find tagsetter elements and set tags using e.g.
46  * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). Also consider
47  * setting the #GstTagMergeMode that is used for tag events that arrive at the
48  * tagsetter element (default mode is to keep existing tags).
49  * The application should do that before the element goes to %GST_STATE_PAUSED.
50  * 
51  * Elements implementing the #GstTagSetter interface often have to merge
52  * any tags received from upstream and the tags set by the application via
53  * the interface. This can be done like this:
54  * 
55  * |[<!-- language="C" -->
56  * GstTagMergeMode merge_mode;
57  * const GstTagList *application_tags;
58  * const GstTagList *event_tags;
59  * GstTagSetter *tagsetter;
60  * GstTagList *result;
61  * 
62  * tagsetter = GST_TAG_SETTER (element);
63  * 
64  * merge_mode = gst_tag_setter_get_tag_merge_mode (tagsetter);
65  * application_tags = gst_tag_setter_get_tag_list (tagsetter);
66  * event_tags = (const GstTagList *) element->event_tags;
67  * 
68  * GST_LOG_OBJECT (tagsetter, "merging tags, merge mode = %d", merge_mode);
69  * GST_LOG_OBJECT (tagsetter, "event tags: %" GST_PTR_FORMAT, event_tags);
70  * GST_LOG_OBJECT (tagsetter, "set   tags: %" GST_PTR_FORMAT, application_tags);
71  * 
72  * result = gst_tag_list_merge (application_tags, event_tags, merge_mode);
73  * 
74  * GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);
75  * ]|
76  */
77 public template TagSetterT(TStruct)
78 {
79 	/** Get the main Gtk struct */
80 	public GstTagSetter* getTagSetterStruct(bool transferOwnership = false)
81 	{
82 		if (transferOwnership)
83 			ownedRef = false;
84 		return cast(GstTagSetter*)getStruct();
85 	}
86 
87 
88 	/**
89 	 * Adds the given tag / value pairs on the setter using the given merge mode.
90 	 * The list must be terminated with %NULL.
91 	 *
92 	 * Params:
93 	 *     mode = the mode to use
94 	 *     tag = tag to set
95 	 *     varArgs = tag / value pairs to set
96 	 */
97 	public void addTagValist(GstTagMergeMode mode, string tag, void* varArgs)
98 	{
99 		gst_tag_setter_add_tag_valist(getTagSetterStruct(), mode, Str.toStringz(tag), varArgs);
100 	}
101 
102 	/**
103 	 * Adds the given tag / GValue pairs on the setter using the given merge mode.
104 	 * The list must be terminated with %NULL.
105 	 *
106 	 * Params:
107 	 *     mode = the mode to use
108 	 *     tag = tag to set
109 	 *     varArgs = tag / GValue pairs to set
110 	 */
111 	public void addTagValistValues(GstTagMergeMode mode, string tag, void* varArgs)
112 	{
113 		gst_tag_setter_add_tag_valist_values(getTagSetterStruct(), mode, Str.toStringz(tag), varArgs);
114 	}
115 
116 	/**
117 	 * Adds the given tag / GValue pair on the setter using the given merge mode.
118 	 *
119 	 * Params:
120 	 *     mode = the mode to use
121 	 *     tag = tag to set
122 	 *     value = GValue to set for the tag
123 	 */
124 	public void addTagValue(GstTagMergeMode mode, string tag, Value value)
125 	{
126 		gst_tag_setter_add_tag_value(getTagSetterStruct(), mode, Str.toStringz(tag), (value is null) ? null : value.getValueStruct());
127 	}
128 
129 	/**
130 	 * Returns the current list of tags the setter uses.  The list should not be
131 	 * modified or freed.
132 	 *
133 	 * This function is not thread-safe.
134 	 *
135 	 * Returns: a current snapshot of the
136 	 *     taglist used in the setter or %NULL if none is used.
137 	 */
138 	public TagList getTagList()
139 	{
140 		auto p = gst_tag_setter_get_tag_list(getTagSetterStruct());
141 		
142 		if(p is null)
143 		{
144 			return null;
145 		}
146 		
147 		return ObjectG.getDObject!(TagList)(cast(GstTagList*) p);
148 	}
149 
150 	/**
151 	 * Queries the mode by which tags inside the setter are overwritten by tags
152 	 * from events
153 	 *
154 	 * Returns: the merge mode used inside the element.
155 	 */
156 	public GstTagMergeMode getTagMergeMode()
157 	{
158 		return gst_tag_setter_get_tag_merge_mode(getTagSetterStruct());
159 	}
160 
161 	/**
162 	 * Merges the given list into the setter's list using the given mode.
163 	 *
164 	 * Params:
165 	 *     list = a tag list to merge from
166 	 *     mode = the mode to merge with
167 	 */
168 	public void mergeTags(TagList list, GstTagMergeMode mode)
169 	{
170 		gst_tag_setter_merge_tags(getTagSetterStruct(), (list is null) ? null : list.getTagListStruct(), mode);
171 	}
172 
173 	/**
174 	 * Reset the internal taglist. Elements should call this from within the
175 	 * state-change handler.
176 	 */
177 	public void resetTags()
178 	{
179 		gst_tag_setter_reset_tags(getTagSetterStruct());
180 	}
181 
182 	/**
183 	 * Sets the given merge mode that is used for adding tags from events to tags
184 	 * specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
185 	 * the tags set with this interface and discards tags from events.
186 	 *
187 	 * Params:
188 	 *     mode = The mode with which tags are added
189 	 */
190 	public void setTagMergeMode(GstTagMergeMode mode)
191 	{
192 		gst_tag_setter_set_tag_merge_mode(getTagSetterStruct(), mode);
193 	}
194 }