Class: TagLib::ID3v2::RelativeVolumeFrame

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

Overview

Relative volume adjustment frame (RVAD or RVA2).

Constant Summary collapse

Other =
0x00
MasterVolume =
0x01
FrontRight =
0x02
FrontLeft =
0x03
BackRight =
0x04
BackLeft =
0x05
FrontCentre =
0x06
BackCentre =
0x07
Subwoofer =
0x08

Instance Attribute Summary collapse

Attributes inherited from Frame

#frame_id

Instance Method Summary collapse

Methods inherited from Frame

#to_string

Instance Attribute Details

#identificationString

Returns relative volume identification

Returns:

  • (String)

    relative volume identification


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

def identification
  @identification
end

Instance Method Details

#channelsArray<TagLib::ID3v2::RelativeVolumeFrame constant>

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

Returns:


335
336
# 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:

Returns:


345
346
# 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:


353
354
# 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:


372
373
# 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:


391
392
# 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:

Returns:

  • (Float)

362
363
# 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:

Returns:

  • (Integer)

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

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