/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GstTypeFindFactory.html
 * outPack = gstreamer
 * outFile = TypeFindFactory
 * strct   = GstTypeFindFactory
 * realStrct=
 * ctorStrct=
 * clss    = TypeFindFactory
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gst_type_find_factory_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * 	- glib.ListG
 * 	- gstreamer.Caps
 * 	- gstreamer.TypeFind
 * structWrap:
 * 	- GList* -> ListG
 * 	- GstCaps* -> Caps
 * 	- GstTypeFind* -> TypeFind
 * module aliases:
 * local aliases:
 * overrides:
 */

module gstreamer.TypeFindFactory;

public  import gstreamerc.gstreamertypes;

private import gstreamerc.gstreamer;
private import glib.ConstructionException;
private import gobject.ObjectG;

private import glib.Str;
private import glib.ListG;
private import gstreamer.Caps;
private import gstreamer.TypeFind;


private import gstreamer.PluginFeature;

/**
 * These functions allow querying informations about registered typefind
 * functions. How to create and register these functions is described in
 * the section
 * "Writing typefind functions".
 *
 * $(DDOC_COMMENT example)
 *
 * The above example shows how to write a very simple typefinder that
 * identifies the given data. You can get quite a bit more complicated than
 * that though.
 *
 * Last reviewed on 2005-11-09 (0.9.4)
 */
public class TypeFindFactory : PluginFeature
{
	
	/** the main Gtk struct */
	protected GstTypeFindFactory* gstTypeFindFactory;
	
	
	/** Get the main Gtk struct */
	public GstTypeFindFactory* getTypeFindFactoryStruct()
	{
		return gstTypeFindFactory;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gstTypeFindFactory;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GstTypeFindFactory* gstTypeFindFactory)
	{
		super(cast(GstPluginFeature*)gstTypeFindFactory);
		this.gstTypeFindFactory = gstTypeFindFactory;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gstTypeFindFactory = cast(GstTypeFindFactory*)obj;
	}
	
	/**
	 */
	
	/**
	 * Gets the list of all registered typefind factories. You must free the
	 * list using gst_plugin_feature_list_free().
	 * The returned factories are sorted by highest rank first, and then by
	 * factory name.
	 * Free-function: gst_plugin_feature_list_free
	 * Returns: the list of all registered GstTypeFindFactory. [transfer full][element-type Gst.TypeFindFactory]
	 */
	public static ListG getList()
	{
		// GList * gst_type_find_factory_get_list (void);
		auto p = gst_type_find_factory_get_list();
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ListG)(cast(GList*) p);
	}
	
	/**
	 * Gets the extensions associated with a GstTypeFindFactory. The returned
	 * array should not be changed. If you need to change stuff in it, you should
	 * copy it using g_strdupv(). This function may return NULL to indicate
	 * a 0-length list.
	 * Returns: a NULL-terminated array of extensions associated with this factory. [transfer none][array zero-terminated=1][element-type utf8]
	 */
	public string[] getExtensions()
	{
		// const gchar * const * gst_type_find_factory_get_extensions  (GstTypeFindFactory *factory);
		return Str.toStringArray(gst_type_find_factory_get_extensions(gstTypeFindFactory));
	}
	
	/**
	 * Gets the GstCaps associated with a typefind factory.
	 * Returns: the GstCaps associated with this factory. [transfer none]
	 */
	public Caps getCaps()
	{
		// GstCaps * gst_type_find_factory_get_caps (GstTypeFindFactory *factory);
		auto p = gst_type_find_factory_get_caps(gstTypeFindFactory);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Caps)(cast(GstCaps*) p);
	}
	
	/**
	 * Check whether the factory has a typefind function. Typefind factories
	 * without typefind functions are a last-effort fallback mechanism to
	 * e.g. assume a certain media type based on the file extension.
	 * Returns: TRUE if the factory has a typefind functions set, otherwise FALSE
	 */
	public int hasFunction()
	{
		// gboolean gst_type_find_factory_has_function (GstTypeFindFactory *factory);
		return gst_type_find_factory_has_function(gstTypeFindFactory);
	}
	
	/**
	 * Calls the GstTypeFindFunction associated with this factory.
	 * Params:
	 * find = a properly setup GstTypeFind entry. The get_data
	 * and suggest_type members must be set. [transfer none]
	 */
	public void callFunction(TypeFind find)
	{
		// void gst_type_find_factory_call_function (GstTypeFindFactory *factory,  GstTypeFind *find);
		gst_type_find_factory_call_function(gstTypeFindFactory, (find is null) ? null : find.getTypeFindStruct());
	}
}