1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>GstStructure: GStreamer 1.0 Core Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual"> 8<link rel="up" href="libgstreamer.html" title="GStreamer Core Library"> 9<link rel="prev" href="gstreamer-GstStreamCollection.html" title="GstStreamCollection"> 10<link rel="next" href="GstSystemClock.html" title="GstSystemClock"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#GstStructure.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#GstStructure.object-hierarchy" class="shortcut">Object Hierarchy</a></span> 20</td> 21<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 22<td><a accesskey="u" href="libgstreamer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 23<td><a accesskey="p" href="gstreamer-GstStreamCollection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 24<td><a accesskey="n" href="GstSystemClock.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 25</tr></table> 26<div class="refentry"> 27<a name="GstStructure"></a><div class="titlepage"></div> 28<div class="refnamediv"><table width="100%"><tr> 29<td valign="top"> 30<h2><span class="refentrytitle"><a name="GstStructure.top_of_page"></a>GstStructure</span></h2> 31<p>GstStructure — Generic structure containing fields of names and values</p> 32</td> 33<td class="gallery_image" valign="top" align="right"></td> 34</tr></table></div> 35<div class="refsect1"> 36<a name="GstStructure.functions"></a><h2>Functions</h2> 37<div class="informaltable"><table class="informaltable" width="100%" border="0"> 38<colgroup> 39<col width="150px" class="functions_return"> 40<col class="functions_name"> 41</colgroup> 42<tbody> 43<tr> 44<td class="function_type"> 45<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 46</td> 47<td class="function_name"> 48<span class="c_punctuation">(</span><a class="link" href="GstStructure.html#GstStructureForeachFunc" title="GstStructureForeachFunc ()">*GstStructureForeachFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> 49</td> 50</tr> 51<tr> 52<td class="function_type"> 53<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 54</td> 55<td class="function_name"> 56<span class="c_punctuation">(</span><a class="link" href="GstStructure.html#GstStructureMapFunc" title="GstStructureMapFunc ()">*GstStructureMapFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> 57</td> 58</tr> 59<tr> 60<td class="function_type"> 61<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 62</td> 63<td class="function_name"> 64<span class="c_punctuation">(</span><a class="link" href="GstStructure.html#GstStructureFilterMapFunc" title="GstStructureFilterMapFunc ()">*GstStructureFilterMapFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> 65</td> 66</tr> 67<tr> 68<td class="function_type"> 69<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 70</td> 71<td class="function_name"> 72<a class="link" href="GstStructure.html#gst-structure-new-empty" title="gst_structure_new_empty ()">gst_structure_new_empty</a> <span class="c_punctuation">()</span> 73</td> 74</tr> 75<tr> 76<td class="function_type"> 77<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 78</td> 79<td class="function_name"> 80<a class="link" href="GstStructure.html#gst-structure-new-id-empty" title="gst_structure_new_id_empty ()">gst_structure_new_id_empty</a> <span class="c_punctuation">()</span> 81</td> 82</tr> 83<tr> 84<td class="function_type"> 85<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 86</td> 87<td class="function_name"> 88<a class="link" href="GstStructure.html#gst-structure-new" title="gst_structure_new ()">gst_structure_new</a> <span class="c_punctuation">()</span> 89</td> 90</tr> 91<tr> 92<td class="function_type"> 93<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 94</td> 95<td class="function_name"> 96<a class="link" href="GstStructure.html#gst-structure-new-valist" title="gst_structure_new_valist ()">gst_structure_new_valist</a> <span class="c_punctuation">()</span> 97</td> 98</tr> 99<tr> 100<td class="function_type"> 101<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 102</td> 103<td class="function_name"> 104<a class="link" href="GstStructure.html#gst-structure-new-id" title="gst_structure_new_id ()">gst_structure_new_id</a> <span class="c_punctuation">()</span> 105</td> 106</tr> 107<tr> 108<td class="function_type"> 109<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 110</td> 111<td class="function_name"> 112<a class="link" href="GstStructure.html#gst-structure-new-from-string" title="gst_structure_new_from_string ()">gst_structure_new_from_string</a> <span class="c_punctuation">()</span> 113</td> 114</tr> 115<tr> 116<td class="function_type"> 117<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 118</td> 119<td class="function_name"> 120<a class="link" href="GstStructure.html#gst-structure-copy" title="gst_structure_copy ()">gst_structure_copy</a> <span class="c_punctuation">()</span> 121</td> 122</tr> 123<tr> 124<td class="function_type"> 125<span class="returnvalue">void</span> 126</td> 127<td class="function_name"> 128<a class="link" href="GstStructure.html#gst-structure-free" title="gst_structure_free ()">gst_structure_free</a> <span class="c_punctuation">()</span> 129</td> 130</tr> 131<tr> 132<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 133</td> 134<td class="function_name"> 135<a class="link" href="GstStructure.html#gst-structure-get-name" title="gst_structure_get_name ()">gst_structure_get_name</a> <span class="c_punctuation">()</span> 136</td> 137</tr> 138<tr> 139<td class="function_type"> 140<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 141</td> 142<td class="function_name"> 143<a class="link" href="GstStructure.html#gst-structure-has-name" title="gst_structure_has_name ()">gst_structure_has_name</a> <span class="c_punctuation">()</span> 144</td> 145</tr> 146<tr> 147<td class="function_type"> 148<span class="returnvalue">void</span> 149</td> 150<td class="function_name"> 151<a class="link" href="GstStructure.html#gst-structure-set-name" title="gst_structure_set_name ()">gst_structure_set_name</a> <span class="c_punctuation">()</span> 152</td> 153</tr> 154<tr> 155<td class="function_type"> 156<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> 157</td> 158<td class="function_name"> 159<a class="link" href="GstStructure.html#gst-structure-get-name-id" title="gst_structure_get_name_id ()">gst_structure_get_name_id</a> <span class="c_punctuation">()</span> 160</td> 161</tr> 162<tr> 163<td class="function_type"> 164<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 165</td> 166<td class="function_name"> 167<a class="link" href="GstStructure.html#gst-structure-id-get" title="gst_structure_id_get ()">gst_structure_id_get</a> <span class="c_punctuation">()</span> 168</td> 169</tr> 170<tr> 171<td class="function_type"> 172<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 173</td> 174<td class="function_name"> 175<a class="link" href="GstStructure.html#gst-structure-id-get-valist" title="gst_structure_id_get_valist ()">gst_structure_id_get_valist</a> <span class="c_punctuation">()</span> 176</td> 177</tr> 178<tr> 179<td class="function_type">const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="returnvalue">GValue</span></a> * 180</td> 181<td class="function_name"> 182<a class="link" href="GstStructure.html#gst-structure-id-get-value" title="gst_structure_id_get_value ()">gst_structure_id_get_value</a> <span class="c_punctuation">()</span> 183</td> 184</tr> 185<tr> 186<td class="function_type"> 187<span class="returnvalue">void</span> 188</td> 189<td class="function_name"> 190<a class="link" href="GstStructure.html#gst-structure-id-set-value" title="gst_structure_id_set_value ()">gst_structure_id_set_value</a> <span class="c_punctuation">()</span> 191</td> 192</tr> 193<tr> 194<td class="function_type"> 195<span class="returnvalue">void</span> 196</td> 197<td class="function_name"> 198<a class="link" href="GstStructure.html#gst-structure-id-take-value" title="gst_structure_id_take_value ()">gst_structure_id_take_value</a> <span class="c_punctuation">()</span> 199</td> 200</tr> 201<tr> 202<td class="function_type"> 203<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 204</td> 205<td class="function_name"> 206<a class="link" href="GstStructure.html#gst-structure-get" title="gst_structure_get ()">gst_structure_get</a> <span class="c_punctuation">()</span> 207</td> 208</tr> 209<tr> 210<td class="function_type"> 211<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 212</td> 213<td class="function_name"> 214<a class="link" href="GstStructure.html#gst-structure-get-valist" title="gst_structure_get_valist ()">gst_structure_get_valist</a> <span class="c_punctuation">()</span> 215</td> 216</tr> 217<tr> 218<td class="function_type">const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="returnvalue">GValue</span></a> * 219</td> 220<td class="function_name"> 221<a class="link" href="GstStructure.html#gst-structure-get-value" title="gst_structure_get_value ()">gst_structure_get_value</a> <span class="c_punctuation">()</span> 222</td> 223</tr> 224<tr> 225<td class="function_type"> 226<span class="returnvalue">void</span> 227</td> 228<td class="function_name"> 229<a class="link" href="GstStructure.html#gst-structure-set-value" title="gst_structure_set_value ()">gst_structure_set_value</a> <span class="c_punctuation">()</span> 230</td> 231</tr> 232<tr> 233<td class="function_type"> 234<span class="returnvalue">void</span> 235</td> 236<td class="function_name"> 237<a class="link" href="GstStructure.html#gst-structure-set-array" title="gst_structure_set_array ()">gst_structure_set_array</a> <span class="c_punctuation">()</span> 238</td> 239</tr> 240<tr> 241<td class="function_type"> 242<span class="returnvalue">void</span> 243</td> 244<td class="function_name"> 245<a class="link" href="GstStructure.html#gst-structure-set-list" title="gst_structure_set_list ()">gst_structure_set_list</a> <span class="c_punctuation">()</span> 246</td> 247</tr> 248<tr> 249<td class="function_type"> 250<span class="returnvalue">void</span> 251</td> 252<td class="function_name"> 253<a class="link" href="GstStructure.html#gst-structure-take-value" title="gst_structure_take_value ()">gst_structure_take_value</a> <span class="c_punctuation">()</span> 254</td> 255</tr> 256<tr> 257<td class="function_type"> 258<span class="returnvalue">void</span> 259</td> 260<td class="function_name"> 261<a class="link" href="GstStructure.html#gst-structure-set" title="gst_structure_set ()">gst_structure_set</a> <span class="c_punctuation">()</span> 262</td> 263</tr> 264<tr> 265<td class="function_type"> 266<span class="returnvalue">void</span> 267</td> 268<td class="function_name"> 269<a class="link" href="GstStructure.html#gst-structure-set-valist" title="gst_structure_set_valist ()">gst_structure_set_valist</a> <span class="c_punctuation">()</span> 270</td> 271</tr> 272<tr> 273<td class="function_type"> 274<span class="returnvalue">void</span> 275</td> 276<td class="function_name"> 277<a class="link" href="GstStructure.html#gst-structure-id-set" title="gst_structure_id_set ()">gst_structure_id_set</a> <span class="c_punctuation">()</span> 278</td> 279</tr> 280<tr> 281<td class="function_type"> 282<span class="returnvalue">void</span> 283</td> 284<td class="function_name"> 285<a class="link" href="GstStructure.html#gst-structure-id-set-valist" title="gst_structure_id_set_valist ()">gst_structure_id_set_valist</a> <span class="c_punctuation">()</span> 286</td> 287</tr> 288<tr> 289<td class="function_type"> 290<span class="returnvalue">void</span> 291</td> 292<td class="function_name"> 293<a class="link" href="GstStructure.html#gst-structure-remove-field" title="gst_structure_remove_field ()">gst_structure_remove_field</a> <span class="c_punctuation">()</span> 294</td> 295</tr> 296<tr> 297<td class="function_type"> 298<span class="returnvalue">void</span> 299</td> 300<td class="function_name"> 301<a class="link" href="GstStructure.html#gst-structure-remove-fields" title="gst_structure_remove_fields ()">gst_structure_remove_fields</a> <span class="c_punctuation">()</span> 302</td> 303</tr> 304<tr> 305<td class="function_type"> 306<span class="returnvalue">void</span> 307</td> 308<td class="function_name"> 309<a class="link" href="GstStructure.html#gst-structure-remove-fields-valist" title="gst_structure_remove_fields_valist ()">gst_structure_remove_fields_valist</a> <span class="c_punctuation">()</span> 310</td> 311</tr> 312<tr> 313<td class="function_type"> 314<span class="returnvalue">void</span> 315</td> 316<td class="function_name"> 317<a class="link" href="GstStructure.html#gst-structure-remove-all-fields" title="gst_structure_remove_all_fields ()">gst_structure_remove_all_fields</a> <span class="c_punctuation">()</span> 318</td> 319</tr> 320<tr> 321<td class="function_type"> 322<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> 323</td> 324<td class="function_name"> 325<a class="link" href="GstStructure.html#gst-structure-get-field-type" title="gst_structure_get_field_type ()">gst_structure_get_field_type</a> <span class="c_punctuation">()</span> 326</td> 327</tr> 328<tr> 329<td class="function_type"> 330<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> 331</td> 332<td class="function_name"> 333<a class="link" href="GstStructure.html#gst-structure-n-fields" title="gst_structure_n_fields ()">gst_structure_n_fields</a> <span class="c_punctuation">()</span> 334</td> 335</tr> 336<tr> 337<td class="function_type"> 338<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 339</td> 340<td class="function_name"> 341<a class="link" href="GstStructure.html#gst-structure-has-field" title="gst_structure_has_field ()">gst_structure_has_field</a> <span class="c_punctuation">()</span> 342</td> 343</tr> 344<tr> 345<td class="function_type"> 346<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 347</td> 348<td class="function_name"> 349<a class="link" href="GstStructure.html#gst-structure-has-field-typed" title="gst_structure_has_field_typed ()">gst_structure_has_field_typed</a> <span class="c_punctuation">()</span> 350</td> 351</tr> 352<tr> 353<td class="function_type"> 354<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 355</td> 356<td class="function_name"> 357<a class="link" href="GstStructure.html#gst-structure-is-equal" title="gst_structure_is_equal ()">gst_structure_is_equal</a> <span class="c_punctuation">()</span> 358</td> 359</tr> 360<tr> 361<td class="function_type"> 362<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 363</td> 364<td class="function_name"> 365<a class="link" href="GstStructure.html#gst-structure-is-subset" title="gst_structure_is_subset ()">gst_structure_is_subset</a> <span class="c_punctuation">()</span> 366</td> 367</tr> 368<tr> 369<td class="function_type"> 370<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 371</td> 372<td class="function_name"> 373<a class="link" href="GstStructure.html#gst-structure-can-intersect" title="gst_structure_can_intersect ()">gst_structure_can_intersect</a> <span class="c_punctuation">()</span> 374</td> 375</tr> 376<tr> 377<td class="function_type"> 378<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 379</td> 380<td class="function_name"> 381<a class="link" href="GstStructure.html#gst-structure-intersect" title="gst_structure_intersect ()">gst_structure_intersect</a> <span class="c_punctuation">()</span> 382</td> 383</tr> 384<tr> 385<td class="function_type"> 386<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 387</td> 388<td class="function_name"> 389<a class="link" href="GstStructure.html#gst-structure-id-has-field" title="gst_structure_id_has_field ()">gst_structure_id_has_field</a> <span class="c_punctuation">()</span> 390</td> 391</tr> 392<tr> 393<td class="function_type"> 394<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 395</td> 396<td class="function_name"> 397<a class="link" href="GstStructure.html#gst-structure-id-has-field-typed" title="gst_structure_id_has_field_typed ()">gst_structure_id_has_field_typed</a> <span class="c_punctuation">()</span> 398</td> 399</tr> 400<tr> 401<td class="function_type"> 402<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 403</td> 404<td class="function_name"> 405<a class="link" href="GstStructure.html#gst-structure-get-boolean" title="gst_structure_get_boolean ()">gst_structure_get_boolean</a> <span class="c_punctuation">()</span> 406</td> 407</tr> 408<tr> 409<td class="function_type"> 410<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 411</td> 412<td class="function_name"> 413<a class="link" href="GstStructure.html#gst-structure-get-int" title="gst_structure_get_int ()">gst_structure_get_int</a> <span class="c_punctuation">()</span> 414</td> 415</tr> 416<tr> 417<td class="function_type"> 418<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 419</td> 420<td class="function_name"> 421<a class="link" href="GstStructure.html#gst-structure-get-uint" title="gst_structure_get_uint ()">gst_structure_get_uint</a> <span class="c_punctuation">()</span> 422</td> 423</tr> 424<tr> 425<td class="function_type"> 426<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 427</td> 428<td class="function_name"> 429<a class="link" href="GstStructure.html#gst-structure-get-int64" title="gst_structure_get_int64 ()">gst_structure_get_int64</a> <span class="c_punctuation">()</span> 430</td> 431</tr> 432<tr> 433<td class="function_type"> 434<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 435</td> 436<td class="function_name"> 437<a class="link" href="GstStructure.html#gst-structure-get-uint64" title="gst_structure_get_uint64 ()">gst_structure_get_uint64</a> <span class="c_punctuation">()</span> 438</td> 439</tr> 440<tr> 441<td class="function_type"> 442<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 443</td> 444<td class="function_name"> 445<a class="link" href="GstStructure.html#gst-structure-get-double" title="gst_structure_get_double ()">gst_structure_get_double</a> <span class="c_punctuation">()</span> 446</td> 447</tr> 448<tr> 449<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 450</td> 451<td class="function_name"> 452<a class="link" href="GstStructure.html#gst-structure-get-string" title="gst_structure_get_string ()">gst_structure_get_string</a> <span class="c_punctuation">()</span> 453</td> 454</tr> 455<tr> 456<td class="function_type"> 457<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 458</td> 459<td class="function_name"> 460<a class="link" href="GstStructure.html#gst-structure-get-date" title="gst_structure_get_date ()">gst_structure_get_date</a> <span class="c_punctuation">()</span> 461</td> 462</tr> 463<tr> 464<td class="function_type"> 465<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 466</td> 467<td class="function_name"> 468<a class="link" href="GstStructure.html#gst-structure-get-date-time" title="gst_structure_get_date_time ()">gst_structure_get_date_time</a> <span class="c_punctuation">()</span> 469</td> 470</tr> 471<tr> 472<td class="function_type"> 473<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 474</td> 475<td class="function_name"> 476<a class="link" href="GstStructure.html#gst-structure-get-clock-time" title="gst_structure_get_clock_time ()">gst_structure_get_clock_time</a> <span class="c_punctuation">()</span> 477</td> 478</tr> 479<tr> 480<td class="function_type"> 481<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 482</td> 483<td class="function_name"> 484<a class="link" href="GstStructure.html#gst-structure-get-enum" title="gst_structure_get_enum ()">gst_structure_get_enum</a> <span class="c_punctuation">()</span> 485</td> 486</tr> 487<tr> 488<td class="function_type"> 489<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 490</td> 491<td class="function_name"> 492<a class="link" href="GstStructure.html#gst-structure-get-fraction" title="gst_structure_get_fraction ()">gst_structure_get_fraction</a> <span class="c_punctuation">()</span> 493</td> 494</tr> 495<tr> 496<td class="function_type"> 497<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 498</td> 499<td class="function_name"> 500<a class="link" href="GstStructure.html#gst-structure-get-array" title="gst_structure_get_array ()">gst_structure_get_array</a> <span class="c_punctuation">()</span> 501</td> 502</tr> 503<tr> 504<td class="function_type"> 505<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 506</td> 507<td class="function_name"> 508<a class="link" href="GstStructure.html#gst-structure-get-list" title="gst_structure_get_list ()">gst_structure_get_list</a> <span class="c_punctuation">()</span> 509</td> 510</tr> 511<tr> 512<td class="function_type"> 513<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 514</td> 515<td class="function_name"> 516<a class="link" href="GstStructure.html#gst-structure-foreach" title="gst_structure_foreach ()">gst_structure_foreach</a> <span class="c_punctuation">()</span> 517</td> 518</tr> 519<tr> 520<td class="function_type"> 521<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 522</td> 523<td class="function_name"> 524<a class="link" href="GstStructure.html#gst-structure-map-in-place" title="gst_structure_map_in_place ()">gst_structure_map_in_place</a> <span class="c_punctuation">()</span> 525</td> 526</tr> 527<tr> 528<td class="function_type"> 529<span class="returnvalue">void</span> 530</td> 531<td class="function_name"> 532<a class="link" href="GstStructure.html#gst-structure-filter-and-map-in-place" title="gst_structure_filter_and_map_in_place ()">gst_structure_filter_and_map_in_place</a> <span class="c_punctuation">()</span> 533</td> 534</tr> 535<tr> 536<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 537</td> 538<td class="function_name"> 539<a class="link" href="GstStructure.html#gst-structure-nth-field-name" title="gst_structure_nth_field_name ()">gst_structure_nth_field_name</a> <span class="c_punctuation">()</span> 540</td> 541</tr> 542<tr> 543<td class="function_type"> 544<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 545</td> 546<td class="function_name"> 547<a class="link" href="GstStructure.html#gst-structure-set-parent-refcount" title="gst_structure_set_parent_refcount ()">gst_structure_set_parent_refcount</a> <span class="c_punctuation">()</span> 548</td> 549</tr> 550<tr> 551<td class="function_type"> 552<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 553</td> 554<td class="function_name"> 555<a class="link" href="GstStructure.html#gst-structure-to-string" title="gst_structure_to_string ()">gst_structure_to_string</a> <span class="c_punctuation">()</span> 556</td> 557</tr> 558<tr> 559<td class="function_type"> 560<a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 561</td> 562<td class="function_name"> 563<a class="link" href="GstStructure.html#gst-structure-from-string" title="gst_structure_from_string ()">gst_structure_from_string</a> <span class="c_punctuation">()</span> 564</td> 565</tr> 566<tr> 567<td class="function_type"> 568<span class="returnvalue">void</span> 569</td> 570<td class="function_name"> 571<a class="link" href="GstStructure.html#gst-structure-fixate" title="gst_structure_fixate ()">gst_structure_fixate</a> <span class="c_punctuation">()</span> 572</td> 573</tr> 574<tr> 575<td class="function_type"> 576<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 577</td> 578<td class="function_name"> 579<a class="link" href="GstStructure.html#gst-structure-fixate-field" title="gst_structure_fixate_field ()">gst_structure_fixate_field</a> <span class="c_punctuation">()</span> 580</td> 581</tr> 582<tr> 583<td class="function_type"> 584<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 585</td> 586<td class="function_name"> 587<a class="link" href="GstStructure.html#gst-structure-fixate-field-nearest-int" title="gst_structure_fixate_field_nearest_int ()">gst_structure_fixate_field_nearest_int</a> <span class="c_punctuation">()</span> 588</td> 589</tr> 590<tr> 591<td class="function_type"> 592<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 593</td> 594<td class="function_name"> 595<a class="link" href="GstStructure.html#gst-structure-fixate-field-nearest-double" title="gst_structure_fixate_field_nearest_double ()">gst_structure_fixate_field_nearest_double</a> <span class="c_punctuation">()</span> 596</td> 597</tr> 598<tr> 599<td class="function_type"> 600<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 601</td> 602<td class="function_name"> 603<a class="link" href="GstStructure.html#gst-structure-fixate-field-nearest-fraction" title="gst_structure_fixate_field_nearest_fraction ()">gst_structure_fixate_field_nearest_fraction</a> <span class="c_punctuation">()</span> 604</td> 605</tr> 606<tr> 607<td class="function_type"> 608<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 609</td> 610<td class="function_name"> 611<a class="link" href="GstStructure.html#gst-structure-fixate-field-boolean" title="gst_structure_fixate_field_boolean ()">gst_structure_fixate_field_boolean</a> <span class="c_punctuation">()</span> 612</td> 613</tr> 614<tr> 615<td class="function_type"> 616<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 617</td> 618<td class="function_name"> 619<a class="link" href="GstStructure.html#gst-structure-fixate-field-string" title="gst_structure_fixate_field_string ()">gst_structure_fixate_field_string</a> <span class="c_punctuation">()</span> 620</td> 621</tr> 622</tbody> 623</table></div> 624</div> 625<div class="refsect1"> 626<a name="GstStructure.other"></a><h2>Types and Values</h2> 627<div class="informaltable"><table class="informaltable" width="100%" border="0"> 628<colgroup> 629<col width="150px" class="name"> 630<col class="description"> 631</colgroup> 632<tbody><tr> 633<td class="datatype_keyword">struct</td> 634<td class="function_name"><a class="link" href="GstStructure.html#GstStructure-struct" title="struct GstStructure">GstStructure</a></td> 635</tr></tbody> 636</table></div> 637</div> 638<div class="refsect1"> 639<a name="GstStructure.object-hierarchy"></a><h2>Object Hierarchy</h2> 640<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> 641 <span class="lineart">╰──</span> GstStructure 642</pre> 643</div> 644<div class="refsect1"> 645<a name="GstStructure.includes"></a><h2>Includes</h2> 646<pre class="synopsis">#include <gst/gst.h> 647</pre> 648</div> 649<div class="refsect1"> 650<a name="GstStructure.description"></a><h2>Description</h2> 651<p>A <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> is a collection of key/value pairs. The keys are expressed 652as GQuarks and the values can be of any GType.</p> 653<p>In addition to the key/value pairs, a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> also has a name. The name 654starts with a letter and can be filled by letters, numbers and any of "/-_.:".</p> 655<p><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> is used by various GStreamer subsystems to store information 656in a flexible and extensible way. A <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> does not have a refcount 657because it usually is part of a higher level object such as <a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a>, 658<a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>, <a class="link" href="GstEvent.html" title="GstEvent"><span class="type">GstEvent</span></a>, <a class="link" href="GstQuery.html" title="GstQuery"><span class="type">GstQuery</span></a>. It provides a means to enforce mutability 659using the refcount of the parent with the <a class="link" href="GstStructure.html#gst-structure-set-parent-refcount" title="gst_structure_set_parent_refcount ()"><code class="function">gst_structure_set_parent_refcount()</code></a> 660method.</p> 661<p>A <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> can be created with <a class="link" href="GstStructure.html#gst-structure-new-empty" title="gst_structure_new_empty ()"><code class="function">gst_structure_new_empty()</code></a> or 662<a class="link" href="GstStructure.html#gst-structure-new" title="gst_structure_new ()"><code class="function">gst_structure_new()</code></a>, which both take a name and an optional set of 663key/value pairs along with the types of the values.</p> 664<p>Field values can be changed with <a class="link" href="GstStructure.html#gst-structure-set-value" title="gst_structure_set_value ()"><code class="function">gst_structure_set_value()</code></a> or 665<a class="link" href="GstStructure.html#gst-structure-set" title="gst_structure_set ()"><code class="function">gst_structure_set()</code></a>.</p> 666<p>Field values can be retrieved with <a class="link" href="GstStructure.html#gst-structure-get-value" title="gst_structure_get_value ()"><code class="function">gst_structure_get_value()</code></a> or the more 667convenient gst_structure_get_*() functions.</p> 668<p>Fields can be removed with <a class="link" href="GstStructure.html#gst-structure-remove-field" title="gst_structure_remove_field ()"><code class="function">gst_structure_remove_field()</code></a> or 669<a class="link" href="GstStructure.html#gst-structure-remove-fields" title="gst_structure_remove_fields ()"><code class="function">gst_structure_remove_fields()</code></a>.</p> 670<p>Strings in structures must be ASCII or UTF-8 encoded. Other encodings are 671not allowed. Strings may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> however.</p> 672<p>Be aware that the current <a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a> / <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> serialization into string 673has limited support for nested <a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a> / <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> fields. It can only 674support one level of nesting. Using more levels will lead to unexpected 675behavior when using serialization features, such as <a class="link" href="GstCaps.html#gst-caps-to-string" title="gst_caps_to_string ()"><code class="function">gst_caps_to_string()</code></a> or 676<a class="link" href="gstreamer-GstValue.html#gst-value-serialize" title="gst_value_serialize ()"><code class="function">gst_value_serialize()</code></a> and their counterparts.</p> 677</div> 678<div class="refsect1"> 679<a name="GstStructure.functions_details"></a><h2>Functions</h2> 680<div class="refsect2"> 681<a name="GstStructureForeachFunc"></a><h3>GstStructureForeachFunc ()</h3> 682<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 683<span class="c_punctuation">(</span>*GstStructureForeachFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field_id</code></em>, 684 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>, 685 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 686<p>A function that will be called in <a class="link" href="GstStructure.html#gst-structure-foreach" title="gst_structure_foreach ()"><code class="function">gst_structure_foreach()</code></a>. The function may 687not modify <em class="parameter"><code>value</code></em> 688.</p> 689<div class="refsect3"> 690<a name="GstStructureForeachFunc.parameters"></a><h4>Parameters</h4> 691<div class="informaltable"><table class="informaltable" width="100%" border="0"> 692<colgroup> 693<col width="150px" class="parameters_name"> 694<col class="parameters_description"> 695<col width="200px" class="parameters_annotations"> 696</colgroup> 697<tbody> 698<tr> 699<td class="parameter_name"><p>field_id</p></td> 700<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field name</p></td> 701<td class="parameter_annotations"> </td> 702</tr> 703<tr> 704<td class="parameter_name"><p>value</p></td> 705<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> of the field</p></td> 706<td class="parameter_annotations"> </td> 707</tr> 708<tr> 709<td class="parameter_name"><p>user_data</p></td> 710<td class="parameter_description"><p>user data</p></td> 711<td class="parameter_annotations"> </td> 712</tr> 713</tbody> 714</table></div> 715</div> 716<div class="refsect3"> 717<a name="GstStructureForeachFunc.returns"></a><h4>Returns</h4> 718<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the foreach operation should continue, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if 719the foreach operation should stop with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 720</div> 721</div> 722<hr> 723<div class="refsect2"> 724<a name="GstStructureMapFunc"></a><h3>GstStructureMapFunc ()</h3> 725<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 726<span class="c_punctuation">(</span>*GstStructureMapFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field_id</code></em>, 727 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>, 728 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 729<p>A function that will be called in <a class="link" href="GstStructure.html#gst-structure-map-in-place" title="gst_structure_map_in_place ()"><code class="function">gst_structure_map_in_place()</code></a>. The function 730may modify <em class="parameter"><code>value</code></em> 731.</p> 732<div class="refsect3"> 733<a name="GstStructureMapFunc.parameters"></a><h4>Parameters</h4> 734<div class="informaltable"><table class="informaltable" width="100%" border="0"> 735<colgroup> 736<col width="150px" class="parameters_name"> 737<col class="parameters_description"> 738<col width="200px" class="parameters_annotations"> 739</colgroup> 740<tbody> 741<tr> 742<td class="parameter_name"><p>field_id</p></td> 743<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field name</p></td> 744<td class="parameter_annotations"> </td> 745</tr> 746<tr> 747<td class="parameter_name"><p>value</p></td> 748<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> of the field</p></td> 749<td class="parameter_annotations"> </td> 750</tr> 751<tr> 752<td class="parameter_name"><p>user_data</p></td> 753<td class="parameter_description"><p>user data</p></td> 754<td class="parameter_annotations"> </td> 755</tr> 756</tbody> 757</table></div> 758</div> 759<div class="refsect3"> 760<a name="GstStructureMapFunc.returns"></a><h4>Returns</h4> 761<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the map operation should continue, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if 762the map operation should stop with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 763</div> 764</div> 765<hr> 766<div class="refsect2"> 767<a name="GstStructureFilterMapFunc"></a><h3>GstStructureFilterMapFunc ()</h3> 768<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 769<span class="c_punctuation">(</span>*GstStructureFilterMapFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field_id</code></em>, 770 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>, 771 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 772<p>A function that will be called in <a class="link" href="GstStructure.html#gst-structure-filter-and-map-in-place" title="gst_structure_filter_and_map_in_place ()"><code class="function">gst_structure_filter_and_map_in_place()</code></a>. 773The function may modify <em class="parameter"><code>value</code></em> 774, and the value will be removed from 775the structure if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</p> 776<div class="refsect3"> 777<a name="GstStructureFilterMapFunc.parameters"></a><h4>Parameters</h4> 778<div class="informaltable"><table class="informaltable" width="100%" border="0"> 779<colgroup> 780<col width="150px" class="parameters_name"> 781<col class="parameters_description"> 782<col width="200px" class="parameters_annotations"> 783</colgroup> 784<tbody> 785<tr> 786<td class="parameter_name"><p>field_id</p></td> 787<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field name</p></td> 788<td class="parameter_annotations"> </td> 789</tr> 790<tr> 791<td class="parameter_name"><p>value</p></td> 792<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> of the field</p></td> 793<td class="parameter_annotations"> </td> 794</tr> 795<tr> 796<td class="parameter_name"><p>user_data</p></td> 797<td class="parameter_description"><p>user data</p></td> 798<td class="parameter_annotations"> </td> 799</tr> 800</tbody> 801</table></div> 802</div> 803<div class="refsect3"> 804<a name="GstStructureFilterMapFunc.returns"></a><h4>Returns</h4> 805<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the field should be preserved, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it 806should be removed.</p> 807</div> 808</div> 809<hr> 810<div class="refsect2"> 811<a name="gst-structure-new-empty"></a><h3>gst_structure_new_empty ()</h3> 812<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 813gst_structure_new_empty (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> 814<p>Creates a new, empty <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> with the given <em class="parameter"><code>name</code></em> 815.</p> 816<p>See <a class="link" href="GstStructure.html#gst-structure-set-name" title="gst_structure_set_name ()"><code class="function">gst_structure_set_name()</code></a> for constraints on the <em class="parameter"><code>name</code></em> 817 parameter.</p> 818<p>Free-function: gst_structure_free</p> 819<div class="refsect3"> 820<a name="gst-structure-new-empty.parameters"></a><h4>Parameters</h4> 821<div class="informaltable"><table class="informaltable" width="100%" border="0"> 822<colgroup> 823<col width="150px" class="parameters_name"> 824<col class="parameters_description"> 825<col width="200px" class="parameters_annotations"> 826</colgroup> 827<tbody><tr> 828<td class="parameter_name"><p>name</p></td> 829<td class="parameter_description"><p>name of new structure</p></td> 830<td class="parameter_annotations"> </td> 831</tr></tbody> 832</table></div> 833</div> 834<div class="refsect3"> 835<a name="gst-structure-new-empty.returns"></a><h4>Returns</h4> 836<p>a new, empty <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 837<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 838</div> 839</div> 840<hr> 841<div class="refsect2"> 842<a name="gst-structure-new-id-empty"></a><h3>gst_structure_new_id_empty ()</h3> 843<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 844gst_structure_new_id_empty (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> quark</code></em>);</pre> 845<p>Creates a new, empty <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> with the given name as a GQuark.</p> 846<p>Free-function: gst_structure_free</p> 847<div class="refsect3"> 848<a name="gst-structure-new-id-empty.parameters"></a><h4>Parameters</h4> 849<div class="informaltable"><table class="informaltable" width="100%" border="0"> 850<colgroup> 851<col width="150px" class="parameters_name"> 852<col class="parameters_description"> 853<col width="200px" class="parameters_annotations"> 854</colgroup> 855<tbody><tr> 856<td class="parameter_name"><p>quark</p></td> 857<td class="parameter_description"><p>name of new structure</p></td> 858<td class="parameter_annotations"> </td> 859</tr></tbody> 860</table></div> 861</div> 862<div class="refsect3"> 863<a name="gst-structure-new-id-empty.returns"></a><h4>Returns</h4> 864<p>a new, empty <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 865<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 866</div> 867</div> 868<hr> 869<div class="refsect2"> 870<a name="gst-structure-new"></a><h3>gst_structure_new ()</h3> 871<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 872gst_structure_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, 873 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *firstfield</code></em>, 874 <em class="parameter"><code>...</code></em>);</pre> 875<p>Creates a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> with the given name. Parses the 876list of variable arguments and sets fields to the values listed. 877Variable arguments should be passed as field name, field type, 878and value. Last variable argument should be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> 879<p>Free-function: gst_structure_free</p> 880<div class="refsect3"> 881<a name="gst-structure-new.parameters"></a><h4>Parameters</h4> 882<div class="informaltable"><table class="informaltable" width="100%" border="0"> 883<colgroup> 884<col width="150px" class="parameters_name"> 885<col class="parameters_description"> 886<col width="200px" class="parameters_annotations"> 887</colgroup> 888<tbody> 889<tr> 890<td class="parameter_name"><p>name</p></td> 891<td class="parameter_description"><p>name of new structure</p></td> 892<td class="parameter_annotations"> </td> 893</tr> 894<tr> 895<td class="parameter_name"><p>firstfield</p></td> 896<td class="parameter_description"><p>name of first field to set</p></td> 897<td class="parameter_annotations"> </td> 898</tr> 899<tr> 900<td class="parameter_name"><p>...</p></td> 901<td class="parameter_description"><p>additional arguments</p></td> 902<td class="parameter_annotations"> </td> 903</tr> 904</tbody> 905</table></div> 906</div> 907<div class="refsect3"> 908<a name="gst-structure-new.returns"></a><h4>Returns</h4> 909<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 910<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 911</div> 912</div> 913<hr> 914<div class="refsect2"> 915<a name="gst-structure-new-valist"></a><h3>gst_structure_new_valist ()</h3> 916<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 917gst_structure_new_valist (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, 918 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *firstfield</code></em>, 919 <em class="parameter"><code><span class="type">va_list</span> varargs</code></em>);</pre> 920<p>Creates a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> with the given <em class="parameter"><code>name</code></em> 921. Structure fields 922are set according to the varargs in a manner similar to 923<a class="link" href="GstStructure.html#gst-structure-new" title="gst_structure_new ()"><code class="function">gst_structure_new()</code></a>.</p> 924<p>See <a class="link" href="GstStructure.html#gst-structure-set-name" title="gst_structure_set_name ()"><code class="function">gst_structure_set_name()</code></a> for constraints on the <em class="parameter"><code>name</code></em> 925 parameter.</p> 926<p>Free-function: gst_structure_free</p> 927<div class="refsect3"> 928<a name="gst-structure-new-valist.parameters"></a><h4>Parameters</h4> 929<div class="informaltable"><table class="informaltable" width="100%" border="0"> 930<colgroup> 931<col width="150px" class="parameters_name"> 932<col class="parameters_description"> 933<col width="200px" class="parameters_annotations"> 934</colgroup> 935<tbody> 936<tr> 937<td class="parameter_name"><p>name</p></td> 938<td class="parameter_description"><p>name of new structure</p></td> 939<td class="parameter_annotations"> </td> 940</tr> 941<tr> 942<td class="parameter_name"><p>firstfield</p></td> 943<td class="parameter_description"><p>name of first field to set</p></td> 944<td class="parameter_annotations"> </td> 945</tr> 946<tr> 947<td class="parameter_name"><p>varargs</p></td> 948<td class="parameter_description"><p>variable argument list</p></td> 949<td class="parameter_annotations"> </td> 950</tr> 951</tbody> 952</table></div> 953</div> 954<div class="refsect3"> 955<a name="gst-structure-new-valist.returns"></a><h4>Returns</h4> 956<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 957<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 958</div> 959</div> 960<hr> 961<div class="refsect2"> 962<a name="gst-structure-new-id"></a><h3>gst_structure_new_id ()</h3> 963<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 964gst_structure_new_id (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> name_quark</code></em>, 965 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field_quark</code></em>, 966 <em class="parameter"><code>...</code></em>);</pre> 967<p>Creates a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> with the given name as a GQuark, followed by 968fieldname quark, GType, argument(s) "triplets" in the same format as 969<a class="link" href="GstStructure.html#gst-structure-id-set" title="gst_structure_id_set ()"><code class="function">gst_structure_id_set()</code></a>. Basically a convenience wrapper around 970<a class="link" href="GstStructure.html#gst-structure-new-id-empty" title="gst_structure_new_id_empty ()"><code class="function">gst_structure_new_id_empty()</code></a> and <a class="link" href="GstStructure.html#gst-structure-id-set" title="gst_structure_id_set ()"><code class="function">gst_structure_id_set()</code></a>.</p> 971<p>The last variable argument must be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (or 0).</p> 972<p>Free-function: gst_structure_free</p> 973<div class="refsect3"> 974<a name="gst-structure-new-id.parameters"></a><h4>Parameters</h4> 975<div class="informaltable"><table class="informaltable" width="100%" border="0"> 976<colgroup> 977<col width="150px" class="parameters_name"> 978<col class="parameters_description"> 979<col width="200px" class="parameters_annotations"> 980</colgroup> 981<tbody> 982<tr> 983<td class="parameter_name"><p>name_quark</p></td> 984<td class="parameter_description"><p>name of new structure</p></td> 985<td class="parameter_annotations"> </td> 986</tr> 987<tr> 988<td class="parameter_name"><p>field_quark</p></td> 989<td class="parameter_description"><p>the GQuark for the name of the field to set</p></td> 990<td class="parameter_annotations"> </td> 991</tr> 992<tr> 993<td class="parameter_name"><p>...</p></td> 994<td class="parameter_description"><p>variable arguments</p></td> 995<td class="parameter_annotations"> </td> 996</tr> 997</tbody> 998</table></div> 999</div> 1000<div class="refsect3"> 1001<a name="gst-structure-new-id.returns"></a><h4>Returns</h4> 1002<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 1003<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 1004</div> 1005</div> 1006<hr> 1007<div class="refsect2"> 1008<a name="gst-structure-new-from-string"></a><h3>gst_structure_new_from_string ()</h3> 1009<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 1010gst_structure_new_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre> 1011<p>Creates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> from a string representation. 1012If end is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a pointer to the place inside the given string 1013where parsing ended will be returned.</p> 1014<p>The current implementation of serialization will lead to unexpected results 1015when there are nested <a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a> / <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> deeper than one level.</p> 1016<p>Free-function: gst_structure_free</p> 1017<div class="refsect3"> 1018<a name="gst-structure-new-from-string.parameters"></a><h4>Parameters</h4> 1019<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1020<colgroup> 1021<col width="150px" class="parameters_name"> 1022<col class="parameters_description"> 1023<col width="200px" class="parameters_annotations"> 1024</colgroup> 1025<tbody><tr> 1026<td class="parameter_name"><p>string</p></td> 1027<td class="parameter_description"><p>a string representation of a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1028<td class="parameter_annotations"> </td> 1029</tr></tbody> 1030</table></div> 1031</div> 1032<div class="refsect3"> 1033<a name="gst-structure-new-from-string.returns"></a><h4>Returns</h4> 1034<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 1035when the string could not be parsed. Free with 1036<a class="link" href="GstStructure.html#gst-structure-free" title="gst_structure_free ()"><code class="function">gst_structure_free()</code></a> after use. </p> 1037<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 1038</div> 1039<p class="since">Since: <a class="link" href="ix10.html#api-index-1.2">1.2</a></p> 1040</div> 1041<hr> 1042<div class="refsect2"> 1043<a name="gst-structure-copy"></a><h3>gst_structure_copy ()</h3> 1044<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 1045gst_structure_copy (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 1046<p>Duplicates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> and all its fields and values.</p> 1047<p>Free-function: gst_structure_free</p> 1048<div class="refsect3"> 1049<a name="gst-structure-copy.parameters"></a><h4>Parameters</h4> 1050<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1051<colgroup> 1052<col width="150px" class="parameters_name"> 1053<col class="parameters_description"> 1054<col width="200px" class="parameters_annotations"> 1055</colgroup> 1056<tbody><tr> 1057<td class="parameter_name"><p>structure</p></td> 1058<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> to duplicate</p></td> 1059<td class="parameter_annotations"> </td> 1060</tr></tbody> 1061</table></div> 1062</div> 1063<div class="refsect3"> 1064<a name="gst-structure-copy.returns"></a><h4>Returns</h4> 1065<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. </p> 1066<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 1067</div> 1068</div> 1069<hr> 1070<div class="refsect2"> 1071<a name="gst-structure-free"></a><h3>gst_structure_free ()</h3> 1072<pre class="programlisting"><span class="returnvalue">void</span> 1073gst_structure_free (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 1074<p>Frees a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> and all its fields and values. The structure must not 1075have a parent when this function is called.</p> 1076<div class="refsect3"> 1077<a name="gst-structure-free.parameters"></a><h4>Parameters</h4> 1078<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1079<colgroup> 1080<col width="150px" class="parameters_name"> 1081<col class="parameters_description"> 1082<col width="200px" class="parameters_annotations"> 1083</colgroup> 1084<tbody><tr> 1085<td class="parameter_name"><p>structure</p></td> 1086<td class="parameter_description"><p>the <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> to free. </p></td> 1087<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 1088</tr></tbody> 1089</table></div> 1090</div> 1091</div> 1092<hr> 1093<div class="refsect2"> 1094<a name="gst-structure-get-name"></a><h3>gst_structure_get_name ()</h3> 1095<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 1096gst_structure_get_name (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 1097<p>Get the name of <em class="parameter"><code>structure</code></em> 1098 as a string.</p> 1099<div class="refsect3"> 1100<a name="gst-structure-get-name.parameters"></a><h4>Parameters</h4> 1101<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1102<colgroup> 1103<col width="150px" class="parameters_name"> 1104<col class="parameters_description"> 1105<col width="200px" class="parameters_annotations"> 1106</colgroup> 1107<tbody><tr> 1108<td class="parameter_name"><p>structure</p></td> 1109<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1110<td class="parameter_annotations"> </td> 1111</tr></tbody> 1112</table></div> 1113</div> 1114<div class="refsect3"> 1115<a name="gst-structure-get-name.returns"></a><h4>Returns</h4> 1116<p> the name of the structure.</p> 1117</div> 1118</div> 1119<hr> 1120<div class="refsect2"> 1121<a name="gst-structure-has-name"></a><h3>gst_structure_has_name ()</h3> 1122<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1123gst_structure_has_name (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1124 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> 1125<p>Checks if the structure has the given name</p> 1126<div class="refsect3"> 1127<a name="gst-structure-has-name.parameters"></a><h4>Parameters</h4> 1128<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1129<colgroup> 1130<col width="150px" class="parameters_name"> 1131<col class="parameters_description"> 1132<col width="200px" class="parameters_annotations"> 1133</colgroup> 1134<tbody> 1135<tr> 1136<td class="parameter_name"><p>structure</p></td> 1137<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1138<td class="parameter_annotations"> </td> 1139</tr> 1140<tr> 1141<td class="parameter_name"><p>name</p></td> 1142<td class="parameter_description"><p>structure name to check for</p></td> 1143<td class="parameter_annotations"> </td> 1144</tr> 1145</tbody> 1146</table></div> 1147</div> 1148<div class="refsect3"> 1149<a name="gst-structure-has-name.returns"></a><h4>Returns</h4> 1150<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>name</code></em> 1151matches the name of the structure.</p> 1152</div> 1153</div> 1154<hr> 1155<div class="refsect2"> 1156<a name="gst-structure-set-name"></a><h3>gst_structure_set_name ()</h3> 1157<pre class="programlisting"><span class="returnvalue">void</span> 1158gst_structure_set_name (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1159 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> 1160<p>Sets the name of the structure to the given <em class="parameter"><code>name</code></em> 1161. The string 1162provided is copied before being used. It must not be empty, start with a 1163letter and can be followed by letters, numbers and any of "/-_.:".</p> 1164<div class="refsect3"> 1165<a name="gst-structure-set-name.parameters"></a><h4>Parameters</h4> 1166<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1167<colgroup> 1168<col width="150px" class="parameters_name"> 1169<col class="parameters_description"> 1170<col width="200px" class="parameters_annotations"> 1171</colgroup> 1172<tbody> 1173<tr> 1174<td class="parameter_name"><p>structure</p></td> 1175<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1176<td class="parameter_annotations"> </td> 1177</tr> 1178<tr> 1179<td class="parameter_name"><p>name</p></td> 1180<td class="parameter_description"><p>the new name of the structure</p></td> 1181<td class="parameter_annotations"> </td> 1182</tr> 1183</tbody> 1184</table></div> 1185</div> 1186</div> 1187<hr> 1188<div class="refsect2"> 1189<a name="gst-structure-get-name-id"></a><h3>gst_structure_get_name_id ()</h3> 1190<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> 1191gst_structure_get_name_id (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 1192<p>Get the name of <em class="parameter"><code>structure</code></em> 1193 as a GQuark.</p> 1194<div class="refsect3"> 1195<a name="gst-structure-get-name-id.parameters"></a><h4>Parameters</h4> 1196<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1197<colgroup> 1198<col width="150px" class="parameters_name"> 1199<col class="parameters_description"> 1200<col width="200px" class="parameters_annotations"> 1201</colgroup> 1202<tbody><tr> 1203<td class="parameter_name"><p>structure</p></td> 1204<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1205<td class="parameter_annotations"> </td> 1206</tr></tbody> 1207</table></div> 1208</div> 1209<div class="refsect3"> 1210<a name="gst-structure-get-name-id.returns"></a><h4>Returns</h4> 1211<p> the quark representing the name of the structure.</p> 1212</div> 1213</div> 1214<hr> 1215<div class="refsect2"> 1216<a name="gst-structure-id-get"></a><h3>gst_structure_id_get ()</h3> 1217<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1218gst_structure_id_get (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1219 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> first_field_id</code></em>, 1220 <em class="parameter"><code>...</code></em>);</pre> 1221<p>Parses the variable arguments and reads fields from <em class="parameter"><code>structure</code></em> 1222 accordingly. 1223Variable arguments should be in the form field id quark, field type 1224(as a GType), pointer(s) to a variable(s) to hold the return value(s). 1225The last variable argument should be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (technically it should be a 12260 quark, but we require <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> so compilers that support it can check for 1227the <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminator and warn if it's not there).</p> 1228<p>This function is just like <a class="link" href="GstStructure.html#gst-structure-get" title="gst_structure_get ()"><code class="function">gst_structure_get()</code></a> only that it is slightly 1229more efficient since it saves the string-to-quark lookup in the global 1230quark hashtable.</p> 1231<p>For refcounted (mini)objects you will receive a new reference which 1232you must release with a suitable <code class="function">_unref()</code> when no longer needed. For 1233strings and boxed types you will receive a copy which you will need to 1234release with either <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> or the suitable function for the boxed type.</p> 1235<div class="refsect3"> 1236<a name="gst-structure-id-get.parameters"></a><h4>Parameters</h4> 1237<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1238<colgroup> 1239<col width="150px" class="parameters_name"> 1240<col class="parameters_description"> 1241<col width="200px" class="parameters_annotations"> 1242</colgroup> 1243<tbody> 1244<tr> 1245<td class="parameter_name"><p>structure</p></td> 1246<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1247<td class="parameter_annotations"> </td> 1248</tr> 1249<tr> 1250<td class="parameter_name"><p>first_field_id</p></td> 1251<td class="parameter_description"><p>the quark of the first field to read</p></td> 1252<td class="parameter_annotations"> </td> 1253</tr> 1254<tr> 1255<td class="parameter_name"><p>...</p></td> 1256<td class="parameter_description"><p>variable arguments</p></td> 1257<td class="parameter_annotations"> </td> 1258</tr> 1259</tbody> 1260</table></div> 1261</div> 1262<div class="refsect3"> 1263<a name="gst-structure-id-get.returns"></a><h4>Returns</h4> 1264<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem reading any of the fields (e.g. 1265because the field requested did not exist, or was of a type other 1266than the type specified), otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p> 1267</div> 1268</div> 1269<hr> 1270<div class="refsect2"> 1271<a name="gst-structure-id-get-valist"></a><h3>gst_structure_id_get_valist ()</h3> 1272<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1273gst_structure_id_get_valist (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1274 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> first_field_id</code></em>, 1275 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre> 1276<p>Parses the variable arguments and reads fields from <em class="parameter"><code>structure</code></em> 1277 accordingly. 1278valist-variant of <a class="link" href="GstStructure.html#gst-structure-id-get" title="gst_structure_id_get ()"><code class="function">gst_structure_id_get()</code></a>. Look at the documentation of 1279<a class="link" href="GstStructure.html#gst-structure-id-get" title="gst_structure_id_get ()"><code class="function">gst_structure_id_get()</code></a> for more details.</p> 1280<div class="refsect3"> 1281<a name="gst-structure-id-get-valist.parameters"></a><h4>Parameters</h4> 1282<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1283<colgroup> 1284<col width="150px" class="parameters_name"> 1285<col class="parameters_description"> 1286<col width="200px" class="parameters_annotations"> 1287</colgroup> 1288<tbody> 1289<tr> 1290<td class="parameter_name"><p>structure</p></td> 1291<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1292<td class="parameter_annotations"> </td> 1293</tr> 1294<tr> 1295<td class="parameter_name"><p>first_field_id</p></td> 1296<td class="parameter_description"><p>the quark of the first field to read</p></td> 1297<td class="parameter_annotations"> </td> 1298</tr> 1299<tr> 1300<td class="parameter_name"><p>args</p></td> 1301<td class="parameter_description"><p>variable arguments</p></td> 1302<td class="parameter_annotations"> </td> 1303</tr> 1304</tbody> 1305</table></div> 1306</div> 1307<div class="refsect3"> 1308<a name="gst-structure-id-get-valist.returns"></a><h4>Returns</h4> 1309<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem reading any of the fields</p> 1310</div> 1311</div> 1312<hr> 1313<div class="refsect2"> 1314<a name="gst-structure-id-get-value"></a><h3>gst_structure_id_get_value ()</h3> 1315<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="returnvalue">GValue</span></a> * 1316gst_structure_id_get_value (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1317 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field</code></em>);</pre> 1318<p>Get the value of the field with GQuark <em class="parameter"><code>field</code></em> 1319.</p> 1320<div class="refsect3"> 1321<a name="gst-structure-id-get-value.parameters"></a><h4>Parameters</h4> 1322<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1323<colgroup> 1324<col width="150px" class="parameters_name"> 1325<col class="parameters_description"> 1326<col width="200px" class="parameters_annotations"> 1327</colgroup> 1328<tbody> 1329<tr> 1330<td class="parameter_name"><p>structure</p></td> 1331<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1332<td class="parameter_annotations"> </td> 1333</tr> 1334<tr> 1335<td class="parameter_name"><p>field</p></td> 1336<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field to get</p></td> 1337<td class="parameter_annotations"> </td> 1338</tr> 1339</tbody> 1340</table></div> 1341</div> 1342<div class="refsect3"> 1343<a name="gst-structure-id-get-value.returns"></a><h4>Returns</h4> 1344<p>the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> corresponding to the field with the given 1345name identifier. </p> 1346<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 1347</div> 1348</div> 1349<hr> 1350<div class="refsect2"> 1351<a name="gst-structure-id-set-value"></a><h3>gst_structure_id_set_value ()</h3> 1352<pre class="programlisting"><span class="returnvalue">void</span> 1353gst_structure_id_set_value (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1354 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field</code></em>, 1355 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>);</pre> 1356<p>Sets the field with the given GQuark <em class="parameter"><code>field</code></em> 1357 to <em class="parameter"><code>value</code></em> 1358. If the field 1359does not exist, it is created. If the field exists, the previous 1360value is replaced and freed.</p> 1361<div class="refsect3"> 1362<a name="gst-structure-id-set-value.parameters"></a><h4>Parameters</h4> 1363<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1364<colgroup> 1365<col width="150px" class="parameters_name"> 1366<col class="parameters_description"> 1367<col width="200px" class="parameters_annotations"> 1368</colgroup> 1369<tbody> 1370<tr> 1371<td class="parameter_name"><p>structure</p></td> 1372<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1373<td class="parameter_annotations"> </td> 1374</tr> 1375<tr> 1376<td class="parameter_name"><p>field</p></td> 1377<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> representing a field</p></td> 1378<td class="parameter_annotations"> </td> 1379</tr> 1380<tr> 1381<td class="parameter_name"><p>value</p></td> 1382<td class="parameter_description"><p>the new value of the field</p></td> 1383<td class="parameter_annotations"> </td> 1384</tr> 1385</tbody> 1386</table></div> 1387</div> 1388</div> 1389<hr> 1390<div class="refsect2"> 1391<a name="gst-structure-id-take-value"></a><h3>gst_structure_id_take_value ()</h3> 1392<pre class="programlisting"><span class="returnvalue">void</span> 1393gst_structure_id_take_value (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1394 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field</code></em>, 1395 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>);</pre> 1396<p>Sets the field with the given GQuark <em class="parameter"><code>field</code></em> 1397 to <em class="parameter"><code>value</code></em> 1398. If the field 1399does not exist, it is created. If the field exists, the previous 1400value is replaced and freed.</p> 1401<div class="refsect3"> 1402<a name="gst-structure-id-take-value.parameters"></a><h4>Parameters</h4> 1403<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1404<colgroup> 1405<col width="150px" class="parameters_name"> 1406<col class="parameters_description"> 1407<col width="200px" class="parameters_annotations"> 1408</colgroup> 1409<tbody> 1410<tr> 1411<td class="parameter_name"><p>structure</p></td> 1412<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1413<td class="parameter_annotations"> </td> 1414</tr> 1415<tr> 1416<td class="parameter_name"><p>field</p></td> 1417<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> representing a field</p></td> 1418<td class="parameter_annotations"> </td> 1419</tr> 1420<tr> 1421<td class="parameter_name"><p>value</p></td> 1422<td class="parameter_description"><p>the new value of the field. </p></td> 1423<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 1424</tr> 1425</tbody> 1426</table></div> 1427</div> 1428</div> 1429<hr> 1430<div class="refsect2"> 1431<a name="gst-structure-get"></a><h3>gst_structure_get ()</h3> 1432<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1433gst_structure_get (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1434 <em class="parameter"><code>const <span class="type">char</span> *first_fieldname</code></em>, 1435 <em class="parameter"><code>...</code></em>);</pre> 1436<p>Parses the variable arguments and reads fields from <em class="parameter"><code>structure</code></em> 1437 accordingly. 1438Variable arguments should be in the form field name, field type 1439(as a GType), pointer(s) to a variable(s) to hold the return value(s). 1440The last variable argument should be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> 1441<p>For refcounted (mini)objects you will receive a new reference which 1442you must release with a suitable <code class="function">_unref()</code> when no longer needed. For 1443strings and boxed types you will receive a copy which you will need to 1444release with either <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> or the suitable function for the boxed type.</p> 1445<div class="refsect3"> 1446<a name="gst-structure-get.parameters"></a><h4>Parameters</h4> 1447<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1448<colgroup> 1449<col width="150px" class="parameters_name"> 1450<col class="parameters_description"> 1451<col width="200px" class="parameters_annotations"> 1452</colgroup> 1453<tbody> 1454<tr> 1455<td class="parameter_name"><p>structure</p></td> 1456<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1457<td class="parameter_annotations"> </td> 1458</tr> 1459<tr> 1460<td class="parameter_name"><p>first_fieldname</p></td> 1461<td class="parameter_description"><p>the name of the first field to read</p></td> 1462<td class="parameter_annotations"> </td> 1463</tr> 1464<tr> 1465<td class="parameter_name"><p>...</p></td> 1466<td class="parameter_description"><p>variable arguments</p></td> 1467<td class="parameter_annotations"> </td> 1468</tr> 1469</tbody> 1470</table></div> 1471</div> 1472<div class="refsect3"> 1473<a name="gst-structure-get.returns"></a><h4>Returns</h4> 1474<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem reading any of the fields (e.g. 1475because the field requested did not exist, or was of a type other 1476than the type specified), otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p> 1477</div> 1478</div> 1479<hr> 1480<div class="refsect2"> 1481<a name="gst-structure-get-valist"></a><h3>gst_structure_get_valist ()</h3> 1482<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1483gst_structure_get_valist (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1484 <em class="parameter"><code>const <span class="type">char</span> *first_fieldname</code></em>, 1485 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre> 1486<p>Parses the variable arguments and reads fields from <em class="parameter"><code>structure</code></em> 1487 accordingly. 1488valist-variant of <a class="link" href="GstStructure.html#gst-structure-get" title="gst_structure_get ()"><code class="function">gst_structure_get()</code></a>. Look at the documentation of 1489<a class="link" href="GstStructure.html#gst-structure-get" title="gst_structure_get ()"><code class="function">gst_structure_get()</code></a> for more details.</p> 1490<div class="refsect3"> 1491<a name="gst-structure-get-valist.parameters"></a><h4>Parameters</h4> 1492<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1493<colgroup> 1494<col width="150px" class="parameters_name"> 1495<col class="parameters_description"> 1496<col width="200px" class="parameters_annotations"> 1497</colgroup> 1498<tbody> 1499<tr> 1500<td class="parameter_name"><p>structure</p></td> 1501<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1502<td class="parameter_annotations"> </td> 1503</tr> 1504<tr> 1505<td class="parameter_name"><p>first_fieldname</p></td> 1506<td class="parameter_description"><p>the name of the first field to read</p></td> 1507<td class="parameter_annotations"> </td> 1508</tr> 1509<tr> 1510<td class="parameter_name"><p>args</p></td> 1511<td class="parameter_description"><p>variable arguments</p></td> 1512<td class="parameter_annotations"> </td> 1513</tr> 1514</tbody> 1515</table></div> 1516</div> 1517<div class="refsect3"> 1518<a name="gst-structure-get-valist.returns"></a><h4>Returns</h4> 1519<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem reading any of the fields</p> 1520</div> 1521</div> 1522<hr> 1523<div class="refsect2"> 1524<a name="gst-structure-get-value"></a><h3>gst_structure_get_value ()</h3> 1525<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="returnvalue">GValue</span></a> * 1526gst_structure_get_value (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1527 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>);</pre> 1528<p>Get the value of the field with name <em class="parameter"><code>fieldname</code></em> 1529.</p> 1530<div class="refsect3"> 1531<a name="gst-structure-get-value.parameters"></a><h4>Parameters</h4> 1532<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1533<colgroup> 1534<col width="150px" class="parameters_name"> 1535<col class="parameters_description"> 1536<col width="200px" class="parameters_annotations"> 1537</colgroup> 1538<tbody> 1539<tr> 1540<td class="parameter_name"><p>structure</p></td> 1541<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1542<td class="parameter_annotations"> </td> 1543</tr> 1544<tr> 1545<td class="parameter_name"><p>fieldname</p></td> 1546<td class="parameter_description"><p>the name of the field to get</p></td> 1547<td class="parameter_annotations"> </td> 1548</tr> 1549</tbody> 1550</table></div> 1551</div> 1552<div class="refsect3"> 1553<a name="gst-structure-get-value.returns"></a><h4>Returns</h4> 1554<p>the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> corresponding to the field with the given 1555name. </p> 1556<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 1557</div> 1558</div> 1559<hr> 1560<div class="refsect2"> 1561<a name="gst-structure-set-value"></a><h3>gst_structure_set_value ()</h3> 1562<pre class="programlisting"><span class="returnvalue">void</span> 1563gst_structure_set_value (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1564 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1565 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>);</pre> 1566<p>Sets the field with the given name <em class="parameter"><code>field</code></em> 1567 to <em class="parameter"><code>value</code></em> 1568. If the field 1569does not exist, it is created. If the field exists, the previous 1570value is replaced and freed.</p> 1571<div class="refsect3"> 1572<a name="gst-structure-set-value.parameters"></a><h4>Parameters</h4> 1573<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1574<colgroup> 1575<col width="150px" class="parameters_name"> 1576<col class="parameters_description"> 1577<col width="200px" class="parameters_annotations"> 1578</colgroup> 1579<tbody> 1580<tr> 1581<td class="parameter_name"><p>structure</p></td> 1582<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1583<td class="parameter_annotations"> </td> 1584</tr> 1585<tr> 1586<td class="parameter_name"><p>fieldname</p></td> 1587<td class="parameter_description"><p>the name of the field to set</p></td> 1588<td class="parameter_annotations"> </td> 1589</tr> 1590<tr> 1591<td class="parameter_name"><p>value</p></td> 1592<td class="parameter_description"><p>the new value of the field</p></td> 1593<td class="parameter_annotations"> </td> 1594</tr> 1595</tbody> 1596</table></div> 1597</div> 1598</div> 1599<hr> 1600<div class="refsect2"> 1601<a name="gst-structure-set-array"></a><h3>gst_structure_set_array ()</h3> 1602<pre class="programlisting"><span class="returnvalue">void</span> 1603gst_structure_set_array (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1604 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1605 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *array</code></em>);</pre> 1606<p>This is useful in language bindings where unknown GValue types are not 1607supported. This function will convert a <em class="parameter"><code>array</code></em> 1608 to <a class="link" href="gstreamer-GstValue.html#GST-TYPE-ARRAY:CAPS" title="GST_TYPE_ARRAY"><code class="literal">GST_TYPE_ARRAY</code></a> and set 1609the field specified by <em class="parameter"><code>fieldname</code></em> 1610. Be aware that this is slower then using 1611<a class="link" href="gstreamer-GstValue.html#GST-TYPE-ARRAY:CAPS" title="GST_TYPE_ARRAY"><code class="literal">GST_TYPE_ARRAY</code></a> in a <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> directly.</p> 1612<div class="refsect3"> 1613<a name="gst-structure-set-array.parameters"></a><h4>Parameters</h4> 1614<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1615<colgroup> 1616<col width="150px" class="parameters_name"> 1617<col class="parameters_description"> 1618<col width="200px" class="parameters_annotations"> 1619</colgroup> 1620<tbody> 1621<tr> 1622<td class="parameter_name"><p>structure</p></td> 1623<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1624<td class="parameter_annotations"> </td> 1625</tr> 1626<tr> 1627<td class="parameter_name"><p>fieldname</p></td> 1628<td class="parameter_description"><p>the name of a field</p></td> 1629<td class="parameter_annotations"> </td> 1630</tr> 1631<tr> 1632<td class="parameter_name"><p>array</p></td> 1633<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a></p></td> 1634<td class="parameter_annotations"> </td> 1635</tr> 1636</tbody> 1637</table></div> 1638</div> 1639<p class="since">Since: <a class="link" href="ix04.html#api-index-1.12">1.12</a></p> 1640</div> 1641<hr> 1642<div class="refsect2"> 1643<a name="gst-structure-set-list"></a><h3>gst_structure_set_list ()</h3> 1644<pre class="programlisting"><span class="returnvalue">void</span> 1645gst_structure_set_list (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1646 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1647 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *array</code></em>);</pre> 1648<p>This is useful in language bindings where unknown GValue types are not 1649supported. This function will convert a <em class="parameter"><code>array</code></em> 1650 to <a class="link" href="gstreamer-GstValue.html#GST-TYPE-LIST:CAPS" title="GST_TYPE_LIST"><code class="literal">GST_TYPE_LIST</code></a> and set 1651the field specified by <em class="parameter"><code>fieldname</code></em> 1652. Be aware that this is slower then using 1653<a class="link" href="gstreamer-GstValue.html#GST-TYPE-LIST:CAPS" title="GST_TYPE_LIST"><code class="literal">GST_TYPE_LIST</code></a> in a <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> directly.</p> 1654<div class="refsect3"> 1655<a name="gst-structure-set-list.parameters"></a><h4>Parameters</h4> 1656<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1657<colgroup> 1658<col width="150px" class="parameters_name"> 1659<col class="parameters_description"> 1660<col width="200px" class="parameters_annotations"> 1661</colgroup> 1662<tbody> 1663<tr> 1664<td class="parameter_name"><p>structure</p></td> 1665<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1666<td class="parameter_annotations"> </td> 1667</tr> 1668<tr> 1669<td class="parameter_name"><p>fieldname</p></td> 1670<td class="parameter_description"><p>the name of a field</p></td> 1671<td class="parameter_annotations"> </td> 1672</tr> 1673<tr> 1674<td class="parameter_name"><p>array</p></td> 1675<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a></p></td> 1676<td class="parameter_annotations"> </td> 1677</tr> 1678</tbody> 1679</table></div> 1680</div> 1681<p class="since">Since: <a class="link" href="ix04.html#api-index-1.12">1.12</a></p> 1682</div> 1683<hr> 1684<div class="refsect2"> 1685<a name="gst-structure-take-value"></a><h3>gst_structure_take_value ()</h3> 1686<pre class="programlisting"><span class="returnvalue">void</span> 1687gst_structure_take_value (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1688 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1689 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> *value</code></em>);</pre> 1690<p>Sets the field with the given name <em class="parameter"><code>field</code></em> 1691 to <em class="parameter"><code>value</code></em> 1692. If the field 1693does not exist, it is created. If the field exists, the previous 1694value is replaced and freed. The function will take ownership of <em class="parameter"><code>value</code></em> 1695.</p> 1696<div class="refsect3"> 1697<a name="gst-structure-take-value.parameters"></a><h4>Parameters</h4> 1698<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1699<colgroup> 1700<col width="150px" class="parameters_name"> 1701<col class="parameters_description"> 1702<col width="200px" class="parameters_annotations"> 1703</colgroup> 1704<tbody> 1705<tr> 1706<td class="parameter_name"><p>structure</p></td> 1707<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1708<td class="parameter_annotations"> </td> 1709</tr> 1710<tr> 1711<td class="parameter_name"><p>fieldname</p></td> 1712<td class="parameter_description"><p>the name of the field to set</p></td> 1713<td class="parameter_annotations"> </td> 1714</tr> 1715<tr> 1716<td class="parameter_name"><p>value</p></td> 1717<td class="parameter_description"><p>the new value of the field. </p></td> 1718<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 1719</tr> 1720</tbody> 1721</table></div> 1722</div> 1723</div> 1724<hr> 1725<div class="refsect2"> 1726<a name="gst-structure-set"></a><h3>gst_structure_set ()</h3> 1727<pre class="programlisting"><span class="returnvalue">void</span> 1728gst_structure_set (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1729 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1730 <em class="parameter"><code>...</code></em>);</pre> 1731<p>Parses the variable arguments and sets fields accordingly. Fields that 1732weren't already part of the structure are added as needed. 1733Variable arguments should be in the form field name, field type 1734(as a GType), value(s). The last variable argument should be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> 1735<div class="refsect3"> 1736<a name="gst-structure-set.parameters"></a><h4>Parameters</h4> 1737<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1738<colgroup> 1739<col width="150px" class="parameters_name"> 1740<col class="parameters_description"> 1741<col width="200px" class="parameters_annotations"> 1742</colgroup> 1743<tbody> 1744<tr> 1745<td class="parameter_name"><p>structure</p></td> 1746<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1747<td class="parameter_annotations"> </td> 1748</tr> 1749<tr> 1750<td class="parameter_name"><p>fieldname</p></td> 1751<td class="parameter_description"><p>the name of the field to set</p></td> 1752<td class="parameter_annotations"> </td> 1753</tr> 1754<tr> 1755<td class="parameter_name"><p>...</p></td> 1756<td class="parameter_description"><p>variable arguments</p></td> 1757<td class="parameter_annotations"> </td> 1758</tr> 1759</tbody> 1760</table></div> 1761</div> 1762</div> 1763<hr> 1764<div class="refsect2"> 1765<a name="gst-structure-set-valist"></a><h3>gst_structure_set_valist ()</h3> 1766<pre class="programlisting"><span class="returnvalue">void</span> 1767gst_structure_set_valist (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1768 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1769 <em class="parameter"><code><span class="type">va_list</span> varargs</code></em>);</pre> 1770<p>va_list form of <a class="link" href="GstStructure.html#gst-structure-set" title="gst_structure_set ()"><code class="function">gst_structure_set()</code></a>.</p> 1771<div class="refsect3"> 1772<a name="gst-structure-set-valist.parameters"></a><h4>Parameters</h4> 1773<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1774<colgroup> 1775<col width="150px" class="parameters_name"> 1776<col class="parameters_description"> 1777<col width="200px" class="parameters_annotations"> 1778</colgroup> 1779<tbody> 1780<tr> 1781<td class="parameter_name"><p>structure</p></td> 1782<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1783<td class="parameter_annotations"> </td> 1784</tr> 1785<tr> 1786<td class="parameter_name"><p>fieldname</p></td> 1787<td class="parameter_description"><p>the name of the field to set</p></td> 1788<td class="parameter_annotations"> </td> 1789</tr> 1790<tr> 1791<td class="parameter_name"><p>varargs</p></td> 1792<td class="parameter_description"><p>variable arguments</p></td> 1793<td class="parameter_annotations"> </td> 1794</tr> 1795</tbody> 1796</table></div> 1797</div> 1798</div> 1799<hr> 1800<div class="refsect2"> 1801<a name="gst-structure-id-set"></a><h3>gst_structure_id_set ()</h3> 1802<pre class="programlisting"><span class="returnvalue">void</span> 1803gst_structure_id_set (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1804 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> fieldname</code></em>, 1805 <em class="parameter"><code>...</code></em>);</pre> 1806<p>Identical to gst_structure_set, except that field names are 1807passed using the GQuark for the field name. This allows more efficient 1808setting of the structure if the caller already knows the associated 1809quark values. 1810The last variable argument must be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> 1811<div class="refsect3"> 1812<a name="gst-structure-id-set.parameters"></a><h4>Parameters</h4> 1813<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1814<colgroup> 1815<col width="150px" class="parameters_name"> 1816<col class="parameters_description"> 1817<col width="200px" class="parameters_annotations"> 1818</colgroup> 1819<tbody> 1820<tr> 1821<td class="parameter_name"><p>structure</p></td> 1822<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1823<td class="parameter_annotations"> </td> 1824</tr> 1825<tr> 1826<td class="parameter_name"><p>fieldname</p></td> 1827<td class="parameter_description"><p>the GQuark for the name of the field to set</p></td> 1828<td class="parameter_annotations"> </td> 1829</tr> 1830<tr> 1831<td class="parameter_name"><p>...</p></td> 1832<td class="parameter_description"><p>variable arguments</p></td> 1833<td class="parameter_annotations"> </td> 1834</tr> 1835</tbody> 1836</table></div> 1837</div> 1838</div> 1839<hr> 1840<div class="refsect2"> 1841<a name="gst-structure-id-set-valist"></a><h3>gst_structure_id_set_valist ()</h3> 1842<pre class="programlisting"><span class="returnvalue">void</span> 1843gst_structure_id_set_valist (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1844 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> fieldname</code></em>, 1845 <em class="parameter"><code><span class="type">va_list</span> varargs</code></em>);</pre> 1846<p>va_list form of <a class="link" href="GstStructure.html#gst-structure-id-set" title="gst_structure_id_set ()"><code class="function">gst_structure_id_set()</code></a>.</p> 1847<div class="refsect3"> 1848<a name="gst-structure-id-set-valist.parameters"></a><h4>Parameters</h4> 1849<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1850<colgroup> 1851<col width="150px" class="parameters_name"> 1852<col class="parameters_description"> 1853<col width="200px" class="parameters_annotations"> 1854</colgroup> 1855<tbody> 1856<tr> 1857<td class="parameter_name"><p>structure</p></td> 1858<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1859<td class="parameter_annotations"> </td> 1860</tr> 1861<tr> 1862<td class="parameter_name"><p>fieldname</p></td> 1863<td class="parameter_description"><p>the name of the field to set</p></td> 1864<td class="parameter_annotations"> </td> 1865</tr> 1866<tr> 1867<td class="parameter_name"><p>varargs</p></td> 1868<td class="parameter_description"><p>variable arguments</p></td> 1869<td class="parameter_annotations"> </td> 1870</tr> 1871</tbody> 1872</table></div> 1873</div> 1874</div> 1875<hr> 1876<div class="refsect2"> 1877<a name="gst-structure-remove-field"></a><h3>gst_structure_remove_field ()</h3> 1878<pre class="programlisting"><span class="returnvalue">void</span> 1879gst_structure_remove_field (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1880 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>);</pre> 1881<p>Removes the field with the given name. If the field with the given 1882name does not exist, the structure is unchanged.</p> 1883<div class="refsect3"> 1884<a name="gst-structure-remove-field.parameters"></a><h4>Parameters</h4> 1885<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1886<colgroup> 1887<col width="150px" class="parameters_name"> 1888<col class="parameters_description"> 1889<col width="200px" class="parameters_annotations"> 1890</colgroup> 1891<tbody> 1892<tr> 1893<td class="parameter_name"><p>structure</p></td> 1894<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1895<td class="parameter_annotations"> </td> 1896</tr> 1897<tr> 1898<td class="parameter_name"><p>fieldname</p></td> 1899<td class="parameter_description"><p>the name of the field to remove</p></td> 1900<td class="parameter_annotations"> </td> 1901</tr> 1902</tbody> 1903</table></div> 1904</div> 1905</div> 1906<hr> 1907<div class="refsect2"> 1908<a name="gst-structure-remove-fields"></a><h3>gst_structure_remove_fields ()</h3> 1909<pre class="programlisting"><span class="returnvalue">void</span> 1910gst_structure_remove_fields (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1911 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1912 <em class="parameter"><code>...</code></em>);</pre> 1913<p>Removes the fields with the given names. If a field does not exist, the 1914argument is ignored.</p> 1915<div class="refsect3"> 1916<a name="gst-structure-remove-fields.parameters"></a><h4>Parameters</h4> 1917<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1918<colgroup> 1919<col width="150px" class="parameters_name"> 1920<col class="parameters_description"> 1921<col width="200px" class="parameters_annotations"> 1922</colgroup> 1923<tbody> 1924<tr> 1925<td class="parameter_name"><p>structure</p></td> 1926<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1927<td class="parameter_annotations"> </td> 1928</tr> 1929<tr> 1930<td class="parameter_name"><p>fieldname</p></td> 1931<td class="parameter_description"><p>the name of the field to remove</p></td> 1932<td class="parameter_annotations"> </td> 1933</tr> 1934<tr> 1935<td class="parameter_name"><p>...</p></td> 1936<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of more fieldnames to remove</p></td> 1937<td class="parameter_annotations"> </td> 1938</tr> 1939</tbody> 1940</table></div> 1941</div> 1942</div> 1943<hr> 1944<div class="refsect2"> 1945<a name="gst-structure-remove-fields-valist"></a><h3>gst_structure_remove_fields_valist ()</h3> 1946<pre class="programlisting"><span class="returnvalue">void</span> 1947gst_structure_remove_fields_valist (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 1948 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 1949 <em class="parameter"><code><span class="type">va_list</span> varargs</code></em>);</pre> 1950<p>va_list form of <a class="link" href="GstStructure.html#gst-structure-remove-fields" title="gst_structure_remove_fields ()"><code class="function">gst_structure_remove_fields()</code></a>.</p> 1951<div class="refsect3"> 1952<a name="gst-structure-remove-fields-valist.parameters"></a><h4>Parameters</h4> 1953<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1954<colgroup> 1955<col width="150px" class="parameters_name"> 1956<col class="parameters_description"> 1957<col width="200px" class="parameters_annotations"> 1958</colgroup> 1959<tbody> 1960<tr> 1961<td class="parameter_name"><p>structure</p></td> 1962<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1963<td class="parameter_annotations"> </td> 1964</tr> 1965<tr> 1966<td class="parameter_name"><p>fieldname</p></td> 1967<td class="parameter_description"><p>the name of the field to remove</p></td> 1968<td class="parameter_annotations"> </td> 1969</tr> 1970<tr> 1971<td class="parameter_name"><p>varargs</p></td> 1972<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of more fieldnames to remove</p></td> 1973<td class="parameter_annotations"> </td> 1974</tr> 1975</tbody> 1976</table></div> 1977</div> 1978</div> 1979<hr> 1980<div class="refsect2"> 1981<a name="gst-structure-remove-all-fields"></a><h3>gst_structure_remove_all_fields ()</h3> 1982<pre class="programlisting"><span class="returnvalue">void</span> 1983gst_structure_remove_all_fields (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 1984<p>Removes all fields in a GstStructure.</p> 1985<div class="refsect3"> 1986<a name="gst-structure-remove-all-fields.parameters"></a><h4>Parameters</h4> 1987<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1988<colgroup> 1989<col width="150px" class="parameters_name"> 1990<col class="parameters_description"> 1991<col width="200px" class="parameters_annotations"> 1992</colgroup> 1993<tbody><tr> 1994<td class="parameter_name"><p>structure</p></td> 1995<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 1996<td class="parameter_annotations"> </td> 1997</tr></tbody> 1998</table></div> 1999</div> 2000</div> 2001<hr> 2002<div class="refsect2"> 2003<a name="gst-structure-get-field-type"></a><h3>gst_structure_get_field_type ()</h3> 2004<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> 2005gst_structure_get_field_type (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2006 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>);</pre> 2007<p>Finds the field with the given name, and returns the type of the 2008value it contains. If the field is not found, G_TYPE_INVALID is 2009returned.</p> 2010<div class="refsect3"> 2011<a name="gst-structure-get-field-type.parameters"></a><h4>Parameters</h4> 2012<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2013<colgroup> 2014<col width="150px" class="parameters_name"> 2015<col class="parameters_description"> 2016<col width="200px" class="parameters_annotations"> 2017</colgroup> 2018<tbody> 2019<tr> 2020<td class="parameter_name"><p>structure</p></td> 2021<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2022<td class="parameter_annotations"> </td> 2023</tr> 2024<tr> 2025<td class="parameter_name"><p>fieldname</p></td> 2026<td class="parameter_description"><p>the name of the field</p></td> 2027<td class="parameter_annotations"> </td> 2028</tr> 2029</tbody> 2030</table></div> 2031</div> 2032<div class="refsect3"> 2033<a name="gst-structure-get-field-type.returns"></a><h4>Returns</h4> 2034<p> the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> of the field</p> 2035</div> 2036</div> 2037<hr> 2038<div class="refsect2"> 2039<a name="gst-structure-n-fields"></a><h3>gst_structure_n_fields ()</h3> 2040<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> 2041gst_structure_n_fields (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 2042<p>Get the number of fields in the structure.</p> 2043<div class="refsect3"> 2044<a name="gst-structure-n-fields.parameters"></a><h4>Parameters</h4> 2045<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2046<colgroup> 2047<col width="150px" class="parameters_name"> 2048<col class="parameters_description"> 2049<col width="200px" class="parameters_annotations"> 2050</colgroup> 2051<tbody><tr> 2052<td class="parameter_name"><p>structure</p></td> 2053<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2054<td class="parameter_annotations"> </td> 2055</tr></tbody> 2056</table></div> 2057</div> 2058<div class="refsect3"> 2059<a name="gst-structure-n-fields.returns"></a><h4>Returns</h4> 2060<p> the number of fields in the structure</p> 2061</div> 2062</div> 2063<hr> 2064<div class="refsect2"> 2065<a name="gst-structure-has-field"></a><h3>gst_structure_has_field ()</h3> 2066<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2067gst_structure_has_field (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2068 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>);</pre> 2069<p>Check if <em class="parameter"><code>structure</code></em> 2070 contains a field named <em class="parameter"><code>fieldname</code></em> 2071.</p> 2072<div class="refsect3"> 2073<a name="gst-structure-has-field.parameters"></a><h4>Parameters</h4> 2074<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2075<colgroup> 2076<col width="150px" class="parameters_name"> 2077<col class="parameters_description"> 2078<col width="200px" class="parameters_annotations"> 2079</colgroup> 2080<tbody> 2081<tr> 2082<td class="parameter_name"><p>structure</p></td> 2083<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2084<td class="parameter_annotations"> </td> 2085</tr> 2086<tr> 2087<td class="parameter_name"><p>fieldname</p></td> 2088<td class="parameter_description"><p>the name of a field</p></td> 2089<td class="parameter_annotations"> </td> 2090</tr> 2091</tbody> 2092</table></div> 2093</div> 2094<div class="refsect3"> 2095<a name="gst-structure-has-field.returns"></a><h4>Returns</h4> 2096<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure contains a field with the given name</p> 2097</div> 2098</div> 2099<hr> 2100<div class="refsect2"> 2101<a name="gst-structure-has-field-typed"></a><h3>gst_structure_has_field_typed ()</h3> 2102<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2103gst_structure_has_field_typed (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2104 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2105 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre> 2106<p>Check if <em class="parameter"><code>structure</code></em> 2107 contains a field named <em class="parameter"><code>fieldname</code></em> 2108 and with GType <em class="parameter"><code>type</code></em> 2109.</p> 2110<div class="refsect3"> 2111<a name="gst-structure-has-field-typed.parameters"></a><h4>Parameters</h4> 2112<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2113<colgroup> 2114<col width="150px" class="parameters_name"> 2115<col class="parameters_description"> 2116<col width="200px" class="parameters_annotations"> 2117</colgroup> 2118<tbody> 2119<tr> 2120<td class="parameter_name"><p>structure</p></td> 2121<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2122<td class="parameter_annotations"> </td> 2123</tr> 2124<tr> 2125<td class="parameter_name"><p>fieldname</p></td> 2126<td class="parameter_description"><p>the name of a field</p></td> 2127<td class="parameter_annotations"> </td> 2128</tr> 2129<tr> 2130<td class="parameter_name"><p>type</p></td> 2131<td class="parameter_description"><p>the type of a value</p></td> 2132<td class="parameter_annotations"> </td> 2133</tr> 2134</tbody> 2135</table></div> 2136</div> 2137<div class="refsect3"> 2138<a name="gst-structure-has-field-typed.returns"></a><h4>Returns</h4> 2139<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure contains a field with the given name and type</p> 2140</div> 2141</div> 2142<hr> 2143<div class="refsect2"> 2144<a name="gst-structure-is-equal"></a><h3>gst_structure_is_equal ()</h3> 2145<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2146gst_structure_is_equal (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure1</code></em>, 2147 <em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure2</code></em>);</pre> 2148<p>Tests if the two <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> are equal.</p> 2149<div class="refsect3"> 2150<a name="gst-structure-is-equal.parameters"></a><h4>Parameters</h4> 2151<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2152<colgroup> 2153<col width="150px" class="parameters_name"> 2154<col class="parameters_description"> 2155<col width="200px" class="parameters_annotations"> 2156</colgroup> 2157<tbody> 2158<tr> 2159<td class="parameter_name"><p>structure1</p></td> 2160<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>.</p></td> 2161<td class="parameter_annotations"> </td> 2162</tr> 2163<tr> 2164<td class="parameter_name"><p>structure2</p></td> 2165<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>.</p></td> 2166<td class="parameter_annotations"> </td> 2167</tr> 2168</tbody> 2169</table></div> 2170</div> 2171<div class="refsect3"> 2172<a name="gst-structure-is-equal.returns"></a><h4>Returns</h4> 2173<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the two structures have the same name and field.</p> 2174</div> 2175</div> 2176<hr> 2177<div class="refsect2"> 2178<a name="gst-structure-is-subset"></a><h3>gst_structure_is_subset ()</h3> 2179<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2180gst_structure_is_subset (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *subset</code></em>, 2181 <em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *superset</code></em>);</pre> 2182<p>Checks if <em class="parameter"><code>subset</code></em> 2183 is a subset of <em class="parameter"><code>superset</code></em> 2184, i.e. has the same 2185structure name and for all fields that are existing in <em class="parameter"><code>superset</code></em> 2186, 2187<em class="parameter"><code>subset</code></em> 2188 has a value that is a subset of the value in <em class="parameter"><code>superset</code></em> 2189.</p> 2190<div class="refsect3"> 2191<a name="gst-structure-is-subset.parameters"></a><h4>Parameters</h4> 2192<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2193<colgroup> 2194<col width="150px" class="parameters_name"> 2195<col class="parameters_description"> 2196<col width="200px" class="parameters_annotations"> 2197</colgroup> 2198<tbody> 2199<tr> 2200<td class="parameter_name"><p>subset</p></td> 2201<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2202<td class="parameter_annotations"> </td> 2203</tr> 2204<tr> 2205<td class="parameter_name"><p>superset</p></td> 2206<td class="parameter_description"><p>a potentially greater <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2207<td class="parameter_annotations"> </td> 2208</tr> 2209</tbody> 2210</table></div> 2211</div> 2212<div class="refsect3"> 2213<a name="gst-structure-is-subset.returns"></a><h4>Returns</h4> 2214<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>subset</code></em> 2215is a subset of <em class="parameter"><code>superset</code></em> 2216</p> 2217</div> 2218</div> 2219<hr> 2220<div class="refsect2"> 2221<a name="gst-structure-can-intersect"></a><h3>gst_structure_can_intersect ()</h3> 2222<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2223gst_structure_can_intersect (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *struct1</code></em>, 2224 <em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *struct2</code></em>);</pre> 2225<p>Tries intersecting <em class="parameter"><code>struct1</code></em> 2226 and <em class="parameter"><code>struct2</code></em> 2227 and reports whether the result 2228would not be empty.</p> 2229<div class="refsect3"> 2230<a name="gst-structure-can-intersect.parameters"></a><h4>Parameters</h4> 2231<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2232<colgroup> 2233<col width="150px" class="parameters_name"> 2234<col class="parameters_description"> 2235<col width="200px" class="parameters_annotations"> 2236</colgroup> 2237<tbody> 2238<tr> 2239<td class="parameter_name"><p>struct1</p></td> 2240<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2241<td class="parameter_annotations"> </td> 2242</tr> 2243<tr> 2244<td class="parameter_name"><p>struct2</p></td> 2245<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2246<td class="parameter_annotations"> </td> 2247</tr> 2248</tbody> 2249</table></div> 2250</div> 2251<div class="refsect3"> 2252<a name="gst-structure-can-intersect.returns"></a><h4>Returns</h4> 2253<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if intersection would not be empty</p> 2254</div> 2255</div> 2256<hr> 2257<div class="refsect2"> 2258<a name="gst-structure-intersect"></a><h3>gst_structure_intersect ()</h3> 2259<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 2260gst_structure_intersect (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *struct1</code></em>, 2261 <em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *struct2</code></em>);</pre> 2262<p>Intersects <em class="parameter"><code>struct1</code></em> 2263 and <em class="parameter"><code>struct2</code></em> 2264 and returns the intersection.</p> 2265<div class="refsect3"> 2266<a name="gst-structure-intersect.parameters"></a><h4>Parameters</h4> 2267<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2268<colgroup> 2269<col width="150px" class="parameters_name"> 2270<col class="parameters_description"> 2271<col width="200px" class="parameters_annotations"> 2272</colgroup> 2273<tbody> 2274<tr> 2275<td class="parameter_name"><p>struct1</p></td> 2276<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2277<td class="parameter_annotations"> </td> 2278</tr> 2279<tr> 2280<td class="parameter_name"><p>struct2</p></td> 2281<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2282<td class="parameter_annotations"> </td> 2283</tr> 2284</tbody> 2285</table></div> 2286</div> 2287<div class="refsect3"> 2288<a name="gst-structure-intersect.returns"></a><h4>Returns</h4> 2289<p>Intersection of <em class="parameter"><code>struct1</code></em> 2290and <em class="parameter"><code>struct2</code></em> 2291. </p> 2292<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 2293</div> 2294</div> 2295<hr> 2296<div class="refsect2"> 2297<a name="gst-structure-id-has-field"></a><h3>gst_structure_id_has_field ()</h3> 2298<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2299gst_structure_id_has_field (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2300 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field</code></em>);</pre> 2301<p>Check if <em class="parameter"><code>structure</code></em> 2302 contains a field named <em class="parameter"><code>field</code></em> 2303.</p> 2304<div class="refsect3"> 2305<a name="gst-structure-id-has-field.parameters"></a><h4>Parameters</h4> 2306<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2307<colgroup> 2308<col width="150px" class="parameters_name"> 2309<col class="parameters_description"> 2310<col width="200px" class="parameters_annotations"> 2311</colgroup> 2312<tbody> 2313<tr> 2314<td class="parameter_name"><p>structure</p></td> 2315<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2316<td class="parameter_annotations"> </td> 2317</tr> 2318<tr> 2319<td class="parameter_name"><p>field</p></td> 2320<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field name</p></td> 2321<td class="parameter_annotations"> </td> 2322</tr> 2323</tbody> 2324</table></div> 2325</div> 2326<div class="refsect3"> 2327<a name="gst-structure-id-has-field.returns"></a><h4>Returns</h4> 2328<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure contains a field with the given name</p> 2329</div> 2330</div> 2331<hr> 2332<div class="refsect2"> 2333<a name="gst-structure-id-has-field-typed"></a><h3>gst_structure_id_has_field_typed ()</h3> 2334<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2335gst_structure_id_has_field_typed (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2336 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> field</code></em>, 2337 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre> 2338<p>Check if <em class="parameter"><code>structure</code></em> 2339 contains a field named <em class="parameter"><code>field</code></em> 2340 and with GType <em class="parameter"><code>type</code></em> 2341.</p> 2342<div class="refsect3"> 2343<a name="gst-structure-id-has-field-typed.parameters"></a><h4>Parameters</h4> 2344<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2345<colgroup> 2346<col width="150px" class="parameters_name"> 2347<col class="parameters_description"> 2348<col width="200px" class="parameters_annotations"> 2349</colgroup> 2350<tbody> 2351<tr> 2352<td class="parameter_name"><p>structure</p></td> 2353<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2354<td class="parameter_annotations"> </td> 2355</tr> 2356<tr> 2357<td class="parameter_name"><p>field</p></td> 2358<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of the field name</p></td> 2359<td class="parameter_annotations"> </td> 2360</tr> 2361<tr> 2362<td class="parameter_name"><p>type</p></td> 2363<td class="parameter_description"><p>the type of a value</p></td> 2364<td class="parameter_annotations"> </td> 2365</tr> 2366</tbody> 2367</table></div> 2368</div> 2369<div class="refsect3"> 2370<a name="gst-structure-id-has-field-typed.returns"></a><h4>Returns</h4> 2371<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure contains a field with the given name and type</p> 2372</div> 2373</div> 2374<hr> 2375<div class="refsect2"> 2376<a name="gst-structure-get-boolean"></a><h3>gst_structure_get_boolean ()</h3> 2377<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2378gst_structure_get_boolean (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2379 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2380 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *value</code></em>);</pre> 2381<p>Sets the boolean pointed to by <em class="parameter"><code>value</code></em> 2382 corresponding to the value of the 2383given field. Caller is responsible for making sure the field exists 2384and has the correct type.</p> 2385<div class="refsect3"> 2386<a name="gst-structure-get-boolean.parameters"></a><h4>Parameters</h4> 2387<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2388<colgroup> 2389<col width="150px" class="parameters_name"> 2390<col class="parameters_description"> 2391<col width="200px" class="parameters_annotations"> 2392</colgroup> 2393<tbody> 2394<tr> 2395<td class="parameter_name"><p>structure</p></td> 2396<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2397<td class="parameter_annotations"> </td> 2398</tr> 2399<tr> 2400<td class="parameter_name"><p>fieldname</p></td> 2401<td class="parameter_description"><p>the name of a field</p></td> 2402<td class="parameter_annotations"> </td> 2403</tr> 2404<tr> 2405<td class="parameter_name"><p>value</p></td> 2406<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> to set. </p></td> 2407<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2408</tr> 2409</tbody> 2410</table></div> 2411</div> 2412<div class="refsect3"> 2413<a name="gst-structure-get-boolean.returns"></a><h4>Returns</h4> 2414<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2415with <em class="parameter"><code>fieldname</code></em> 2416or the existing field did not contain a boolean, this 2417function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2418</div> 2419</div> 2420<hr> 2421<div class="refsect2"> 2422<a name="gst-structure-get-int"></a><h3>gst_structure_get_int ()</h3> 2423<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2424gst_structure_get_int (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2425 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2426 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</code></em>);</pre> 2427<p>Sets the int pointed to by <em class="parameter"><code>value</code></em> 2428 corresponding to the value of the 2429given field. Caller is responsible for making sure the field exists 2430and has the correct type.</p> 2431<div class="refsect3"> 2432<a name="gst-structure-get-int.parameters"></a><h4>Parameters</h4> 2433<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2434<colgroup> 2435<col width="150px" class="parameters_name"> 2436<col class="parameters_description"> 2437<col width="200px" class="parameters_annotations"> 2438</colgroup> 2439<tbody> 2440<tr> 2441<td class="parameter_name"><p>structure</p></td> 2442<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2443<td class="parameter_annotations"> </td> 2444</tr> 2445<tr> 2446<td class="parameter_name"><p>fieldname</p></td> 2447<td class="parameter_description"><p>the name of a field</p></td> 2448<td class="parameter_annotations"> </td> 2449</tr> 2450<tr> 2451<td class="parameter_name"><p>value</p></td> 2452<td class="parameter_description"><p>a pointer to an int to set. </p></td> 2453<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2454</tr> 2455</tbody> 2456</table></div> 2457</div> 2458<div class="refsect3"> 2459<a name="gst-structure-get-int.returns"></a><h4>Returns</h4> 2460<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2461with <em class="parameter"><code>fieldname</code></em> 2462or the existing field did not contain an int, this function 2463returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2464</div> 2465</div> 2466<hr> 2467<div class="refsect2"> 2468<a name="gst-structure-get-uint"></a><h3>gst_structure_get_uint ()</h3> 2469<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2470gst_structure_get_uint (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2471 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2472 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *value</code></em>);</pre> 2473<p>Sets the uint pointed to by <em class="parameter"><code>value</code></em> 2474 corresponding to the value of the 2475given field. Caller is responsible for making sure the field exists 2476and has the correct type.</p> 2477<div class="refsect3"> 2478<a name="gst-structure-get-uint.parameters"></a><h4>Parameters</h4> 2479<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2480<colgroup> 2481<col width="150px" class="parameters_name"> 2482<col class="parameters_description"> 2483<col width="200px" class="parameters_annotations"> 2484</colgroup> 2485<tbody> 2486<tr> 2487<td class="parameter_name"><p>structure</p></td> 2488<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2489<td class="parameter_annotations"> </td> 2490</tr> 2491<tr> 2492<td class="parameter_name"><p>fieldname</p></td> 2493<td class="parameter_description"><p>the name of a field</p></td> 2494<td class="parameter_annotations"> </td> 2495</tr> 2496<tr> 2497<td class="parameter_name"><p>value</p></td> 2498<td class="parameter_description"><p>a pointer to a uint to set. </p></td> 2499<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2500</tr> 2501</tbody> 2502</table></div> 2503</div> 2504<div class="refsect3"> 2505<a name="gst-structure-get-uint.returns"></a><h4>Returns</h4> 2506<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2507with <em class="parameter"><code>fieldname</code></em> 2508or the existing field did not contain a uint, this function 2509returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2510</div> 2511</div> 2512<hr> 2513<div class="refsect2"> 2514<a name="gst-structure-get-int64"></a><h3>gst_structure_get_int64 ()</h3> 2515<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2516gst_structure_get_int64 (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2517 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2518 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> *value</code></em>);</pre> 2519<p>Sets the <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> pointed to by <em class="parameter"><code>value</code></em> 2520 corresponding to the value of the 2521given field. Caller is responsible for making sure the field exists 2522and has the correct type.</p> 2523<div class="refsect3"> 2524<a name="gst-structure-get-int64.parameters"></a><h4>Parameters</h4> 2525<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2526<colgroup> 2527<col width="150px" class="parameters_name"> 2528<col class="parameters_description"> 2529<col width="200px" class="parameters_annotations"> 2530</colgroup> 2531<tbody> 2532<tr> 2533<td class="parameter_name"><p>structure</p></td> 2534<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2535<td class="parameter_annotations"> </td> 2536</tr> 2537<tr> 2538<td class="parameter_name"><p>fieldname</p></td> 2539<td class="parameter_description"><p>the name of a field</p></td> 2540<td class="parameter_annotations"> </td> 2541</tr> 2542<tr> 2543<td class="parameter_name"><p>value</p></td> 2544<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> to set. </p></td> 2545<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2546</tr> 2547</tbody> 2548</table></div> 2549</div> 2550<div class="refsect3"> 2551<a name="gst-structure-get-int64.returns"></a><h4>Returns</h4> 2552<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2553with <em class="parameter"><code>fieldname</code></em> 2554or the existing field did not contain a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>, this function 2555returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2556</div> 2557<p class="since">Since: <a class="link" href="ix08.html#api-index-1.4">1.4</a></p> 2558</div> 2559<hr> 2560<div class="refsect2"> 2561<a name="gst-structure-get-uint64"></a><h3>gst_structure_get_uint64 ()</h3> 2562<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2563gst_structure_get_uint64 (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2564 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2565 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *value</code></em>);</pre> 2566<p>Sets the <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> pointed to by <em class="parameter"><code>value</code></em> 2567 corresponding to the value of the 2568given field. Caller is responsible for making sure the field exists 2569and has the correct type.</p> 2570<div class="refsect3"> 2571<a name="gst-structure-get-uint64.parameters"></a><h4>Parameters</h4> 2572<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2573<colgroup> 2574<col width="150px" class="parameters_name"> 2575<col class="parameters_description"> 2576<col width="200px" class="parameters_annotations"> 2577</colgroup> 2578<tbody> 2579<tr> 2580<td class="parameter_name"><p>structure</p></td> 2581<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2582<td class="parameter_annotations"> </td> 2583</tr> 2584<tr> 2585<td class="parameter_name"><p>fieldname</p></td> 2586<td class="parameter_description"><p>the name of a field</p></td> 2587<td class="parameter_annotations"> </td> 2588</tr> 2589<tr> 2590<td class="parameter_name"><p>value</p></td> 2591<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> to set. </p></td> 2592<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2593</tr> 2594</tbody> 2595</table></div> 2596</div> 2597<div class="refsect3"> 2598<a name="gst-structure-get-uint64.returns"></a><h4>Returns</h4> 2599<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2600with <em class="parameter"><code>fieldname</code></em> 2601or the existing field did not contain a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>, this function 2602returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2603</div> 2604<p class="since">Since: <a class="link" href="ix08.html#api-index-1.4">1.4</a></p> 2605</div> 2606<hr> 2607<div class="refsect2"> 2608<a name="gst-structure-get-double"></a><h3>gst_structure_get_double ()</h3> 2609<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2610gst_structure_get_double (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2611 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2612 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *value</code></em>);</pre> 2613<p>Sets the double pointed to by <em class="parameter"><code>value</code></em> 2614 corresponding to the value of the 2615given field. Caller is responsible for making sure the field exists 2616and has the correct type.</p> 2617<div class="refsect3"> 2618<a name="gst-structure-get-double.parameters"></a><h4>Parameters</h4> 2619<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2620<colgroup> 2621<col width="150px" class="parameters_name"> 2622<col class="parameters_description"> 2623<col width="200px" class="parameters_annotations"> 2624</colgroup> 2625<tbody> 2626<tr> 2627<td class="parameter_name"><p>structure</p></td> 2628<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2629<td class="parameter_annotations"> </td> 2630</tr> 2631<tr> 2632<td class="parameter_name"><p>fieldname</p></td> 2633<td class="parameter_description"><p>the name of a field</p></td> 2634<td class="parameter_annotations"> </td> 2635</tr> 2636<tr> 2637<td class="parameter_name"><p>value</p></td> 2638<td class="parameter_description"><p>a pointer to a gdouble to set. </p></td> 2639<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2640</tr> 2641</tbody> 2642</table></div> 2643</div> 2644<div class="refsect3"> 2645<a name="gst-structure-get-double.returns"></a><h4>Returns</h4> 2646<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2647with <em class="parameter"><code>fieldname</code></em> 2648or the existing field did not contain a double, this 2649function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2650</div> 2651</div> 2652<hr> 2653<div class="refsect2"> 2654<a name="gst-structure-get-string"></a><h3>gst_structure_get_string ()</h3> 2655<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 2656gst_structure_get_string (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2657 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>);</pre> 2658<p>Finds the field corresponding to <em class="parameter"><code>fieldname</code></em> 2659, and returns the string 2660contained in the field's value. Caller is responsible for making 2661sure the field exists and has the correct type.</p> 2662<p>The string should not be modified, and remains valid until the next 2663call to a gst_structure_*() function with the given structure.</p> 2664<div class="refsect3"> 2665<a name="gst-structure-get-string.parameters"></a><h4>Parameters</h4> 2666<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2667<colgroup> 2668<col width="150px" class="parameters_name"> 2669<col class="parameters_description"> 2670<col width="200px" class="parameters_annotations"> 2671</colgroup> 2672<tbody> 2673<tr> 2674<td class="parameter_name"><p>structure</p></td> 2675<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2676<td class="parameter_annotations"> </td> 2677</tr> 2678<tr> 2679<td class="parameter_name"><p>fieldname</p></td> 2680<td class="parameter_description"><p>the name of a field</p></td> 2681<td class="parameter_annotations"> </td> 2682</tr> 2683</tbody> 2684</table></div> 2685</div> 2686<div class="refsect3"> 2687<a name="gst-structure-get-string.returns"></a><h4>Returns</h4> 2688<p>a pointer to the string or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when the 2689field did not exist or did not contain a string. </p> 2690<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 2691</div> 2692</div> 2693<hr> 2694<div class="refsect2"> 2695<a name="gst-structure-get-date"></a><h3>gst_structure_get_date ()</h3> 2696<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2697gst_structure_get_date (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2698 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2699 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Date-and-Time-Functions.html#GDate"><span class="type">GDate</span></a> **value</code></em>);</pre> 2700<p>Sets the date pointed to by <em class="parameter"><code>value</code></em> 2701 corresponding to the date of the 2702given field. Caller is responsible for making sure the field exists 2703and has the correct type.</p> 2704<p>On success <em class="parameter"><code>value</code></em> 2705 will point to a newly-allocated copy of the date which 2706should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Date-and-Time-Functions.html#g-date-free"><code class="function">g_date_free()</code></a> when no longer needed (note: this is 2707inconsistent with e.g. <a class="link" href="GstStructure.html#gst-structure-get-string" title="gst_structure_get_string ()"><code class="function">gst_structure_get_string()</code></a> which doesn't return a 2708copy of the string).</p> 2709<div class="refsect3"> 2710<a name="gst-structure-get-date.parameters"></a><h4>Parameters</h4> 2711<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2712<colgroup> 2713<col width="150px" class="parameters_name"> 2714<col class="parameters_description"> 2715<col width="200px" class="parameters_annotations"> 2716</colgroup> 2717<tbody> 2718<tr> 2719<td class="parameter_name"><p>structure</p></td> 2720<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2721<td class="parameter_annotations"> </td> 2722</tr> 2723<tr> 2724<td class="parameter_name"><p>fieldname</p></td> 2725<td class="parameter_description"><p>the name of a field</p></td> 2726<td class="parameter_annotations"> </td> 2727</tr> 2728<tr> 2729<td class="parameter_name"><p>value</p></td> 2730<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Date-and-Time-Functions.html#GDate"><span class="type">GDate</span></a> to set. </p></td> 2731<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>]</span></td> 2732</tr> 2733</tbody> 2734</table></div> 2735</div> 2736<div class="refsect3"> 2737<a name="gst-structure-get-date.returns"></a><h4>Returns</h4> 2738<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2739with <em class="parameter"><code>fieldname</code></em> 2740or the existing field did not contain a data, this function 2741returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2742</div> 2743</div> 2744<hr> 2745<div class="refsect2"> 2746<a name="gst-structure-get-date-time"></a><h3>gst_structure_get_date_time ()</h3> 2747<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2748gst_structure_get_date_time (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2749 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2750 <em class="parameter"><code><a class="link" href="GstDateTime.html" title="GstDateTime"><span class="type">GstDateTime</span></a> **value</code></em>);</pre> 2751<p>Sets the datetime pointed to by <em class="parameter"><code>value</code></em> 2752 corresponding to the datetime of the 2753given field. Caller is responsible for making sure the field exists 2754and has the correct type.</p> 2755<p>On success <em class="parameter"><code>value</code></em> 2756 will point to a reference of the datetime which 2757should be unreffed with <a class="link" href="GstDateTime.html#gst-date-time-unref" title="gst_date_time_unref ()"><code class="function">gst_date_time_unref()</code></a> when no longer needed 2758(note: this is inconsistent with e.g. <a class="link" href="GstStructure.html#gst-structure-get-string" title="gst_structure_get_string ()"><code class="function">gst_structure_get_string()</code></a> 2759which doesn't return a copy of the string).</p> 2760<div class="refsect3"> 2761<a name="gst-structure-get-date-time.parameters"></a><h4>Parameters</h4> 2762<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2763<colgroup> 2764<col width="150px" class="parameters_name"> 2765<col class="parameters_description"> 2766<col width="200px" class="parameters_annotations"> 2767</colgroup> 2768<tbody> 2769<tr> 2770<td class="parameter_name"><p>structure</p></td> 2771<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2772<td class="parameter_annotations"> </td> 2773</tr> 2774<tr> 2775<td class="parameter_name"><p>fieldname</p></td> 2776<td class="parameter_description"><p>the name of a field</p></td> 2777<td class="parameter_annotations"> </td> 2778</tr> 2779<tr> 2780<td class="parameter_name"><p>value</p></td> 2781<td class="parameter_description"><p>a pointer to a <a class="link" href="GstDateTime.html" title="GstDateTime"><span class="type">GstDateTime</span></a> to set. </p></td> 2782<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>]</span></td> 2783</tr> 2784</tbody> 2785</table></div> 2786</div> 2787<div class="refsect3"> 2788<a name="gst-structure-get-date-time.returns"></a><h4>Returns</h4> 2789<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2790with <em class="parameter"><code>fieldname</code></em> 2791or the existing field did not contain a data, this function 2792returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2793</div> 2794</div> 2795<hr> 2796<div class="refsect2"> 2797<a name="gst-structure-get-clock-time"></a><h3>gst_structure_get_clock_time ()</h3> 2798<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2799gst_structure_get_clock_time (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2800 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2801 <em class="parameter"><code><a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> *value</code></em>);</pre> 2802<p>Sets the clock time pointed to by <em class="parameter"><code>value</code></em> 2803 corresponding to the clock time 2804of the given field. Caller is responsible for making sure the field exists 2805and has the correct type.</p> 2806<div class="refsect3"> 2807<a name="gst-structure-get-clock-time.parameters"></a><h4>Parameters</h4> 2808<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2809<colgroup> 2810<col width="150px" class="parameters_name"> 2811<col class="parameters_description"> 2812<col width="200px" class="parameters_annotations"> 2813</colgroup> 2814<tbody> 2815<tr> 2816<td class="parameter_name"><p>structure</p></td> 2817<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2818<td class="parameter_annotations"> </td> 2819</tr> 2820<tr> 2821<td class="parameter_name"><p>fieldname</p></td> 2822<td class="parameter_description"><p>the name of a field</p></td> 2823<td class="parameter_annotations"> </td> 2824</tr> 2825<tr> 2826<td class="parameter_name"><p>value</p></td> 2827<td class="parameter_description"><p>a pointer to a <a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> to set. </p></td> 2828<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2829</tr> 2830</tbody> 2831</table></div> 2832</div> 2833<div class="refsect3"> 2834<a name="gst-structure-get-clock-time.returns"></a><h4>Returns</h4> 2835<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2836with <em class="parameter"><code>fieldname</code></em> 2837or the existing field did not contain a <a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a>, this 2838function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2839</div> 2840</div> 2841<hr> 2842<div class="refsect2"> 2843<a name="gst-structure-get-enum"></a><h3>gst_structure_get_enum ()</h3> 2844<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2845gst_structure_get_enum (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2846 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2847 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enumtype</code></em>, 2848 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</code></em>);</pre> 2849<p>Sets the int pointed to by <em class="parameter"><code>value</code></em> 2850 corresponding to the value of the 2851given field. Caller is responsible for making sure the field exists, 2852has the correct type and that the enumtype is correct.</p> 2853<div class="refsect3"> 2854<a name="gst-structure-get-enum.parameters"></a><h4>Parameters</h4> 2855<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2856<colgroup> 2857<col width="150px" class="parameters_name"> 2858<col class="parameters_description"> 2859<col width="200px" class="parameters_annotations"> 2860</colgroup> 2861<tbody> 2862<tr> 2863<td class="parameter_name"><p>structure</p></td> 2864<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2865<td class="parameter_annotations"> </td> 2866</tr> 2867<tr> 2868<td class="parameter_name"><p>fieldname</p></td> 2869<td class="parameter_description"><p>the name of a field</p></td> 2870<td class="parameter_annotations"> </td> 2871</tr> 2872<tr> 2873<td class="parameter_name"><p>enumtype</p></td> 2874<td class="parameter_description"><p>the enum type of a field</p></td> 2875<td class="parameter_annotations"> </td> 2876</tr> 2877<tr> 2878<td class="parameter_name"><p>value</p></td> 2879<td class="parameter_description"><p>a pointer to an int to set. </p></td> 2880<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2881</tr> 2882</tbody> 2883</table></div> 2884</div> 2885<div class="refsect3"> 2886<a name="gst-structure-get-enum.returns"></a><h4>Returns</h4> 2887<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2888with <em class="parameter"><code>fieldname</code></em> 2889or the existing field did not contain an enum of the given 2890type, this function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2891</div> 2892</div> 2893<hr> 2894<div class="refsect2"> 2895<a name="gst-structure-get-fraction"></a><h3>gst_structure_get_fraction ()</h3> 2896<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2897gst_structure_get_fraction (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2898 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2899 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value_numerator</code></em>, 2900 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value_denominator</code></em>);</pre> 2901<p>Sets the integers pointed to by <em class="parameter"><code>value_numerator</code></em> 2902 and <em class="parameter"><code>value_denominator</code></em> 2903 2904corresponding to the value of the given field. Caller is responsible 2905for making sure the field exists and has the correct type.</p> 2906<div class="refsect3"> 2907<a name="gst-structure-get-fraction.parameters"></a><h4>Parameters</h4> 2908<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2909<colgroup> 2910<col width="150px" class="parameters_name"> 2911<col class="parameters_description"> 2912<col width="200px" class="parameters_annotations"> 2913</colgroup> 2914<tbody> 2915<tr> 2916<td class="parameter_name"><p>structure</p></td> 2917<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2918<td class="parameter_annotations"> </td> 2919</tr> 2920<tr> 2921<td class="parameter_name"><p>fieldname</p></td> 2922<td class="parameter_description"><p>the name of a field</p></td> 2923<td class="parameter_annotations"> </td> 2924</tr> 2925<tr> 2926<td class="parameter_name"><p>value_numerator</p></td> 2927<td class="parameter_description"><p>a pointer to an int to set. </p></td> 2928<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2929</tr> 2930<tr> 2931<td class="parameter_name"><p>value_denominator</p></td> 2932<td class="parameter_description"><p>a pointer to an int to set. </p></td> 2933<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2934</tr> 2935</tbody> 2936</table></div> 2937</div> 2938<div class="refsect3"> 2939<a name="gst-structure-get-fraction.returns"></a><h4>Returns</h4> 2940<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the values could be set correctly. If there was no field 2941with <em class="parameter"><code>fieldname</code></em> 2942or the existing field did not contain a GstFraction, this 2943function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2944</div> 2945</div> 2946<hr> 2947<div class="refsect2"> 2948<a name="gst-structure-get-array"></a><h3>gst_structure_get_array ()</h3> 2949<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2950gst_structure_get_array (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2951 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2952 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> **array</code></em>);</pre> 2953<p>This is useful in language bindings where unknown <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> types are not 2954supported. This function will convert the <a class="link" href="gstreamer-GstValue.html#GST-TYPE-ARRAY:CAPS" title="GST_TYPE_ARRAY"><code class="literal">GST_TYPE_ARRAY</code></a> into a newly 2955allocated <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> and return it through <em class="parameter"><code>array</code></em> 2956. Be aware that this is 2957slower then getting the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> directly.</p> 2958<div class="refsect3"> 2959<a name="gst-structure-get-array.parameters"></a><h4>Parameters</h4> 2960<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2961<colgroup> 2962<col width="150px" class="parameters_name"> 2963<col class="parameters_description"> 2964<col width="200px" class="parameters_annotations"> 2965</colgroup> 2966<tbody> 2967<tr> 2968<td class="parameter_name"><p>structure</p></td> 2969<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 2970<td class="parameter_annotations"> </td> 2971</tr> 2972<tr> 2973<td class="parameter_name"><p>fieldname</p></td> 2974<td class="parameter_description"><p>the name of a field</p></td> 2975<td class="parameter_annotations"> </td> 2976</tr> 2977<tr> 2978<td class="parameter_name"><p>array</p></td> 2979<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a>. </p></td> 2980<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2981</tr> 2982</tbody> 2983</table></div> 2984</div> 2985<div class="refsect3"> 2986<a name="gst-structure-get-array.returns"></a><h4>Returns</h4> 2987<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 2988with <em class="parameter"><code>fieldname</code></em> 2989or the existing field did not contain a <a class="link" href="gstreamer-GstValue.html#GST-TYPE-ARRAY:CAPS" title="GST_TYPE_ARRAY"><code class="literal">GST_TYPE_ARRAY</code></a>, 2990this function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 2991</div> 2992</div> 2993<hr> 2994<div class="refsect2"> 2995<a name="gst-structure-get-list"></a><h3>gst_structure_get_list ()</h3> 2996<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2997gst_structure_get_list (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 2998 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fieldname</code></em>, 2999 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> **array</code></em>);</pre> 3000<p>This is useful in language bindings where unknown <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> types are not 3001supported. This function will convert the <a class="link" href="gstreamer-GstValue.html#GST-TYPE-LIST:CAPS" title="GST_TYPE_LIST"><code class="literal">GST_TYPE_LIST</code></a> into a newly 3002allocated GValueArray and return it through <em class="parameter"><code>array</code></em> 3003. Be aware that this is 3004slower then getting the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue-struct"><span class="type">GValue</span></a> directly.</p> 3005<div class="refsect3"> 3006<a name="gst-structure-get-list.parameters"></a><h4>Parameters</h4> 3007<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3008<colgroup> 3009<col width="150px" class="parameters_name"> 3010<col class="parameters_description"> 3011<col width="200px" class="parameters_annotations"> 3012</colgroup> 3013<tbody> 3014<tr> 3015<td class="parameter_name"><p>structure</p></td> 3016<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3017<td class="parameter_annotations"> </td> 3018</tr> 3019<tr> 3020<td class="parameter_name"><p>fieldname</p></td> 3021<td class="parameter_description"><p>the name of a field</p></td> 3022<td class="parameter_annotations"> </td> 3023</tr> 3024<tr> 3025<td class="parameter_name"><p>array</p></td> 3026<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a>. </p></td> 3027<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 3028</tr> 3029</tbody> 3030</table></div> 3031</div> 3032<div class="refsect3"> 3033<a name="gst-structure-get-list.returns"></a><h4>Returns</h4> 3034<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value could be set correctly. If there was no field 3035with <em class="parameter"><code>fieldname</code></em> 3036or the existing field did not contain a <a class="link" href="gstreamer-GstValue.html#GST-TYPE-LIST:CAPS" title="GST_TYPE_LIST"><code class="literal">GST_TYPE_LIST</code></a>, this 3037function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 3038</div> 3039<p class="since">Since: <a class="link" href="ix04.html#api-index-1.12">1.12</a></p> 3040</div> 3041<hr> 3042<div class="refsect2"> 3043<a name="gst-structure-foreach"></a><h3>gst_structure_foreach ()</h3> 3044<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3045gst_structure_foreach (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3046 <em class="parameter"><code><a class="link" href="GstStructure.html#GstStructureForeachFunc" title="GstStructureForeachFunc ()"><span class="type">GstStructureForeachFunc</span></a> func</code></em>, 3047 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 3048<p>Calls the provided function once for each field in the <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. The 3049function must not modify the fields. Also see <a class="link" href="GstStructure.html#gst-structure-map-in-place" title="gst_structure_map_in_place ()"><code class="function">gst_structure_map_in_place()</code></a> 3050and <a class="link" href="GstStructure.html#gst-structure-filter-and-map-in-place" title="gst_structure_filter_and_map_in_place ()"><code class="function">gst_structure_filter_and_map_in_place()</code></a>.</p> 3051<div class="refsect3"> 3052<a name="gst-structure-foreach.parameters"></a><h4>Parameters</h4> 3053<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3054<colgroup> 3055<col width="150px" class="parameters_name"> 3056<col class="parameters_description"> 3057<col width="200px" class="parameters_annotations"> 3058</colgroup> 3059<tbody> 3060<tr> 3061<td class="parameter_name"><p>structure</p></td> 3062<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3063<td class="parameter_annotations"> </td> 3064</tr> 3065<tr> 3066<td class="parameter_name"><p>func</p></td> 3067<td class="parameter_description"><p>a function to call for each field. </p></td> 3068<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> 3069</tr> 3070<tr> 3071<td class="parameter_name"><p>user_data</p></td> 3072<td class="parameter_description"><p>private data. </p></td> 3073<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> 3074</tr> 3075</tbody> 3076</table></div> 3077</div> 3078<div class="refsect3"> 3079<a name="gst-structure-foreach.returns"></a><h4>Returns</h4> 3080<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the supplied function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> For each of the fields, 3081<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> 3082</div> 3083</div> 3084<hr> 3085<div class="refsect2"> 3086<a name="gst-structure-map-in-place"></a><h3>gst_structure_map_in_place ()</h3> 3087<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3088gst_structure_map_in_place (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3089 <em class="parameter"><code><a class="link" href="GstStructure.html#GstStructureMapFunc" title="GstStructureMapFunc ()"><span class="type">GstStructureMapFunc</span></a> func</code></em>, 3090 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 3091<p>Calls the provided function once for each field in the <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. In 3092contrast to <a class="link" href="GstStructure.html#gst-structure-foreach" title="gst_structure_foreach ()"><code class="function">gst_structure_foreach()</code></a>, the function may modify but not delete the 3093fields. The structure must be mutable.</p> 3094<div class="refsect3"> 3095<a name="gst-structure-map-in-place.parameters"></a><h4>Parameters</h4> 3096<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3097<colgroup> 3098<col width="150px" class="parameters_name"> 3099<col class="parameters_description"> 3100<col width="200px" class="parameters_annotations"> 3101</colgroup> 3102<tbody> 3103<tr> 3104<td class="parameter_name"><p>structure</p></td> 3105<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3106<td class="parameter_annotations"> </td> 3107</tr> 3108<tr> 3109<td class="parameter_name"><p>func</p></td> 3110<td class="parameter_description"><p>a function to call for each field. </p></td> 3111<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> 3112</tr> 3113<tr> 3114<td class="parameter_name"><p>user_data</p></td> 3115<td class="parameter_description"><p>private data. </p></td> 3116<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> 3117</tr> 3118</tbody> 3119</table></div> 3120</div> 3121<div class="refsect3"> 3122<a name="gst-structure-map-in-place.returns"></a><h4>Returns</h4> 3123<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the supplied function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> For each of the fields, 3124<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> 3125</div> 3126</div> 3127<hr> 3128<div class="refsect2"> 3129<a name="gst-structure-filter-and-map-in-place"></a><h3>gst_structure_filter_and_map_in_place ()</h3> 3130<pre class="programlisting"><span class="returnvalue">void</span> 3131gst_structure_filter_and_map_in_place (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3132 <em class="parameter"><code><a class="link" href="GstStructure.html#GstStructureFilterMapFunc" title="GstStructureFilterMapFunc ()"><span class="type">GstStructureFilterMapFunc</span></a> func</code></em>, 3133 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> 3134<p>Calls the provided function once for each field in the <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. In 3135contrast to <a class="link" href="GstStructure.html#gst-structure-foreach" title="gst_structure_foreach ()"><code class="function">gst_structure_foreach()</code></a>, the function may modify the fields. 3136In contrast to <a class="link" href="GstStructure.html#gst-structure-map-in-place" title="gst_structure_map_in_place ()"><code class="function">gst_structure_map_in_place()</code></a>, the field is removed from 3137the structure if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned from the function. 3138The structure must be mutable.</p> 3139<div class="refsect3"> 3140<a name="gst-structure-filter-and-map-in-place.parameters"></a><h4>Parameters</h4> 3141<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3142<colgroup> 3143<col width="150px" class="parameters_name"> 3144<col class="parameters_description"> 3145<col width="200px" class="parameters_annotations"> 3146</colgroup> 3147<tbody> 3148<tr> 3149<td class="parameter_name"><p>structure</p></td> 3150<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3151<td class="parameter_annotations"> </td> 3152</tr> 3153<tr> 3154<td class="parameter_name"><p>func</p></td> 3155<td class="parameter_description"><p>a function to call for each field. </p></td> 3156<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> 3157</tr> 3158<tr> 3159<td class="parameter_name"><p>user_data</p></td> 3160<td class="parameter_description"><p>private data. </p></td> 3161<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> 3162</tr> 3163</tbody> 3164</table></div> 3165</div> 3166<p class="since">Since: <a class="link" href="ix07.html#api-index-1.6">1.6</a></p> 3167</div> 3168<hr> 3169<div class="refsect2"> 3170<a name="gst-structure-nth-field-name"></a><h3>gst_structure_nth_field_name ()</h3> 3171<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 3172gst_structure_nth_field_name (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3173 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> index</code></em>);</pre> 3174<p>Get the name of the given field number, counting from 0 onwards.</p> 3175<div class="refsect3"> 3176<a name="gst-structure-nth-field-name.parameters"></a><h4>Parameters</h4> 3177<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3178<colgroup> 3179<col width="150px" class="parameters_name"> 3180<col class="parameters_description"> 3181<col width="200px" class="parameters_annotations"> 3182</colgroup> 3183<tbody> 3184<tr> 3185<td class="parameter_name"><p>structure</p></td> 3186<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3187<td class="parameter_annotations"> </td> 3188</tr> 3189<tr> 3190<td class="parameter_name"><p>index</p></td> 3191<td class="parameter_description"><p>the index to get the name of</p></td> 3192<td class="parameter_annotations"> </td> 3193</tr> 3194</tbody> 3195</table></div> 3196</div> 3197<div class="refsect3"> 3198<a name="gst-structure-nth-field-name.returns"></a><h4>Returns</h4> 3199<p> the name of the given field number</p> 3200</div> 3201</div> 3202<hr> 3203<div class="refsect2"> 3204<a name="gst-structure-set-parent-refcount"></a><h3>gst_structure_set_parent_refcount ()</h3> 3205<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3206gst_structure_set_parent_refcount (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3207 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *refcount</code></em>);</pre> 3208<p>Sets the parent_refcount field of <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>. This field is used to 3209determine whether a structure is mutable or not. This function should only be 3210called by code implementing parent objects of <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>, as described in 3211the MT Refcounting section of the design documents.</p> 3212<div class="refsect3"> 3213<a name="gst-structure-set-parent-refcount.parameters"></a><h4>Parameters</h4> 3214<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3215<colgroup> 3216<col width="150px" class="parameters_name"> 3217<col class="parameters_description"> 3218<col width="200px" class="parameters_annotations"> 3219</colgroup> 3220<tbody> 3221<tr> 3222<td class="parameter_name"><p>structure</p></td> 3223<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3224<td class="parameter_annotations"> </td> 3225</tr> 3226<tr> 3227<td class="parameter_name"><p>refcount</p></td> 3228<td class="parameter_description"><p>a pointer to the parent's refcount. </p></td> 3229<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td> 3230</tr> 3231</tbody> 3232</table></div> 3233</div> 3234<div class="refsect3"> 3235<a name="gst-structure-set-parent-refcount.returns"></a><h4>Returns</h4> 3236<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the parent refcount could be set.</p> 3237</div> 3238</div> 3239<hr> 3240<div class="refsect2"> 3241<a name="gst-structure-to-string"></a><h3>gst_structure_to_string ()</h3> 3242<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 3243gst_structure_to_string (<em class="parameter"><code>const <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 3244<p>Converts <em class="parameter"><code>structure</code></em> 3245 to a human-readable string representation.</p> 3246<p>For debugging purposes its easier to do something like this:</p> 3247<div class="informalexample"> 3248 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 3249 <tbody> 3250 <tr> 3251 <td class="listing_lines" align="right"><pre>1</pre></td> 3252 <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gstreamer-GstInfo.html#GST-LOG:CAPS">GST_LOG</a></span> <span class="gtkdoc opt">(</span><span class="string">"structure is %"</span> GST_PTR_FORMAT<span class="gtkdoc opt">,</span> structure<span class="gtkdoc opt">);</span></pre></td> 3253 </tr> 3254 </tbody> 3255 </table> 3256</div> 3257 3258<p> 3259This prints the structure in human readable form.</p> 3260<p>The current implementation of serialization will lead to unexpected results 3261when there are nested <a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a> / <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> deeper than one level.</p> 3262<p>Free-function: g_free</p> 3263<div class="refsect3"> 3264<a name="gst-structure-to-string.parameters"></a><h4>Parameters</h4> 3265<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3266<colgroup> 3267<col width="150px" class="parameters_name"> 3268<col class="parameters_description"> 3269<col width="200px" class="parameters_annotations"> 3270</colgroup> 3271<tbody><tr> 3272<td class="parameter_name"><p>structure</p></td> 3273<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3274<td class="parameter_annotations"> </td> 3275</tr></tbody> 3276</table></div> 3277</div> 3278<div class="refsect3"> 3279<a name="gst-structure-to-string.returns"></a><h4>Returns</h4> 3280<p>a pointer to string allocated by <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-malloc"><code class="function">g_malloc()</code></a>. 3281<a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after usage. </p> 3282<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 3283</div> 3284</div> 3285<hr> 3286<div class="refsect2"> 3287<a name="gst-structure-from-string"></a><h3>gst_structure_from_string ()</h3> 3288<pre class="programlisting"><a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * 3289gst_structure_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>, 3290 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **end</code></em>);</pre> 3291<p>Creates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> from a string representation. 3292If end is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a pointer to the place inside the given string 3293where parsing ended will be returned.</p> 3294<p>Free-function: gst_structure_free</p> 3295<div class="refsect3"> 3296<a name="gst-structure-from-string.parameters"></a><h4>Parameters</h4> 3297<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3298<colgroup> 3299<col width="150px" class="parameters_name"> 3300<col class="parameters_description"> 3301<col width="200px" class="parameters_annotations"> 3302</colgroup> 3303<tbody> 3304<tr> 3305<td class="parameter_name"><p>string</p></td> 3306<td class="parameter_description"><p>a string representation of a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a>.</p></td> 3307<td class="parameter_annotations"> </td> 3308</tr> 3309<tr> 3310<td class="parameter_name"><p>end</p></td> 3311<td class="parameter_description"><p>pointer to store the end of the string in. </p></td> 3312<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></td> 3313</tr> 3314</tbody> 3315</table></div> 3316</div> 3317<div class="refsect3"> 3318<a name="gst-structure-from-string.returns"></a><h4>Returns</h4> 3319<p>a new <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 3320when the string could not be parsed. Free with 3321<a class="link" href="GstStructure.html#gst-structure-free" title="gst_structure_free ()"><code class="function">gst_structure_free()</code></a> after use. </p> 3322<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> 3323</div> 3324</div> 3325<hr> 3326<div class="refsect2"> 3327<a name="gst-structure-fixate"></a><h3>gst_structure_fixate ()</h3> 3328<pre class="programlisting"><span class="returnvalue">void</span> 3329gst_structure_fixate (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 3330<p>Fixate all values in <em class="parameter"><code>structure</code></em> 3331 using <a class="link" href="gstreamer-GstValue.html#gst-value-fixate" title="gst_value_fixate ()"><code class="function">gst_value_fixate()</code></a>. 3332<em class="parameter"><code>structure</code></em> 3333 will be modified in-place and should be writable.</p> 3334<div class="refsect3"> 3335<a name="gst-structure-fixate.parameters"></a><h4>Parameters</h4> 3336<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3337<colgroup> 3338<col width="150px" class="parameters_name"> 3339<col class="parameters_description"> 3340<col width="200px" class="parameters_annotations"> 3341</colgroup> 3342<tbody><tr> 3343<td class="parameter_name"><p>structure</p></td> 3344<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3345<td class="parameter_annotations"> </td> 3346</tr></tbody> 3347</table></div> 3348</div> 3349</div> 3350<hr> 3351<div class="refsect2"> 3352<a name="gst-structure-fixate-field"></a><h3>gst_structure_fixate_field ()</h3> 3353<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3354gst_structure_fixate_field (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3355 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>);</pre> 3356<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given field with its fixated value.</p> 3357<div class="refsect3"> 3358<a name="gst-structure-fixate-field.parameters"></a><h4>Parameters</h4> 3359<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3360<colgroup> 3361<col width="150px" class="parameters_name"> 3362<col class="parameters_description"> 3363<col width="200px" class="parameters_annotations"> 3364</colgroup> 3365<tbody> 3366<tr> 3367<td class="parameter_name"><p>structure</p></td> 3368<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3369<td class="parameter_annotations"> </td> 3370</tr> 3371<tr> 3372<td class="parameter_name"><p>field_name</p></td> 3373<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3374</p></td> 3375<td class="parameter_annotations"> </td> 3376</tr> 3377</tbody> 3378</table></div> 3379</div> 3380<div class="refsect3"> 3381<a name="gst-structure-fixate-field.returns"></a><h4>Returns</h4> 3382<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure field could be fixated</p> 3383</div> 3384</div> 3385<hr> 3386<div class="refsect2"> 3387<a name="gst-structure-fixate-field-nearest-int"></a><h3>gst_structure_fixate_field_nearest_int ()</h3> 3388<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3389gst_structure_fixate_field_nearest_int 3390 (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3391 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>, 3392 <em class="parameter"><code><span class="type">int</span> target</code></em>);</pre> 3393<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given field to the nearest 3394integer to <em class="parameter"><code>target</code></em> 3395 that is a subset of the existing field.</p> 3396<div class="refsect3"> 3397<a name="gst-structure-fixate-field-nearest-int.parameters"></a><h4>Parameters</h4> 3398<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3399<colgroup> 3400<col width="150px" class="parameters_name"> 3401<col class="parameters_description"> 3402<col width="200px" class="parameters_annotations"> 3403</colgroup> 3404<tbody> 3405<tr> 3406<td class="parameter_name"><p>structure</p></td> 3407<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3408<td class="parameter_annotations"> </td> 3409</tr> 3410<tr> 3411<td class="parameter_name"><p>field_name</p></td> 3412<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3413</p></td> 3414<td class="parameter_annotations"> </td> 3415</tr> 3416<tr> 3417<td class="parameter_name"><p>target</p></td> 3418<td class="parameter_description"><p>the target value of the fixation</p></td> 3419<td class="parameter_annotations"> </td> 3420</tr> 3421</tbody> 3422</table></div> 3423</div> 3424<div class="refsect3"> 3425<a name="gst-structure-fixate-field-nearest-int.returns"></a><h4>Returns</h4> 3426<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure could be fixated</p> 3427</div> 3428</div> 3429<hr> 3430<div class="refsect2"> 3431<a name="gst-structure-fixate-field-nearest-double"></a><h3>gst_structure_fixate_field_nearest_double ()</h3> 3432<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3433gst_structure_fixate_field_nearest_double 3434 (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3435 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>, 3436 <em class="parameter"><code><span class="type">double</span> target</code></em>);</pre> 3437<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given field to the nearest 3438double to <em class="parameter"><code>target</code></em> 3439 that is a subset of the existing field.</p> 3440<div class="refsect3"> 3441<a name="gst-structure-fixate-field-nearest-double.parameters"></a><h4>Parameters</h4> 3442<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3443<colgroup> 3444<col width="150px" class="parameters_name"> 3445<col class="parameters_description"> 3446<col width="200px" class="parameters_annotations"> 3447</colgroup> 3448<tbody> 3449<tr> 3450<td class="parameter_name"><p>structure</p></td> 3451<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3452<td class="parameter_annotations"> </td> 3453</tr> 3454<tr> 3455<td class="parameter_name"><p>field_name</p></td> 3456<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3457</p></td> 3458<td class="parameter_annotations"> </td> 3459</tr> 3460<tr> 3461<td class="parameter_name"><p>target</p></td> 3462<td class="parameter_description"><p>the target value of the fixation</p></td> 3463<td class="parameter_annotations"> </td> 3464</tr> 3465</tbody> 3466</table></div> 3467</div> 3468<div class="refsect3"> 3469<a name="gst-structure-fixate-field-nearest-double.returns"></a><h4>Returns</h4> 3470<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure could be fixated</p> 3471</div> 3472</div> 3473<hr> 3474<div class="refsect2"> 3475<a name="gst-structure-fixate-field-nearest-fraction"></a><h3>gst_structure_fixate_field_nearest_fraction ()</h3> 3476<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3477gst_structure_fixate_field_nearest_fraction 3478 (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3479 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>, 3480 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> target_numerator</code></em>, 3481 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> target_denominator</code></em>);</pre> 3482<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given field to the nearest 3483fraction to <em class="parameter"><code>target_numerator</code></em> 3484/<em class="parameter"><code>target_denominator</code></em> 3485 that is a subset 3486of the existing field.</p> 3487<div class="refsect3"> 3488<a name="gst-structure-fixate-field-nearest-fraction.parameters"></a><h4>Parameters</h4> 3489<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3490<colgroup> 3491<col width="150px" class="parameters_name"> 3492<col class="parameters_description"> 3493<col width="200px" class="parameters_annotations"> 3494</colgroup> 3495<tbody> 3496<tr> 3497<td class="parameter_name"><p>structure</p></td> 3498<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3499<td class="parameter_annotations"> </td> 3500</tr> 3501<tr> 3502<td class="parameter_name"><p>field_name</p></td> 3503<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3504</p></td> 3505<td class="parameter_annotations"> </td> 3506</tr> 3507<tr> 3508<td class="parameter_name"><p>target_numerator</p></td> 3509<td class="parameter_description"><p>The numerator of the target value of the fixation</p></td> 3510<td class="parameter_annotations"> </td> 3511</tr> 3512<tr> 3513<td class="parameter_name"><p>target_denominator</p></td> 3514<td class="parameter_description"><p>The denominator of the target value of the fixation</p></td> 3515<td class="parameter_annotations"> </td> 3516</tr> 3517</tbody> 3518</table></div> 3519</div> 3520<div class="refsect3"> 3521<a name="gst-structure-fixate-field-nearest-fraction.returns"></a><h4>Returns</h4> 3522<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure could be fixated</p> 3523</div> 3524</div> 3525<hr> 3526<div class="refsect2"> 3527<a name="gst-structure-fixate-field-boolean"></a><h3>gst_structure_fixate_field_boolean ()</h3> 3528<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3529gst_structure_fixate_field_boolean (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3530 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>, 3531 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> target</code></em>);</pre> 3532<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given <em class="parameter"><code>field_name</code></em> 3533 field to the given 3534<em class="parameter"><code>target</code></em> 3535 boolean if that field is not fixed yet.</p> 3536<div class="refsect3"> 3537<a name="gst-structure-fixate-field-boolean.parameters"></a><h4>Parameters</h4> 3538<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3539<colgroup> 3540<col width="150px" class="parameters_name"> 3541<col class="parameters_description"> 3542<col width="200px" class="parameters_annotations"> 3543</colgroup> 3544<tbody> 3545<tr> 3546<td class="parameter_name"><p>structure</p></td> 3547<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3548<td class="parameter_annotations"> </td> 3549</tr> 3550<tr> 3551<td class="parameter_name"><p>field_name</p></td> 3552<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3553</p></td> 3554<td class="parameter_annotations"> </td> 3555</tr> 3556<tr> 3557<td class="parameter_name"><p>target</p></td> 3558<td class="parameter_description"><p>the target value of the fixation</p></td> 3559<td class="parameter_annotations"> </td> 3560</tr> 3561</tbody> 3562</table></div> 3563</div> 3564<div class="refsect3"> 3565<a name="gst-structure-fixate-field-boolean.returns"></a><h4>Returns</h4> 3566<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure could be fixated</p> 3567</div> 3568</div> 3569<hr> 3570<div class="refsect2"> 3571<a name="gst-structure-fixate-field-string"></a><h3>gst_structure_fixate_field_string ()</h3> 3572<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 3573gst_structure_fixate_field_string (<em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>, 3574 <em class="parameter"><code>const <span class="type">char</span> *field_name</code></em>, 3575 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target</code></em>);</pre> 3576<p>Fixates a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> by changing the given <em class="parameter"><code>field_name</code></em> 3577 field to the given 3578<em class="parameter"><code>target</code></em> 3579 string if that field is not fixed yet.</p> 3580<div class="refsect3"> 3581<a name="gst-structure-fixate-field-string.parameters"></a><h4>Parameters</h4> 3582<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3583<colgroup> 3584<col width="150px" class="parameters_name"> 3585<col class="parameters_description"> 3586<col width="200px" class="parameters_annotations"> 3587</colgroup> 3588<tbody> 3589<tr> 3590<td class="parameter_name"><p>structure</p></td> 3591<td class="parameter_description"><p>a <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a></p></td> 3592<td class="parameter_annotations"> </td> 3593</tr> 3594<tr> 3595<td class="parameter_name"><p>field_name</p></td> 3596<td class="parameter_description"><p>a field in <em class="parameter"><code>structure</code></em> 3597</p></td> 3598<td class="parameter_annotations"> </td> 3599</tr> 3600<tr> 3601<td class="parameter_name"><p>target</p></td> 3602<td class="parameter_description"><p>the target value of the fixation</p></td> 3603<td class="parameter_annotations"> </td> 3604</tr> 3605</tbody> 3606</table></div> 3607</div> 3608<div class="refsect3"> 3609<a name="gst-structure-fixate-field-string.returns"></a><h4>Returns</h4> 3610<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the structure could be fixated</p> 3611</div> 3612</div> 3613</div> 3614<div class="refsect1"> 3615<a name="GstStructure.other_details"></a><h2>Types and Values</h2> 3616<div class="refsect2"> 3617<a name="GstStructure-struct"></a><h3>struct GstStructure</h3> 3618<pre class="programlisting">struct GstStructure { 3619 GType type; 3620}; 3621</pre> 3622<p>The GstStructure object. Most fields are private.</p> 3623<div class="refsect3"> 3624<a name="GstStructure.members"></a><h4>Members</h4> 3625<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3626<colgroup> 3627<col width="300px" class="struct_members_name"> 3628<col class="struct_members_description"> 3629<col width="200px" class="struct_members_annotations"> 3630</colgroup> 3631<tbody><tr> 3632<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GstStructure-struct.type"></a>type</code></em>;</p></td> 3633<td class="struct_member_description"><p>the GType of a structure</p></td> 3634<td class="struct_member_annotations"> </td> 3635</tr></tbody> 3636</table></div> 3637</div> 3638</div> 3639</div> 3640<div class="refsect1"> 3641<a name="GstStructure.see-also"></a><h2>See Also</h2> 3642<p><a class="link" href="GstCaps.html" title="GstCaps"><span class="type">GstCaps</span></a>, <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>, <a class="link" href="GstEvent.html" title="GstEvent"><span class="type">GstEvent</span></a>, <a class="link" href="GstQuery.html" title="GstQuery"><span class="type">GstQuery</span></a></p> 3643</div> 3644</div> 3645<div class="footer"> 3646<hr>Generated by GTK-Doc V1.28</div> 3647</body> 3648</html>
