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.PresetT;
26 
27 public  import glib.Str;
28 public  import gstreamerc.gstreamer;
29 public  import gstreamerc.gstreamertypes;
30 
31 
32 /**
33  * This interface offers methods to query and manipulate parameter preset sets.
34  * A preset is a bunch of property settings, together with meta data and a name.
35  * The name of a preset serves as key for subsequent method calls to manipulate
36  * single presets.
37  * All instances of one type will share the list of presets. The list is created
38  * on demand, if presets are not used, the list is not created.
39  * 
40  * The interface comes with a default implementation that serves most plugins.
41  * Wrapper plugins will override most methods to implement support for the
42  * native preset format of those wrapped plugins.
43  * One method that is useful to be overridden is gst_preset_get_property_names().
44  * With that one can control which properties are saved and in which order.
45  * When implementing support for read-only presets, one should set the vmethods
46  * for gst_preset_save_preset() and gst_preset_delete_preset() to %NULL.
47  * Applications can use gst_preset_is_editable() to check for that.
48  * 
49  * The default implementation supports presets located in a system directory,
50  * application specific directory and in the users home directory. When getting
51  * a list of presets individual presets are read and overlaid in 1) system,
52  * 2) application and 3) user order. Whenever an earlier entry is newer, the
53  * later entries will be updated. Since 1.8 you can also provide extra paths
54  * where to find presets through the GST_PRESET_PATH environment variable.
55  * Presets found in those paths will be concidered as "app presets".
56  */
57 public template PresetT(TStruct)
58 {
59 	/** Get the main Gtk struct */
60 	public GstPreset* getPresetStruct(bool transferOwnership = false)
61 	{
62 		if (transferOwnership)
63 			ownedRef = false;
64 		return cast(GstPreset*)getStruct();
65 	}
66 
67 
68 	/**
69 	 * Gets the directory for application specific presets if set by the
70 	 * application.
71 	 *
72 	 * Returns: the directory or %NULL, don't free or modify
73 	 *     the string
74 	 */
75 	public static string getAppDir()
76 	{
77 		return Str.toString(gst_preset_get_app_dir());
78 	}
79 
80 	/**
81 	 * Sets an extra directory as an absolute path that should be considered when
82 	 * looking for presets. Any presets in the application dir will shadow the
83 	 * system presets.
84 	 *
85 	 * Params:
86 	 *     appDir = the application specific preset dir
87 	 *
88 	 * Returns: %TRUE for success, %FALSE if the dir already has been set
89 	 */
90 	public static bool setAppDir(string appDir)
91 	{
92 		return gst_preset_set_app_dir(Str.toStringz(appDir)) != 0;
93 	}
94 
95 	/**
96 	 * Delete the given preset.
97 	 *
98 	 * Params:
99 	 *     name = preset name to remove
100 	 *
101 	 * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
102 	 */
103 	public bool deletePreset(string name)
104 	{
105 		return gst_preset_delete_preset(getPresetStruct(), Str.toStringz(name)) != 0;
106 	}
107 
108 	/**
109 	 * Gets the @value for an existing meta data @tag. Meta data @tag names can be
110 	 * something like e.g. "comment". Returned values need to be released when done.
111 	 *
112 	 * Params:
113 	 *     name = preset name
114 	 *     tag = meta data item name
115 	 *     value = value
116 	 *
117 	 * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
118 	 *     or no value for the given @tag
119 	 */
120 	public bool getMeta(string name, string tag, out string value)
121 	{
122 		char* outvalue = null;
123 		
124 		auto p = gst_preset_get_meta(getPresetStruct(), Str.toStringz(name), Str.toStringz(tag), &outvalue) != 0;
125 		
126 		value = Str.toString(outvalue);
127 		
128 		return p;
129 	}
130 
131 	/**
132 	 * Get a copy of preset names as a %NULL terminated string array.
133 	 *
134 	 * Returns: list with names, use g_strfreev() after usage.
135 	 */
136 	public string[] getPresetNames()
137 	{
138 		auto retStr = gst_preset_get_preset_names(getPresetStruct());
139 		
140 		scope(exit) Str.freeStringArray(retStr);
141 		return Str.toStringArray(retStr);
142 	}
143 
144 	/**
145 	 * Get a the names of the GObject properties that can be used for presets.
146 	 *
147 	 * Returns: an
148 	 *     array of property names which should be freed with g_strfreev() after use.
149 	 */
150 	public string[] getPropertyNames()
151 	{
152 		auto retStr = gst_preset_get_property_names(getPresetStruct());
153 		
154 		scope(exit) Str.freeStringArray(retStr);
155 		return Str.toStringArray(retStr);
156 	}
157 
158 	/**
159 	 * Check if one can add new presets, change existing ones and remove presets.
160 	 *
161 	 * Returns: %TRUE if presets are editable or %FALSE if they are static
162 	 *
163 	 * Since: 1.6
164 	 */
165 	public bool isEditable()
166 	{
167 		return gst_preset_is_editable(getPresetStruct()) != 0;
168 	}
169 
170 	/**
171 	 * Load the given preset.
172 	 *
173 	 * Params:
174 	 *     name = preset name to load
175 	 *
176 	 * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
177 	 */
178 	public bool loadPreset(string name)
179 	{
180 		return gst_preset_load_preset(getPresetStruct(), Str.toStringz(name)) != 0;
181 	}
182 
183 	/**
184 	 * Renames a preset. If there is already a preset by the @new_name it will be
185 	 * overwritten.
186 	 *
187 	 * Params:
188 	 *     oldName = current preset name
189 	 *     newName = new preset name
190 	 *
191 	 * Returns: %TRUE for success, %FALSE if e.g. there is no preset with @old_name
192 	 */
193 	public bool renamePreset(string oldName, string newName)
194 	{
195 		return gst_preset_rename_preset(getPresetStruct(), Str.toStringz(oldName), Str.toStringz(newName)) != 0;
196 	}
197 
198 	/**
199 	 * Save the current object settings as a preset under the given name. If there
200 	 * is already a preset by this @name it will be overwritten.
201 	 *
202 	 * Params:
203 	 *     name = preset name to save
204 	 *
205 	 * Returns: %TRUE for success, %FALSE
206 	 */
207 	public bool savePreset(string name)
208 	{
209 		return gst_preset_save_preset(getPresetStruct(), Str.toStringz(name)) != 0;
210 	}
211 
212 	/**
213 	 * Sets a new @value for an existing meta data item or adds a new item. Meta
214 	 * data @tag names can be something like e.g. "comment". Supplying %NULL for the
215 	 * @value will unset an existing value.
216 	 *
217 	 * Params:
218 	 *     name = preset name
219 	 *     tag = meta data item name
220 	 *     value = new value
221 	 *
222 	 * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
223 	 */
224 	public bool setMeta(string name, string tag, string value)
225 	{
226 		return gst_preset_set_meta(getPresetStruct(), Str.toStringz(name), Str.toStringz(tag), Str.toStringz(value)) != 0;
227 	}
228 }