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