Audio::TagLib::Ogg::FieldListMap - Perl-only class


Audio-TagLib documentation Contained in the Audio-TagLib distribution.

Index


Code Index:

NAME

Top

Audio::TagLib::Ogg::FieldListMap - Perl-only class

SYNOPSIS

Top

  use Audio::TagLib::Ogg::FieldListMap;

  my $xc = Audio::TagLib::Ogg::XiphComment->new();
  $xc->setTitle(Audio::TagLib::String->new("title"));
  $xc->setArtist(Audio::TagLib::String->new("artist"));
  my $i  = $xc->fieldListMap();

  tie my %i, ref($i), $i;
  print $i{Audio::TagLib::String->new("TITLE")}->toString()->toCString(),
  "\n"; # got "title"

DESCRIPTION

Top

Implements TagLib::Ogg::FieldListMap in C/C++ code, which is of type TagLib::Map<String, StringList>.

Optionally, you can tie an instance of ItemListMap with a hash symbol, just like this: tie my %h, ref($i), $i;, Then operate throught %h.

see Audio::TagLib::Ogg::XiphComment::fieldListMap()

new()

Constructs an empty FieldListMap.

new(FieldListMap $m)

Make a shallow, implicitly shared, copy of $m.

DESTROY()

Destroys this instance of the FieldListMap.

Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator) begin()

Returns an STL style iterator to the beginning of the map.

see Audio::TagLib::Ogg::FieldListMap::Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator)

Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator) end()

Returns an STL style iterator to the end of the map.

see Audio::TagLib::Ogg::FieldListMap::Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator)

void insert(String $key, StringList $value)

Inserts $value under $key in the map. If a value for $key already exists it will be overwritten.

void clear()

Removes all of the elements from elements from the map. This however will not free memory of all the items.

UV size()

The number of elements in the map.

see isEmpty()

BOOL isEmpty()

Returns true if the map is empty.

see size()

Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator) find(String $key)

Find the first occurance of $key.

BOOL contains(String $key)

Returns true if the map contains an instance of $key.

void erase(Iterator (Audio::TagLib::Ogg::FieldListMap::Iterator) $it)

Erase the item at $it from the list.

StringList getItem(String $key)

Returns the value associated with $key.

note This has undefined behavior if the key is not present in the map.

copy(FieldListMap $m)

Make a shallow, implicitly shared, copy of $m.

EXPORT

None by default.

SEE ALSO

Top

Audio::TagLib

AUTHOR

Top

Dongxu Ma, <dongxu@cpan.org>

COPYRIGHT AND LICENSE

Top


Audio-TagLib documentation Contained in the Audio-TagLib distribution.

package Audio::TagLib::Ogg::FieldListMap;

use 5.008003;
use strict;
use warnings;

our $VERSION = '1.41';

use Audio::TagLib;

# Preloaded methods go here.
1;
__END__
# Below is stub documentation for your module. You'd better edit it!