Class: TagLib::ID3v2::RelativeVolumeFrame

Inherits:

Frame

• Object
• Frame
• TagLib::ID3v2::RelativeVolumeFrame

Defined in:

docs/taglib/id3v2.rb

Overview

Relative volume adjustment frame (RVAD or RVA2).

Constant Summary

Other =

0x00

MasterVolume =

0x01

FrontRight =

0x02

FrontLeft =

0x03

BackRight =

0x04

BackLeft =

0x05

FrontCentre =

0x06

BackCentre =

0x07

Subwoofer =

0x08

Instance Attribute Summary

• #identification ⇒ String

  Relative volume identification.

Attributes inherited from Frame

#frame_id

Instance Method Summary

• #channels ⇒ Array<TagLib::ID3v2::RelativeVolumeFrame constant>

  The channel types for which volume adjustment information is stored in this frame.

• #peak_volume(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ TagLib::ID3v2::PeakVolume

  Returns peak volume for channel type.

• #set_peak_volume(peak, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

  Sets peak volume for channel type.

• #set_volume_adjustment(adjustment, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

  Sets volume adjustment in decibels for a specific channel type.

• #set_volume_adjustment_index(index, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

  Sets volume adjustment index for a specific channel type.

• #volume_adjustment(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ Float

  Returns volume adjustment in decibels for a specific channel type.

• #volume_adjustment_index(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ Integer

  Returns volume adjustment index for a specific channel type.

Methods inherited from Frame

#to_string

Instance Attribute Details

#identification ⇒ String

Returns relative volume identification.

Returns:

• (String) —

  relative volume identification

# File 'docs/taglib/id3v2.rb', line 339

def identification
  @identification
end

Instance Method Details

#channels ⇒ Array<TagLib::ID3v2::RelativeVolumeFrame constant>

Returns the channel types for which volume adjustment information is stored in this frame.

Returns:

• (Array<TagLib::ID3v2::RelativeVolumeFrame constant>) —

  the channel types for which volume adjustment information is stored in this frame

# File 'docs/taglib/id3v2.rb', line 335

def channels
end

#peak_volume(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ TagLib::ID3v2::PeakVolume

Returns peak volume for channel type.

Parameters:

• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

Returns:

• (TagLib::ID3v2::PeakVolume)

# File 'docs/taglib/id3v2.rb', line 345

def peak_volume(type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end

#set_peak_volume(peak, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

This method returns an undefined value.

Sets peak volume for channel type.

Parameters:

• peak (TagLib::ID3v2::PeakVolume) —

  peak volume

• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

# File 'docs/taglib/id3v2.rb', line 353

def set_peak_volume(peak, type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end

#set_volume_adjustment(adjustment, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

This method returns an undefined value.

Sets volume adjustment in decibels for a specific channel type. Internally, this is stored as an index, see #set_volume_adjustment_index.

Parameters:

• adjustment (Float)
• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

# File 'docs/taglib/id3v2.rb', line 372

def set_volume_adjustment(adjustment, type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end

#set_volume_adjustment_index(index, type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ void

This method returns an undefined value.

Sets volume adjustment index for a specific channel type. When dividing the index by 512, it corresponds to the volume adjustment in decibel.

Parameters:

• index (Integer)
• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

# File 'docs/taglib/id3v2.rb', line 391

def set_volume_adjustment_index(index, type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end

#volume_adjustment(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ Float

Returns volume adjustment in decibels for a specific channel type. Internally, this is stored as an index, see #volume_adjustment_index.

Parameters:

• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

Returns:

• (Float)

# File 'docs/taglib/id3v2.rb', line 362

def volume_adjustment(type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end

#volume_adjustment_index(type = TagLib::ID3v2::RelativeVolumeFrame::MasterVolume) ⇒ Integer

Returns volume adjustment index for a specific channel type. When dividing the index by 512, it corresponds to the volume adjustment in decibel.

Parameters:

• type (TagLib::ID3v2::RelativeVolumeFrame constant) (defaults to: TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)

Returns:

• (Integer)

# File 'docs/taglib/id3v2.rb', line 381

def volume_adjustment_index(type=TagLib::ID3v2::RelativeVolumeFrame::MasterVolume)
end