Unofficial Dub Package Documentation 
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  * Conversion parameters:
26  * inFile  = GstTagSetter.html
27  * outPack = gstreamer
28  * outFile = TagSetterIF
29  * strct   = GstTagSetter
30  * realStrct=
31  * ctorStrct=
32  * clss    = TagSetterT
33  * interf  = TagSetterIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gst_tag_setter_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- glib.Str
47  * 	- gobject.Value
48  * 	- gstreamer.TagList
49  * structWrap:
50  * 	- GValue* -> Value
51  * 	- GstTagList* -> TagList
52  * module aliases:
53  * local aliases:
54  * overrides:
55  */
56 
57 module gstreamer.TagSetterIF;
58 
59 public  import gstreamerc.gstreamertypes;
60 
61 private import gstreamerc.gstreamer;
62 private import glib.ConstructionException;
63 private import gobject.ObjectG;
64 
65 
66 private import glib.Str;
67 private import gobject.Value;
68 private import gstreamer.TagList;
69 
70 
71 
72 
73 /**
74  * Element interface that allows setting of media metadata.
75  *
76  * Elements that support changing a stream's metadata will implement this
77  * interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
78  * 'id3v2mux'.
79  *
80  * If you just want to retrieve metadata in your application then all you
81  * need to do is watch for tag messages on your pipeline's bus. This
82  * interface is only for setting metadata, not for extracting it. To set tags
83  * from the application, find tagsetter elements and set tags using e.g.
84  * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). Also consider
85  * setting the GstTagMergeMode that is used for tag events that arrive at the
86  * tagsetter element (default mode is to keep existing tags).
87  * The application should do that before the element goes to GST_STATE_PAUSED.
88  *
89  * Elements implementing the GstTagSetter interface often have to merge
90  * any tags received from upstream and the tags set by the application via
91  * the interface. This can be done like this:
92  *
93  * $(DDOC_COMMENT example)
94  *
95  * Last reviewed on 2006-05-18 (0.10.6)
96  */
97 public interface TagSetterIF
98 {
99 	
100 	
101 	public GstTagSetter* getTagSetterTStruct();
102 	
103 	/** the main Gtk struct as a void* */
104 	protected void* getStruct();
105 	
106 	
107 	/**
108 	 */
109 	
110 	/**
111 	 * Reset the internal taglist. Elements should call this from within the
112 	 * state-change handler.
113 	 */
114 	public void resetTags();
115 	
116 	/**
117 	 * Merges the given list into the setter's list using the given mode.
118 	 * Params:
119 	 * list = a tag list to merge from
120 	 * mode = the mode to merge with
121 	 */
122 	public void mergeTags(TagList list, GstTagMergeMode mode);
123 	
124 	/**
125 	 * Adds the given tag / GValue pair on the setter using the given merge mode.
126 	 * Params:
127 	 * mode = the mode to use
128 	 * tag = tag to set
129 	 * value = GValue to set for the tag
130 	 */
131 	public void addTagValue(GstTagMergeMode mode, string tag, Value value);
132 	
133 	/**
134 	 * Adds the given tag / value pairs on the setter using the given merge mode.
135 	 * The list must be terminated with NULL.
136 	 * Params:
137 	 * mode = the mode to use
138 	 * tag = tag to set
139 	 * varArgs = tag / value pairs to set
140 	 */
141 	public void addTagValist(GstTagMergeMode mode, string tag, void* varArgs);
142 	
143 	/**
144 	 * Adds the given tag / GValue pairs on the setter using the given merge mode.
145 	 * The list must be terminated with NULL.
146 	 * Params:
147 	 * mode = the mode to use
148 	 * tag = tag to set
149 	 * varArgs = tag / GValue pairs to set
150 	 */
151 	public void addTagValistValues(GstTagMergeMode mode, string tag, void* varArgs);
152 	
153 	/**
154 	 * Returns the current list of tags the setter uses. The list should not be
155 	 * modified or freed.
156 	 * This function is not thread-safe.
157 	 * Returns: a current snapshot of the taglist used in the setter or NULL if none is used. [transfer none]
158 	 */
159 	public TagList getTagList();
160 	
161 	/**
162 	 * Sets the given merge mode that is used for adding tags from events to tags
163 	 * specified by this interface. The default is GST_TAG_MERGE_KEEP, which keeps
164 	 * the tags set with this interface and discards tags from events.
165 	 * Params:
166 	 * mode = The mode with which tags are added
167 	 */
168 	public void setTagMergeMode(GstTagMergeMode mode);
169 	
170 	/**
171 	 * Queries the mode by which tags inside the setter are overwritten by tags
172 	 * from events
173 	 * Returns: the merge mode used inside the element.
174 	 */
175 	public GstTagMergeMode getTagMergeMode();
176 }

Page generated by adrdox