TagLib::S3M::Properties Class Reference

#include <s3mproperties.h>

Inheritance diagram for TagLib::S3M::Properties:
Collaboration diagram for TagLib::S3M::Properties:

Public Types

enum  {
  ST2Vibrato = 1, ST2Tempo = 2, AmigaSlides = 4, Vol0MixOptimizations = 8,
  AmigaLimits = 16, EnableFilter = 32, CustomData = 128
- Public Types inherited from TagLib::AudioProperties
enum  ReadStyle { Fast, Average, Accurate }

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 sampleCount () const
unsigned short patternCount () const
unsigned short flags () const
unsigned short trackerVersion () const
unsigned short fileFormatVersion () const
unsigned char globalVolume () const
unsigned char masterVolume () const
unsigned char tempo () const
unsigned char bpmSpeed () const
void setChannels (int channels)
void setLengthInPatterns (unsigned short lengthInPatterns)
void setStereo (bool stereo)
void setSampleCount (unsigned short sampleCount)
void setPatternCount (unsigned short patternCount)
void setFlags (unsigned short flags)
void setTrackerVersion (unsigned short trackerVersion)
void setFileFormatVersion (unsigned short fileFormatVersion)
void setGlobalVolume (unsigned char globalVolume)
void setMasterVolume (unsigned char masterVolume)
void setTempo (unsigned char tempo)
void setBpmSpeed (unsigned char bpmSpeed)
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()
int lengthInSeconds () const
int lengthInMilliseconds () const


class File

Additional Inherited Members

- Protected Member Functions inherited from TagLib::AudioProperties
 AudioProperties (ReadStyle style)

Member Enumeration Documentation

anonymous enum

Flag bits.


Constructor & Destructor Documentation

TagLib::S3M::Properties::Properties ( AudioProperties::ReadStyle  propertiesStyle)
virtual TagLib::S3M::Properties::~Properties ( )

Member Function Documentation

int TagLib::S3M::Properties::bitrate ( ) const

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::S3M::Properties::bpmSpeed ( ) const
int TagLib::S3M::Properties::channels ( ) const

Returns the number of audio channels.

Implements TagLib::AudioProperties.

unsigned short TagLib::S3M::Properties::fileFormatVersion ( ) const
unsigned short TagLib::S3M::Properties::flags ( ) const
unsigned char TagLib::S3M::Properties::globalVolume ( ) const
int TagLib::S3M::Properties::length ( ) const

Returns the length of the file in seconds.

Implements TagLib::AudioProperties.

int TagLib::S3M::Properties::lengthInMilliseconds ( ) const
unsigned short TagLib::S3M::Properties::lengthInPatterns ( ) const
int TagLib::S3M::Properties::lengthInSeconds ( ) const
unsigned char TagLib::S3M::Properties::masterVolume ( ) const
unsigned short TagLib::S3M::Properties::patternCount ( ) const
unsigned short TagLib::S3M::Properties::sampleCount ( ) const
int TagLib::S3M::Properties::sampleRate ( ) const

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

void TagLib::S3M::Properties::setBpmSpeed ( unsigned char  bpmSpeed)
void TagLib::S3M::Properties::setChannels ( int  channels)
void TagLib::S3M::Properties::setFileFormatVersion ( unsigned short  fileFormatVersion)
void TagLib::S3M::Properties::setFlags ( unsigned short  flags)
void TagLib::S3M::Properties::setGlobalVolume ( unsigned char  globalVolume)
void TagLib::S3M::Properties::setLengthInPatterns ( unsigned short  lengthInPatterns)
void TagLib::S3M::Properties::setMasterVolume ( unsigned char  masterVolume)
void TagLib::S3M::Properties::setPatternCount ( unsigned short  patternCount)
void TagLib::S3M::Properties::setSampleCount ( unsigned short  sampleCount)
void TagLib::S3M::Properties::setStereo ( bool  stereo)
void TagLib::S3M::Properties::setTempo ( unsigned char  tempo)
void TagLib::S3M::Properties::setTrackerVersion ( unsigned short  trackerVersion)
bool TagLib::S3M::Properties::stereo ( ) const
unsigned char TagLib::S3M::Properties::tempo ( ) const
unsigned short TagLib::S3M::Properties::trackerVersion ( ) const

Friends And Related Function Documentation

friend class File

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