Class: TagLib::Ogg::Vorbis::File

Inherits:

File

• Object
• File
• File
• TagLib::Ogg::Vorbis::File

Defined in:

docs/taglib/vorbis.rb

Overview

The file class for .ogg and other .oga files.

Examples:

Reading Vorbis comments

TagLib::Ogg::Vorbis::File.open("file.oga") do |file|
  tag = file.tag
  puts tag.title
  fields = tag.field_list_map
  puts fields['DATE']
end

Class Method Summary

• .open(filename, read_properties = true) {|file| ... } ⇒ Object

Instance Method Summary

• #audio_properties ⇒ TagLib::Ogg::Vorbis::Properties

  Returns audio properties.

• #initialize(filename, read_properties = true) ⇒ File constructor

  Load an Ogg Vorbis file.

• #tag ⇒ TagLib::Ogg::XiphComment

  Returns the VorbisComment tag.

Methods inherited from File

#close, #save

Constructor Details

#initialize(filename, read_properties = true) ⇒ File

Load an Ogg Vorbis file.

Parameters:

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

  if audio properties should be read

# File 'docs/taglib/vorbis.rb', line 29

def initialize(filename, read_properties=true)
end

Class Method Details

.open(filename, read_properties = true) {|file| ... } ⇒ Object

Parameters:

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

  if audio properties should be read

Yields:

• (file) —

  the TagLib::Ogg::Vorbis::File object, as obtained by #initialize

Returns:

• the return value of the block

Since:

• 0.4.0

# File 'docs/taglib/vorbis.rb', line 21

def self.open(filename, read_properties=true)
end

Instance Method Details

#audio_properties ⇒ TagLib::Ogg::Vorbis::Properties

Returns audio properties.

Returns:

• (TagLib::Ogg::Vorbis::Properties)

# File 'docs/taglib/vorbis.rb', line 41

def audio_properties
end

#tag ⇒ TagLib::Ogg::XiphComment

Returns the VorbisComment tag.

Returns:

• (TagLib::Ogg::XiphComment)

# File 'docs/taglib/vorbis.rb', line 35

def tag
end