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
ushort lengthInPatterns () const
bool stereo () const
ushort sampleCount () const
ushort patternCount () const
ushort flags () const
ushort trackerVersion () const
ushort fileFormatVersion () const
uchar globalVolume () const
uchar masterVolume () const
uchar tempo () const
uchar bpmSpeed () const
void setChannels (int channels)
void setLengthInPatterns (ushort lengthInPatterns)
void setStereo (bool stereo)
void setSampleCount (ushort sampleCount)
void setPatternCount (ushort patternCount)
void setFlags (ushort flags)
void setTrackerVersion (ushort trackerVersion)
void setFileFormatVersion (ushort fileFormatVersion)
void setGlobalVolume (uchar globalVolume)
void setMasterVolume (uchar masterVolume)
void setTempo (uchar tempo)
void setBpmSpeed (uchar 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.

uchar TagLib::S3M::Properties::bpmSpeed ( ) const
int TagLib::S3M::Properties::channels ( ) const

Returns the number of audio channels.

Implements TagLib::AudioProperties.

ushort TagLib::S3M::Properties::fileFormatVersion ( ) const
ushort TagLib::S3M::Properties::flags ( ) const
uchar 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
ushort TagLib::S3M::Properties::lengthInPatterns ( ) const
int TagLib::S3M::Properties::lengthInSeconds ( ) const
uchar TagLib::S3M::Properties::masterVolume ( ) const
ushort TagLib::S3M::Properties::patternCount ( ) const
ushort 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 ( uchar  bpmSpeed)
void TagLib::S3M::Properties::setChannels ( int  channels)
void TagLib::S3M::Properties::setFileFormatVersion ( ushort  fileFormatVersion)
void TagLib::S3M::Properties::setFlags ( ushort  flags)
void TagLib::S3M::Properties::setGlobalVolume ( uchar  globalVolume)
void TagLib::S3M::Properties::setLengthInPatterns ( ushort  lengthInPatterns)
void TagLib::S3M::Properties::setMasterVolume ( uchar  masterVolume)
void TagLib::S3M::Properties::setPatternCount ( ushort  patternCount)
void TagLib::S3M::Properties::setSampleCount ( ushort  sampleCount)
void TagLib::S3M::Properties::setStereo ( bool  stereo)
void TagLib::S3M::Properties::setTempo ( uchar  tempo)
void TagLib::S3M::Properties::setTrackerVersion ( ushort  trackerVersion)
bool TagLib::S3M::Properties::stereo ( ) const
uchar TagLib::S3M::Properties::tempo ( ) const
ushort TagLib::S3M::Properties::trackerVersion ( ) const

Friends And Related Function Documentation

friend class File

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