Okular::AudioPlayer Class Reference

#include <audioplayer.h>

Inheritance diagram for Okular::AudioPlayer:

Public Types
enum	State { PlayingState, StoppedState }

Public Member Functions
	~AudioPlayer ()
void	playSound (const Sound *sound, const SoundAction *linksound=0)
State	state () const
void	stopPlaybacks ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static AudioPlayer *	instance ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

An audio player.

Singleton utility class to play sounds in documents using the KDE sound system.

Definition at line 30 of file audioplayer.h.

Member Enumeration Documentation

enum Okular::AudioPlayer::State

The state of AudioPlayer.

Since

0.19 (KDE 4.13)

Enumerator
PlayingState	The AudioPlayer is playing a audio file.
StoppedState	The AudioPlayer isn't playing a audio file.

Definition at line 40 of file audioplayer.h.

Constructor & Destructor Documentation

AudioPlayer::~AudioPlayer

(

)

Definition at line 217 of file audioplayer.cpp.

Member Function Documentation

AudioPlayer * AudioPlayer::instance ( )

static

Gets the instance of the audio player.

Definition at line 222 of file audioplayer.cpp.

void AudioPlayer::playSound	(	const Sound *	sound,
		const SoundAction *	linksound = 0
	)

Enqueue the specified sound for playing, optionally taking more information about the playing from the soundlink .

Definition at line 228 of file audioplayer.cpp.

AudioPlayer::State AudioPlayer::state

(

)

const

Return state of sound (playing/stopped)

Since

0.19 (KDE 4.13)

Definition at line 254 of file audioplayer.cpp.

void AudioPlayer::stopPlaybacks

(

)

Tell the AudioPlayer to stop all the playbacks.

Definition at line 249 of file audioplayer.cpp.

---

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

• audioplayer.h
• audioplayer.cpp