File: AggregatorPad.d

package info (click to toggle)
gtk-d 3.10.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 20,152 kB
  • sloc: javascript: 565; sh: 71; makefile: 25
file content (150 lines) | stat: -rw-r--r-- 3,830 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * 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


module gst.base.AggregatorPad;

private import gobject.ObjectG;
private import gobject.Signals;
private import gst.base.c.functions;
public  import gst.base.c.types;
private import gstreamer.Buffer;
private import gstreamer.Pad;
private import std.algorithm;


/**
 * Pads managed by a #GstAggregor subclass.
 * 
 * This class used to live in gst-plugins-bad and was moved to core.
 *
 * Since: 1.14
 */
public class AggregatorPad : Pad
{
	/** the main Gtk struct */
	protected GstAggregatorPad* gstAggregatorPad;

	/** Get the main Gtk struct */
	public GstAggregatorPad* getAggregatorPadStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gstAggregatorPad;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gstAggregatorPad;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GstAggregatorPad* gstAggregatorPad, bool ownedRef = false)
	{
		this.gstAggregatorPad = gstAggregatorPad;
		super(cast(GstPad*)gstAggregatorPad, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return gst_aggregator_pad_get_type();
	}

	/**
	 * Drop the buffer currently queued in @pad.
	 *
	 * Returns: TRUE if there was a buffer queued in @pad, or FALSE if not.
	 */
	public bool dropBuffer()
	{
		return gst_aggregator_pad_drop_buffer(gstAggregatorPad) != 0;
	}

	/**
	 * This checks if a pad has a buffer available that will be returned by
	 * a call to gst_aggregator_pad_peek_buffer() or
	 * gst_aggregator_pad_pop_buffer().
	 *
	 * Returns: %TRUE if the pad has a buffer available as the next thing.
	 *
	 * Since: 1.14.1
	 */
	public bool hasBuffer()
	{
		return gst_aggregator_pad_has_buffer(gstAggregatorPad) != 0;
	}

	/**
	 * Returns: %TRUE if the pad is EOS, otherwise %FALSE.
	 */
	public bool isEos()
	{
		return gst_aggregator_pad_is_eos(gstAggregatorPad) != 0;
	}

	/**
	 * Returns: A reference to the buffer in @pad or
	 *     NULL if no buffer was queued. You should unref the buffer after
	 *     usage.
	 */
	public Buffer peekBuffer()
	{
		auto p = gst_aggregator_pad_peek_buffer(gstAggregatorPad);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Buffer)(cast(GstBuffer*) p, true);
	}

	/**
	 * Steal the ref to the buffer currently queued in @pad.
	 *
	 * Returns: The buffer in @pad or NULL if no buffer was
	 *     queued. You should unref the buffer after usage.
	 */
	public Buffer popBuffer()
	{
		auto p = gst_aggregator_pad_pop_buffer(gstAggregatorPad);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Buffer)(cast(GstBuffer*) p, true);
	}

	/** */
	gulong addOnBufferConsumed(void delegate(Buffer, AggregatorPad) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "buffer-consumed", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}
}