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

#identification ⇒ String

Returns relative volume identification.

Returns:

  • (String) —

    relative volume identification



241
242
243
 
# File 'docs/taglib/id3v2.rb', line 241

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:



237
238
 
# File 'docs/taglib/id3v2.rb', line 237

def channels
end

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

Returns peak volume for channel type.

Parameters:

Returns:



247
248
 
# File 'docs/taglib/id3v2.rb', line 247

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:



255
256
 
# File 'docs/taglib/id3v2.rb', line 255

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:



274
275
 
# File 'docs/taglib/id3v2.rb', line 274

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:



293
294
 
# File 'docs/taglib/id3v2.rb', line 293

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) 


264
265
 
# File 'docs/taglib/id3v2.rb', line 264

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) 


283
284
 
# File 'docs/taglib/id3v2.rb', line 283

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