/usr/include/gstreamermm-1.0/gstreamermm/taglist.h is in libgstreamermm-1.0-dev 1.4.3+dfsg-5.
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 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GSTREAMERMM_TAGLIST_H
#define _GSTREAMERMM_TAGLIST_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* gstreamermm - a C++ wrapper for gstreamer
*
* Copyright 2008 The gstreamermm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gst/gst.h>
#include <gstreamermm/structure.h>
namespace Gst
{
/** @addtogroup gstreamermmEnums gstreamermm Enums and Flags */
/**
* @var TagMergeMode TAG_MERGE_UNDEFINED
* Undefined merge mode.
*
* @var TagMergeMode TAG_MERGE_REPLACE_ALL
* Replace all tags (clear list and append).
*
* @var TagMergeMode TAG_MERGE_REPLACE
* Replace tags.
*
* @var TagMergeMode TAG_MERGE_APPEND
* Append tags.
*
* @var TagMergeMode TAG_MERGE_PREPEND
* Prepend tags.
*
* @var TagMergeMode TAG_MERGE_KEEP
* Keep existing tags.
*
* @var TagMergeMode TAG_MERGE_KEEP_ALL
* Keep all existing tags.
*
* @var TagMergeMode TAG_MERGE_COUNT
* The number of merge modes.
*
* @enum TagMergeMode
*
* The different tag merging modes are basically replace, overwrite and append,
* but they can be seen from two directions. Given two taglists: (A) the tags
* already in the element and (B) the ones that are supplied to the element (
* e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
* Gst::EVENT_TAG), how are these tags merged?
* In the table below this is shown for the cases that a tag exists in the list
* (A) or does not exists (!A) and combinations thereof.
*
* <table frame="all" colsep="1" rowsep="1">
* <title>merge mode</title>
* <tgroup cols='5' align='left'>
* <thead>
* <row>
* <entry>merge mode</entry>
* <entry>A + B</entry>
* <entry>A + !B</entry>
* <entry>!A + B</entry>
* <entry>!A + !B</entry>
* </row>
* </thead>
* <tbody>
* <row>
* <entry>REPLACE_ALL</entry>
* <entry>B</entry>
* <entry>-</entry>
* <entry>B</entry>
* <entry>-</entry>
* </row>
* <row>
* <entry>REPLACE</entry>
* <entry>B</entry>
* <entry>A</entry>
* <entry>B</entry>
* <entry>-</entry>
* </row>
* <row>
* <entry>APPEND</entry>
* <entry>A, B</entry>
* <entry>A</entry>
* <entry>B</entry>
* <entry>-</entry>
* </row>
* <row>
* <entry>PREPEND</entry>
* <entry>B, A</entry>
* <entry>A</entry>
* <entry>B</entry>
* <entry>-</entry>
* </row>
* <row>
* <entry>KEEP</entry>
* <entry>A</entry>
* <entry>A</entry>
* <entry>B</entry>
* <entry>-</entry>
* </row>
* <row>
* <entry>KEEP_ALL</entry>
* <entry>A</entry>
* <entry>A</entry>
* <entry>-</entry>
* <entry>-</entry>
* </row>
* </tbody>
* </tgroup>
* </table>
* @ingroup gstreamermmEnums
*/
enum TagMergeMode
{
TAG_MERGE_UNDEFINED,
TAG_MERGE_REPLACE_ALL,
TAG_MERGE_REPLACE,
TAG_MERGE_APPEND,
TAG_MERGE_PREPEND,
TAG_MERGE_KEEP,
TAG_MERGE_KEEP_ALL,
TAG_MERGE_COUNT
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::TagMergeMode> : public Glib::Value_Enum<Gst::TagMergeMode>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/**
* @var TagFlag TAG_FLAG_UNDEFINED
* Undefined flag.
*
* @var TagFlag TAG_FLAG_META
* Tag is meta data.
*
* @var TagFlag TAG_FLAG_ENCODED
* Tag is encoded.
*
* @var TagFlag TAG_FLAG_DECODED
* Tag is decoded.
*
* @var TagFlag TAG_FLAG_COUNT
* Number of tag flags.
*
* @enum TagFlag
*
* Extra tag flags used when registering tags.
* @ingroup gstreamermmEnums
*/
enum TagFlag
{
TAG_FLAG_UNDEFINED,
TAG_FLAG_META,
TAG_FLAG_ENCODED,
TAG_FLAG_DECODED,
TAG_FLAG_COUNT
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::TagFlag> : public Glib::Value_Enum<Gst::TagFlag>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
// When adding tags, make sure that they are added to this enum and then in the
// ccg file in the correct order. Also make sure that the size of the array of
// strings is updated in the declaration below and in the ccg file.
// These correspond to the GST_TAG_* #defines in the C API.
//TODO: Maybe do something like Glib::StockID instead?
/** Identifiers for commonly-used tags.
*/
enum Tag
{
/** The commonly used title (string).
* The title as it should be displayed, e.g. 'The Doll House'.
*/
TAG_TITLE,
/** The commonly used title, as used for sorting (string).
* The title as it should be sorted, e.g. 'Doll House, The'.
*
* Since 0.10.15.
*/
TAG_TITLE_SORTNAME,
/** The person(s) responsible for the recording (string).
* The artist name as it should be displayed, e.g. 'Jimi Hendrix' or 'The
* Guitar Heroes'.
*/
TAG_ARTIST,
/** The person(s) responsible for the recording, as used for sorting (string).
* The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or 'Guitar
* Heroes, The'.
*
* Since 0.10.15.
*/
TAG_ARTIST_SORTNAME,
/** The album containing this data (string).
* The album name as it should be displayed, e.g. 'The Jazz Guitar'.
*/
TAG_ALBUM,
/** The album containing this data, as used for sorting (string).
* The album name as it should be sorted, e.g. 'Jazz Guitar, The'.
*
* Since 0.10.15.
*/
TAG_ALBUM_SORTNAME,
/** The date the data was created (GDate structure).
*/
TAG_DATE,
/** The genre this data belongs to (string).
*/
TAG_GENRE,
/** The free text commenting the data (string).
*/
TAG_COMMENT,
/** The Key/value text commenting the data (string).
* Must be in the form of 'key=comment' or 'key[lc]=comment' where 'lc' is an
* ISO-639 language code.
*
* This tag is used for unknown Vorbis comment tags, unknown APE tags and
* certain ID3v2 comment fields.
*
* Since 0.10.10.
*/
TAG_EXTENDED_COMMENT,
/** The track number inside a collection (unsigned integer).
*/
TAG_TRACK_NUMBER,
/** The count of tracks inside collection this track belongs to (unsigned
* integer).
*/
TAG_TRACK_COUNT,
/** The disc number inside a collection (unsigned integer).
*/
TAG_ALBUM_VOLUME_NUMBER,
/** The count of discs inside collection this disc belongs to (unsigned
* integer).
*/
TAG_ALBUM_VOLUME_COUNT,
/** The original location of file as a URI (string).
*/
TAG_LOCATION,
/** The short text describing the content of the data (string).
*/
TAG_DESCRIPTION,
/** The version of this data (string).
*/
TAG_VERSION,
/** The International Standard Recording Code - see http://www.ifpi.org/isrc/
* (string).
*/
TAG_ISRC,
/** The organization (string).
*/
TAG_ORGANIZATION,
/** The copyright notice of the data (string).
*/
TAG_COPYRIGHT,
/** The URI to location where copyright details can be found (string).
* Since 0.10.14.
*/
TAG_COPYRIGHT_URI,
/** The person(s) who composed the recording (string).
* Since 0.10.15.
*/
TAG_COMPOSER,
/** The contact information (string).
*/
TAG_CONTACT,
/** The license of the data (string).
*/
TAG_LICENSE,
/** The URI to the location where license details can be found (string).
* Since 0.10.14.
*/
TAG_LICENSE_URI,
/** The person(s) performing (string).
*/
TAG_PERFORMER,
/** The length in GStreamer time units (nanoseconds) (unsigned 64-bit
* integer).
*/
TAG_DURATION,
/** The codec the data is stored in (string).
*/
TAG_CODEC,
/** The codec the video data is stored in (string).
*/
TAG_VIDEO_CODEC,
/** The codec the audio data is stored in (string).
*/
TAG_AUDIO_CODEC,
/** The exact or average bitrate in bits/s (unsigned integer).
*/
TAG_BITRATE,
/** The nominal bitrate in bits/s (unsigned integer).
*/
TAG_NOMINAL_BITRATE,
/** The minimum bitrate in bits/s (unsigned integer).
*/
TAG_MINIMUM_BITRATE,
/** The maximum bitrate in bits/s (unsigned integer).
*/
TAG_MAXIMUM_BITRATE,
/** The serial number of track (unsigned integer).
*/
TAG_SERIAL,
/** The encoder used to encode this stream (string).
*/
TAG_ENCODER,
/** The version of the encoder used to encode this stream (unsigned integer).
*/
TAG_ENCODER_VERSION,
/** The track gain in db (double).
*/
TAG_TRACK_GAIN,
/** The peak of the track (double).
*/
TAG_TRACK_PEAK,
/** The album gain in db (double).
*/
TAG_ALBUM_GAIN,
/** The peak of the album (double).
*/
TAG_ALBUM_PEAK,
/** The reference level of track and album gain values (double).
* Since 0.10.12.
*/
TAG_REFERENCE_LEVEL,
/** The language code (ISO-639-1) (string) of the content.
*/
TAG_LANGUAGE_CODE,
/** The image (buffer) (buffer caps should specify the content type and
* preferably also set "image-type" field as GstTagImageType).
* Since 0.10.6
*/
TAG_IMAGE,
/** The image that is meant for preview purposes, e.g.\ small icon-sized
* version (buffer) (buffer caps should specify the content type).
* Since 0.10.7.
*/
TAG_PREVIEW_IMAGE,
/** The generic file attachment (buffer) (buffer caps should specify the
* content type and if possible set "filename" to the file name of the
* attachment).
*
* Since 0.10.21.
*/
TAG_ATTACHMENT,
/** The number of beats per minute in audio (double).
* Since 0.10.12.
*/
TAG_BEATS_PER_MINUTE,
/** The comma separated keywords describing the content (string).
*
* Since 0.10.21
*/
TAG_KEYWORDS,
/** The human readable descriptive location of where the media has been
* recorded or produced. (string).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_NAME,
/** The geo latitude location of where the media has been recorded or produced
* in degrees according to WGS84 (zero at the equator, negative values for
* southern latitudes) (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_LATITUDE,
/** The geo longitude location of where the media has been recorded or
* produced in degrees according to WGS84 (zero at the prime meridian in
* Greenwich/UK, negative values for western longitudes). (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_LONGITUDE,
/** The geo elevation of where the media has been recorded or produced in
* meters according to WGS84 (zero is average sea level) (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_ELEVATION
};
/** An Output stream operator for the Gst::Tag enum (this will output a
* string).
*/
std::ostream& operator<<(std::ostream& stream, Tag tag);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
const char* gstreamermm_get_stock_tag(Tag tag);
#endif
/** A class tha represents a list of tags and values used to describe media
* metadata.
* Taglists form part of media streams and describe the content of a stream in
* a non-technical way. Examples include the author of a song, the title of
* that very same song or the album it is a part of. Tag reading is done
* through a Gst::Bus. You can listen for Gst::MESSAGE_TAG messages and handle
* them as you wish.
*
* Note, however, that the Gst::MESSAGE_TAG message may be fired multiple
* times in the pipeline. It is the application's responsibility to put all
* those tags together and display them to the user in a nice, coherent way.
* Usually, using merge() is a good enough way of doing this; make sure to
* empty the cache when loading a new song, or after every few minutes when
* listening to internet radio. Also, make sure you use Gst::TAG_MERGE_PREPEND
* as merging mode, so that a new title (which came in later) has a preference
* over the old one for display.
*/
class TagList
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef TagList CppObjectType;
typedef GstTagList BaseObjectType;
static GType get_type() G_GNUC_CONST;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
TagList();
explicit TagList(GstTagList* gobject, bool make_a_copy = true);
TagList(const TagList& other);
TagList& operator=(const TagList& other);
~TagList();
void swap(TagList& other);
///Provides access to the underlying C instance.
GstTagList* gobj() { return gobject_; }
///Provides access to the underlying C instance.
const GstTagList* gobj() const { return gobject_; }
///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
GstTagList* gobj_copy() const;
protected:
GstTagList* gobject_;
private:
//gtkmmproc error: gst_tag_list_free : ignored method defs lookup failed
public:
/** Use this to discover if the TagList is a valid object.
*/
operator bool() const;
/** Checks if the given type is already registered.
*
* @param tag Name of the tag.
* @return <tt>true</tt> if the type is already registered.
*/
static bool exists(const Glib::ustring& tag);
/** Gets the Type used for this tag.
*
* @param tag The tag.
* @return The Type of this tag.
*/
static GType get_type(const Glib::ustring& tag);
/** Returns the human-readable name of this tag, You must not change or free
* this string.
*
* @param tag The tag.
* @return The human-readable name of this tag.
*/
static Glib::ustring get_nick(const Glib::ustring& tag);
/** Returns the human-readable description of this tag, You must not change or
* free this string.
*
* @param tag The tag.
* @return The human-readable description of this tag.
*/
static Glib::ustring get_description(const Glib::ustring& tag);
/** Gets the flag of @a tag.
*
* @param tag The tag.
* @return The flag of this tag.
*/
static TagFlag get_flag(const Glib::ustring& tag);
/** Checks if the given tag is fixed. A fixed tag can only contain one value.
* Unfixed tags can contain lists of values.
*
* @param tag Tag to check.
* @return <tt>true</tt>, if the given tag is fixed.
*/
static bool is_fixed(const Glib::ustring& tag);
/** Checks if the given taglist is empty.
*
* @return <tt>true</tt> if the taglist is empty, otherwise <tt>false</tt>.
*/
bool is_empty() const;
/** Inserts the tags of the @a from list into the first list using the given mode.
*
* @param from List to merge from.
* @param mode The mode to use.
*/
void insert(const Gst::TagList& other, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Merges the two given lists into a new list. If one of the lists is <tt>0</tt>, a
* copy of the other is returned. If both lists are <tt>0</tt>, <tt>0</tt> is returned.
*
* Free-function: gst_tag_list_unref
*
* @param list2 Second list to merge.
* @param mode The mode to use.
* @return The new list.
*/
Gst::TagList merge(const Gst::TagList& other, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Checks how many value are stored in this tag list for the given tag.
*
* @param tag The tag to query.
* @return The number of tags stored.
*/
guint size(const Glib::ustring& tag) const;
/** Sets a GValue for the given @a tag using the specified mode.
*
* @param tag The tag name.
* @param mode The mode to use.
* @param value The Glib::Value<> to use.
*/
void add_value(Tag tag, const Glib::ValueBase& value, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Sets a GValue for the given @a tag using the specified mode.
*
* @param tag The tag name.
* @param mode The mode to use.
* @param value The Glib::Value<> to use.
*/
void add_value(const Glib::ustring& tag, const Glib::ValueBase& value, TagMergeMode mode = TAG_MERGE_PREPEND);
//TODO: Doesn't this conflict with the template? murrayc.
//
//It doesn't seem so. The taglist test (test-taglist) uses it when adding a
//title and an artist tag (lines 35, 36). The test wont compile without it
//and declaring the template before this doesn't seem to make the compiler
//select the template over this method. I could be wrong. Jose.
/** Sets the value for the given tag to string @a data using the specified
* mode.
*
* @param tag The tag name.
* @param data A string to which the tag should be set to.
* @param mode The merge mode to use.
*/
void add(Tag tag, const char* data, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Sets the value for the given tag to string @a data using the specified
* mode.
*
* @param tag The tag name.
* @param data A string to which the tag should be set to.
* @param mode The merge mode to use.
*/
void add(const Glib::ustring& tag, const char* data, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Sets the value for the given tag using the specified mode.
*
* @param tag The tag name.
* @param data A value which the tag should be set to (this can be any
* supported C++ type).
* @param mode The merge mode to use.
*/
template <class DataType>
void add(Tag tag, const DataType& data, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Sets the value for the given tag using the specified mode.
*
* @param tag The tag name.
* @param data A value which the tag should be set to (this can be any
* supported C++ type).
* @param mode The merge mode to use.
*/
template <class DataType>
void add(const Glib::ustring& tag, const DataType& data, TagMergeMode mode = TAG_MERGE_PREPEND);
// Methods below are written as workaround for Glib::Date - it's not working with
// with Glib::Value, because GValue with Glib::Date is invalid type for gstreamer functions.
/** Sets the value for the given tag using the specified mode.
*
* @param tag The tag name.
* @param data A value which the tag should be set to (this can be any
* supported C++ type).
* @param mode The merge mode to use.
*/
void add(Tag tag, const Glib::Date& date, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Sets the value for the given tag using the specified mode.
*
* @param tag The tag name.
* @param data A value which the tag should be set to (this can be any
* supported C++ type).
* @param mode The merge mode to use.
*/
void add(const Glib::ustring& tag, const Glib::Date& date, TagMergeMode mode = TAG_MERGE_PREPEND);
/** Removes the given tag from the taglist.
*
* @param tag Tag to remove.
*/
void remove_tag(Tag tag);
/** Removes the given tag from the taglist.
*
* @param tag Tag to remove.
*/
void remove_tag(const Glib::ustring& tag);
/** For example,
* void on_foreach(const Glib::ustring& tag);.
*/
typedef sigc::slot<void, const Glib::ustring&> SlotForeach;
/** Calls the given slot for each tag inside the tag list. Note that if there
* is no tag, the slot won't be called at all.
*
* @param slot Slot to be called for each tag.
*/
void foreach(const SlotForeach& slot);
/** Copies the contents for the given tag into the value, merging multiple
* values into one if multiple values are associated with the tag.
*
* @param dest An uninitialized Glib::ValueBase to copy into.
* @param tag The tag to read out.
* @return true, if a value was copied, false if the tag didn't exist in the
* list.
*/
bool get_value(Tag tag, Glib::ValueBase& dest) const;
/** Copies the contents for the given tag into the value, merging multiple
* values into one if multiple values are associated with the tag.
*
* @param dest An uninitialized Glib::ValueBase to copy into.
* @param tag The tag to read out.
* @return true, if a value was copied, false if the tag didn't exist in the
* list.
*/
bool get_value(const Glib::ustring& tag, Glib::ValueBase& dest) const;
/** Gets the value that is at the given index for the given tag.
* @param tag The tag to read out.
* @param index Number of entry to read out.
* @@param The Glib::ValueBase to store the value in.
* @return true if tag was available and had right number of entries, false
* otherwise.
*/
bool get_value(Tag tag, guint index, Glib::ValueBase& dest) const;
/** Gets the value that is at the given index for the given tag.
* @param tag The tag to read out.
* @param index Number of entry to read out.
* @@param The Glib::ValueBase to store the value in.
* @return true if tag was available and had right number of entries, false
* otherwise.
*/
bool get_value(const Glib::ustring& tag, guint index, Glib::ValueBase& dest) const;
/** Copies the contents for the given tag into the value, merging multiple
* values into one if multiple values are associated with the tag.
* @param tag The tag to read out.
* @param value Location for the result (this can be any supported C++ type).
* @return true, if a value was copied, false if the tag didn't exist in the
* given list.
*/
template<class DataType>
bool get(Tag tag, DataType& value) const;
/** Copies the contents for the given tag into the value, merging multiple
* values into one if multiple values are associated with the tag.
* @param tag The tag to read out.
* @param value Location for the result (this can be any supported C++ type).
* @return true, if a value was copied, false if the tag didn't exist in the
* given list.
*/
template<class DataType>
bool get(const Glib::ustring& tag, DataType& value) const;
//gtkmmproc error: gst_tag_list_get_char : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_uchar : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_long : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_ulong : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_buffer : ignored method defs lookup failed
/** Gets the value that is at the given index for the given tag.
* @param tag The tag to read out.
* @param index Number of entry to read out.
* @param value Location for the result (this can be any supported C++ type).
* @return true, if a value was copied, false if the tag didn't exist in the
* given list.
*/
template<class DataType>
bool get(Tag tag, guint index, DataType& value) const;
/** Gets the value that is at the given index for the given tag.
* @param tag The tag to read out.
* @param index Number of entry to read out.
* @param value Location for the result (this can be any supported C++ type).
* @return true, if a value was copied, false if the tag didn't exist in the
* given list.
*/
template<class DataType>
bool get(const Glib::ustring& tag, guint index, DataType& value) const;
//gtkmmproc error: gst_tag_list_get_char_index : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_uchar_index : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_long_index : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_ulong_index : ignored method defs lookup failed//gtkmmproc error: gst_tag_list_get_buffer_index : ignored method defs lookup failed
//Variable argument functions are ignored.
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/***************************** Gst::TagList *****************************/
template <class DataType>
void TagList::add(Tag tag, const DataType& data, TagMergeMode mode)
{
typedef Glib::Value<DataType> ValueType;
ValueType value;
value.init(ValueType::value_type());
value.set(data);
this->add_value(tag, value, mode);
}
template <class DataType>
void TagList::add(const Glib::ustring& tag, const DataType& data, TagMergeMode mode)
{
typedef Glib::Value<DataType> ValueType;
ValueType value;
value.init(ValueType::value_type());
value.set(data);
this->add_value(tag, value, mode);
}
template<class DataType>
bool TagList::get(Tag tag, DataType& data) const
{
Glib::Value<DataType> value;
value.init(value.value_type());
const bool result = this->get_value(tag, value);
if(result)
data = value.get();
return result;
}
template<class DataType>
bool TagList::get(const Glib::ustring& tag, DataType& data) const
{
Glib::Value<DataType> value;
value.init(value.value_type());
const bool result = this->get_value(tag, value);
if(result)
data = value.get();
return result;
}
template<class DataType>
bool TagList::get(Tag tag, guint index, DataType& data) const
{
Glib::Value<DataType> value;
value.init(value.value_type());
bool result = this->get_value(tag, index, value);
if(result)
data = value.get();
return result;
}
template<class DataType>
bool TagList::get(const Glib::ustring& tag, guint index, DataType& data) const
{
Glib::Value<DataType> value;
value.init(value.value_type());
bool result = this->get_value(tag, index, value);
if(result)
data = value.get();
return result;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
} //namespace Gst
namespace Gst
{
/** @relates Gst::TagList
* @param lhs The left-hand side
* @param rhs The right-hand side
*/
inline void swap(TagList& lhs, TagList& rhs)
{ lhs.swap(rhs); }
} // namespace Gst
namespace Glib
{
/** A Glib::wrap() method for this object. The method has a non-standard name because otherwise it would collide with the wrap method for Gst::Structure because both Gst::TagList and Gst::Structure wrap the same underlying C type.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gst::TagList
*/
Gst::TagList wrap_taglist(GstTagList* object, bool take_copy = false);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class Value<Gst::TagList> : public Glib::Value_Boxed<Gst::TagList>
{};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
} // namespace Glib
#endif /* _GSTREAMERMM_TAGLIST_H */
|