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