gstreamer.TagSetterIF source code

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 private import glib.Str;
66 private import gobject.Value;
67 private import gstreamer.TagList;
68 
69 
70 
71 /**
72  * Element interface that allows setting of media metadata.
73  *
74  * Elements that support changing a stream's metadata will implement this
75  * interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
76  * 'id3v2mux'.
77  *
78  * If you just want to retrieve metadata in your application then all you
79  * need to do is watch for tag messages on your pipeline's bus. This
80  * interface is only for setting metadata, not for extracting it. To set tags
81  * from the application, find tagsetter elements and set tags using e.g.
82  * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). Also consider
83  * setting the GstTagMergeMode that is used for tag events that arrive at the
84  * tagsetter element (default mode is to keep existing tags).
85  * The application should do that before the element goes to GST_STATE_PAUSED.
86  *
87  * Elements implementing the GstTagSetter interface often have to merge
88  * any tags received from upstream and the tags set by the application via
89  * the interface. This can be done like this:
90  *
91  * $(DDOC_COMMENT example)
92  *
93  * Last reviewed on 2006-05-18 (0.10.6)
94  */
95 public interface TagSetterIF
96 {
97 	
98 	
99 	/** Get the main Gtk struct */
100 	public GstTagSetter* getTagSetterTStruct();
101 	
102 	/** the main Gtk struct as a void* */
103 	protected void* getStruct();
104 	
105 	
106 	/**
107 	 */
108 	
109 	/**
110 	 * Reset the internal taglist. Elements should call this from within the
111 	 * state-change handler.
112 	 */
113 	public void resetTags();
114 	
115 	/**
116 	 * Merges the given list into the setter's list using the given mode.
117 	 * Params:
118 	 * list = a tag list to merge from
119 	 * mode = the mode to merge with
120 	 */
121 	public void mergeTags(TagList list, GstTagMergeMode mode);
122 	
123 	/**
124 	 * Adds the given tag / GValue pair on the setter using the given merge mode.
125 	 * Params:
126 	 * mode = the mode to use
127 	 * tag = tag to set
128 	 * value = GValue to set for the tag
129 	 */
130 	public void addTagValue(GstTagMergeMode mode, string tag, Value value);
131 	
132 	/**
133 	 * Adds the given tag / value pairs on the setter using the given merge mode.
134 	 * The list must be terminated with NULL.
135 	 * Params:
136 	 * mode = the mode to use
137 	 * tag = tag to set
138 	 * varArgs = tag / value pairs to set
139 	 */
140 	public void addTagValist(GstTagMergeMode mode, string tag, void* varArgs);
141 	
142 	/**
143 	 * Adds the given tag / GValue pairs on the setter using the given merge mode.
144 	 * The list must be terminated with NULL.
145 	 * Params:
146 	 * mode = the mode to use
147 	 * tag = tag to set
148 	 * varArgs = tag / GValue pairs to set
149 	 */
150 	public void addTagValistValues(GstTagMergeMode mode, string tag, void* varArgs);
151 	
152 	/**
153 	 * Returns the current list of tags the setter uses. The list should not be
154 	 * modified or freed.
155 	 * This function is not thread-safe.
156 	 * Returns: a current snapshot of the taglist used in the setter or NULL if none is used. [transfer none]
157 	 */
158 	public TagList getTagList();
159 	
160 	/**
161 	 * Sets the given merge mode that is used for adding tags from events to tags
162 	 * specified by this interface. The default is GST_TAG_MERGE_KEEP, which keeps
163 	 * the tags set with this interface and discards tags from events.
164 	 * Params:
165 	 * mode = The mode with which tags are added
166 	 */
167 	public void setTagMergeMode(GstTagMergeMode mode);
168 	
169 	/**
170 	 * Queries the mode by which tags inside the setter are overwritten by tags
171 	 * from events
172 	 * Returns: the merge mode used inside the element.
173 	 */
174 	public GstTagMergeMode getTagMergeMode();
175 }