NAME

Audio::TagLib::ID3v2::UserTextIdentificationFrame - An ID3v2 custom text identification frame implementation

SYNOPSIS

  use Audio::TagLib::ID3v2::UserTextIdentificationFrame;
  
  my $i = Audio::TagLib::ID3v2::UserTextIdentificationFrame->new("Latin1");
  $i->setDescription(Audio::TagLib::String->new("blah blah"));
  print $i->description()->toCString(), "\n"; # got "blah blah"

DESCRIPTION

This is a specialization of text identification frames that allows for user defined entries. Each entry has a description in addition to the normal list of fields that a text identification frame has.

This description identifies the frame and must be unique.

new(PV $encoding = "Latin1")

Constructs an empty user defined text identification frame. For this to be a useful frame both a description and text must be set.

new(ByteVector $data)

Creates a frame based on $data.

String description()

Returns the description for this frame.

void setDescription(String $s)

Sets the description of the frame to $s. $s must be unique. You can check for the presense of another user defined text frame of the same type using find() and testing for null.

StringList fieldList()

void setText(String $text)

void setText(StringList $fields)

see Audio::TagLib::ID3v2::TextIdentificationFrame

UserTextIdentificationFrame find(Tag $tag, String $description) [static]

Searches for the user defined text frame with the description $description in $tag. This returns undef if no matching frame were found.

EXPORT

None by default.

SEE ALSO

Audio::TagLib TextIdentificationFrame

AUTHOR

Dongxu Ma, <dongxu@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Dongxu Ma

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.