Class: TagLib::ID3v2::AttachedPictureFrame

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

Overview

Attached picture frame (APIC), e.g. for cover art.

The constants in this class are used for the #type attribute.

Constant Summary collapse

Other =

Other

0x00
FileIcon =

32x32 file icon (PNG only)

0x01
OtherFileIcon = 
0x02
FrontCover = 
0x03
BackCover = 
0x04
LeafletPage = 
0x05
Media = 
0x06
LeadArtist = 
0x07
Artist = 
0x08
Conductor = 
0x09
Band = 
0x0A
Composer = 
0x0B
Lyricist = 
0x0C
RecordingLocation = 
0x0D
DuringRecording = 
0x0E
DuringPerformance = 
0x0F
MovieScreenCapture = 
0x10
ColouredFish = 
0x11
Illustration = 
0x12
BandLogo = 
0x13
PublisherLogo = 
0x14

Instance Attribute Summary collapse

Attributes inherited from Frame

#frame_id

Instance Method Summary collapse

Methods inherited from Frame

#to_string

Constructor Details

#initialize ⇒ AttachedPictureFrame

Returns a new instance of AttachedPictureFrame.



226
227
 
# File 'docs/taglib/id3v2.rb', line 226

def initialize
end

Instance Attribute Details

#description ⇒ String

Returns:

  • (String) 


230
231
232
 
# File 'docs/taglib/id3v2.rb', line 230

def description
  @description
end

#mime_type ⇒ String

MIME type (e.g. "image/png")

Returns:

  • (String) 


234
235
236
 
# File 'docs/taglib/id3v2.rb', line 234

def mime_type
  @mime_type
end

#picture ⇒ binary String

Binary data string.

Be sure to use a binary string when setting this attribute. In Ruby 1.9, this means reading from a file with "b" mode to get a string with encoding BINARY / ASCII-8BIT.

Returns:

  • (binary String) 


239
240
241
 
# File 'docs/taglib/id3v2.rb', line 239

def picture
  @picture
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) 


244
245
246
 
# File 'docs/taglib/id3v2.rb', line 244

def text_encoding
  @text_encoding
end

#type ⇒ AttachedPictureFrame constant

Type of the attached picture, see constants.

Returns:



248
249
250
 
# File 'docs/taglib/id3v2.rb', line 248

def type
  @type
end