StateHandler Class Reference

The StateHandler class allows to track information about playback progress. More...

#include <statehandler.h>

List of all members.

Signals
void	elapsedChanged (qint64 time)
void	bitrateChanged (int bitrate)
void	frequencyChanged (quint32 frequency)
void	precisionChanged (int precision)
void	channelsChanged (int channels)
void	metaDataChanged ()
void	stateChanged (Qmmp::State newState)
void	finished ()
void	aboutToFinish ()
void	bufferingProgress (int progress)
Public Member Functions
	StateHandler (QObject *parent=0)
	~StateHandler ()
virtual void	dispatch (qint64 elapsed, int bitrate, quint32 frequency, int precision, int channels)
virtual void	dispatch (const QMap< Qmmp::MetaData, QString > &metaData)
virtual void	dispatch (Qmmp::State state)
virtual void	dispatchBuffer (int percent)
qint64	elapsed ()
int	bitrate ()
int	frequency ()
int	precision ()
int	channels ()
Qmmp::State	state () const
QMap< Qmmp::MetaData, QString >	metaData ()
QString	metaData (Qmmp::MetaData key)
Static Public Member Functions
static StateHandler *	instance ()

---

Detailed Description

The StateHandler class allows to track information about playback progress.

Author:

Ilya Kotov <forkotov02@hotmail.ru>

---

Constructor & Destructor Documentation

StateHandler::StateHandler

(

QObject *

parent = 0

)

Object constructor.

Parameters:

parent

Parent object.

StateHandler::~StateHandler

(

)

Destructor.

---

Member Function Documentation

void StateHandler::aboutToFinish

(

)

[signal]

Emitted before the playback ends.

int StateHandler::bitrate

(

)

Returns current bitrate (in kbps)

void StateHandler::bitrateChanged

(

int

bitrate

)

[signal]

Emitted when bitrate has changed.

Parameters:

bitrate

New bitrate (in kbps)

void StateHandler::bufferingProgress

(

int

progress

)

[signal]

This signal is emitted when the stream reader fills it's buffer. The argument progress indicates the current percentage of buffering completed.

int StateHandler::channels

(

)

Returns channels number.

void StateHandler::channelsChanged

(

int

channels

)

[signal]

Emitted when channels number has changed.

Parameters:

channels

New channels number.

virtual void StateHandler::dispatch

(

Qmmp::State

state

)

[virtual]

Sends playback state.

virtual void StateHandler::dispatch

(

const QMap< Qmmp::MetaData, QString > &

metaData

)

[virtual]

Sends metadata metaData

virtual void StateHandler::dispatch	(	qint64	elapsed,
		int	bitrate,
		quint32	frequency,
		int	precision,
		int	channels
	)			[virtual]

Sends information about playback progress.

Parameters:

	elapsed	Current time (in milliseconds).
	bitrate	Current bitrate (in kbps).
	frequency	Current samplerate (in Hz).
	precision	Sample size (in bits).
	channels	Number of channels.

virtual void StateHandler::dispatchBuffer

(

int

percent

)

[virtual]

Sends buffering progress.

Parameters:

percent

Indicates the current percentage of buffering completed.

qint64 StateHandler::elapsed

(

)

Returns the current time (in milliseconds).

void StateHandler::elapsedChanged

(

qint64

time

)

[signal]

Tracks elapesed time.

Parameters:

time

New track position in milliseconds.

void StateHandler::finished

(

)

[signal]

Emitted when playback has finished.

int StateHandler::frequency

(

)

Returns current sample rate (in Hz).

void StateHandler::frequencyChanged

(

quint32

frequency

)

[signal]

Emitted when samplerate has changed.

Parameters:

frequency

New sample rate (in Hz)

static StateHandler* StateHandler::instance

(

)

[static]

Returns a pointer to the first created StateHandler instance.

QString StateHandler::metaData

(

Qmmp::MetaData

key

)

Returns the metdata string associated with the given key.

QMap<Qmmp::MetaData, QString> StateHandler::metaData

(

)

Returns all meta data in map.

void StateHandler::metaDataChanged

(

)

[signal]

Emitted when new metadata is available.

int StateHandler::precision

(

)

Returns sample size (in bits).

void StateHandler::precisionChanged

(

int

precision

)

[signal]

Emitted when sample size has changed.

Parameters:

precision

New sample size (in bits)

Qmmp::State StateHandler::state

(

)

const

Returns the current state.

void StateHandler::stateChanged

(

Qmmp::State

newState

)

[signal]

This signal is emitted when the playback state has changed.

---

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

• /usr/src/RPM/BUILD/qmmp-0.4-svn/src/qmmp/statehandler.h