← Back to branch summary

~mhall119/+junk/api-website

« back to all changes in this revision

Viewing changes to girs/GstNetbuffer-0.10.gir

  • Committer: Michael Hall
  • Date: 2012-08-31 15:20:59 UTC
  • Revision ID: mhall119@ubuntu.com-20120831152059-rsczy11h96ryyevd
Add local GIR files

Show diffs side-by-side

added added

removed removed

Lines of Context:
girs/GstNetbuffer-0.10.gir
 
1
<?xml version="1.0"?>
 
2
<!-- This file was automatically generated from C sources - DO NOT EDIT!
 
3
To affect the contents of this file, edit the original C definitions,
 
4
and/or use gtk-doc annotations.  -->
 
5
<repository version="1.2"
 
6
            xmlns="http://www.gtk.org/introspection/core/1.0"
 
7
            xmlns:c="http://www.gtk.org/introspection/c/1.0"
 
8
            xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
 
9
  <include name="GLib" version="2.0"/>
 
10
  <include name="GModule" version="2.0"/>
 
11
  <include name="GObject" version="2.0"/>
 
12
  <include name="Gst" version="0.10"/>
 
13
  <include name="libxml2" version="2.0"/>
 
14
  <package name="gstreamer-netbuffer-0.10"/>
 
15
  <c:include name="gst/netbuffer/gstnetbuffer.h"/>
 
16
  <namespace name="GstNetbuffer"
 
17
             version="0.10"
 
18
             shared-library="libgstnetbuffer-0.10.so.0"
 
19
             c:identifier-prefixes="Gst"
 
20
             c:symbol-prefixes="gst">
 
21
    <constant name="NETADDRESS_MAX_LEN"
 
22
              value="64"
 
23
              c:type="GST_NETADDRESS_MAX_LEN">
 
24
      <type name="gint" c:type="gint"/>
 
25
    </constant>
 
26
    <record name="NetAddress" c:type="GstNetAddress">
 
27
      <doc xml:whitespace="preserve">An opaque network address as used in #GstNetBuffer.</doc>
 
28
      <field name="type" readable="0" private="1">
 
29
        <type name="NetType" c:type="GstNetType"/>
 
30
      </field>
 
31
      <union name="address" c:type="address">
 
32
        <field name="ip6" writable="1">
 
33
          <array zero-terminated="0" c:type="guint8" fixed-size="16">
 
34
            <type name="guint8" c:type="guint8"/>
 
35
          </array>
 
36
        </field>
 
37
        <field name="ip4" writable="1">
 
38
          <type name="guint32" c:type="guint32"/>
 
39
        </field>
 
40
      </union>
 
41
      <field name="port" writable="1">
 
42
        <type name="guint16" c:type="guint16"/>
 
43
      </field>
 
44
      <field name="_gst_reserved" readable="0" private="1">
 
45
        <array zero-terminated="0" c:type="gpointer" fixed-size="4">
 
46
          <type name="gpointer" c:type="gpointer"/>
 
47
        </array>
 
48
      </field>
 
49
    </record>
 
50
    <class name="NetBuffer"
 
51
           c:symbol-prefix="netbuffer"
 
52
           c:type="GstNetBuffer"
 
53
           parent="Gst.Buffer"
 
54
           glib:type-name="GstNetBuffer"
 
55
           glib:get-type="gst_netbuffer_get_type"
 
56
           glib:type-struct="NetBufferClass"
 
57
           glib:fundamental="1">
 
58
      <doc xml:whitespace="preserve">#GstNetBuffer is a subclass of a normal #GstBuffer that contains two
 
59
additional metadata fields of type #GstNetAddress named 'to' and 'from'. The
 
60
buffer can be used to store additional information about the origin of the
 
61
buffer data and is used in various network elements to track the to and from
 
62
addresses.
 
63
 
 
64
Last reviewed on 2006-08-21 (0.10.10)</doc>
 
65
      <constructor name="new" c:identifier="gst_netbuffer_new">
 
66
        <doc xml:whitespace="preserve">Create a new network buffer.</doc>
 
67
        <return-value transfer-ownership="full">
 
68
          <doc xml:whitespace="preserve">a new #GstNetBuffer.</doc>
 
69
          <type name="NetBuffer" c:type="GstNetBuffer*"/>
 
70
        </return-value>
 
71
      </constructor>
 
72
      <field name="buffer">
 
73
        <type name="Gst.Buffer" c:type="GstBuffer"/>
 
74
      </field>
 
75
      <field name="from">
 
76
        <type name="NetAddress" c:type="GstNetAddress"/>
 
77
      </field>
 
78
      <field name="to">
 
79
        <type name="NetAddress" c:type="GstNetAddress"/>
 
80
      </field>
 
81
      <field name="_gst_reserved" readable="0" private="1">
 
82
        <array zero-terminated="0" c:type="gpointer" fixed-size="4">
 
83
          <type name="gpointer" c:type="gpointer"/>
 
84
        </array>
 
85
      </field>
 
86
    </class>
 
87
    <record name="NetBufferClass"
 
88
            c:type="GstNetBufferClass"
 
89
            glib:is-gtype-struct-for="NetBuffer">
 
90
      <field name="buffer_class">
 
91
        <type name="Gst.BufferClass" c:type="GstBufferClass"/>
 
92
      </field>
 
93
      <field name="_gst_reserved" readable="0" private="1">
 
94
        <array zero-terminated="0" c:type="gpointer" fixed-size="4">
 
95
          <type name="gpointer" c:type="gpointer"/>
 
96
        </array>
 
97
      </field>
 
98
    </record>
 
99
    <enumeration name="NetType" c:type="GstNetType">
 
100
      <doc xml:whitespace="preserve">The Address type used in #GstNetAddress.</doc>
 
101
      <member name="unknown" value="0" c:identifier="GST_NET_TYPE_UNKNOWN"/>
 
102
      <member name="ip4" value="1" c:identifier="GST_NET_TYPE_IP4"/>
 
103
      <member name="ip6" value="2" c:identifier="GST_NET_TYPE_IP6"/>
 
104
    </enumeration>
 
105
    <function name="netaddress_equal"
 
106
              c:identifier="gst_netaddress_equal"
 
107
              version="0.10.18">
 
108
      <doc xml:whitespace="preserve">Compare two #GstNetAddress structures</doc>
 
109
      <return-value transfer-ownership="none">
 
110
        <doc xml:whitespace="preserve">TRUE if they are identical, FALSE otherwise</doc>
 
111
        <type name="gboolean" c:type="gboolean"/>
 
112
      </return-value>
 
113
      <parameters>
 
114
        <parameter name="naddr1" transfer-ownership="none">
 
115
          <doc xml:whitespace="preserve">The first #GstNetAddress</doc>
 
116
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
117
        </parameter>
 
118
        <parameter name="naddr2" transfer-ownership="none">
 
119
          <doc xml:whitespace="preserve">The second #GstNetAddress</doc>
 
120
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
121
        </parameter>
 
122
      </parameters>
 
123
    </function>
 
124
    <function name="netaddress_get_address_bytes"
 
125
              c:identifier="gst_netaddress_get_address_bytes"
 
126
              version="0.10.22">
 
127
      <doc xml:whitespace="preserve">Get just the address bytes stored in @naddr into @address.
 
128
 
 
129
Note that @port is expressed in network byte order, use g_ntohs() to convert
 
130
it to host order. IP4 addresses are also stored in network byte order.</doc>
 
131
      <return-value transfer-ownership="none">
 
132
        <doc xml:whitespace="preserve">number of bytes actually copied</doc>
 
133
        <type name="gint" c:type="gint"/>
 
134
      </return-value>
 
135
      <parameters>
 
136
        <parameter name="naddr" transfer-ownership="none">
 
137
          <doc xml:whitespace="preserve">a network address</doc>
 
138
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
139
        </parameter>
 
140
        <parameter name="address" transfer-ownership="none">
 
141
          <doc xml:whitespace="preserve">a location to store the result.</doc>
 
142
          <type name="guint8" c:type="guint8"/>
 
143
        </parameter>
 
144
        <parameter name="port" transfer-ownership="none">
 
145
          <doc xml:whitespace="preserve">a location to store the port.</doc>
 
146
          <type name="guint16" c:type="guint16*"/>
 
147
        </parameter>
 
148
      </parameters>
 
149
    </function>
 
150
    <function name="netaddress_get_ip4_address"
 
151
              c:identifier="gst_netaddress_get_ip4_address">
 
152
      <doc xml:whitespace="preserve">Get the IPv4 address stored in @naddr into @address. This function requires
 
153
that the address type of @naddr is of type #GST_NET_TYPE_IP4.
 
154
 
 
155
Note that @port and @address are expressed in network byte order, use
 
156
g_ntohs() and g_ntohl() to convert them to host order.</doc>
 
157
      <return-value transfer-ownership="none">
 
158
        <doc xml:whitespace="preserve">TRUE if the address could be retrieved.</doc>
 
159
        <type name="gboolean" c:type="gboolean"/>
 
160
      </return-value>
 
161
      <parameters>
 
162
        <parameter name="naddr" transfer-ownership="none">
 
163
          <doc xml:whitespace="preserve">a network address</doc>
 
164
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
165
        </parameter>
 
166
        <parameter name="address" transfer-ownership="none">
 
167
          <doc xml:whitespace="preserve">a location to store the address.</doc>
 
168
          <type name="guint32" c:type="guint32*"/>
 
169
        </parameter>
 
170
        <parameter name="port" transfer-ownership="none">
 
171
          <doc xml:whitespace="preserve">a location to store the port.</doc>
 
172
          <type name="guint16" c:type="guint16*"/>
 
173
        </parameter>
 
174
      </parameters>
 
175
    </function>
 
176
    <function name="netaddress_get_ip6_address"
 
177
              c:identifier="gst_netaddress_get_ip6_address">
 
178
      <doc xml:whitespace="preserve">Get the IPv6 address stored in @naddr into @address.
 
179
 
 
180
If @naddr is of type GST_NET_TYPE_IP4, the transitional IP6 address is
 
181
returned.
 
182
 
 
183
Note that @port is expressed in network byte order, use g_ntohs() to convert
 
184
it to host order.</doc>
 
185
      <return-value transfer-ownership="none">
 
186
        <doc xml:whitespace="preserve">TRUE if the address could be retrieved.</doc>
 
187
        <type name="gboolean" c:type="gboolean"/>
 
188
      </return-value>
 
189
      <parameters>
 
190
        <parameter name="naddr" transfer-ownership="none">
 
191
          <doc xml:whitespace="preserve">a network address</doc>
 
192
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
193
        </parameter>
 
194
        <parameter name="address" transfer-ownership="none">
 
195
          <doc xml:whitespace="preserve">a location to store the result.</doc>
 
196
          <type name="guint8" c:type="guint8"/>
 
197
        </parameter>
 
198
        <parameter name="port" transfer-ownership="none">
 
199
          <doc xml:whitespace="preserve">a location to store the port.</doc>
 
200
          <type name="guint16" c:type="guint16*"/>
 
201
        </parameter>
 
202
      </parameters>
 
203
    </function>
 
204
    <function name="netaddress_get_net_type"
 
205
              c:identifier="gst_netaddress_get_net_type">
 
206
      <doc xml:whitespace="preserve">Get the type of address stored in @naddr.</doc>
 
207
      <return-value transfer-ownership="none">
 
208
        <doc xml:whitespace="preserve">the network type stored in @naddr.</doc>
 
209
        <type name="NetType" c:type="GstNetType"/>
 
210
      </return-value>
 
211
      <parameters>
 
212
        <parameter name="naddr" transfer-ownership="none">
 
213
          <doc xml:whitespace="preserve">a network address</doc>
 
214
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
215
        </parameter>
 
216
      </parameters>
 
217
    </function>
 
218
    <function name="netaddress_set_address_bytes"
 
219
              c:identifier="gst_netaddress_set_address_bytes"
 
220
              version="0.10.22">
 
221
      <doc xml:whitespace="preserve">Set just the address bytes stored in @naddr into @address.
 
222
 
 
223
Note that @port must be expressed in network byte order, use g_htons() to
 
224
convert it to network byte order. IP4 address bytes must also be
 
225
stored in network byte order.</doc>
 
226
      <return-value transfer-ownership="none">
 
227
        <doc xml:whitespace="preserve">number of bytes actually copied</doc>
 
228
        <type name="gint" c:type="gint"/>
 
229
      </return-value>
 
230
      <parameters>
 
231
        <parameter name="naddr" transfer-ownership="none">
 
232
          <doc xml:whitespace="preserve">a network address</doc>
 
233
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
234
        </parameter>
 
235
        <parameter name="type" transfer-ownership="none">
 
236
          <doc xml:whitespace="preserve">the address type (IPv4 or IPV6)</doc>
 
237
          <type name="NetType" c:type="GstNetType"/>
 
238
        </parameter>
 
239
        <parameter name="address" transfer-ownership="none">
 
240
          <doc xml:whitespace="preserve">a location to store the result.</doc>
 
241
          <type name="guint8" c:type="guint8"/>
 
242
        </parameter>
 
243
        <parameter name="port" transfer-ownership="none">
 
244
          <doc xml:whitespace="preserve">a location to store the port.</doc>
 
245
          <type name="guint16" c:type="guint16"/>
 
246
        </parameter>
 
247
      </parameters>
 
248
    </function>
 
249
    <function name="netaddress_set_ip4_address"
 
250
              c:identifier="gst_netaddress_set_ip4_address">
 
251
      <doc xml:whitespace="preserve">Set @naddr with the IPv4 @address and @port pair.
 
252
 
 
253
Note that @port and @address must be expressed in network byte order,
 
254
use g_htons() and g_htonl() to convert them to network byte order.</doc>
 
255
      <return-value transfer-ownership="none">
 
256
        <type name="none" c:type="void"/>
 
257
      </return-value>
 
258
      <parameters>
 
259
        <parameter name="naddr" transfer-ownership="none">
 
260
          <doc xml:whitespace="preserve">a network address</doc>
 
261
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
262
        </parameter>
 
263
        <parameter name="address" transfer-ownership="none">
 
264
          <doc xml:whitespace="preserve">an IPv4 network address.</doc>
 
265
          <type name="guint32" c:type="guint32"/>
 
266
        </parameter>
 
267
        <parameter name="port" transfer-ownership="none">
 
268
          <doc xml:whitespace="preserve">a port number to set.</doc>
 
269
          <type name="guint16" c:type="guint16"/>
 
270
        </parameter>
 
271
      </parameters>
 
272
    </function>
 
273
    <function name="netaddress_set_ip6_address"
 
274
              c:identifier="gst_netaddress_set_ip6_address">
 
275
      <doc xml:whitespace="preserve">Set @naddr with the IPv6 @address and @port pair.
 
276
 
 
277
Note that @port must be expressed in network byte order, use g_htons() to convert
 
278
it to network byte order.</doc>
 
279
      <return-value transfer-ownership="none">
 
280
        <type name="none" c:type="void"/>
 
281
      </return-value>
 
282
      <parameters>
 
283
        <parameter name="naddr" transfer-ownership="none">
 
284
          <doc xml:whitespace="preserve">a network address</doc>
 
285
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
286
        </parameter>
 
287
        <parameter name="address" transfer-ownership="none">
 
288
          <doc xml:whitespace="preserve">an IPv6 network address.</doc>
 
289
          <type name="guint8" c:type="guint8"/>
 
290
        </parameter>
 
291
        <parameter name="port" transfer-ownership="none">
 
292
          <doc xml:whitespace="preserve">a port number to set.</doc>
 
293
          <type name="guint16" c:type="guint16"/>
 
294
        </parameter>
 
295
      </parameters>
 
296
    </function>
 
297
    <function name="netaddress_to_string"
 
298
              c:identifier="gst_netaddress_to_string"
 
299
              version="0.10.24">
 
300
      <doc xml:whitespace="preserve">Copies a string representation of @naddr into @dest. Up to @len bytes are
 
301
copied.</doc>
 
302
      <return-value transfer-ownership="none">
 
303
        <doc xml:whitespace="preserve">the number of bytes which would be produced if the buffer was large enough</doc>
 
304
        <type name="gint" c:type="gint"/>
 
305
      </return-value>
 
306
      <parameters>
 
307
        <parameter name="naddr" transfer-ownership="none">
 
308
          <doc xml:whitespace="preserve">a #GstNetAddress</doc>
 
309
          <type name="NetAddress" c:type="GstNetAddress*"/>
 
310
        </parameter>
 
311
        <parameter name="dest" transfer-ownership="none">
 
312
          <doc xml:whitespace="preserve">destination</doc>
 
313
          <type name="utf8" c:type="gchar*"/>
 
314
        </parameter>
 
315
        <parameter name="len" transfer-ownership="none">
 
316
          <doc xml:whitespace="preserve">len of @dest</doc>
 
317
          <type name="gulong" c:type="gulong"/>
 
318
        </parameter>
 
319
      </parameters>
 
320
    </function>
 
321
  </namespace>
 
322
</repository>