The QAudioSink class provides an interface for sending audio data to an audio output device. More...

#include <qaudiosink.h>

Inheritance diagram for QAudioSink:

Collaboration diagram for QAudioSink:

Signals
void	stateChanged (QAudio::State state)
	This signal is emitted when the device state has changed.
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QAudioSink (const QAudioFormat &format=QAudioFormat(), QObject *parent=nullptr)
	Construct a new audio output and attach it to parent.
	QAudioSink (const QAudioDevice &audioDeviceInfo, const QAudioFormat &format=QAudioFormat(), QObject *parent=nullptr)
	Construct a new audio output and attach it to parent.
	~QAudioSink () override
	Destroys this audio output.
bool	isNull () const
	Returns `true` is the QAudioSink instance is `null`, otherwise returns `false`.
QAudioFormat	format () const
	Returns the QAudioFormat being used.
void	start (QIODevice *device)
	Starts transferring audio data from the device to the system's audio output.
QIODevice *	start ()
	Returns a pointer to the internal QIODevice being used to transfer data to the system's audio output.
void	stop ()
	Stops the audio output, detaching from the system resource.
void	reset ()
	Immediately halts audio output and discards any audio data currently in the buffers.
void	suspend ()
	Stops processing audio data, preserving buffered audio data.
void	resume ()
	Resumes processing audio data after a suspend().
void	setBufferSize (qsizetype bytes)
	Sets the audio buffer size to value in bytes.
qsizetype	bufferSize () const
	Returns the audio buffer size in bytes.
void	setBufferFrameCount (qsizetype framesCount)
	Sets the audio buffer size to value in frame count.
qsizetype	bufferFrameCount () const
	Returns the audio buffer size in frames.
qsizetype	bytesFree () const
	Returns the number of free bytes available in the audio buffer.
qsizetype	framesFree () const
	Returns the number of free frames available in the audio buffer.
qint64	processedUSecs () const
	Returns the amount of audio data processed since start() was called (in microseconds).
qint64	elapsedUSecs () const
	Returns the microseconds since start() was called, including time in Idle and Suspend states.
QtAudio::Error	error () const
	Returns the error state.
QtAudio::State	state () const
	Returns the state of audio processing.
void	setVolume (qreal)
	Sets the output volume to volume.
qreal	volume () const
	Returns the volume between 0.0 and 1.0 inclusive.
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) 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.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
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`.

Friends
class	QPlatformAudioSink

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QAudioSink class provides an interface for sending audio data to an audio output device.

\inmodule QtMultimedia

You can construct an audio output with the system's default audio output device. It is also possible to create QAudioSink with a specific QAudioDevice. When you create the audio output, you should also send in the QAudioFormat to be used for the playback (see the QAudioFormat class description for details).

To play a file:

Starting to play an audio stream is simply a matter of calling start() with a QIODevice. QAudioSink will then fetch the data it needs from the io device. So playing back an audio file is as simple as:

The file will start playing assuming that the audio system and output device support it. If you run out of luck, check what's up with the error() function.

After the file has finished playing, we need to stop the device:

At any given time, the QAudioSink will be in one of four states: active, suspended, stopped, or idle. These states are described by the QtAudio::State enum. State changes are reported through the stateChanged() signal. You can use this signal to, for instance, update the GUI of the application; the mundane example here being changing the state of a { play/pause } button. You request a state change directly with suspend(), stop(), reset(), resume(), and start().

If an error occurs, you can fetch the \l{QtAudio::Error}{error type} with the error() function. Please see the QtAudio::Error enum for a description of the possible errors that are reported. The QAudioSink will enter the \l{QtAudio::}{StoppedState} when an error is encountered.

You can check for errors by connecting to the stateChanged() signal:

See also: QAudioSource, QAudioDevice

Definition at line 23 of file qaudiosink.h.

Constructor & Destructor Documentation

◆ QAudioSink() [1/2]

QAudioSink::QAudioSink	(	const QAudioFormat &	format = QAudioFormat(),
		QObject *	parent = nullptr )

explicit

Construct a new audio output and attach it to parent.

The default audio output device is used with the output format parameters. If format is default-initialized, the format will be set to the preferred format of the audio device.

Definition at line 78 of file qaudiosink.cpp.

◆ QAudioSink() [2/2]

QAudioSink::QAudioSink	(	const QAudioDevice &	audioDevice,
		const QAudioFormat &	format = QAudioFormat(),
		QObject *	parent = nullptr )

explicit

Construct a new audio output and attach it to parent.

The device referenced by audioDevice is used with the output format parameters. If format is default-initialized, the format will be set to the preferred format of audioDevice.

Definition at line 89 of file qaudiosink.cpp.

◆ ~QAudioSink()

QAudioSink::~QAudioSink ( )

override

Destroys this audio output.

This will release any system resources used and free any buffers.

Definition at line 112 of file qaudiosink.cpp.

Member Function Documentation

◆ bufferFrameCount()

qsizetype QAudioSink::bufferFrameCount ( ) const

Returns the audio buffer size in frames.

If called before \l start(), returns platform default value. If called before start() but \l setBufferSize() or \l setBufferFrameCount() was called prior, returns value set by setBufferSize() or setBufferFrameCount(). If called after start(), returns the actual buffer size being used. This may not be what was set previously by setBufferSize() or setBufferFrameCount().

See also: bufferSize

Since: 6.10

Definition at line 353 of file qaudiosink.cpp.

◆ bufferSize()

qsizetype QAudioSink::bufferSize ( ) const

Returns the audio buffer size in bytes.

If called before \l start(), returns platform default value. If called before start() but \l setBufferSize() or \l setBufferFrameCount() was called prior, returns value set by setBufferSize() or setBufferFrameCount(). If called after start(), returns the actual buffer size being used. This may not be what was set previously by setBufferSize() or setBufferFrameCount().

See also: bufferFrameCount

Definition at line 317 of file qaudiosink.cpp.

◆ bytesFree()

qsizetype QAudioSink::bytesFree ( ) const

Returns the number of free bytes available in the audio buffer.

Note: The returned value is only valid while in QtAudio::ActiveState or QtAudio::IdleState state, otherwise returns zero.

See also: framesFree

Definition at line 270 of file qaudiosink.cpp.

◆ elapsedUSecs()

qint64 QAudioSink::elapsedUSecs ( ) const

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

Definition at line 371 of file qaudiosink.cpp.

◆ error()

QtAudio::Error QAudioSink::error ( ) const

Returns the error state.

Definition at line 379 of file qaudiosink.cpp.

◆ format()

QAudioFormat QAudioSink::format ( ) const

Returns the QAudioFormat being used.

Definition at line 121 of file qaudiosink.cpp.

◆ framesFree()

qsizetype QAudioSink::framesFree ( ) const

Returns the number of free frames available in the audio buffer.

Note: The returned value is only valid while in QtAudio::ActiveState or QtAudio::IdleState state, otherwise returns zero.

See also: bytesFree

Since: 6.10

Definition at line 285 of file qaudiosink.cpp.

◆ isNull()

bool QAudioSink::isNull ( ) const

inline

Returns true is the QAudioSink instance is null, otherwise returns false.

Definition at line 32 of file qaudiosink.h.

◆ processedUSecs()

qint64 QAudioSink::processedUSecs ( ) const

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

Definition at line 362 of file qaudiosink.cpp.

◆ reset()

void QAudioSink::reset ( )

Immediately halts audio output and discards any audio data currently in the buffers.

All pending audio data pushed to QIODevice is ignored.

See also: stop()

Definition at line 231 of file qaudiosink.cpp.

◆ resume()

void QAudioSink::resume ( )

Resumes processing audio data after a suspend().

Sets state() to the state the sink had when suspend() was called, and sets error() to QAudioError::NoError. This function does nothing if the audio sink's state is not QtAudio::SuspendedState.

Definition at line 256 of file qaudiosink.cpp.

◆ setBufferFrameCount()

void QAudioSink::setBufferFrameCount ( qsizetype value )

Sets the audio buffer size to value in frame count.

Note: This function can be called anytime before start(). Calls to this are ignored after start(). It should not be assumed that the buffer size set is the actual buffer size used - call bufferFrameCount() anytime after start() to return the actual buffer size being used.

See also: setBufferSize

Since: 6.10

Definition at line 334 of file qaudiosink.cpp.

◆ setBufferSize()

void QAudioSink::setBufferSize ( qsizetype value )

Sets the audio buffer size to value in bytes.

Note: This function can be called anytime before start(). Calls to this are ignored after start(). It should not be assumed that the buffer size set is the actual buffer size used - call bufferSize() anytime after start() to return the actual buffer size being used.

See also: setBufferFrameCount

Definition at line 300 of file qaudiosink.cpp.

◆ setVolume()

void QAudioSink::setVolume ( qreal volume )

Sets the output volume to volume.

The volume is scaled linearly from 0.0 (silence) to 1.0 (full volume). Values outside this range will be clamped.

The default volume is 1.0.

Note: Adjustments to the volume will change the volume of this audio stream, not the global volume.

UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. See QtAudio::convertVolume() for more details.

Definition at line 408 of file qaudiosink.cpp.

◆ start() [1/2]

QIODevice * QAudioSink::start ( )

Returns a pointer to the internal QIODevice being used to transfer data to the system's audio output.

The device will already be open and \l{QIODevice::write()}{write()} can write data directly to it.

Note: The pointer will become invalid after the stream is stopped or if you start another stream.

If the QAudioSink is able to access the system's audio device, state() returns QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted.

If a problem occurs during this process, error() returns QtAudio::OpenError, state() returns QtAudio::StoppedState and the stateChanged() signal is emitted.

See also: QIODevice

Definition at line 193 of file qaudiosink.cpp.

◆ start() [2/2]

void QAudioSink::start ( QIODevice * device )

Starts transferring audio data from the device to the system's audio output.

The device must have been opened in the \l{QIODevice::ReadOnly}{ReadOnly} or \l{QIODevice::ReadWrite}{ReadWrite} modes.

If the QAudioSink is able to successfully output audio data, state() returns QtAudio::ActiveState, error() returns QtAudio::NoError and the stateChanged() signal is emitted.

If a problem occurs during this process, error() returns QtAudio::OpenError, state() returns QtAudio::StoppedState and the stateChanged() signal is emitted.

See also: QIODevice

Definition at line 156 of file qaudiosink.cpp.

◆ state()

QtAudio::State QAudioSink::state ( ) const

Returns the state of audio processing.

Definition at line 387 of file qaudiosink.cpp.

◆ stateChanged

void QAudioSink::stateChanged ( QAudio::State state )

signal

This signal is emitted when the device state has changed.

This is the current state of the audio output.

Note: The QtAudio namespace was named QAudio up to and including Qt 6.6. String-based connections to this signal have to use {QAudio::State} as the parameter type: {connect(source, SIGNAL(stateChanged(QAudio::State)), ...);}

◆ stop()

void QAudioSink::stop ( )

Stops the audio output, detaching from the system resource.

Sets error() to QtAudio::NoError, state() to QtAudio::StoppedState and emit stateChanged() signal.

Note: On Linux, and Darwin, this operation synchronously drains the underlying audio buffer, which may cause delays accordingly to the buffer payload. To reset all the buffers immediately, use the method \l reset instead.

See also: reset()

Definition at line 219 of file qaudiosink.cpp.

◆ suspend()

void QAudioSink::suspend ( )

Stops processing audio data, preserving buffered audio data.

Sets error() to QtAudio::NoError, state() to QtAudio::SuspendedState and emits stateChanged() signal.

Definition at line 243 of file qaudiosink.cpp.

◆ volume()

qreal QAudioSink::volume ( ) const

Returns the volume between 0.0 and 1.0 inclusive.

Definition at line 421 of file qaudiosink.cpp.

◆ QPlatformAudioSink

friend class QPlatformAudioSink

friend

Definition at line 73 of file qaudiosink.h.

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

qtmultimedia/src/multimedia/audio/qaudiosink.h (951d5e7cab38caa03a979462e641ffa307227c9b)
qtmultimedia/src/multimedia/audio/qaudiosink.cpp (951d5e7cab38caa03a979462e641ffa307227c9b)

Signals

Public Member Functions

Friends

Additional Inherited Members