← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gstreamer1.0/trusty

« back to all changes in this revision

Viewing changes to docs/gst/html/GstPad.html

  • Committer: Package Import Robot
  • Author(s): Sebastian Dröge
  • Date: 2012-08-08 18:12:33 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20120808181233-riejwxprfsxh1njl
Tags: 0.11.93-1
* New upstream release:
  + debian/libgstreamer.symbols:
    - Update symbols file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/gst/html/GstPad.html
76
76
<a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="returnvalue">GstCaps</span></a> *           <a class="link" href="GstPad.html#gst-pad-get-allowed-caps" title="gst_pad_get_allowed_caps ()">gst_pad_get_allowed_caps</a>            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
77
77
<a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="returnvalue">GstCaps</span></a> *           <a class="link" href="GstPad.html#gst-pad-get-current-caps" title="gst_pad_get_current_caps ()">gst_pad_get_current_caps</a>            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
78
78
<a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="returnvalue">GstCaps</span></a> *           <a class="link" href="GstPad.html#gst-pad-get-pad-template-caps" title="gst_pad_get_pad_template_caps ()">gst_pad_get_pad_template_caps</a>       (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
79
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-set-caps" title="gst_pad_set_caps ()">gst_pad_set_caps</a>                    (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
80
 
                                                         <em class="parameter"><code><a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
81
79
<a class="link" href="GstPad.html" title="GstPad"><span class="returnvalue">GstPad</span></a> *            <a class="link" href="GstPad.html#gst-pad-get-peer" title="gst_pad_get_peer ()">gst_pad_get_peer</a>                    (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
82
80
<span class="returnvalue">void</span>                <a class="link" href="GstPad.html#gst-pad-use-fixed-caps" title="gst_pad_use_fixed_caps ()">gst_pad_use_fixed_caps</a>              (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
83
81
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-has-current-caps" title="gst_pad_has_current_caps ()">gst_pad_has_current_caps</a>            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
301
299
<span class="returnvalue">void</span>                <a class="link" href="GstPad.html#gst-pad-set-element-private" title="gst_pad_set_element_private ()">gst_pad_set_element_private</a>         (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
302
300
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> priv</code></em>);
303
301
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="GstPad.html#gst-pad-get-element-private" title="gst_pad_get_element_private ()">gst_pad_get_element_private</a>         (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
 
302
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="GstPad.html#gst-pad-create-stream-id" title="gst_pad_create_stream_id ()">gst_pad_create_stream_id</a>            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
 
303
                                                         <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> *parent</code></em>,
 
304
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stream_id</code></em>);
304
305
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GstPad.html#GstPadForwardFunction" title="GstPadForwardFunction ()">*GstPadForwardFunction</a>)            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
305
306
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
306
307
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-forward" title="gst_pad_forward ()">gst_pad_forward</a>                     (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
313
314
                                                         <em class="parameter"><code><a class="link" href="gstreamer-GstBufferList.html#GstBufferList" title="GstBufferList"><span class="type">GstBufferList</span></a> *list</code></em>);
314
315
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-start-task" title="gst_pad_start_task ()">gst_pad_start_task</a>                  (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
315
316
                                                         <em class="parameter"><code><a class="link" href="GstTask.html#GstTaskFunction" title="GstTaskFunction ()"><span class="type">GstTaskFunction</span></a> func</code></em>,
316
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
 
317
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
318
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
317
319
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-pause-task" title="gst_pad_pause_task ()">gst_pad_pause_task</a>                  (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
318
320
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-stop-task" title="gst_pad_stop_task ()">gst_pad_stop_task</a>                   (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);
319
321
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstPad.html#gst-pad-set-active" title="gst_pad_set_active ()">gst_pad_set_active</a>                  (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
510
512
  GST_PAD_FLAG_FIXED_CAPS       = (GST_OBJECT_FLAG_LAST &lt;&lt; 7),
511
513
  GST_PAD_FLAG_PROXY_CAPS       = (GST_OBJECT_FLAG_LAST &lt;&lt; 8),
512
514
  GST_PAD_FLAG_PROXY_ALLOCATION = (GST_OBJECT_FLAG_LAST &lt;&lt; 9),
 
515
  GST_PAD_FLAG_PROXY_SCHEDULING = (GST_OBJECT_FLAG_LAST &lt;&lt; 10),
513
516
  /* padding */
514
517
  GST_PAD_FLAG_LAST        = (GST_OBJECT_FLAG_LAST &lt;&lt; 16)
515
518
} GstPadFlags;
580
583
</td>
581
584
</tr>
582
585
<tr>
 
586
<td><p><a name="GST-PAD-FLAG-PROXY-SCHEDULING:CAPS"></a><span class="term"><code class="literal">GST_PAD_FLAG_PROXY_SCHEDULING</code></span></p></td>
 
587
<td>the default query handler will forward
 
588
                     scheduling queries to the internally linked pads
 
589
                     instead of discarding them.
 
590
</td>
 
591
</tr>
 
592
<tr>
583
593
<td><p><a name="GST-PAD-FLAG-LAST:CAPS"></a><span class="term"><code class="literal">GST_PAD_FLAG_LAST</code></span></p></td>
584
594
<td>offset to define more flags
585
595
</td>
736
746
</tr>
737
747
</tbody>
738
748
</table></div>
739
 
<p class="since">Since 0.10.30</p>
740
749
</div>
741
750
<hr>
742
751
<div class="refsect2">
747
756
The default checks done when linking pads (i.e. the ones used by
748
757
<a class="link" href="GstPad.html#gst-pad-link" title="gst_pad_link ()"><code class="function">gst_pad_link()</code></a>).
749
758
</p>
750
 
<p class="since">Since 0.10.30</p>
751
759
</div>
752
760
<hr>
753
761
<div class="refsect2">
780
788
</p>
781
789
<p>
782
790
Note that the custom return values should not be exposed outside of the
783
 
element scope and are available since 0.10.7.
 
791
element scope.
784
792
</p>
785
793
<div class="variablelist"><table border="0">
786
794
<col align="left" valign="top">
787
795
<tbody>
788
796
<tr>
789
797
<td><p><a name="GST-FLOW-CUSTOM-SUCCESS-2:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_SUCCESS_2</code></span></p></td>
790
 
<td>Pre-defined custom success code. Since 0.10.29.
 
798
<td>Pre-defined custom success code.
791
799
</td>
792
800
</tr>
793
801
<tr>
794
802
<td><p><a name="GST-FLOW-CUSTOM-SUCCESS-1:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_SUCCESS_1</code></span></p></td>
795
803
<td>Pre-defined custom success code (define your
796
804
                              custom success code to this to avoid compiler
797
 
                              warnings). Since 0.10.29.
 
805
                              warnings).
798
806
</td>
799
807
</tr>
800
808
<tr>
801
809
<td><p><a name="GST-FLOW-CUSTOM-SUCCESS:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_SUCCESS</code></span></p></td>
802
810
<td>Elements can use values starting from
803
811
                              this (and higher) to define custom success
804
 
                              codes. Since 0.10.7.
 
812
                              codes.
805
813
</td>
806
814
</tr>
807
815
<tr>
845
853
<td><p><a name="GST-FLOW-CUSTOM-ERROR:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_ERROR</code></span></p></td>
846
854
<td>Elements can use values starting from
847
855
                              this (and lower) to define custom error codes.
848
 
                              Since 0.10.7.
849
856
</td>
850
857
</tr>
851
858
<tr>
852
859
<td><p><a name="GST-FLOW-CUSTOM-ERROR-1:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_ERROR_1</code></span></p></td>
853
860
<td>Pre-defined custom error code (define your
854
861
                              custom error code to this to avoid compiler
855
 
                              warnings). Since 0.10.29.
 
862
                              warnings).
856
863
</td>
857
864
</tr>
858
865
<tr>
859
866
<td><p><a name="GST-FLOW-CUSTOM-ERROR-2:CAPS"></a><span class="term"><code class="literal">GST_FLOW_CUSTOM_ERROR_2</code></span></p></td>
860
 
<td>Pre-defined custom error code. Since 0.10.29.
 
867
<td>Pre-defined custom error code.
861
868
</td>
862
869
</tr>
863
870
</tbody>
1080
1087
</tr>
1081
1088
</tbody>
1082
1089
</table></div>
1083
 
<p class="since">Since 0.10.30</p>
1084
1090
</div>
1085
1091
<hr>
1086
1092
<div class="refsect2">
1238
1244
</div>
1239
1245
<hr>
1240
1246
<div class="refsect2">
1241
 
<a name="gst-pad-set-caps"></a><h3>gst_pad_set_caps ()</h3>
1242
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_pad_set_caps                    (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
1243
 
                                                         <em class="parameter"><code><a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
1244
 
<p>
1245
 
Sets the capabilities of this pad. The caps must be fixed. Any previous
1246
 
caps on the pad will be unreffed. This function refs the caps so you should
1247
 
unref if as soon as you don't need it anymore.
1248
 
It is possible to set NULL caps, which will make the pad unnegotiated
1249
 
again.
1250
 
</p>
1251
 
<div class="variablelist"><table border="0">
1252
 
<col align="left" valign="top">
1253
 
<tbody>
1254
 
<tr>
1255
 
<td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1256
 
<td>a  <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> to set the capabilities of.</td>
1257
 
</tr>
1258
 
<tr>
1259
 
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1260
 
<td>a <a class="link" href="gstreamer-GstCaps.html#GstCaps" title="struct GstCaps"><span class="type">GstCaps</span></a> to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1261
 
</td>
1262
 
</tr>
1263
 
<tr>
1264
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1265
 
<td>TRUE if the caps could be set. FALSE if the caps were not fixed
1266
 
or bad parameters were provided to this function.
1267
 
MT safe.</td>
1268
 
</tr>
1269
 
</tbody>
1270
 
</table></div>
1271
 
</div>
1272
 
<hr>
1273
 
<div class="refsect2">
1274
1247
<a name="gst-pad-get-peer"></a><h3>gst_pad_get_peer ()</h3>
1275
1248
<pre class="programlisting"><a class="link" href="GstPad.html" title="GstPad"><span class="returnvalue">GstPad</span></a> *            gst_pad_get_peer                    (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
1276
1249
<p>
1299
1272
<pre class="programlisting"><span class="returnvalue">void</span>                gst_pad_use_fixed_caps              (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
1300
1273
<p>
1301
1274
A helper function you can use that sets the FIXED_CAPS flag
1302
 
This way the default getcaps function will always return the negotiated caps
 
1275
This way the default CAPS query will always return the negotiated caps
1303
1276
or in case the pad is not negotiated, the padtemplate caps.
1304
1277
</p>
1305
1278
<p>
1306
 
Use this function on a pad that, once <a class="link" href="GstPad.html#gst-pad-set-caps" title="gst_pad_set_caps ()"><code class="function">gst_pad_set_caps()</code></a> has been called
1307
 
on it, cannot be renegotiated to something else.
 
1279
The negotiated caps are the caps of the last CAPS event that passed on the
 
1280
pad. Use this function on a pad that, once it negotiated to a CAPS, cannot
 
1281
be renegotiated to something else.
1308
1282
</p>
1309
1283
<div class="variablelist"><table border="0">
1310
1284
<col align="left" valign="top">
1907
1881
</tr>
1908
1882
</tbody>
1909
1883
</table></div>
1910
 
<p class="since">Since 0.10.11</p>
1911
1884
</div>
1912
1885
<hr>
1913
1886
<div class="refsect2">
2051
2024
<a name="gst-pad-set-chain-function"></a><h3>gst_pad_set_chain_function()</h3>
2052
2025
<pre class="programlisting">#define gst_pad_set_chain_function(p,f)         gst_pad_set_chain_function_full((p),(f),NULL,NULL)
2053
2026
</pre>
 
2027
<p>
 
2028
Calls <a class="link" href="GstPad.html#gst-pad-set-chain-function-full" title="gst_pad_set_chain_function_full ()"><code class="function">gst_pad_set_chain_function_full()</code></a> with NULL for the user_data and
 
2029
notify.
 
2030
</p>
 
2031
<div class="variablelist"><table border="0">
 
2032
<col align="left" valign="top">
 
2033
<tbody>
 
2034
<tr>
 
2035
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2036
<td>a sink <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2037
</tr>
 
2038
<tr>
 
2039
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2040
<td>the <a class="link" href="GstPad.html#GstPadChainFunction" title="GstPadChainFunction ()"><span class="type">GstPadChainFunction</span></a> to set.</td>
 
2041
</tr>
 
2042
</tbody>
 
2043
</table></div>
2054
2044
</div>
2055
2045
<hr>
2056
2046
<div class="refsect2">
2135
2125
<a name="gst-pad-set-chain-list-function"></a><h3>gst_pad_set_chain_list_function()</h3>
2136
2126
<pre class="programlisting">#define gst_pad_set_chain_list_function(p,f)    gst_pad_set_chain_list_function_full((p),(f),NULL,NULL)
2137
2127
</pre>
 
2128
<p>
 
2129
Calls <a class="link" href="GstPad.html#gst-pad-set-chain-list-function-full" title="gst_pad_set_chain_list_function_full ()"><code class="function">gst_pad_set_chain_list_function_full()</code></a> with NULL for the user_data and
 
2130
notify.
 
2131
</p>
 
2132
<div class="variablelist"><table border="0">
 
2133
<col align="left" valign="top">
 
2134
<tbody>
 
2135
<tr>
 
2136
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2137
<td>a sink <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2138
</tr>
 
2139
<tr>
 
2140
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2141
<td>the <a class="link" href="GstPad.html#GstPadChainListFunction" title="GstPadChainListFunction ()"><span class="type">GstPadChainListFunction</span></a> to set.</td>
 
2142
</tr>
 
2143
</tbody>
 
2144
</table></div>
2138
2145
</div>
2139
2146
<hr>
2140
2147
<div class="refsect2">
2171
2178
</tr>
2172
2179
</tbody>
2173
2180
</table></div>
2174
 
<p class="since">Since 0.10.24</p>
2175
2181
</div>
2176
2182
<hr>
2177
2183
<div class="refsect2">
2292
2298
<a name="gst-pad-set-getrange-function"></a><h3>gst_pad_set_getrange_function()</h3>
2293
2299
<pre class="programlisting">#define gst_pad_set_getrange_function(p,f)      gst_pad_set_getrange_function_full((p),(f),NULL,NULL)
2294
2300
</pre>
 
2301
<p>
 
2302
Calls <a class="link" href="GstPad.html#gst-pad-set-getrange-function-full" title="gst_pad_set_getrange_function_full ()"><code class="function">gst_pad_set_getrange_function_full()</code></a> with NULL for the user_data and
 
2303
notify.
 
2304
</p>
 
2305
<div class="variablelist"><table border="0">
 
2306
<col align="left" valign="top">
 
2307
<tbody>
 
2308
<tr>
 
2309
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2310
<td>a source <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2311
</tr>
 
2312
<tr>
 
2313
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2314
<td>the <a class="link" href="GstPad.html#GstPadGetRangeFunction" title="GstPadGetRangeFunction ()"><span class="type">GstPadGetRangeFunction</span></a> to set.</td>
 
2315
</tr>
 
2316
</tbody>
 
2317
</table></div>
2295
2318
</div>
2296
2319
<hr>
2297
2320
<div class="refsect2">
2416
2439
<a name="gst-pad-set-event-function"></a><h3>gst_pad_set_event_function()</h3>
2417
2440
<pre class="programlisting">#define gst_pad_set_event_function(p,f)         gst_pad_set_event_function_full((p),(f),NULL,NULL)
2418
2441
</pre>
 
2442
<p>
 
2443
Calls <a class="link" href="GstPad.html#gst-pad-set-event-function-full" title="gst_pad_set_event_function_full ()"><code class="function">gst_pad_set_event_function_full()</code></a> with NULL for the user_data and
 
2444
notify.
 
2445
</p>
 
2446
<div class="variablelist"><table border="0">
 
2447
<col align="left" valign="top">
 
2448
<tbody>
 
2449
<tr>
 
2450
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2451
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> of either direction.</td>
 
2452
</tr>
 
2453
<tr>
 
2454
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2455
<td>the <a class="link" href="GstPad.html#GstPadEventFunction" title="GstPadEventFunction ()"><span class="type">GstPadEventFunction</span></a> to set.</td>
 
2456
</tr>
 
2457
</tbody>
 
2458
</table></div>
2419
2459
</div>
2420
2460
<hr>
2421
2461
<div class="refsect2">
2488
2528
<a name="gst-pad-set-link-function"></a><h3>gst_pad_set_link_function()</h3>
2489
2529
<pre class="programlisting">#define gst_pad_set_link_function(p,f)          gst_pad_set_link_function_full((p),(f),NULL,NULL)
2490
2530
</pre>
 
2531
<p>
 
2532
Calls <a class="link" href="GstPad.html#gst-pad-set-link-function-full" title="gst_pad_set_link_function_full ()"><code class="function">gst_pad_set_link_function_full()</code></a> with NULL
 
2533
for the user_data and notify.
 
2534
</p>
 
2535
<div class="variablelist"><table border="0">
 
2536
<col align="left" valign="top">
 
2537
<tbody>
 
2538
<tr>
 
2539
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2540
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2541
</tr>
 
2542
<tr>
 
2543
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2544
<td>the <a class="link" href="GstPad.html#GstPadLinkFunction" title="GstPadLinkFunction ()"><span class="type">GstPadLinkFunction</span></a> to set.</td>
 
2545
</tr>
 
2546
</tbody>
 
2547
</table></div>
2491
2548
</div>
2492
2549
<hr>
2493
2550
<div class="refsect2">
2566
2623
<a name="gst-pad-set-unlink-function"></a><h3>gst_pad_set_unlink_function()</h3>
2567
2624
<pre class="programlisting">#define gst_pad_set_unlink_function(p,f)        gst_pad_set_unlink_function_full((p),(f),NULL,NULL)
2568
2625
</pre>
 
2626
<p>
 
2627
Calls <a class="link" href="GstPad.html#gst-pad-set-unlink-function-full" title="gst_pad_set_unlink_function_full ()"><code class="function">gst_pad_set_unlink_function_full()</code></a> with NULL
 
2628
for the user_data and notify.
 
2629
</p>
 
2630
<div class="variablelist"><table border="0">
 
2631
<col align="left" valign="top">
 
2632
<tbody>
 
2633
<tr>
 
2634
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2635
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2636
</tr>
 
2637
<tr>
 
2638
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2639
<td>the <a class="link" href="GstPad.html#GstPadUnlinkFunction" title="GstPadUnlinkFunction ()"><span class="type">GstPadUnlinkFunction</span></a> to set.</td>
 
2640
</tr>
 
2641
</tbody>
 
2642
</table></div>
2569
2643
</div>
2570
2644
<hr>
2571
2645
<div class="refsect2">
2685
2759
<a name="gst-pad-set-activate-function"></a><h3>gst_pad_set_activate_function()</h3>
2686
2760
<pre class="programlisting">#define gst_pad_set_activate_function(p,f)      gst_pad_set_activate_function_full((p),(f),NULL,NULL)
2687
2761
</pre>
 
2762
<p>
 
2763
Calls <a class="link" href="GstPad.html#gst-pad-set-activate-function-full" title="gst_pad_set_activate_function_full ()"><code class="function">gst_pad_set_activate_function_full()</code></a> with NULL for the user_data and
 
2764
notify.
 
2765
</p>
 
2766
<div class="variablelist"><table border="0">
 
2767
<col align="left" valign="top">
 
2768
<tbody>
 
2769
<tr>
 
2770
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2771
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2772
</tr>
 
2773
<tr>
 
2774
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2775
<td>the <a class="link" href="GstPad.html#GstPadActivateFunction" title="GstPadActivateFunction ()"><span class="type">GstPadActivateFunction</span></a> to set.</td>
 
2776
</tr>
 
2777
</tbody>
 
2778
</table></div>
2688
2779
</div>
2689
2780
<hr>
2690
2781
<div class="refsect2">
2760
2851
<a name="gst-pad-set-activatemode-function"></a><h3>gst_pad_set_activatemode_function()</h3>
2761
2852
<pre class="programlisting">#define gst_pad_set_activatemode_function(p,f)  gst_pad_set_activatemode_function_full((p),(f),NULL,NULL)
2762
2853
</pre>
 
2854
<p>
 
2855
Calls <a class="link" href="GstPad.html#gst-pad-set-activatemode-function-full" title="gst_pad_set_activatemode_function_full ()"><code class="function">gst_pad_set_activatemode_function_full()</code></a> with NULL for the user_data and
 
2856
notify.
 
2857
</p>
 
2858
<div class="variablelist"><table border="0">
 
2859
<col align="left" valign="top">
 
2860
<tbody>
 
2861
<tr>
 
2862
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
2863
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>.</td>
 
2864
</tr>
 
2865
<tr>
 
2866
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
2867
<td>the <a class="link" href="GstPad.html#GstPadActivateModeFunction" title="GstPadActivateModeFunction ()"><span class="type">GstPadActivateModeFunction</span></a> to set.</td>
 
2868
</tr>
 
2869
</tbody>
 
2870
</table></div>
2763
2871
</div>
2764
2872
<hr>
2765
2873
<div class="refsect2">
2993
3101
</tr>
2994
3102
</tbody>
2995
3103
</table></div>
2996
 
<p class="since">Since 0.10.24</p>
2997
3104
</div>
2998
3105
<hr>
2999
3106
<div class="refsect2">
3257
3364
</tr>
3258
3365
</tbody>
3259
3366
</table></div>
3260
 
<p class="since">Since 0.10.15</p>
3261
3367
</div>
3262
3368
<hr>
3263
3369
<div class="refsect2">
3436
3542
<p>
3437
3543
Gets the capabilities this pad can produce or consume.
3438
3544
Note that this method doesn't necessarily return the caps set by
3439
 
<a class="link" href="GstPad.html#gst-pad-set-caps" title="gst_pad_set_caps ()"><code class="function">gst_pad_set_caps()</code></a> - use <a class="link" href="GstPad.html#gst-pad-get-current-caps" title="gst_pad_get_current_caps ()"><code class="function">gst_pad_get_current_caps()</code></a> for that instead.
 
3545
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#gst-pad-set-caps"><code class="function">gst_pad_set_caps()</code></a> - use <a class="link" href="GstPad.html#gst-pad-get-current-caps" title="gst_pad_get_current_caps ()"><code class="function">gst_pad_get_current_caps()</code></a> for that instead.
3440
3546
gst_pad_query_caps returns all possible caps a pad can operate with, using
3441
3547
the pad's CAPS query function, If the query fails, this function will return
3442
3548
<em class="parameter"><code>filter</code></em>, if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>, otherwise ANY.
3641
3747
</tr>
3642
3748
<tr>
3643
3749
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3644
 
<td>the caps of the peer pad with incremented ref-count. This function
3645
 
returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when there is no peer pad.</td>
 
3750
<td>the caps of the peer pad with incremented ref-count. When there is
 
3751
no peer pad, this function returns <em class="parameter"><code>filter</code></em> or, when <em class="parameter"><code>filter</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, ANY
 
3752
caps.</td>
3646
3753
</tr>
3647
3754
</tbody>
3648
3755
</table></div>
3652
3759
<a name="gst-pad-set-query-function"></a><h3>gst_pad_set_query_function()</h3>
3653
3760
<pre class="programlisting">#define gst_pad_set_query_function(p,f)   gst_pad_set_query_function_full((p),(f),NULL,NULL)
3654
3761
</pre>
 
3762
<p>
 
3763
Calls <a class="link" href="GstPad.html#gst-pad-set-query-function-full" title="gst_pad_set_query_function_full ()"><code class="function">gst_pad_set_query_function_full()</code></a> with NULL for the user_data and
 
3764
notify.
 
3765
</p>
 
3766
<div class="variablelist"><table border="0">
 
3767
<col align="left" valign="top">
 
3768
<tbody>
 
3769
<tr>
 
3770
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
3771
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> of either direction.</td>
 
3772
</tr>
 
3773
<tr>
 
3774
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
3775
<td>the <a class="link" href="GstPad.html#GstPadQueryFunction" title="GstPadQueryFunction ()"><span class="type">GstPadQueryFunction</span></a> to set.</td>
 
3776
</tr>
 
3777
</tbody>
 
3778
</table></div>
3655
3779
</div>
3656
3780
<hr>
3657
3781
<div class="refsect2">
3724
3848
<a name="gst-pad-set-iterate-internal-links-function"></a><h3>gst_pad_set_iterate_internal_links_function()</h3>
3725
3849
<pre class="programlisting">#define gst_pad_set_iterate_internal_links_function(p,f) gst_pad_set_iterate_internal_links_function_full((p),(f),NULL,NULL)
3726
3850
</pre>
 
3851
<p>
 
3852
Calls <a class="link" href="GstPad.html#gst-pad-set-iterate-internal-links-function-full" title="gst_pad_set_iterate_internal_links_function_full ()"><code class="function">gst_pad_set_iterate_internal_links_function_full()</code></a> with NULL
 
3853
for the user_data and notify.
 
3854
</p>
 
3855
<div class="variablelist"><table border="0">
 
3856
<col align="left" valign="top">
 
3857
<tbody>
 
3858
<tr>
 
3859
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 
3860
<td>a <a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> of either direction.</td>
 
3861
</tr>
 
3862
<tr>
 
3863
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
 
3864
<td>the <a class="link" href="GstPad.html#GstPadIterIntLinkFunction" title="GstPadIterIntLinkFunction ()"><span class="type">GstPadIterIntLinkFunction</span></a> to set.</td>
 
3865
</tr>
 
3866
</tbody>
 
3867
</table></div>
3727
3868
</div>
3728
3869
<hr>
3729
3870
<div class="refsect2">
3758
3899
</tr>
3759
3900
</tbody>
3760
3901
</table></div>
3761
 
<p class="since">Since 0.10.21</p>
3762
3902
</div>
3763
3903
<hr>
3764
3904
<div class="refsect2">
3785
3925
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3786
3926
<td>a new <a class="link" href="gstreamer-GstIterator.html#GstIterator" title="struct GstIterator"><span class="type">GstIterator</span></a> that will iterate over all pads that are
3787
3927
linked to the given pad on the inside of the parent element.
3788
 
the caller must call <a class="link" href="gstreamer-GstIterator.html#gst-iterator-free" title="gst_iterator_free ()"><code class="function">gst_iterator_free()</code></a> after usage.
3789
 
Since 0.10.21</td>
 
3928
the caller must call <a class="link" href="gstreamer-GstIterator.html#gst-iterator-free" title="gst_iterator_free ()"><code class="function">gst_iterator_free()</code></a> after usage.</td>
3790
3929
</tr>
3791
3930
</tbody>
3792
3931
</table></div>
3822
3961
</tr>
3823
3962
</tbody>
3824
3963
</table></div>
3825
 
<p class="since">Since 0.10.21</p>
3826
3964
</div>
3827
3965
<hr>
3828
3966
<div class="refsect2">
3857
3995
</tr>
3858
3996
</tbody>
3859
3997
</table></div>
3860
 
<p class="since">Since 0.10.21</p>
3861
3998
</div>
3862
3999
<hr>
3863
4000
<div class="refsect2">
3908
4045
</div>
3909
4046
<hr>
3910
4047
<div class="refsect2">
 
4048
<a name="gst-pad-create-stream-id"></a><h3>gst_pad_create_stream_id ()</h3>
 
4049
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gst_pad_create_stream_id            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
 
4050
                                                         <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> *parent</code></em>,
 
4051
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stream_id</code></em>);</pre>
 
4052
</div>
 
4053
<hr>
 
4054
<div class="refsect2">
3911
4055
<a name="GstPadForwardFunction"></a><h3>GstPadForwardFunction ()</h3>
3912
4056
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GstPadForwardFunction)            (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
3913
4057
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
3957
4101
</tr>
3958
4102
<tr>
3959
4103
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
3960
 
<td>a <a class="link" href="GstPad.html#GstPadForwardFunction" title="GstPadForwardFunction ()"><span class="type">GstPadForwardFunction</span></a>
 
4104
<td>a <a class="link" href="GstPad.html#GstPadForwardFunction" title="GstPadForwardFunction ()"><span class="type">GstPadForwardFunction</span></a>. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
3961
4105
</td>
3962
4106
</tr>
3963
4107
<tr>
4066
4210
</tr>
4067
4211
</tbody>
4068
4212
</table></div>
4069
 
<p class="since">Since 0.10.24</p>
4070
4213
</div>
4071
4214
<hr>
4072
4215
<div class="refsect2">
4073
4216
<a name="gst-pad-start-task"></a><h3>gst_pad_start_task ()</h3>
4074
4217
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_pad_start_task                  (<em class="parameter"><code><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a> *pad</code></em>,
4075
4218
                                                         <em class="parameter"><code><a class="link" href="GstTask.html#GstTaskFunction" title="GstTaskFunction ()"><span class="type">GstTaskFunction</span></a> func</code></em>,
4076
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
4219
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
4220
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
4077
4221
<p>
4078
 
Starts a task that repeatedly calls <em class="parameter"><code>func</code></em> with <em class="parameter"><code>data</code></em>. This function
 
4222
Starts a task that repeatedly calls <em class="parameter"><code>func</code></em> with <em class="parameter"><code>user_data</code></em>. This function
4079
4223
is mostly used in pad activation functions to start the dataflow.
4080
4224
The <a class="link" href="GstPad.html#GST-PAD-STREAM-LOCK:CAPS" title="GST_PAD_STREAM_LOCK()"><span class="type">GST_PAD_STREAM_LOCK</span></a> of <em class="parameter"><code>pad</code></em> will automatically be acquired
4081
4225
before <em class="parameter"><code>func</code></em> is called.
4092
4236
<td>the task function to call</td>
4093
4237
</tr>
4094
4238
<tr>
4095
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
4096
 
<td>data passed to the task function</td>
 
4239
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
4240
<td>user data passed to the task function</td>
 
4241
</tr>
 
4242
<tr>
 
4243
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
 
4244
<td>called when <em class="parameter"><code>user_data</code></em> is no longer referenced</td>
4097
4245
</tr>
4098
4246
<tr>
4099
4247
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>