Class: TagLib::ID3v2::TextIdentificationFrame

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

Overview

Text identification frame (T???).

Examples:

Create a new TIT2 frame

frame = TagLib::ID3v2::TextIdentificationFrame.new("TIT2", TagLib::String::UTF8)
frame.text = "Title"

Direct Known Subclasses

UserTextIdentificationFrame

Instance Attribute Summary collapse

Attributes inherited from Frame

#frame_id

Instance Method Summary collapse

Methods inherited from Frame

#to_string

Constructor Details

#initialize(type, encoding) ⇒ TextIdentificationFrame

Returns a new instance of TextIdentificationFrame.

Parameters:

  • type (String) —

    the frame ID, e.g. TDRC

  • encoding (TagLib::String constant) —

    text encoding, e.g. TagLib::String::UTF8



420
421
 
# File 'docs/taglib/id3v2.rb', line 420

def initialize(type, encoding)
end

Instance Attribute Details

#field_list ⇒ Array<String>

Returns list of text strings in this frame.

Returns:

  • (Array<String>) —

    list of text strings in this frame



431
432
433
 
# File 'docs/taglib/id3v2.rb', line 431

def field_list
  @field_list
end

#text=(value) ⇒ Object (writeonly)

Parameters:

  • value (String) —

    simple text to set



434
435
436
 
# File 'docs/taglib/id3v2.rb', line 434

def text=(value)
  @text = value
end

#text_encoding ⇒ TagLib::String constant

Encoding for storing the text in the tag, e.g. TagLib::String::UTF8. See the section String Encodings in TagLib.

Returns:

  • (TagLib::String constant) 


428
429
430
 
# File 'docs/taglib/id3v2.rb', line 428

def text_encoding
  @text_encoding
end