gstreamer.ControlSource 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 module gstreamer.ControlSource;
26 
27 private import gstreamer.ObjectGst;
28 private import gstreamer.c.functions;
29 public  import gstreamer.c.types;
30 public  import gstreamerc.gstreamertypes;
31 
32 
33 /**
34  * The #GstControlSource is a base class for control value sources that could
35  * be used to get timestamp-value pairs. A control source essentially is a
36  * function over time.
37  * 
38  * A #GstControlSource is used by first getting an instance of a specific
39  * control-source, creating a binding for the control-source to the target property
40  * of the element and then adding the binding to the element. The binding will
41  * convert the data types and value range to fit to the bound property.
42  * 
43  * For implementing a new #GstControlSource one has to implement
44  * #GstControlSourceGetValue and #GstControlSourceGetValueArray functions.
45  * These are then used by gst_control_source_get_value() and
46  * gst_control_source_get_value_array() to get values for specific timestamps.
47  */
48 public class ControlSource : ObjectGst
49 {
50 	/** the main Gtk struct */
51 	protected GstControlSource* gstControlSource;
52 
53 	/** Get the main Gtk struct */
54 	public GstControlSource* getControlSourceStruct(bool transferOwnership = false)
55 	{
56 		if (transferOwnership)
57 			ownedRef = false;
58 		return gstControlSource;
59 	}
60 
61 	/** the main Gtk struct as a void* */
62 	protected override void* getStruct()
63 	{
64 		return cast(void*)gstControlSource;
65 	}
66 
67 	/**
68 	 * Sets our main struct and passes it to the parent class.
69 	 */
70 	public this (GstControlSource* gstControlSource, bool ownedRef = false)
71 	{
72 		this.gstControlSource = gstControlSource;
73 		super(cast(GstObject*)gstControlSource, ownedRef);
74 	}
75 
76 
77 	/** */
78 	public static GType getType()
79 	{
80 		return gst_control_source_get_type();
81 	}
82 
83 	/**
84 	 * Gets the value for this #GstControlSource at a given timestamp.
85 	 *
86 	 * Params:
87 	 *     timestamp = the time for which the value should be returned
88 	 *     value = the value
89 	 *
90 	 * Returns: %FALSE if the value couldn't be returned, %TRUE otherwise.
91 	 */
92 	public bool getValue(GstClockTime timestamp, out double value)
93 	{
94 		return gst_control_source_get_value(gstControlSource, timestamp, &value) != 0;
95 	}
96 
97 	/**
98 	 * Gets an array of values for for this #GstControlSource. Values that are
99 	 * undefined contain NANs.
100 	 *
101 	 * Params:
102 	 *     timestamp = the first timestamp
103 	 *     interval = the time steps
104 	 *     values = array to put control-values in
105 	 *
106 	 * Returns: %TRUE if the given array could be filled, %FALSE otherwise
107 	 */
108 	public bool getValueArray(GstClockTime timestamp, GstClockTime interval, double[] values)
109 	{
110 		return gst_control_source_get_value_array(gstControlSource, timestamp, interval, cast(uint)values.length, values.ptr) != 0;
111 	}
112 }