Class: TagLib::ID3v2::Tag

Inherits:
Tag
  • Object
show all
Defined in:
docs/taglib/id3v2.rb

Overview

An ID3v2 tag.

Instance Attribute Summary

Attributes inherited from Tag

#album, #artist, #comment, #genre, #title, #track, #year

Instance Method Summary collapse

Methods inherited from Tag

#empty?

Instance Method Details

#add_frame(frame) ⇒ void

This method returns an undefined value.

Add a frame to the tag.

Parameters:



24
25
 
# File 'docs/taglib/id3v2.rb', line 24

def add_frame(frame)
end

#frame_list ⇒ Array<TagLib::ID3v2::Frame> #frame_list(frame_id) ⇒ Array<TagLib::ID3v2::Frame>

Get a list of frames. Note that the frames returned are subclasses of Frame, depending on the frame ID.

Overloads:

  • #frame_list ⇒ Array<TagLib::ID3v2::Frame>

    Returns all frames.

  • #frame_list(frame_id) ⇒ Array<TagLib::ID3v2::Frame>

    Returns frames matching ID.

    Parameters:

    • frame_id (String) —

      Specify this parameter to get only the frames matching a frame ID (e.g. "TIT2").

Returns:



17
18
 
# File 'docs/taglib/id3v2.rb', line 17

def frame_list
end

#remove_frame(frame) ⇒ void

This method returns an undefined value.

Remove the passed frame from the tag.

Note: You can and shall not call any methods on the frame object after you have passed it to this method, because the underlying C++ object has been deleted.

Parameters:

  • frame (Frame) —

    to remove



35
36
 
# File 'docs/taglib/id3v2.rb', line 35

def remove_frame(frame)
end

#remove_frames(id) ⇒ void

This method returns an undefined value.

Remove all frames with the specified ID from the tag.

Note: If you have obtained any frame objects with the same ID from the tag before calling this method, you should not touch them anymore. The reason is that the C++ objects may have been deleted.

Parameters:

  • id (String) 


46
47
 
# File 'docs/taglib/id3v2.rb', line 46

def remove_frames(id)
end