/usr/share/gir-1.0/TotemPlParser-1.0.gir is in libtotem-plparser-dev 3.10.2-0ubuntu1.
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 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<namespace name="TotemPlParser"
version="1.0"
shared-library="libtotem-plparser.so.18"
c:identifier-prefixes="TotemPl,TotemDisc,TotemCd"
c:symbol-prefixes="totem_pl,totem_disc,totem_cd">
<alias name="ParserMetadata"
c:type="TotemPlParserMetadata"
introspectable="0">
<doc xml:space="preserve">An alias for #GHashTable, used in the #TotemPlParser::entry-parsed and
#TotemPlParser::playlist-started signals due to #GHashTable not being a
boxed type when totem-pl-parser was originally written.
The hash table is a mapping from field names (such as
%TOTEM_PL_PARSER_FIELD_ALBUM) to their associated values.
It is safe to use #GHashTable instead of #TotemPlParserMetadata everywhere.</doc>
<type name="GLib.HashTable" c:type="GHashTable"/>
</alias>
<constant name="PARSER_FIELD_ABSTRACT"
value="abstract"
c:type="TOTEM_PL_PARSER_FIELD_ABSTRACT">
<doc xml:space="preserve">Metadata field for an entry's abstract text.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_ALBUM"
value="album"
c:type="TOTEM_PL_PARSER_FIELD_ALBUM">
<doc xml:space="preserve">Metadata field for an entry's album.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_AUTHOR"
value="author"
c:type="TOTEM_PL_PARSER_FIELD_AUTHOR">
<doc xml:space="preserve">Metadata field for an entry's author/composer/director.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_AUTOPLAY"
value="autoplay"
c:type="TOTEM_PL_PARSER_FIELD_AUTOPLAY">
<doc xml:space="preserve">Metadata field for an entry's "autoplay" flag, which is %TRUE if the entry should play automatically.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_BASE"
value="base"
c:type="TOTEM_PL_PARSER_FIELD_BASE">
<doc xml:space="preserve">Metadata field for an entry's base path.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_CONTACT"
value="contact"
c:type="TOTEM_PL_PARSER_FIELD_CONTACT">
<doc xml:space="preserve">Metadata field for an entry's contact details for the webmaster.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_CONTENT_TYPE"
value="content-type"
c:type="TOTEM_PL_PARSER_FIELD_CONTENT_TYPE">
<doc xml:space="preserve">Metadata field for an entry's content-type (usually a mime-type coming
from a web server).</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_COPYRIGHT"
value="copyright"
c:type="TOTEM_PL_PARSER_FIELD_COPYRIGHT">
<doc xml:space="preserve">Metadata field for an entry's copyright line.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_DESCRIPTION"
value="description"
c:type="TOTEM_PL_PARSER_FIELD_DESCRIPTION">
<doc xml:space="preserve">Metadata field for an entry's description.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_DOWNLOAD_URI"
value="download-url"
c:type="TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI"
version="2.26">
<doc xml:space="preserve">Metadata field for an entry's download URI. Only used if an alternate download
location is available for the entry.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_DURATION"
value="duration"
c:type="TOTEM_PL_PARSER_FIELD_DURATION">
<doc xml:space="preserve">Metadata field for an entry's playback duration, which should be parsed using totem_pl_parser_parse_duration().</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_DURATION_MS"
value="duration-ms"
c:type="TOTEM_PL_PARSER_FIELD_DURATION_MS">
<doc xml:space="preserve">Metadata field for an entry's playback duration, in milliseconds. It's only used when an entry's
duration is available in that format, so one would get either the %TOTEM_PL_PARSER_FIELD_DURATION
or %TOTEM_PL_PARSER_FIELD_DURATION_MS as metadata.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_ENDTIME"
value="endtime"
c:type="TOTEM_PL_PARSER_FIELD_ENDTIME">
<doc xml:space="preserve">Metadata field for an entry's playback end time.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_FILESIZE"
value="filesize"
c:type="TOTEM_PL_PARSER_FIELD_FILESIZE">
<doc xml:space="preserve">Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_GENRE"
value="genre"
c:type="TOTEM_PL_PARSER_FIELD_GENRE">
<doc xml:space="preserve">Metadata field for an entry's genre.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_ID"
value="id"
c:type="TOTEM_PL_PARSER_FIELD_ID">
<doc xml:space="preserve">Metadata field for an entry's identifier. Its use is dependent on the format
of the playlist parsed, and its origin.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_IMAGE_URI"
value="image-url"
c:type="TOTEM_PL_PARSER_FIELD_IMAGE_URI"
version="2.26">
<doc xml:space="preserve">Metadata field for an entry's thumbnail image URI.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_IS_PLAYLIST"
value="is-playlist"
c:type="TOTEM_PL_PARSER_FIELD_IS_PLAYLIST">
<doc xml:space="preserve">Metadata field used to tell the calling code that the parsing of a playlist
started. It is only %TRUE for the metadata passed to #TotemPlParser::playlist-started or
#TotemPlParser::playlist-ended signal handlers.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_LANGUAGE"
value="language"
c:type="TOTEM_PL_PARSER_FIELD_LANGUAGE">
<doc xml:space="preserve">Metadata field for an entry's audio language.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_MOREINFO"
value="moreinfo"
c:type="TOTEM_PL_PARSER_FIELD_MOREINFO">
<doc xml:space="preserve">Metadata field for an entry's "more info" URI.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_PLAYING"
value="playing"
c:type="TOTEM_PL_PARSER_FIELD_PLAYING">
<doc xml:space="preserve">Metadata field for an entry's status in a playlist. This is usually
used when saving the state of an on-going playlist.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_PUB_DATE"
value="publication-date"
c:type="TOTEM_PL_PARSER_FIELD_PUB_DATE">
<doc xml:space="preserve">Metadata field for an entry's publication date, which should be parsed using totem_pl_parser_parse_date().</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_SCREENSIZE"
value="screensize"
c:type="TOTEM_PL_PARSER_FIELD_SCREENSIZE">
<doc xml:space="preserve">Metadata field for an entry's preferred screen size.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_STARTTIME"
value="starttime"
c:type="TOTEM_PL_PARSER_FIELD_STARTTIME">
<doc xml:space="preserve">Metadata field for an entry's playback start time, which should be parsed using totem_pl_parser_parse_duration().</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_SUBTITLE_URI"
value="subtitle-uri"
c:type="TOTEM_PL_PARSER_FIELD_SUBTITLE_URI">
<doc xml:space="preserve">The URI of the entry's subtitle file.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_TITLE"
value="title"
c:type="TOTEM_PL_PARSER_FIELD_TITLE">
<doc xml:space="preserve">Metadata field for an entry's displayable title.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_UI_MODE"
value="ui-mode"
c:type="TOTEM_PL_PARSER_FIELD_UI_MODE">
<doc xml:space="preserve">Metadata field for an entry's preferred UI mode.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_URI"
value="url"
c:type="TOTEM_PL_PARSER_FIELD_URI"
version="2.26">
<doc xml:space="preserve">Metadata field for an entry's URI.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_FIELD_VOLUME"
value="volume"
c:type="TOTEM_PL_PARSER_FIELD_VOLUME">
<doc xml:space="preserve">Metadata field for an entry's playback volume.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PARSER_VERSION_MAJOR"
value="3"
c:type="TOTEM_PL_PARSER_VERSION_MAJOR">
<type name="gint" c:type="gint"/>
</constant>
<constant name="PARSER_VERSION_MICRO"
value="2"
c:type="TOTEM_PL_PARSER_VERSION_MICRO">
<type name="gint" c:type="gint"/>
</constant>
<constant name="PARSER_VERSION_MINOR"
value="10"
c:type="TOTEM_PL_PARSER_VERSION_MINOR">
<type name="gint" c:type="gint"/>
</constant>
<class name="Parser"
c:symbol-prefix="parser"
c:type="TotemPlParser"
parent="GObject.Object"
glib:type-name="TotemPlParser"
glib:get-type="totem_pl_parser_get_type"
glib:type-struct="ParserClass">
<doc xml:space="preserve">All the fields in the #TotemPlParser structure are private and should never be accessed directly.</doc>
<constructor name="new" c:identifier="totem_pl_parser_new">
<doc xml:space="preserve">Creates a #TotemPlParser object.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</return-value>
</constructor>
<function name="can_parse_from_data"
c:identifier="totem_pl_parser_can_parse_from_data">
<doc xml:space="preserve">Checks if the first @len bytes of @data can be parsed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @data can be parsed</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the data to check for parsability</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">the length of data to check</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="debug" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if debug statements should be printed</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="can_parse_from_filename"
c:identifier="totem_pl_parser_can_parse_from_filename">
<doc xml:space="preserve">Checks if the file can be parsed. Files can be parsed if:
<itemizedlist>
<listitem><para>they have a special mimetype, or</para></listitem>
<listitem><para>they have a mimetype which could be a video or a playlist.</para></listitem>
</itemizedlist></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @filename can be parsed</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the file to check for parsability</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="debug" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if debug statements should be printed</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="can_parse_from_uri"
c:identifier="totem_pl_parser_can_parse_from_uri">
<doc xml:space="preserve">Checks if the remote URI can be parsed. Note that this does
not actually try to open the remote URI, or deduce its mime-type
from filename, as this would bring too many false positives.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @uri could be parsed</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the remote URI to check for parsability</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="debug" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if debug statements should be printed</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="parse_date" c:identifier="totem_pl_parser_parse_date">
<doc xml:space="preserve">Parses the given date string and returns it as a <type>gint64</type>
denoting the date in seconds since the UNIX Epoch.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the date in seconds, or -1 on error</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<parameter name="date_str" transfer-ownership="none">
<doc xml:space="preserve">the date string to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="debug" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if debug statements should be printed</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="parse_duration"
c:identifier="totem_pl_parser_parse_duration">
<doc xml:space="preserve">Parses the given duration string and returns it as a <type>gint64</type>
denoting the duration in seconds.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the duration in seconds, or -1 on error</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<parameter name="duration" transfer-ownership="none">
<doc xml:space="preserve">the duration string to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="debug" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if debug statements should be printed</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<virtual-method name="entry_parsed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="playlist_ended">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="playlist_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</virtual-method>
<method name="add_ignored_mimetype"
c:identifier="totem_pl_parser_add_ignored_mimetype">
<doc xml:space="preserve">Adds a mimetype to the list of mimetypes to ignore, so that
any URI of that mimetype is ignored during playlist parsing.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="mimetype" transfer-ownership="none">
<doc xml:space="preserve">the mimetype to ignore</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="add_ignored_scheme"
c:identifier="totem_pl_parser_add_ignored_scheme">
<doc xml:space="preserve">Adds a scheme to the list of schemes to ignore, so that
any URI using that scheme is ignored during playlist parsing.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve">the scheme to ignore</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="parse" c:identifier="totem_pl_parser_parse">
<doc xml:space="preserve">Parses a playlist given by the absolute URI @uri. This method is
synchronous, and will block on (e.g.) network requests to slow
servers. totem_pl_parser_parse_async() is recommended instead.
Return values are as totem_pl_parser_parse_with_base().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParserResult</doc>
<type name="ParserResult" c:type="TotemPlParserResult"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the playlist to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="fallback" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the parser should add the playlist URI to the
end of the playlist on parse failure</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="parse_async" c:identifier="totem_pl_parser_parse_async">
<doc xml:space="preserve">Starts asynchronous parsing of a playlist given by the absolute URI @uri. @parser and @uri are both reffed/copied
when this function is called, so can safely be freed after this function returns.
For more details, see totem_pl_parser_parse(), which is the synchronous version of this function.
When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish()
to get the results of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the playlist to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="fallback" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the parser should add the playlist URI to the
end of the playlist on parse failure</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
allow-none="1"
scope="async"
closure="4">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when parsing is finished</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to the @callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="parse_finish"
c:identifier="totem_pl_parser_parse_finish"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous playlist parsing operation started with totem_pl_parser_parse_async()
or totem_pl_parser_parse_with_base_async().
If parsing of the playlist is cancelled part-way through, %TOTEM_PL_PARSER_RESULT_CANCELLED is returned when
this function is called.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParserResult</doc>
<type name="ParserResult" c:type="TotemPlParserResult"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="async_result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="parse_with_base"
c:identifier="totem_pl_parser_parse_with_base">
<doc xml:space="preserve">Parses a playlist given by the absolute URI @uri, using
@base to resolve relative paths where appropriate.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParserResult</doc>
<type name="ParserResult" c:type="TotemPlParserResult"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the playlist to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="base" transfer-ownership="none" allow-none="1">
<doc xml:space="preserve">the base path for relative filenames, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="fallback" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the parser should add the playlist URI to the
end of the playlist on parse failure</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="parse_with_base_async"
c:identifier="totem_pl_parser_parse_with_base_async">
<doc xml:space="preserve">Starts asynchronous parsing of a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate.
@parser and @uri are both reffed/copied when this function is called, so can safely be freed after this function returns.
For more details, see totem_pl_parser_parse_with_base(), which is the synchronous version of this function.
When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish()
to get the results of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the playlist to parse</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="base" transfer-ownership="none" allow-none="1">
<doc xml:space="preserve">the base path for relative filenames, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="fallback" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the parser should add the playlist URI to the
end of the playlist on parse failure</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
allow-none="1"
scope="async"
closure="5">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when parsing is finished</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to the @callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="save" c:identifier="totem_pl_parser_save" throws="1">
<doc xml:space="preserve">Writes the playlist held by @parser and @playlist out to the path
pointed by @dest. The playlist is written in the format @type and is
given the title @title.
If the @output file is a directory the #G_IO_ERROR_IS_DIRECTORY error
will be returned, and if the file is some other form of non-regular file
then a #G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some file
systems don't allow all file names, and may return a
#G_IO_ERROR_INVALID_FILENAME error, and if the name is too long,
#G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible
too, and depend on what kind of filesystem the file is on.
In extreme cases, a #G_IO_ERROR_INVALID_ARGUMENT error can be returned, if
parts of the playlist to be written are too long.
If writing a PLA playlist and there is an error converting a URI's encoding,
a code from #GConvertError will be returned.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="parser" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParser</doc>
<type name="Parser" c:type="TotemPlParser*"/>
</instance-parameter>
<parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">output #GFile</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
<parameter name="title" transfer-ownership="none">
<doc xml:space="preserve">the playlist title</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlParserType for the outputted playlist</doc>
<type name="ParserType" c:type="TotemPlParserType"/>
</parameter>
</parameters>
</method>
<property name="debug" writable="1" transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, the parser will output debug information.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="disable-unsafe" writable="1" transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, the parser will not parse unsafe locations, such as local devices
and local files if the playlist isn't local. This is useful if the library
is parsing a playlist from a remote location such as a website.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="force" writable="1" transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, the parser will attempt to parse a playlist, even if it
appears to be unsupported (usually because of its filename extension).</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="recurse"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, the parser will recursively fetch playlists linked to by
the current one.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ParserPrivate" c:type="TotemPlParserPrivate*"/>
</field>
<glib:signal name="entry-parsed" when="last">
<doc xml:space="preserve">The ::entry-parsed signal is emitted when a new entry is parsed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the entry parsed</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<doc xml:space="preserve">a #GHashTable of metadata relating to the entry added</doc>
<type name="GLib.HashTable">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="playlist-ended" when="last">
<doc xml:space="preserve">The ::playlist-ended signal is emitted when a playlist is finished
parsing. It is only called when #TotemPlParser::playlist-started
has been called for that playlist.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the playlist that finished parsing.</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="playlist-started" when="last">
<doc xml:space="preserve">The ::playlist-started signal is emitted when a playlist parsing has
started. This signal isn't emitted for all types of playlists, but
can be relied on to be called for playlists which support playlist
metadata, such as title.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the new playlist started</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<doc xml:space="preserve">a #GHashTable of metadata relating to the playlist that
started.</doc>
<type name="GLib.HashTable">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ParserClass"
c:type="TotemPlParserClass"
glib:is-gtype-struct-for="Parser">
<doc xml:space="preserve">The class structure for the #TotemPlParser type.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="entry_parsed">
<callback name="entry_parsed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</callback>
</field>
<field name="playlist_started">
<callback name="playlist_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="metadata" transfer-ownership="none">
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</callback>
</field>
<field name="playlist_ended">
<callback name="playlist_ended">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="parser" transfer-ownership="none">
<type name="Parser" c:type="TotemPlParser*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="ParserError"
glib:type-name="TotemPlParserError"
glib:get-type="totem_pl_parser_error_get_type"
c:type="TotemPlParserError"
glib:error-domain="totem_pl_parser_error">
<doc xml:space="preserve">Allows you to differentiate between different
errors occurring during file operations in a #TotemPlParser.</doc>
<member name="no_disc"
value="0"
c:identifier="TOTEM_PL_PARSER_ERROR_NO_DISC"
glib:nick="no-disc">
<doc xml:space="preserve">Error attempting to open a disc device when no disc is present</doc>
</member>
<member name="mount_failed"
value="1"
c:identifier="TOTEM_PL_PARSER_ERROR_MOUNT_FAILED"
glib:nick="mount-failed">
<doc xml:space="preserve">An attempted mount operation failed</doc>
</member>
<member name="empty_playlist"
value="2"
c:identifier="TOTEM_PL_PARSER_ERROR_EMPTY_PLAYLIST"
glib:nick="empty-playlist">
<doc xml:space="preserve">Playlist to be saved is empty</doc>
</member>
<function name="quark" c:identifier="totem_pl_parser_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<record name="ParserPrivate" c:type="TotemPlParserPrivate" disguised="1">
</record>
<enumeration name="ParserResult"
glib:type-name="TotemPlParserResult"
glib:get-type="totem_pl_parser_result_get_type"
c:type="TotemPlParserResult">
<doc xml:space="preserve">Gives the result of parsing a playlist.</doc>
<member name="unhandled"
value="0"
c:identifier="TOTEM_PL_PARSER_RESULT_UNHANDLED"
glib:nick="unhandled">
<doc xml:space="preserve">The playlist could not be handled.</doc>
</member>
<member name="error"
value="1"
c:identifier="TOTEM_PL_PARSER_RESULT_ERROR"
glib:nick="error">
<doc xml:space="preserve">There was an error parsing the playlist.</doc>
</member>
<member name="success"
value="2"
c:identifier="TOTEM_PL_PARSER_RESULT_SUCCESS"
glib:nick="success">
<doc xml:space="preserve">The playlist was parsed successfully.</doc>
</member>
<member name="ignored"
value="3"
c:identifier="TOTEM_PL_PARSER_RESULT_IGNORED"
glib:nick="ignored">
<doc xml:space="preserve">The playlist was ignored due to its scheme or MIME type (see totem_pl_parser_add_ignored_scheme()
and totem_pl_parser_add_ignored_mimetype()).</doc>
</member>
<member name="cancelled"
value="4"
c:identifier="TOTEM_PL_PARSER_RESULT_CANCELLED"
glib:nick="cancelled">
<doc xml:space="preserve">Parsing of the playlist was cancelled part-way through.</doc>
</member>
</enumeration>
<enumeration name="ParserType"
glib:type-name="TotemPlParserType"
glib:get-type="totem_pl_parser_type_get_type"
c:type="TotemPlParserType">
<doc xml:space="preserve">The type of playlist a #TotemPlParser will parse.</doc>
<member name="pls"
value="0"
c:identifier="TOTEM_PL_PARSER_PLS"
glib:nick="pls">
<doc xml:space="preserve">PLS parser</doc>
</member>
<member name="m3u"
value="1"
c:identifier="TOTEM_PL_PARSER_M3U"
glib:nick="m3u">
<doc xml:space="preserve">M3U parser</doc>
</member>
<member name="m3u_dos"
value="2"
c:identifier="TOTEM_PL_PARSER_M3U_DOS"
glib:nick="m3u-dos">
<doc xml:space="preserve">M3U (DOS linebreaks) parser</doc>
</member>
<member name="xspf"
value="3"
c:identifier="TOTEM_PL_PARSER_XSPF"
glib:nick="xspf">
<doc xml:space="preserve">XSPF parser</doc>
</member>
<member name="iriver_pla"
value="4"
c:identifier="TOTEM_PL_PARSER_IRIVER_PLA"
glib:nick="iriver-pla">
<doc xml:space="preserve">iRiver PLA parser</doc>
</member>
</enumeration>
<class name="Playlist"
c:symbol-prefix="playlist"
c:type="TotemPlPlaylist"
parent="GObject.Object"
glib:type-name="TotemPlPlaylist"
glib:get-type="totem_pl_playlist_get_type"
glib:type-struct="PlaylistClass">
<doc xml:space="preserve">All the fields in the #TotemPlPlaylist structure are private and should never be accessed directly.</doc>
<constructor name="new" c:identifier="totem_pl_playlist_new">
<doc xml:space="preserve">Creates a new #TotemPlPlaylist object.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The newly created #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</return-value>
</constructor>
<method name="append" c:identifier="totem_pl_playlist_append">
<doc xml:space="preserve">Appends a new empty element to @playlist, and modifies @iter so
it points to it. To fill in values, you need to call
totem_pl_playlist_set() or totem_pl_playlist_set_value().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">an unset #TotemPlPlaylistIter for returning the location</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="get"
c:identifier="totem_pl_playlist_get"
introspectable="0">
<doc xml:space="preserve">Gets the value for one or more keys from the element pointed
by @iter.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">pairs of key/return location for value, terminated by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="get_valist"
c:identifier="totem_pl_playlist_get_valist"
introspectable="0">
<doc xml:space="preserve">See totem_pl_playlist_get(), this function takes a va_list.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">a va_list</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</method>
<method name="get_value" c:identifier="totem_pl_playlist_get_value">
<doc xml:space="preserve">Gets the value for @key (Such as %TOTEM_PL_PARSER_FIELD_URI) in
the playlist item pointed by @iter.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @iter contains data for @key.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">data key</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">an empty #GValue to set</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
</parameters>
</method>
<method name="insert" c:identifier="totem_pl_playlist_insert">
<doc xml:space="preserve">Inserts a new empty element to @playlist at @position, and modifies
@iter so it points to it. To fill in values, you need to call
totem_pl_playlist_set() or totem_pl_playlist_set_value().
@position may be minor than 0 to prepend elements, or bigger than
the current @playlist size to append elements.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">position in the playlist</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">an unset #TotemPlPlaylistIter for returning the location</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="iter_first" c:identifier="totem_pl_playlist_iter_first">
<doc xml:space="preserve">Modifies @iter so it points to the first element in @playlist.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if there is such first element.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">an unset #TotemPlPlaylistIter for returning the location</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="iter_next" c:identifier="totem_pl_playlist_iter_next">
<doc xml:space="preserve">Modifies @iter so it points to the next element it previously
pointed to. This function will return %FALSE if there was no
next element, or @iter didn't actually point to any element
in @playlist.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if there was next element.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="iter_prev" c:identifier="totem_pl_playlist_iter_prev">
<doc xml:space="preserve">Modifies @iter so it points to the previous element it previously
pointed to. This function will return %FALSE if there was no
previous element, or @iter didn't actually point to any element
in @playlist.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if there was previous element.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="prepend" c:identifier="totem_pl_playlist_prepend">
<doc xml:space="preserve">Prepends a new empty element to @playlist, and modifies @iter so
it points to it. To fill in values, you need to call
totem_pl_playlist_set() or totem_pl_playlist_set_value().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">an unset #TotemPlPlaylistIter for returning the location</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
</parameters>
</method>
<method name="set"
c:identifier="totem_pl_playlist_set"
introspectable="0">
<doc xml:space="preserve">Sets the value for one or several keys in the element pointed
by @iter.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">key/value string pairs, terminated with %NULL</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="set_valist"
c:identifier="totem_pl_playlist_set_valist"
introspectable="0">
<doc xml:space="preserve">See totem_pl_playlist_set(), this function takes a va_list.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">a va_list</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</method>
<method name="set_value" c:identifier="totem_pl_playlist_set_value">
<doc xml:space="preserve">Sets the value for @key in the element pointed by @iter.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the value could be stored in @playlist</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylistIter pointing to some item in @playlist</doc>
<type name="PlaylistIter" c:type="TotemPlPlaylistIter*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">key to set the value for</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">#GValue containing the key value</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
</parameters>
</method>
<method name="size" c:identifier="totem_pl_playlist_size">
<doc xml:space="preserve">Returns the number of elements in @playlist.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of elements</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="playlist" transfer-ownership="none">
<doc xml:space="preserve">a #TotemPlPlaylist</doc>
<type name="Playlist" c:type="TotemPlPlaylist*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="PlaylistClass"
c:type="TotemPlPlaylistClass"
glib:is-gtype-struct-for="Playlist">
<doc xml:space="preserve">All the fields in the #TotemPlPlaylistClass structure are private and should never be accessed directly.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<record name="PlaylistIter" c:type="TotemPlPlaylistIter">
<doc xml:space="preserve">All the fields in the #TotemPlPlaylistIter structure are private and should never be accessed directly.</doc>
<field name="data1" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="data2" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
</record>
<function name="parser_error_quark"
c:identifier="totem_pl_parser_error_quark"
moved-to="ParserError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="parser_metadata_get_type"
c:identifier="totem_pl_parser_metadata_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
</namespace>
</repository>
|