Class: TagLib::ID3v2::Frame

Inherits:

Object

• Object
• TagLib::ID3v2::Frame

Defined in:

docs/taglib/id3v2.rb

Overview

The base class for all ID3v2 frames.

In ID3v2 all frames are identified by a frame ID, such as TIT2 or APIC. The data in the frames is different depending on the frame type, which is why there is a subclass for each type.

The most common frame type is the text identification frame. All frame IDs of this type begin with T, for example TALB for the album. See TextIdentificationFrame.

Then there are the URL link frames, which begin with W, see UrlLinkFrame.

Finally, there are some specialized frame types and their corresponding classes:

• APIC: AttachedPictureFrame
• COMM: CommentsFrame
• GEOB: GeneralEncapsulatedObjectFrame
• POPM: PopularimeterFrame
• PRIV: PrivateFrame
• RVAD: RelativeVolumeFrame
• TXXX: UserTextIdentificationFrame
• UFID: UniqueFileIdentifierFrame
• USLT: UnsynchronizedLyricsFrame
• WXXX: UserUrlLinkFrame

Direct Known Subclasses

AttachedPictureFrame, CommentsFrame, GeneralEncapsulatedObjectFrame, PopularimeterFrame, PrivateFrame, RelativeVolumeFrame, TextIdentificationFrame, UniqueFileIdentifierFrame, UnsynchronizedLyricsFrame, UrlLinkFrame

Instance Attribute Summary

• #frame_id ⇒ String readonly

  Frame ID.

Instance Method Summary

• #to_string ⇒ String

  A subclass-specific string representation.

Instance Attribute Details

#frame_id ⇒ String (readonly)

Returns frame ID.

Returns:

• (String) —

  frame ID

# File 'docs/taglib/id3v2.rb', line 93

def frame_id
  @frame_id
end

Instance Method Details

#to_string ⇒ String

Returns a subclass-specific string representation.

Returns:

• (String) —

  a subclass-specific string representation

# File 'docs/taglib/id3v2.rb', line 96

def to_string
end