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