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 
63 private import gstreamer.Toc;
64 
65 
66 
67 
68 /**
69  * Element interface that allows setting of the TOC.
70  *
71  * Elements that support some kind of chapters or editions (or tracks like in
72  * the FLAC cue sheet) will implement this interface.
73  *
74  * If you just want to retrieve the TOC in your application then all you
75  * need to do is watch for TOC messages on your pipeline's bus (or you can
76  * perform TOC query). This interface is only for setting TOC data, not for
77  * extracting it. To set TOC from the application, find proper tocsetter element
78  * and set TOC using gst_toc_setter_set_toc().
79  *
80  * Elements implementing the GstTocSetter interface can extend existing TOC
81  * by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it)
82  * with any TOC entries received from downstream.
83  */
84 public interface TocSetterIF
85 {
86 	
87 	
88 	public GstTocSetter* getTocSetterTStruct();
89 	
90 	/** the main Gtk struct as a void* */
91 	protected void* getStruct();
92 	
93 	
94 	/**
95 	 */
96 	
97 	/**
98 	 * Set the given TOC on the setter. Previously setted TOC will be
99 	 * unrefed before setting a new one.
100 	 * Params:
101 	 * toc = a GstToc to set. [allow-none]
102 	 */
103 	public void setToc(Toc toc);
104 	
105 	/**
106 	 * Return current TOC the setter uses. The TOC should not be
107 	 * modified without making it writable first.
108 	 * Returns: TOC set, or NULL. Unref with gst_toc_unref() when no longer needed. [transfer full]
109 	 */
110 	public Toc getToc();
111 	
112 	/**
113 	 * Reset the internal TOC. Elements should call this from within the
114 	 * state-change handler.
115 	 */
116 	public void reset();
117 }