TagLib 1.6.1 (TagLib: TagLib::ID3v2::RelativeVolumeFrame Class Reference)

TagLib::ID3v2::RelativeVolumeFrame Class Reference

An ID3v2 relative volume adjustment frame implementation. More...

#include <relativevolumeframe.h>

Inheritance diagram for TagLib::ID3v2::RelativeVolumeFrame:
Collaboration diagram for TagLib::ID3v2::RelativeVolumeFrame:

List of all members.

Classes

struct  PeakVolume
 Struct that stores the relevant values for ID3v2 peak volume. More...

Public Types

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

Public Member Functions

 RelativeVolumeFrame ()
 RelativeVolumeFrame (const ByteVector &data)
virtual ~RelativeVolumeFrame ()
virtual String toString () const
List< ChannelTypechannels () const
ChannelType channelType () const
void setChannelType (ChannelType t)
short volumeAdjustmentIndex (ChannelType type=MasterVolume) const
void setVolumeAdjustmentIndex (short index, ChannelType type=MasterVolume)
float volumeAdjustment (ChannelType type=MasterVolume) const
void setVolumeAdjustment (float adjustment, ChannelType type=MasterVolume)
PeakVolume peakVolume (ChannelType type=MasterVolume) const
void setPeakVolume (const PeakVolume &peak, ChannelType type=MasterVolume)
String identification () const
void setIdentification (const String &s)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Friends

class FrameFactory


Detailed Description

An ID3v2 relative volume adjustment frame implementation.

This is an implementation of ID3v2 relative volume adjustment. The presence of this frame makes it possible to specify an increase in volume for an audio file or specific audio tracks in that file.

Multiple relative volume adjustment frames may be present in the tag each with a unique identification and describing volume adjustment for different channel types.


Member Enumeration Documentation

This indicates the type of volume adjustment that should be applied.

Enumerator:
Other  A type not enumerated below.
MasterVolume  The master volume for the track.
FrontRight  The front right audio channel.
FrontLeft  The front left audio channel.
BackRight  The back right audio channel.
BackLeft  The back left audio channel.
FrontCentre  The front center audio channel.
BackCentre  The back center audio channel.
Subwoofer  The subwoofer audio channel.


Constructor & Destructor Documentation

TagLib::ID3v2::RelativeVolumeFrame::RelativeVolumeFrame (  ) 

Constructs a RelativeVolumeFrame. The relevant data should be set manually.

TagLib::ID3v2::RelativeVolumeFrame::RelativeVolumeFrame ( const ByteVector data  ) 

Constructs a RelativeVolumeFrame based on the contents of data.

virtual TagLib::ID3v2::RelativeVolumeFrame::~RelativeVolumeFrame (  )  [virtual]

Destroys the RelativeVolumeFrame instance.


Member Function Documentation

List<ChannelType> TagLib::ID3v2::RelativeVolumeFrame::channels (  )  const

Returns a list of channels with information currently in the frame.

ChannelType TagLib::ID3v2::RelativeVolumeFrame::channelType (  )  const

String TagLib::ID3v2::RelativeVolumeFrame::identification (  )  const

Returns the identification for this frame.

virtual void TagLib::ID3v2::RelativeVolumeFrame::parseFields ( const ByteVector data  )  [protected, virtual]

Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

PeakVolume TagLib::ID3v2::RelativeVolumeFrame::peakVolume ( ChannelType  type = MasterVolume  )  const

Returns the peak volume (represented as a length and a string of bits).

This defaults to returning the value for the master volume channel if available and returns 0 if the specified channel does not exist.

See also:
setPeakVolume()

virtual ByteVector TagLib::ID3v2::RelativeVolumeFrame::renderFields (  )  const [protected, virtual]

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

void TagLib::ID3v2::RelativeVolumeFrame::setChannelType ( ChannelType  t  ) 

void TagLib::ID3v2::RelativeVolumeFrame::setIdentification ( const String s  ) 

Sets the identification of the frame to s. The string is used to identify the situation and/or device where this adjustment should apply.

void TagLib::ID3v2::RelativeVolumeFrame::setPeakVolume ( const PeakVolume peak,
ChannelType  type = MasterVolume 
)

Sets the peak volume to peak.

By default this sets the value for the master volume.

See also:
peakVolume()

void TagLib::ID3v2::RelativeVolumeFrame::setVolumeAdjustment ( float  adjustment,
ChannelType  type = MasterVolume 
)

Set the relative volume adjustment in decibels to adjustment.

By default this sets the value for the master volume.

Note:
Because this is actually stored internally as an "index" to this value the value set by this method may not be identical to the one returned by volumeAdjustment().
See also:
setVolumeAdjustment()

volumeAdjustmentIndex()

void TagLib::ID3v2::RelativeVolumeFrame::setVolumeAdjustmentIndex ( short  index,
ChannelType  type = MasterVolume 
)

Set the volume adjustment to index. As indicated by the ID3v2 standard this is a 16-bit signed integer that reflects the decibils of adjustment when divided by 512.

By default this sets the value for the master volume.

See also:
volumeAdjustmentIndex()

setVolumeAjustment()

virtual String TagLib::ID3v2::RelativeVolumeFrame::toString (  )  const [virtual]

Returns the frame's identification.

See also:
identification()

Implements TagLib::ID3v2::Frame.

float TagLib::ID3v2::RelativeVolumeFrame::volumeAdjustment ( ChannelType  type = MasterVolume  )  const

Returns the relative volume adjustment in decibels.

Note:
Because this is actually stored internally as an "index" to this value the value returned by this method may not be identical to the value set using setVolumeAdjustment().
This defaults to returning the value for the master volume channel if available and returns 0 if the specified channel does not exist.

See also:
setVolumeAdjustment()

volumeAdjustmentIndex()

short TagLib::ID3v2::RelativeVolumeFrame::volumeAdjustmentIndex ( ChannelType  type = MasterVolume  )  const

Returns the relative volume adjustment "index". As indicated by the ID3v2 standard this is a 16-bit signed integer that reflects the decibils of adjustment when divided by 512.

This defaults to returning the value for the master volume channel if available and returns 0 if the specified channel does not exist.

See also:
setVolumeAdjustmentIndex()

volumeAjustment()


Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.


The documentation for this class was generated from the following file: