gstreamer.StaticCaps 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.StaticCaps;
26 
27 private import gobject.ObjectG;
28 private import gstreamer.Caps;
29 private import gstreamerc.gstreamer;
30 public  import gstreamerc.gstreamertypes;
31 
32 
33 /**
34  * Datastructure to initialize #GstCaps from a string description usually
35  * used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to
36  * instantiate a #GstCaps.
37  */
38 public class StaticCaps
39 {
40 	/** the main Gtk struct */
41 	protected GstStaticCaps* gstStaticCaps;
42 	protected bool ownedRef;
43 
44 	/** Get the main Gtk struct */
45 	public GstStaticCaps* getStaticCapsStruct()
46 	{
47 		return gstStaticCaps;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected void* getStruct()
52 	{
53 		return cast(void*)gstStaticCaps;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GstStaticCaps* gstStaticCaps, bool ownedRef = false)
60 	{
61 		this.gstStaticCaps = gstStaticCaps;
62 		this.ownedRef = ownedRef;
63 	}
64 
65 
66 	/**
67 	 * Clean up the cached caps contained in @static_caps.
68 	 */
69 	public void cleanup()
70 	{
71 		gst_static_caps_cleanup(gstStaticCaps);
72 	}
73 
74 	/**
75 	 * Converts a #GstStaticCaps to a #GstCaps.
76 	 *
77 	 * Return: a pointer to the #GstCaps. Unref after usage.
78 	 *     Since the core holds an additional ref to the returned caps,
79 	 *     use gst_caps_make_writable() on the returned caps to modify it.
80 	 */
81 	public Caps get()
82 	{
83 		auto p = gst_static_caps_get(gstStaticCaps);
84 		
85 		if(p is null)
86 		{
87 			return null;
88 		}
89 		
90 		return ObjectG.getDObject!(Caps)(cast(GstCaps*) p, true);
91 	}
92 }