SoundCore Class Reference

The SoundCore class provides a simple interface for audio playback. More...

#include <soundcore.h>

List of all members.

Public Slots

void setVolume (int left, int right)
bool play (const QString &source, bool queue=false, qint64 offset=-1)
void stop ()
void pause ()
void seek (qint64 pos)
const QString url () const
bool nextTrackAccepted () const

Signals

void bufferingProgress (int progress)
void elapsedChanged (qint64 time)
void bitrateChanged (int bitrate)
void frequencyChanged (quint32 frequency)
void sampleSizeChanged (int size)
void channelsChanged (int channels)
void metaDataChanged ()
void stateChanged (Qmmp::State newState)
void finished ()
void volumeChanged (int left, int right)
void eqSettingsChanged ()
void nextTrackRequest ()

Public Member Functions

 SoundCore (QObject *parent=0)
 ~SoundCore ()
qint64 totalTime () const
EqSettings eqSettings () const
void setEqSettings (const EqSettings &settings)
int leftVolume ()
int rightVolume ()
qint64 elapsed ()
int bitrate ()
quint32 frequency ()
int sampleSize ()
int channels ()
Qmmp::State state () const
QMap< Qmmp::MetaData, QString > metaData ()
QString metaData (Qmmp::MetaData key)

Static Public Member Functions

static SoundCoreinstance ()


Detailed Description

The SoundCore class provides a simple interface for audio playback.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

SoundCore ( QObject *  parent = 0  ) 

Object constructor.

Parameters:
parent Parent object.

~SoundCore (  ) 

Destructor.


Member Function Documentation

int bitrate (  ) 

Returns current bitrate (in kbps)

void bitrateChanged ( int  bitrate  )  [signal]

Emitted when bitrate has changed.

Parameters:
bitrate New bitrate (in kbps)

void 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 channels (  ) 

Returns channels number.

void channelsChanged ( int  channels  )  [signal]

Emitted when channels number has changed.

Parameters:
channels New channels number.

qint64 elapsed (  ) 

Returns the current time (in milliseconds).

void elapsedChanged ( qint64  time  )  [signal]

Tracks elapesed time.

Parameters:
time New track position in milliseconds.

EqSettings eqSettings (  )  const

Returns equalizer settings

void eqSettingsChanged (  )  [signal]

Emitted when equalizer settings have changed.

void finished (  )  [signal]

Emitted when playback has finished.

quint32 frequency (  ) 

Returns current sample rate (in Hz).

void frequencyChanged ( quint32  frequency  )  [signal]

Emitted when samplerate has changed.

Parameters:
frequency New sample rate (in Hz)

static SoundCore* instance (  )  [static]

Returns a pointer to the SoundCore instance.

int leftVolume (  ) 

Returns left volume level.

QString metaData ( Qmmp::MetaData  key  ) 

Returns the metdata string associated with the given key.

QMap<Qmmp::MetaData, QString> metaData (  ) 

Returns all meta data in map.

void metaDataChanged (  )  [signal]

Emitted when new metadata is available.

bool nextTrackAccepted (  )  const [slot]

Indicates that the current active engine will be used for the next queued track. May be useful for some effect plugins.

void nextTrackRequest (  )  [signal]

Emitted before playback ends. Use this signal to append new url to the queue.

void pause (  )  [slot]

Pauses/resumes playback

bool play ( const QString &  source,
bool  queue = false,
qint64  offset = -1 
) [slot]

This function plays file or stream with the given path source. Returns true if playback has been started successful or source is not a local file, otherwise returns false. Useful for invalid files skipping.

int rightVolume (  ) 

Returns left volume level.

int sampleSize (  ) 

Returns sample size (in bits).

void sampleSizeChanged ( int  size  )  [signal]

Emitted when sample size has changed.

Parameters:
size New sample size (in bits)

void seek ( qint64  pos  )  [slot]

This function sets the current play position to pos in milliseconds.

void setEqSettings ( const EqSettings settings  ) 

Chages equalizer settings to settings.

void setVolume ( int  left,
int  right 
) [slot]

Sets volume.

Parameters:
left - volume of the left channel [0..100].
right - volume of the right channel [0..100].

Qmmp::State state (  )  const

Returns the current state.

void stateChanged ( Qmmp::State  newState  )  [signal]

This signal is emitted when the state of the SoundCore has changed.

void stop (  )  [slot]

Stops playback

qint64 totalTime (  )  const

Returns length in milliseconds

const QString url (  )  const [slot]

This function returns file path or stream url.

void volumeChanged ( int  left,
int  right 
) [signal]

Emitted when volume has changed.

Parameters:
left Left channel volume level. It should be [0..100]
right Right channel volume level. It should be [0..100]


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

Generated on Thu Nov 10 20:39:11 2011 for Qmmp by  doxygen 1.5.9