Qt 4.8
Signals | Public Functions | List of all members
QAbstractAudioOutput Class Referenceabstract

The QAbstractAudioOutput class provides access for QAudioOutput to access the audio device provided by the plugin. More...

#include <qaudioengine.h>

Inheritance diagram for QAbstractAudioOutput:
QObject QAudioOutputPrivate QAudioOutputPrivate QAudioOutputPrivate QNullOutputDevice

Signals

void notify ()
 This signal is emitted when x ms of audio data has been processed the interval set by setNotifyInterval(x). More...
 
void stateChanged (QAudio::State)
 This signal is emitted when the device state has changed. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

virtual int bufferSize () const =0
 Returns the audio buffer size in bytes. More...
 
virtual int bytesFree () const =0
 Returns the free space available in bytes in the audio buffer. More...
 
virtual qint64 elapsedUSecs () const =0
 Returns the milliseconds since start() was called, including time in Idle and suspend states. More...
 
virtual QAudio::Error error () const =0
 Returns the error state. More...
 
virtual QAudioFormat format () const =0
 Returns the QAudioFormat being used. More...
 
virtual int notifyInterval () const =0
 Returns the notify interval in milliseconds. More...
 
virtual int periodSize () const =0
 Returns the period size in bytes. More...
 
virtual qint64 processedUSecs () const =0
 Returns the amount of audio data processed since start() was called in milliseconds. More...
 
virtual void reset ()=0
 Drops all audio data in the buffers, resets buffers to zero. More...
 
virtual void resume ()=0
 Resumes processing audio data after a suspend() More...
 
virtual void setBufferSize (int value)=0
 Sets the audio buffer size to value in bytes. More...
 
virtual void setNotifyInterval (int milliSeconds)=0
 Sets the interval for notify() signal to be emitted. More...
 
virtual QIODevicestart (QIODevice *device)=0
 Uses the device as the QIODevice to transfer data. More...
 
virtual QAudio::State state () const =0
 Returns the state of audio processing. More...
 
virtual void stop ()=0
 Stops the audio output. More...
 
virtual void suspend ()=0
 Stops processing audio data, preserving buffered audio data. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QAbstractAudioOutput class provides access for QAudioOutput to access the audio device provided by the plugin.

Warning
This function is not part of the public interface.

QAbstractAudioOutput implements audio functionality for QAudioOutput, i.e., QAudioOutput routes function calls to QAbstractAudioOutput. For a description of the functionality that is implemented, see the QAudioOutput class and function descriptions.

See also
QAudioOutput

Definition at line 73 of file qaudioengine.h.

Functions

◆ bufferSize()

int QAbstractAudioOutput::bufferSize ( ) const
pure virtual

Returns the audio buffer size in bytes.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::bufferSize().

◆ bytesFree()

int QAbstractAudioOutput::bytesFree ( ) const
pure virtual

Returns the free space available in bytes in the audio buffer.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::bytesFree().

◆ elapsedUSecs()

qint64 QAbstractAudioOutput::elapsedUSecs ( ) const
pure virtual

Returns the milliseconds since start() was called, including time in Idle and suspend states.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::elapsedUSecs().

◆ error()

QAudio::Error QAbstractAudioOutput::error ( ) const
pure virtual

Returns the error state.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::error().

◆ format()

QAudioFormat QAbstractAudioOutput::format ( ) const
pure virtual

◆ notify

QAbstractAudioOutput::notify ( )
signal

This signal is emitted when x ms of audio data has been processed the interval set by setNotifyInterval(x).

Referenced by QAudioOutputPrivate::deviceReady(), and QAudioOutputPrivate::freeBlocks().

◆ notifyInterval()

int QAbstractAudioOutput::notifyInterval ( ) const
pure virtual

Returns the notify interval in milliseconds.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::notifyInterval().

◆ periodSize()

int QAbstractAudioOutput::periodSize ( ) const
pure virtual

Returns the period size in bytes.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::periodSize().

◆ processedUSecs()

qint64 QAbstractAudioOutput::processedUSecs ( ) const
pure virtual

Returns the amount of audio data processed since start() was called in milliseconds.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::processedUSecs().

◆ reset()

void QAbstractAudioOutput::reset ( )
pure virtual

Drops all audio data in the buffers, resets buffers to zero.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::reset().

◆ resume()

void QAbstractAudioOutput::resume ( )
pure virtual

Resumes processing audio data after a suspend()

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::resume().

◆ setBufferSize()

void QAbstractAudioOutput::setBufferSize ( int  value)
pure virtual

Sets the audio buffer size to value in bytes.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::setBufferSize().

◆ setNotifyInterval()

void QAbstractAudioOutput::setNotifyInterval ( int  ms)
pure virtual

Sets the interval for notify() signal to be emitted.

This is based on the ms of audio data processed not on actual real-time. The resolution of the timer is platform specific.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::setNotifyInterval().

◆ start()

QIODevice * QAbstractAudioOutput::start ( QIODevice device)
pure virtual

Uses the device as the QIODevice to transfer data.

If device is null then the class creates an internal QIODevice. Returns a pointer to the QIODevice being used to handle the data transfer. This QIODevice can be used to write() audio data directly. Passing a QIODevice allows the data to be transferred without any extra code.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::start().

◆ state()

QAudio::State QAbstractAudioOutput::state ( ) const
pure virtual

Returns the state of audio processing.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::state().

◆ stateChanged

QAbstractAudioOutput::stateChanged ( QAudio::State  state)
signal

◆ stop()

void QAbstractAudioOutput::stop ( )
pure virtual

Stops the audio output.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::stop().

◆ suspend()

void QAbstractAudioOutput::suspend ( )
pure virtual

Stops processing audio data, preserving buffered audio data.

Implemented in QAudioOutputPrivate, QNullOutputDevice, QAudioOutputPrivate, and QAudioOutputPrivate.

Referenced by QAudioOutput::suspend().


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