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