TagLib API Documentation
Public Types | Public Member Functions | List of all members
TagLib::S3M::Properties Class Reference

An implementation of audio property reading for S3M. More...

#include <s3mproperties.h>

Inheritance diagram for TagLib::S3M::Properties:
[legend]
Collaboration diagram for TagLib::S3M::Properties:
[legend]

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)
 
 ~Properties () override
 
 Properties (const Properties &)=delete
 
Propertiesoperator= (const Properties &)=delete
 
int channels () const override
 
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 ()
 
 AudioProperties (const AudioProperties &)=delete
 
AudioPropertiesoperator= (const AudioProperties &)=delete
 
virtual TAGLIB_DEPRECATED int length () const
 
virtual int lengthInSeconds () const
 
virtual int lengthInMilliseconds () const
 
virtual int bitrate () const
 
virtual int sampleRate () const
 
virtual int channels () const =0
 

Additional Inherited Members

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

Detailed Description

An implementation of audio property reading for S3M.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Flag bits.

Enumerator
ST2Vibrato 
ST2Tempo 
AmigaSlides 
Vol0MixOptimizations 
AmigaLimits 
EnableFilter 
CustomData 

Constructor & Destructor Documentation

◆ Properties() [1/2]

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

◆ ~Properties()

TagLib::S3M::Properties::~Properties ( )
override

◆ Properties() [2/2]

TagLib::S3M::Properties::Properties ( const Properties )
delete

Member Function Documentation

◆ bpmSpeed()

unsigned char TagLib::S3M::Properties::bpmSpeed ( ) const

◆ channels()

int TagLib::S3M::Properties::channels ( ) const
overridevirtual

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ fileFormatVersion()

unsigned short TagLib::S3M::Properties::fileFormatVersion ( ) const

◆ flags()

unsigned short TagLib::S3M::Properties::flags ( ) const

◆ globalVolume()

unsigned char TagLib::S3M::Properties::globalVolume ( ) const

◆ lengthInPatterns()

unsigned short TagLib::S3M::Properties::lengthInPatterns ( ) const

◆ masterVolume()

unsigned char TagLib::S3M::Properties::masterVolume ( ) const

◆ operator=()

Properties & TagLib::S3M::Properties::operator= ( const Properties )
delete

◆ patternCount()

unsigned short TagLib::S3M::Properties::patternCount ( ) const

◆ sampleCount()

unsigned short TagLib::S3M::Properties::sampleCount ( ) const

◆ setBpmSpeed()

void TagLib::S3M::Properties::setBpmSpeed ( unsigned char  bpmSpeed)

◆ setChannels()

void TagLib::S3M::Properties::setChannels ( int  channels)

◆ setFileFormatVersion()

void TagLib::S3M::Properties::setFileFormatVersion ( unsigned short  fileFormatVersion)

◆ setFlags()

void TagLib::S3M::Properties::setFlags ( unsigned short  flags)

◆ setGlobalVolume()

void TagLib::S3M::Properties::setGlobalVolume ( unsigned char  globalVolume)

◆ setLengthInPatterns()

void TagLib::S3M::Properties::setLengthInPatterns ( unsigned short  lengthInPatterns)

◆ setMasterVolume()

void TagLib::S3M::Properties::setMasterVolume ( unsigned char  masterVolume)

◆ setPatternCount()

void TagLib::S3M::Properties::setPatternCount ( unsigned short  patternCount)

◆ setSampleCount()

void TagLib::S3M::Properties::setSampleCount ( unsigned short  sampleCount)

◆ setStereo()

void TagLib::S3M::Properties::setStereo ( bool  stereo)

◆ setTempo()

void TagLib::S3M::Properties::setTempo ( unsigned char  tempo)

◆ setTrackerVersion()

void TagLib::S3M::Properties::setTrackerVersion ( unsigned short  trackerVersion)

◆ stereo()

bool TagLib::S3M::Properties::stereo ( ) const

◆ tempo()

unsigned char TagLib::S3M::Properties::tempo ( ) const

◆ trackerVersion()

unsigned short TagLib::S3M::Properties::trackerVersion ( ) const

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