TagLib::ASF::Properties Class Reference

An implementation of ASF audio properties. More...

#include <asfproperties.h>

Inheritance diagram for TagLib::ASF::Properties:

Public Types
enum	Codec {   Unknown = 0, WMA1, WMA2, WMA9Pro,   WMA9Lossless }
	Audio codec types can be used in ASF file. More...
Public Types inherited from TagLib::AudioProperties
enum	ReadStyle { Fast, Average, Accurate }
	Reading audio properties from a file can sometimes be very time consuming and for the most accurate results can often involve reading the entire file. More...

Public Member Functions
	Properties ()
	Creates an instance of ASF::Properties. More...
virtual	~Properties ()
	Destroys this ASF::Properties instance. More...
virtual int	length () const
	Returns the length of the file in seconds. More...
int	lengthInSeconds () const
	Returns the length of the file in seconds. More...
int	lengthInMilliseconds () const
	Returns the length of the file in milliseconds. More...
virtual int	bitrate () const
	Returns the average bit rate of the file in kb/s. More...
virtual int	sampleRate () const
	Returns the sample rate in Hz. More...
virtual int	channels () const
	Returns the number of audio channels. More...
int	bitsPerSample () const
	Returns the number of bits per audio sample. More...
Codec	codec () const
	Returns the codec used in the file. More...
String	codecName () const
	Returns the concrete codec name, for example "Windows Media Audio 9.1" used in the file if available, otherwise an empty string. More...
String	codecDescription () const
	Returns the codec description, typically contains the encoder settings, for example "VBR Quality 50, 44kHz, stereo 1-pass VBR" if available, otherwise an empty string. More...
bool	isEncrypted () const
	Returns whether or not the file is encrypted. More...
void	setLength (int value)
void	setLengthInMilliseconds (int value)
void	setBitrate (int value)
void	setSampleRate (int value)
void	setChannels (int value)
void	setBitsPerSample (int value)
void	setCodec (int value)
void	setCodecName (const String &value)
void	setCodecDescription (const String &value)
void	setEncrypted (bool value)
Public Member Functions inherited from TagLib::AudioProperties
virtual	~AudioProperties ()
	Destroys this AudioProperties instance. More...
int	lengthInSeconds () const
	Returns the length of the file in seconds. More...
int	lengthInMilliseconds () const
	Returns the length of the file in milliseconds. More...

Additional Inherited Members
Protected Member Functions inherited from TagLib::AudioProperties
	AudioProperties (ReadStyle style)
	Construct an audio properties instance. More...

Detailed Description

An implementation of ASF audio properties.

Member Enumeration Documentation

Codec

enum TagLib::ASF::Properties::Codec

Audio codec types can be used in ASF file.

Enumerator
Unknown	Couldn't detect the codec.
WMA1	Windows Media Audio 1.
WMA2	Windows Media Audio 2 or above.
WMA9Pro	Windows Media Audio 9 Professional.
WMA9Lossless	Windows Media Audio 9 Lossless.

Constructor & Destructor Documentation

Properties()

TagLib::ASF::Properties::Properties

(

)

Creates an instance of ASF::Properties.

~Properties()

virtual TagLib::ASF::Properties::~Properties ( )

virtual

Destroys this ASF::Properties instance.

Member Function Documentation

bitrate()

virtual int TagLib::ASF::Properties::bitrate ( ) const

virtual

Returns the average bit rate of the file in kb/s.

Implements TagLib::AudioProperties.

bitsPerSample()

int TagLib::ASF::Properties::bitsPerSample

(

)

const

Returns the number of bits per audio sample.

channels()

virtual int TagLib::ASF::Properties::channels ( ) const

virtual

Returns the number of audio channels.

Implements TagLib::AudioProperties.

codec()

Codec TagLib::ASF::Properties::codec

(

)

const

Returns the codec used in the file.

See also

codecName()

codecDescription()

codecDescription()

String TagLib::ASF::Properties::codecDescription

(

)

const

Returns the codec description, typically contains the encoder settings, for example "VBR Quality 50, 44kHz, stereo 1-pass VBR" if available, otherwise an empty string.

See also

codec()

codecName()

codecName()

String TagLib::ASF::Properties::codecName

(

)

const

Returns the concrete codec name, for example "Windows Media Audio 9.1" used in the file if available, otherwise an empty string.

See also

codec()

codecDescription()

isEncrypted()

bool TagLib::ASF::Properties::isEncrypted

(

)

const

Returns whether or not the file is encrypted.

length()

virtual int TagLib::ASF::Properties::length ( ) const

virtual

Returns the length of the file in seconds.

The length is rounded down to the nearest whole second.

Note

This method is just an alias of lengthInSeconds().

Deprecated:

Implements TagLib::AudioProperties.

lengthInMilliseconds()

int TagLib::ASF::Properties::lengthInMilliseconds

(

)

const

Returns the length of the file in milliseconds.

See also

lengthInSeconds()

lengthInSeconds()

int TagLib::ASF::Properties::lengthInSeconds

(

)

const

Returns the length of the file in seconds.

The length is rounded down to the nearest whole second.

See also

lengthInMilliseconds()

sampleRate()

virtual int TagLib::ASF::Properties::sampleRate ( ) const

virtual

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

setBitrate()

void TagLib::ASF::Properties::setBitrate

(

int

value

)

setBitsPerSample()

void TagLib::ASF::Properties::setBitsPerSample

(

int

value

)

setChannels()

void TagLib::ASF::Properties::setChannels

(

int

value

)

setCodec()

void TagLib::ASF::Properties::setCodec

(

int

value

)

setCodecDescription()

void TagLib::ASF::Properties::setCodecDescription

(

const String &

value

)

setCodecName()

void TagLib::ASF::Properties::setCodecName

(

const String &

value

)

setEncrypted()

void TagLib::ASF::Properties::setEncrypted

(

bool

value

)

setLength()

void TagLib::ASF::Properties::setLength

(

int

value

)

setLengthInMilliseconds()

void TagLib::ASF::Properties::setLengthInMilliseconds

(

int

value

)

setSampleRate()

void TagLib::ASF::Properties::setSampleRate

(

int

value

)

---

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

• src/core/3rdparty/taglib/asfproperties.h