gstreamer.TocSetterIF 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  * Conversion parameters:
26  * inFile  = gstreamer-GstTocSetter.html
27  * outPack = gstreamer
28  * outFile = TocSetterIF
29  * strct   = GstTocSetter
30  * realStrct=
31  * ctorStrct=
32  * clss    = TocSetterT
33  * interf  = TocSetterIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gst_toc_setter_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- gstreamer.Toc
47  * structWrap:
48  * 	- GstToc* -> Toc
49  * module aliases:
50  * local aliases:
51  * overrides:
52  */
53 
54 module gstreamer.TocSetterIF;
55 
56 public  import gstreamerc.gstreamertypes;
57 
58 private import gstreamerc.gstreamer;
59 private import glib.ConstructionException;
60 private import gobject.ObjectG;
61 
62 private import gstreamer.Toc;
63 
64 
65 
66 /**
67  * Element interface that allows setting of the TOC.
68  *
69  * Elements that support some kind of chapters or editions (or tracks like in
70  * the FLAC cue sheet) will implement this interface.
71  *
72  * If you just want to retrieve the TOC in your application then all you
73  * need to do is watch for TOC messages on your pipeline's bus (or you can
74  * perform TOC query). This interface is only for setting TOC data, not for
75  * extracting it. To set TOC from the application, find proper tocsetter element
76  * and set TOC using gst_toc_setter_set_toc().
77  *
78  * Elements implementing the GstTocSetter interface can extend existing TOC
79  * by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it)
80  * with any TOC entries received from downstream.
81  */
82 public interface TocSetterIF
83 {
84 	
85 	
86 	/** Get the main Gtk struct */
87 	public GstTocSetter* getTocSetterTStruct();
88 	
89 	/** the main Gtk struct as a void* */
90 	protected void* getStruct();
91 	
92 	
93 	/**
94 	 */
95 	
96 	/**
97 	 * Set the given TOC on the setter. Previously setted TOC will be
98 	 * unrefed before setting a new one.
99 	 * Params:
100 	 * toc = a GstToc to set. [allow-none]
101 	 */
102 	public void setToc(Toc toc);
103 	
104 	/**
105 	 * Return current TOC the setter uses. The TOC should not be
106 	 * modified without making it writable first.
107 	 * Returns: TOC set, or NULL. Unref with gst_toc_unref() when no longer needed. [transfer full]
108 	 */
109 	public Toc getToc();
110 	
111 	/**
112 	 * Reset the internal TOC. Elements should call this from within the
113 	 * state-change handler.
114 	 */
115 	public void reset();
116 }