Module: AudioRating::MP3

Defined in:
lib/audio_rating/mp3.rb

Overview

Base class for MP3 files.

Class Method Summary collapse

Class Method Details

.get(path) ⇒ Integer, ...

Get an MP3 file’s embedded star-rating metadata if present.

Uses taglib-ruby class: rubydoc.info/gems/taglib-ruby/TagLib/MPEG/File

Parameters:

  • path (String) —

    the MP3 file path

Returns:

  • (Integer) —

    the star-rating of 1, 2, 3, 4 or 5

  • (Float) —

    the star-rating of 0.5, 1.5, 2.5, 3.5 or 4.5

  • (nil) —

    if file not found, or file has no star-rating metadata



16
17
18
19
20
21
22
 
# File 'lib/audio_rating/mp3.rb', line 16

def self.get(path)
  TagLib::MPEG::File.open(path) do |file|
    next unless file&.valid? && file&.id3v2_tag?

    AudioRating::ID3v2.get file.id3v2_tag
  end
end