Class: Id3Taginator::Id3Taginator

Inherits:
Object
  • Object
show all
Includes:
Extensions::Optionable
Defined in:
lib/id3taginator.rb

Instance Method Summary collapse

Methods included from Extensions::Optionable

#add_size_frame, #default_decode_for_destination, #default_encode_for_destination, #ignore_v23_frame_error, #ignore_v24_frame_error, #tag_padding

Constructor Details

#initialize(options) ⇒ Id3Taginator

Returns a new instance of Id3Taginator.



182
183
184
 
# File 'lib/id3taginator.rb', line 182

def initialize(options)
  @options = options
end

Instance Method Details

#build_by_bytes(bytes, no_tag_parsing: false) ⇒ Id3Taginator::AudioFile

builds an audio file

Parameters:

  • bytes (String) —

    String representing the byte array of the file

  • no_tag_parsing (Boolean) (defaults to: false) —

    if true, no Id3v2 tag is parsed

Returns:



212
213
214
 
# File 'lib/id3taginator.rb', line 212

def build_by_bytes(bytes, no_tag_parsing: false)
  AudioFile.new(StringIO.new(bytes), @options, no_tag_parsing: no_tag_parsing)
end

#build_by_file(file, no_tag_parsing: false) ⇒ Id3Taginator::AudioFile

builds an audio file

Parameters:

  • file (StringIO, IO, File) —

    the file stream

  • no_tag_parsing (Boolean) (defaults to: false) —

    if true, no Id3v2 tag is parsed

Returns:



192
193
194
 
# File 'lib/id3taginator.rb', line 192

def build_by_file(file, no_tag_parsing: false)
  AudioFile.new(file, @options, no_tag_parsing: no_tag_parsing)
end

#build_by_path(path, no_tag_parsing: false) ⇒ Id3Taginator::AudioFile

builds an audio file

Parameters:

  • path (String) —

    path to the mp3 file

  • no_tag_parsing (Boolean) (defaults to: false) —

    if true, no Id3v2 tag is parsed

Returns:



202
203
204
 
# File 'lib/id3taginator.rb', line 202

def build_by_path(path, no_tag_parsing: false)
  AudioFile.new(File.new(path), @options, no_tag_parsing: no_tag_parsing)
end