/usr/share/gtk-doc/html/rhythmbox/RBMetaData.html is in rhythmbox-doc 2.96-0ubuntu4.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBMetaData</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch03.html" title="Metadata">
<link rel="prev" href="ch03.html" title="Metadata">
<link rel="next" href="ch04.html" title="RhythmDB">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBMetaData.synopsis" class="shortcut">Top</a>
|
<a href="#RBMetaData.description" class="shortcut">Description</a>
|
<a href="#RBMetaData.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBMetaData"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBMetaData.top_of_page"></a>RBMetaData</span></h2>
<p>RBMetaData — metadata reader and writer interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBMetaData.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="RBMetaData.html#RBMetaData-struct" title="struct RBMetaData">RBMetaData</a>;
struct <a class="link" href="RBMetaData.html#RBMetaDataClass" title="struct RBMetaDataClass">RBMetaDataClass</a>;
enum <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField">RBMetaDataField</a>;
enum <a class="link" href="RBMetaData.html#RBMetaDataError" title="enum RBMetaDataError">RBMetaDataError</a>;
<a class="link" href="RBMetaData.html" title="RBMetaData"><span class="returnvalue">RBMetaData</span></a> * <a class="link" href="RBMetaData.html#rb-metadata-new" title="rb_metadata_new ()">rb_metadata_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="RBMetaData.html#rb-metadata-get-field-type" title="rb_metadata_get_field_type ()">rb_metadata_get_field_type</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="RBMetaData.html#rb-metadata-get-field-name" title="rb_metadata_get_field_name ()">rb_metadata_get_field_name</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBMetaData.html#rb-metadata-can-save" title="rb_metadata_can_save ()">rb_metadata_can_save</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBMetaData.html#rb-metadata-load" title="rb_metadata_load ()">rb_metadata_load</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBMetaData.html#rb-metadata-save" title="rb_metadata_save ()">rb_metadata_save</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="RBMetaData.html#rb-metadata-get-media-type" title="rb_metadata_get_media_type ()">rb_metadata_get_media_type</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBMetaData.html#rb-metadata-has-missing-plugins" title="rb_metadata_has_missing_plugins ()">rb_metadata_has_missing_plugins</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBMetaData.html#rb-metadata-get-missing-plugins" title="rb_metadata_get_missing_plugins ()">rb_metadata_get_missing_plugins</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><span class="type">char</span> ***missing_plugins</code></em>,
<em class="parameter"><code><span class="type">char</span> ***plugin_descriptions</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBMetaData.html#rb-metadata-get" title="rb_metadata_get ()">rb_metadata_get</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBMetaData.html#rb-metadata-set" title="rb_metadata_set ()">rb_metadata_set</a> (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBMetaData.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----RBMetaData
</pre>
</div>
<div class="refsect1">
<a name="RBMetaData.description"></a><h2>Description</h2>
<p>
Provides a simple synchronous interface for metadata extraction and updating.
</p>
</div>
<div class="refsect1">
<a name="RBMetaData.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBMetaData-struct"></a><h3>struct RBMetaData</h3>
<pre class="programlisting">struct RBMetaData;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBMetaDataClass"></a><h3>struct RBMetaDataClass</h3>
<pre class="programlisting">struct RBMetaDataClass {
GObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBMetaDataField"></a><h3>enum RBMetaDataField</h3>
<pre class="programlisting">typedef enum {
RB_METADATA_FIELD_TITLE, /* string */
RB_METADATA_FIELD_ARTIST, /* string */
RB_METADATA_FIELD_ALBUM, /* string */
RB_METADATA_FIELD_DATE, /* ulong */
RB_METADATA_FIELD_GENRE, /* string */
RB_METADATA_FIELD_COMMENT, /* string */
RB_METADATA_FIELD_TRACK_NUMBER, /* ulong */
RB_METADATA_FIELD_MAX_TRACK_NUMBER, /* ulong */
RB_METADATA_FIELD_DISC_NUMBER, /* ulong */
RB_METADATA_FIELD_MAX_DISC_NUMBER, /* ulong */
RB_METADATA_FIELD_DESCRIPTION, /* string */
RB_METADATA_FIELD_VERSION, /* string */
RB_METADATA_FIELD_ISRC, /* string */
RB_METADATA_FIELD_ORGANIZATION, /* string */
RB_METADATA_FIELD_COPYRIGHT, /* string */
RB_METADATA_FIELD_CONTACT, /* string */
RB_METADATA_FIELD_LICENSE, /* string */
RB_METADATA_FIELD_PERFORMER, /* string */
RB_METADATA_FIELD_DURATION, /* ulong */
RB_METADATA_FIELD_CODEC, /* string */
RB_METADATA_FIELD_BITRATE, /* ulong */
RB_METADATA_FIELD_TRACK_GAIN, /* double */
RB_METADATA_FIELD_TRACK_PEAK, /* double */
RB_METADATA_FIELD_ALBUM_GAIN, /* double */
RB_METADATA_FIELD_ALBUM_PEAK, /* double */
RB_METADATA_FIELD_LANGUAGE_CODE, /* string */
RB_METADATA_FIELD_BPM, /* double */
RB_METADATA_FIELD_MUSICBRAINZ_TRACKID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID, /* string */
RB_METADATA_FIELD_ARTIST_SORTNAME, /* string */
RB_METADATA_FIELD_ALBUM_SORTNAME, /* string */
RB_METADATA_FIELD_ALBUM_ARTIST, /* string */
RB_METADATA_FIELD_ALBUM_ARTIST_SORTNAME, /* string */
RB_METADATA_FIELD_LAST /* nothing */
} RBMetaDataField;
</pre>
<p>
Metadata fields that can be read from and written to files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="RB-METADATA-FIELD-TITLE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TITLE</code></span></p></td>
<td>Title of the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ARTIST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ARTIST</code></span></p></td>
<td>Person(s) responsible for the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM</code></span></p></td>
<td>Album containing the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-DATE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DATE</code></span></p></td>
<td>Release date of the album
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-GENRE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_GENRE</code></span></p></td>
<td>Genre of the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-COMMENT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_COMMENT</code></span></p></td>
<td>Free form comment on the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-TRACK-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_NUMBER</code></span></p></td>
<td>Track number inside a collection
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MAX-TRACK-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MAX_TRACK_NUMBER</code></span></p></td>
<td>Count of tracks inside the collection
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-DISC-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DISC_NUMBER</code></span></p></td>
<td>Disc number inside a collection
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MAX-DISC-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MAX_DISC_NUMBER</code></span></p></td>
<td>Count of discs inside the collection
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-DESCRIPTION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DESCRIPTION</code></span></p></td>
<td>Short text describing the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-VERSION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_VERSION</code></span></p></td>
<td>Version of the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ISRC:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ISRC</code></span></p></td>
<td>International Standard Recording Code
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ORGANIZATION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ORGANIZATION</code></span></p></td>
<td>Organization responsible for the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-COPYRIGHT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_COPYRIGHT</code></span></p></td>
<td>Copyright notice on the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-CONTACT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_CONTACT</code></span></p></td>
<td>Contact information
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-LICENSE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LICENSE</code></span></p></td>
<td>License of the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-PERFORMER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_PERFORMER</code></span></p></td>
<td>Person(s) performing in the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-DURATION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DURATION</code></span></p></td>
<td>Duration of the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-CODEC:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_CODEC</code></span></p></td>
<td>Codec used to store the recording
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-BITRATE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_BITRATE</code></span></p></td>
<td>Exact or average encoding bitrate in bits/s
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-TRACK-GAIN:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_GAIN</code></span></p></td>
<td>Track gain in dB for replaygain
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-TRACK-PEAK:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_PEAK</code></span></p></td>
<td>Track peak volume level
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM-GAIN:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_GAIN</code></span></p></td>
<td>Album gain in dB for replaygain
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM-PEAK:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_PEAK</code></span></p></td>
<td>Album peak volume level
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-LANGUAGE-CODE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LANGUAGE_CODE</code></span></p></td>
<td>Language code (ISO-639-1)
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-BPM:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_BPM</code></span></p></td>
<td>Beats Per Minute
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-TRACKID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_TRACKID</code></span></p></td>
<td>MusicBrainz track ID
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ARTISTID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID</code></span></p></td>
<td>MusicBrainz artist ID
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID</code></span></p></td>
<td>MusicBrainz album ID
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMARTISTID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID</code></span></p></td>
<td>MusicBrainz album artist ID
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ARTIST-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ARTIST_SORTNAME</code></span></p></td>
<td>Person(s) responsible for the recording, as used for sorting
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_SORTNAME</code></span></p></td>
<td>Album containing the recording, as used for sorting
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM-ARTIST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_ARTIST</code></span></p></td>
<td>The artist of the entire album
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-ALBUM-ARTIST-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_ARTIST_SORTNAME</code></span></p></td>
<td>The artist of the entire album, as it should be sorted
</td>
</tr>
<tr>
<td><p><a name="RB-METADATA-FIELD-LAST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LAST</code></span></p></td>
<td>invalid field
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="RBMetaDataError"></a><h3>enum RBMetaDataError</h3>
<pre class="programlisting">typedef enum {
RB_METADATA_ERROR_IO,
RB_METADATA_ERROR_MISSING_PLUGIN,
RB_METADATA_ERROR_UNRECOGNIZED,
RB_METADATA_ERROR_UNSUPPORTED,
RB_METADATA_ERROR_GENERAL,
RB_METADATA_ERROR_INTERNAL,
RB_METADATA_ERROR_EMPTY_FILE
} RBMetaDataError;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-new"></a><h3>rb_metadata_new ()</h3>
<pre class="programlisting"><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="returnvalue">RBMetaData</span></a> * rb_metadata_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new metadata backend instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-get-field-type"></a><h3>rb_metadata_get_field_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> rb_metadata_get_field_type (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);</pre>
<p>
Returns the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the value for a metadata field.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>value type</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-get-field-name"></a><h3>rb_metadata_get_field_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_metadata_get_field_name (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);</pre>
<p>
Returns the name of a metadata field.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>field name</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-can-save"></a><h3>rb_metadata_can_save ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_metadata_can_save (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>);</pre>
<p>
Checks if the metadata writer is capable of updating file metadata
for a given media type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>media_type</code></em> :</span></p></td>
<td>the media type string to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the file metadata for the given media type can be updated</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-load"></a><h3>rb_metadata_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_metadata_load (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Reads metadata information from the specified URI.
Once this has returned successfully (with *error == NULL),
rb_metadata_get, rb_metadata_get_media_type, rb_metadata_has_missing_plugins,
and rb_metadata_get_missing_plugins can usefully be called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>URI from which to load metadata</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>returns error information</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-save"></a><h3>rb_metadata_save ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_metadata_save (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Saves all metadata changes made with rb_metadata_set to the
target URI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the target URI</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>returns error information</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-get-media-type"></a><h3>rb_metadata_get_media_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_metadata_get_media_type (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);</pre>
<p>
Returns the type of the file from which metadata was read.
This may look like a MIME type, but it isn't.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>media type string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-has-missing-plugins"></a><h3>rb_metadata_has_missing_plugins ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_metadata_has_missing_plugins (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);</pre>
<p>
If the metadata reader could not decode the file it was asked to
because one or more media framework plugins (specifically, for the
existing implementations, GStreamer plugins) required are missing,
this will return TRUE.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if required plugins are missing</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-get-missing-plugins"></a><h3>rb_metadata_get_missing_plugins ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_metadata_get_missing_plugins (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><span class="type">char</span> ***missing_plugins</code></em>,
<em class="parameter"><code><span class="type">char</span> ***plugin_descriptions</code></em>);</pre>
<p>
This function returns the information used to request automatic
installation of media framework plugins required to decode the target URI.
Use <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> to free the returned information arrays.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>missing_plugins</code></em> :</span></p></td>
<td>returns machine-readable
missing plugin information. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_descriptions</code></em> :</span></p></td>
<td>returns human-readable
missing plugin descriptions. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if missing plugin information was returned</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-get"></a><h3>rb_metadata_get ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_metadata_get (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);</pre>
<p>
Retrieves the value of a metadata field extracted from the target URI.
If the target URI contained no value for the field, returns FALSE.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
<td>the <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> to retrieve</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>returns the field value. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a> caller-allocates][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if a value was returned</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-metadata-set"></a><h3>rb_metadata_set ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_metadata_set (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);</pre>
<p>
Sets a metadata field value. The value is only stored inside the
<a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> object until rb_metadata_save is called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
<td>the <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>the value to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the field is valid</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|