TagLib 1.11 (TagLib: TagLib::IT::Properties Class Reference)

TagLib::IT::Properties Class Reference

#include <itproperties.h>

Inheritance diagram for TagLib::IT::Properties:
Collaboration diagram for TagLib::IT::Properties:

List of all members.

Public Types

enum  {
  Stereo = 1, Vol0MixOptimizations = 2, UseInstruments = 4, LinearSlides = 8,
  OldEffects = 16, LinkEffects = 32, UseMidiPitchController = 64, RequestEmbeddedMidiConf = 128
}
enum  { MessageAttached = 1, MidiConfEmbedded = 8 }

Public Member Functions

 Properties (AudioProperties::ReadStyle propertiesStyle)
virtual ~Properties ()
int length () const
int lengthInSeconds () const
int lengthInMilliseconds () const
int bitrate () const
int sampleRate () const
int channels () const
unsigned short lengthInPatterns () const
bool stereo () const
unsigned short instrumentCount () const
unsigned short sampleCount () const
unsigned short patternCount () const
unsigned short version () const
unsigned short compatibleVersion () const
unsigned short flags () const
unsigned short special () const
unsigned char globalVolume () const
unsigned char mixVolume () const
unsigned char tempo () const
unsigned char bpmSpeed () const
unsigned char panningSeparation () const
unsigned char pitchWheelDepth () const
void setChannels (int channels)
void setLengthInPatterns (unsigned short lengthInPatterns)
void setInstrumentCount (unsigned short instrumentCount)
void setSampleCount (unsigned short sampleCount)
void setPatternCount (unsigned short patternCount)
void setVersion (unsigned short version)
void setCompatibleVersion (unsigned short compatibleVersion)
void setFlags (unsigned short flags)
void setSpecial (unsigned short special)
void setGlobalVolume (unsigned char globalVolume)
void setMixVolume (unsigned char mixVolume)
void setTempo (unsigned char tempo)
void setBpmSpeed (unsigned char bpmSpeed)
void setPanningSeparation (unsigned char panningSeparation)
void setPitchWheelDepth (unsigned char pitchWheelDepth)

Friends

class File

Member Enumeration Documentation

anonymous enum

Flag bits.

Enumerator:
Stereo 
Vol0MixOptimizations 
UseInstruments 
LinearSlides 
OldEffects 
LinkEffects 
UseMidiPitchController 
RequestEmbeddedMidiConf 
anonymous enum

Special bits.

Enumerator:
MessageAttached 
MidiConfEmbedded 

Constructor & Destructor Documentation

TagLib::IT::Properties::Properties ( AudioProperties::ReadStyle  propertiesStyle)
virtual TagLib::IT::Properties::~Properties ( ) [virtual]

Member Function Documentation

int TagLib::IT::Properties::bitrate ( ) const [virtual]

Returns the most appropriate bit rate for the file in kb/s. For constant bitrate formats this is simply the bitrate of the file. For variable bitrate formats this is either the average or nominal bitrate.

Implements TagLib::AudioProperties.

unsigned char TagLib::IT::Properties::bpmSpeed ( ) const
int TagLib::IT::Properties::channels ( ) const [virtual]

Returns the number of audio channels.

Implements TagLib::AudioProperties.

unsigned short TagLib::IT::Properties::compatibleVersion ( ) const
unsigned short TagLib::IT::Properties::flags ( ) const
unsigned char TagLib::IT::Properties::globalVolume ( ) const
unsigned short TagLib::IT::Properties::instrumentCount ( ) const
int TagLib::IT::Properties::length ( ) const [virtual]

Returns the length of the file in seconds.

Implements TagLib::AudioProperties.

int TagLib::IT::Properties::lengthInMilliseconds ( ) const

Returns the length of the file in milliseconds.

See also:
lengthInSeconds()

Reimplemented from TagLib::AudioProperties.

unsigned short TagLib::IT::Properties::lengthInPatterns ( ) const
int TagLib::IT::Properties::lengthInSeconds ( ) const

Returns the length of the file in seconds. The length is rounded down to the nearest whole second.

See also:
lengthInMilliseconds()

Reimplemented from TagLib::AudioProperties.

unsigned char TagLib::IT::Properties::mixVolume ( ) const
unsigned char TagLib::IT::Properties::panningSeparation ( ) const
unsigned short TagLib::IT::Properties::patternCount ( ) const
unsigned char TagLib::IT::Properties::pitchWheelDepth ( ) const
unsigned short TagLib::IT::Properties::sampleCount ( ) const
int TagLib::IT::Properties::sampleRate ( ) const [virtual]

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

void TagLib::IT::Properties::setBpmSpeed ( unsigned char  bpmSpeed)
void TagLib::IT::Properties::setChannels ( int  channels)
void TagLib::IT::Properties::setCompatibleVersion ( unsigned short  compatibleVersion)
void TagLib::IT::Properties::setFlags ( unsigned short  flags)
void TagLib::IT::Properties::setGlobalVolume ( unsigned char  globalVolume)
void TagLib::IT::Properties::setInstrumentCount ( unsigned short  instrumentCount)
void TagLib::IT::Properties::setLengthInPatterns ( unsigned short  lengthInPatterns)
void TagLib::IT::Properties::setMixVolume ( unsigned char  mixVolume)
void TagLib::IT::Properties::setPanningSeparation ( unsigned char  panningSeparation)
void TagLib::IT::Properties::setPatternCount ( unsigned short  patternCount)
void TagLib::IT::Properties::setPitchWheelDepth ( unsigned char  pitchWheelDepth)
void TagLib::IT::Properties::setSampleCount ( unsigned short  sampleCount)
void TagLib::IT::Properties::setSpecial ( unsigned short  special)
void TagLib::IT::Properties::setTempo ( unsigned char  tempo)
void TagLib::IT::Properties::setVersion ( unsigned short  version)
unsigned short TagLib::IT::Properties::special ( ) const
bool TagLib::IT::Properties::stereo ( ) const
unsigned char TagLib::IT::Properties::tempo ( ) const
unsigned short TagLib::IT::Properties::version ( ) const

Friends And Related Function Documentation

friend class File [friend]

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