gstreamer.ParseContext 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.ParseContext;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gstreamerc.gstreamer;
31 public  import gstreamerc.gstreamertypes;
32 private import gtkd.Loader;
33 
34 
35 /**
36  * Opaque structure.
37  */
38 public class ParseContext
39 {
40 	/** the main Gtk struct */
41 	protected GstParseContext* gstParseContext;
42 	protected bool ownedRef;
43 
44 	/** Get the main Gtk struct */
45 	public GstParseContext* getParseContextStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return gstParseContext;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected void* getStruct()
54 	{
55 		return cast(void*)gstParseContext;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (GstParseContext* gstParseContext, bool ownedRef = false)
62 	{
63 		this.gstParseContext = gstParseContext;
64 		this.ownedRef = ownedRef;
65 	}
66 
67 	~this ()
68 	{
69 		if (  Linker.isLoaded(LIBRARY_GSTREAMER) && ownedRef )
70 			gst_parse_context_free(gstParseContext);
71 	}
72 
73 
74 	/** */
75 	public static GType getType()
76 	{
77 		return gst_parse_context_get_type();
78 	}
79 
80 	/**
81 	 * Allocates a parse context for use with gst_parse_launch_full() or
82 	 * gst_parse_launchv_full().
83 	 *
84 	 * Free-function: gst_parse_context_free
85 	 *
86 	 * Returns: a newly-allocated parse context. Free with
87 	 *     gst_parse_context_free() when no longer needed.
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this()
92 	{
93 		auto p = gst_parse_context_new();
94 		
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 		
100 		this(cast(GstParseContext*) p);
101 	}
102 
103 	/**
104 	 * Frees a parse context previously allocated with gst_parse_context_new().
105 	 */
106 	public void free()
107 	{
108 		gst_parse_context_free(gstParseContext);
109 		ownedRef = false;
110 	}
111 
112 	/**
113 	 * Retrieve missing elements from a previous run of gst_parse_launch_full()
114 	 * or gst_parse_launchv_full(). Will only return results if an error code
115 	 * of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.
116 	 *
117 	 * Returns: a
118 	 *     %NULL-terminated array of element factory name strings of missing
119 	 *     elements. Free with g_strfreev() when no longer needed.
120 	 */
121 	public string[] getMissingElements()
122 	{
123 		auto retStr = gst_parse_context_get_missing_elements(gstParseContext);
124 		
125 		scope(exit) Str.freeStringArray(retStr);
126 		return Str.toStringArray(retStr);
127 	}
128 }