Class: TagLib::FileRef

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

Overview

This class allows to read basic tagging and audio properties from files, without having to know what the file type is. Thus, it works for all tagging formats that taglib supports, but only provides a minimal API.

Should you need more, use the file type specific classes, see subclasses of File.

Instance Method Summary collapse

Constructor Details

#initialize(filename, read_audio_properties = true, audio_properties_style = TagLib::AudioProperties::Average) ⇒ FileRef

Create a FileRef from a file name.

Parameters:

  • filename (String)
  • read_audio_properties (Boolean) (defaults to: true) —

    true if audio properties should be read

  • audio_properties_style (TagLib::AudioProperties constants) (defaults to: TagLib::AudioProperties::Average) —

    how accurately the audio properties should be read, e.g. AudioProperties::Average

[View source]

43
44
45
 
# File 'docs/taglib/base.rb', line 43

def initialize(filename, read_audio_properties=true,
               audio_properties_style=TagLib::AudioProperties::Average)
end

Instance Method Details

#audio_properties ⇒ TagLib::AudioProperties

Returns the audio properties.

Returns:

[View source]

48
49
 
# File 'docs/taglib/base.rb', line 48

def audio_properties
end

#close ⇒ void

This method returns an undefined value.

Closes the file and releases all objects that were read from the file.

See Also:

[View source]

71
72
 
# File 'docs/taglib/base.rb', line 71

def close
end

#null? ⇒ Boolean

Returns if the file is null (i.e. it could not be read).

Returns:

  • (Boolean) —

    if the file is null (i.e. it could not be read)

[View source]

52
53
 
# File 'docs/taglib/base.rb', line 52

def null?
end

#save ⇒ Boolean

Saves the file

Returns:

  • (Boolean) —

    whether saving was successful

[View source]

58
59
 
# File 'docs/taglib/base.rb', line 58

def save
end

#tag ⇒ TagLib::Tag

Returns the tag.

Returns:

[View source]

62
63
 
# File 'docs/taglib/base.rb', line 62

def tag
end