Miam-Player  0.8.0
A nice music player
TagLib::ID3v2::RelativeVolumeFrame Class Reference

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

#include <relativevolumeframe.h>

Inheritance diagram for TagLib::ID3v2::RelativeVolumeFrame:
TagLib::ID3v2::Frame TagLib::ID3v2::Header

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
}
 This indicates the type of volume adjustment that should be applied. More...
 

Public Member Functions

 RelativeVolumeFrame ()
 Constructs a RelativeVolumeFrame. More...
 
 RelativeVolumeFrame (const ByteVector &data)
 Constructs a RelativeVolumeFrame based on the contents of data. More...
 
virtual ~RelativeVolumeFrame ()
 Destroys the RelativeVolumeFrame instance. More...
 
virtual String toString () const
 Returns the frame's identification. More...
 
List< ChannelTypechannels () const
 Returns a list of channels with information currently in the frame. More...
 
ChannelType channelType () const
 
void setChannelType (ChannelType t)
 
short volumeAdjustmentIndex (ChannelType type) const
 
short volumeAdjustmentIndex () const
 
void setVolumeAdjustmentIndex (short index, ChannelType type)
 
void setVolumeAdjustmentIndex (short index)
 
float volumeAdjustment (ChannelType type) const
 
float volumeAdjustment () const
 
void setVolumeAdjustment (float adjustment, ChannelType type)
 
void setVolumeAdjustment (float adjustment)
 
PeakVolume peakVolume (ChannelType type) const
 
PeakVolume peakVolume () const
 
void setPeakVolume (const PeakVolume &peak, ChannelType type)
 
void setPeakVolume (const PeakVolume &peak)
 
String identification () const
 Returns the identification for this frame. More...
 
void setIdentification (const String &s)
 Sets the identification of the frame to s. More...
 
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Destroys this Frame instance. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
unsigned int size () const
 Returns the size of the frame. More...
 
void setData (const ByteVector &data)
 Sets the data that will be used as the frame. More...
 
virtual void setText (const String &text)
 Set the text of frame in the sanest way possible. More...
 
ByteVector render () const
 Render the frame back to its binary format in a ByteVector. More...
 
 Header (const ByteVector &data, bool synchSafeInts)
 Construct a Frame Header based on data. More...
 
 Header (const ByteVector &data, unsigned int version=4)
 Construct a Frame Header based on data. More...
 
virtual ~Header ()
 Destroys this Header instance. More...
 
void setData (const ByteVector &data, bool synchSafeInts)
 Sets the data for the Header. More...
 
void setData (const ByteVector &data, unsigned int version=4)
 Sets the data for the Header. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
void setFrameID (const ByteVector &id)
 Sets the frame's ID to id. More...
 
unsigned int frameSize () const
 Returns the size of the frame data portion, as set when setData() was called or set explicitly via setFrameSize(). More...
 
void setFrameSize (unsigned int size)
 Sets the size of the frame data portion. More...
 
unsigned int version () const
 Returns the ID3v2 version of the header, as passed in from the construction of the header or set via setVersion(). More...
 
void setVersion (unsigned int version)
 Sets the ID3v2 version of the header, changing has impact on the correct parsing/rendering of frame data. More...
 
bool tagAlterPreservation () const
 Returns true if the flag for tag alter preservation is set. More...
 
void setTagAlterPreservation (bool discard)
 Sets the flag for preservation of this frame if the tag is set. More...
 
bool fileAlterPreservation () const
 Returns true if the flag for file alter preservation is set. More...
 
bool readOnly () const
 Returns true if the frame is meant to be read only. More...
 
bool groupingIdentity () const
 Returns true if the flag for the grouping identity is set. More...
 
bool compression () const
 Returns true if compression is enabled for this frame. More...
 
bool encryption () const
 Returns true if encryption is enabled for this frame. More...
 
bool unsycronisation () const
 
bool unsynchronisation () const
 Returns true if unsynchronisation is enabled for this frame. More...
 
bool dataLengthIndicator () const
 Returns true if the flag for a data length indicator is set. More...
 
ByteVector render () const
 Render the Header back to binary format in a ByteVector. More...
 
bool frameAlterPreservation () const
 

Protected Member Functions

virtual void parseFields (const ByteVector &data)
 Called by parse() to parse the field data. More...
 
virtual ByteVector renderFields () const
 Render the field data back to a binary format in a ByteVector. More...
 
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Constructs an ID3v2 frame using data to read the header information. More...
 
 Frame (Header *h)
 This creates an Frame using the header h. More...
 
Headerheader () const
 Returns a pointer to the frame header. More...
 
void setHeader (Header *h, bool deleteCurrent=true)
 Sets the header to h. More...
 
void parse (const ByteVector &data)
 Called by setData() to parse the frame data. More...
 
ByteVector fieldData (const ByteVector &frameData) const
 Returns a ByteVector containing the field data given the frame data. More...
 
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
 Reads a String of type encoding from the ByteVector data. More...
 
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
PropertyMap asProperties () const
 Parses the contents of this frame as PropertyMap. More...
 

Friends

class FrameFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
 Creates a textual frame which corresponds to a single key in the PropertyMap interface. More...
 
static unsigned int headerSize ()
 Returns the size of the frame header. More...
 
static unsigned int headerSize (unsigned int version)
 Returns the size of the frame header for the given ID3v2 version. More...
 
static ByteVector textDelimiter (String::Type t)
 Returns the text delimiter that is used between fields for the string type t. More...
 
static unsigned int size ()
 Returns the size of the frame header in bytes. More...
 
static unsigned int size (unsigned int version)
 Returns the size of the frame header in bytes for the ID3v2 version that's given. More...
 
- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
 The string with which an instrument name is prefixed to build a key in a PropertyMap; used to translate PropertyMaps to TMCL frames. More...
 
static const String commentPrefix
 The PropertyMap key prefix which triggers the use of a COMM frame instead of a TXXX frame for a non-standard key. More...
 
static const String lyricsPrefix
 The PropertyMap key prefix which triggers the use of a USLT frame instead of a TXXX frame for a non-standard key. More...
 
static const String urlPrefix
 The PropertyMap key prefix which triggers the use of a WXXX frame instead of a TXX frame for a non-standard key. More...
 
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static String::Type checkEncoding (const StringList &fields, String::Type encoding, unsigned int version)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static ByteVector keyToFrameID (const String &)
 Returns an appropriate ID3 frame ID for the given free-form tag key. More...
 
static String frameIDToKey (const ByteVector &)
 Returns a free-form tag name for the given ID3 frame ID. More...
 
static String keyToTXXX (const String &)
 Returns an appropriate TXXX frame description for the given free-form tag key. More...
 
static String txxxToKey (const String &)
 Returns a free-form tag name for the given ID3 frame description. More...
 
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)
 This helper function splits the PropertyMap original into three ProperytMaps singleFrameProperties, tiplProperties, and tmclProperties, such that: More...
 

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

◆ ChannelType

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

◆ RelativeVolumeFrame() [1/2]

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

Constructs a RelativeVolumeFrame.

The relevant data should be set manually.

◆ RelativeVolumeFrame() [2/2]

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

Constructs a RelativeVolumeFrame based on the contents of data.

◆ ~RelativeVolumeFrame()

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

Destroys the RelativeVolumeFrame instance.

Member Function Documentation

◆ channels()

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

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

◆ channelType()

ChannelType TagLib::ID3v2::RelativeVolumeFrame::channelType ( ) const
Deprecated:
Always returns master volume.

◆ identification()

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

Returns the identification for this frame.

◆ parseFields()

virtual void TagLib::ID3v2::RelativeVolumeFrame::parseFields ( const ByteVector data)
protectedvirtual

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() [1/2]

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

◆ peakVolume() [2/2]

PeakVolume TagLib::ID3v2::RelativeVolumeFrame::peakVolume ( ) const

◆ renderFields()

virtual ByteVector TagLib::ID3v2::RelativeVolumeFrame::renderFields ( ) const
protectedvirtual

Render the field data back to a binary format in a ByteVector.

This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

◆ setChannelType()

void TagLib::ID3v2::RelativeVolumeFrame::setChannelType ( ChannelType  t)
Deprecated:
This method no longer has any effect.

◆ setIdentification()

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.

◆ setPeakVolume() [1/2]

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

◆ setPeakVolume() [2/2]

void TagLib::ID3v2::RelativeVolumeFrame::setPeakVolume ( const PeakVolume peak)

◆ setVolumeAdjustment() [1/2]

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

◆ setVolumeAdjustment() [2/2]

void TagLib::ID3v2::RelativeVolumeFrame::setVolumeAdjustment ( float  adjustment)

◆ setVolumeAdjustmentIndex() [1/2]

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

◆ setVolumeAdjustmentIndex() [2/2]

void TagLib::ID3v2::RelativeVolumeFrame::setVolumeAdjustmentIndex ( short  index)

◆ toString()

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

Returns the frame's identification.

See also
identification()

Implements TagLib::ID3v2::Frame.

◆ volumeAdjustment() [1/2]

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

◆ volumeAdjustment() [2/2]

float TagLib::ID3v2::RelativeVolumeFrame::volumeAdjustment ( ) const

◆ volumeAdjustmentIndex() [1/2]

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

◆ volumeAdjustmentIndex() [2/2]

short TagLib::ID3v2::RelativeVolumeFrame::volumeAdjustmentIndex ( ) const

Friends And Related Function Documentation

◆ FrameFactory

friend class FrameFactory
friend

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