\qmltype AudioOutput \instantiates QAudioOutput More...

#include <qaudiooutput.h>

Inheritance diagram for QAudioOutput:

Collaboration diagram for QAudioOutput:

Public Slots
void	setDevice (const QAudioDevice &device)

void	setVolume (float volume)

void	setMuted (bool muted)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	deviceChanged ()

void	volumeChanged (float volume)

void	mutedChanged (bool muted)

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
	QAudioOutput (QObject *parent=nullptr)

	QAudioOutput (const QAudioDevice &device, QObject *parent=nullptr)

	~QAudioOutput ()

QAudioDevice	device () const

float	volume () const

bool	isMuted () const

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	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`.

Properties
QAudioDevice	device
	\qmlproperty AudioDevice QtMultimedia::AudioOutput::device

float	volume
	\qmlproperty real QtMultimedia::AudioOutput::volume

bool	muted
	\qmlproperty bool QtMultimedia::AudioOutput::muted

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QMediaCaptureSession

class	QMediaPlayer

Additional Inherited Members
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

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

\qmltype AudioOutput \instantiates QAudioOutput

An audio output to be used for playback or monitoring of a capture session.

\inqmlmodule QtMultimedia

\qml MediaPlayer { id: playMusic source: "music.wav" audioOutput: AudioOutput { volume: slider.value } } Slider { id: slider from: 0. to: 1. } \endqml

You can use AudioOutput together with a QtMultiMedia::MediaPlayer to play audio content, or you can use it in conjunction with a MultiMedia::CaptureSession to monitor the audio processed by the capture session.

See also: VideoOutput, AudioInput

Represents an output channel for audio. \inmodule QtMultimedia

Since: 6.0

This class represents an output channel that can be used together with QMediaPlayer or QMediaCaptureSession. It enables the selection of the physical output device to be used, muting the channel, and changing the channel's volume.

Definition at line 18 of file qaudiooutput.h.

Constructor & Destructor Documentation

◆ QAudioOutput() [1/2]

QAudioOutput::QAudioOutput ( QObject * parent = nullptr )

explicit

Definition at line 54 of file qaudiooutput.cpp.

◆ QAudioOutput() [2/2]

QAudioOutput::QAudioOutput	(	const QAudioDevice &	device,
		QObject *	parent = nullptr )

explicit

Definition at line 59 of file qaudiooutput.cpp.

References QMediaDevices::defaultAudioOutput, device, QPlatformAudioOutput::device, QPlatformMediaIntegration::instance(), QAudioDevice::mode, QAudioDevice::Output, qWarning, and QPlatformAudioOutput::setAudioDevice().

Here is the call graph for this function:

◆ ~QAudioOutput()

QAudioOutput::~QAudioOutput ( )

Definition at line 73 of file qaudiooutput.cpp.

Member Function Documentation

◆ device()

QAudioDevice QAudioOutput::device ( ) const

Definition at line 177 of file qaudiooutput.cpp.

References QPlatformAudioOutput::device.

◆ deviceChanged

void QAudioOutput::deviceChanged ( )

signal

Referenced by QFFmpeg::AudioRenderer::AudioRenderer(), QWindowsMediaDeviceSession::setAudioOutput(), AVFCameraService::setAudioOutput(), MFPlayerSession::setAudioOutput(), QAndroidCaptureSession::setAudioOutput(), QAndroidMediaPlayer::setAudioOutput(), AVFMediaPlayer::setAudioOutput(), QFFmpegMediaCaptureSession::setAudioOutput(), and setDevice().

Here is the caller graph for this function:

◆ isMuted()

bool QAudioOutput::isMuted ( ) const

Definition at line 143 of file qaudiooutput.cpp.

References QPlatformAudioOutput::muted.

Referenced by MFPlayerSession::setAudioOutput(), and QFFmpeg::AudioRenderer::updateVolume().

Here is the caller graph for this function:

◆ mutedChanged

void QAudioOutput::mutedChanged ( bool muted )

signal

References d.

Referenced by QFFmpeg::AudioRenderer::AudioRenderer(), QWindowsMediaDeviceSession::setAudioOutput(), AVFCameraService::setAudioOutput(), QQnxMediaPlayer::setAudioOutput(), MFPlayerSession::setAudioOutput(), QAndroidMediaPlayer::setAudioOutput(), AVFMediaPlayer::setAudioOutput(), QFFmpegMediaCaptureSession::setAudioOutput(), and setMuted().

Here is the caller graph for this function:

◆ setDevice

void QAudioOutput::setDevice ( const QAudioDevice & device )

slot

Definition at line 182 of file qaudiooutput.cpp.

References QMediaDevices::defaultAudioOutput, device, QPlatformAudioOutput::device, deviceChanged(), emit, QAudioDevice::Output, and QPlatformAudioOutput::setAudioDevice().

Here is the call graph for this function:

◆ setMuted

void QAudioOutput::setMuted ( bool muted )

slot

Definition at line 148 of file qaudiooutput.cpp.

References emit, muted, QPlatformAudioOutput::muted, mutedChanged(), and QPlatformAudioOutput::setMuted().

Here is the call graph for this function:

◆ setVolume

void QAudioOutput::setVolume ( float volume )

slot

Definition at line 119 of file qaudiooutput.cpp.

References emit, qBound(), QPlatformAudioOutput::setVolume(), volume, QPlatformAudioOutput::volume, and volumeChanged().

Here is the call graph for this function:

◆ volume()

float QAudioOutput::volume ( ) const

Definition at line 114 of file qaudiooutput.cpp.

References QPlatformAudioOutput::volume.

◆ volumeChanged

void QAudioOutput::volumeChanged ( float volume )

signal

Referenced by QFFmpeg::AudioRenderer::AudioRenderer(), QWindowsMediaDeviceSession::setAudioOutput(), AVFCameraService::setAudioOutput(), QQnxMediaPlayer::setAudioOutput(), MFPlayerSession::setAudioOutput(), QAndroidMediaPlayer::setAudioOutput(), AVFMediaPlayer::setAudioOutput(), QFFmpegMediaCaptureSession::setAudioOutput(), and setVolume().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

friend class QMediaCaptureSession

friend

Definition at line 47 of file qaudiooutput.h.

◆ QMediaPlayer

friend class QMediaPlayer

friend

Definition at line 48 of file qaudiooutput.h.

Property Documentation

◆ device

QAudioOutput::device

readwrite

\qmlproperty AudioDevice QtMultimedia::AudioOutput::device

This property describes the audio device connected to this output.

The device property represents the audio device this output is connected to. This property can be used to select an output device from the QtMultimedia::MediaDevices::audioOutputs() list.

The audio device connected to this output.

The device property represents the audio device this output is connected to. This property can be used to select an output device from the QMediaDevices::audioOutputs() list. You can select the system default audio output by setting this property to a default constructed QAudioDevice object.

Definition at line 21 of file qaudiooutput.h.

Referenced by QAudioOutput(), QWindowsMediaDeviceSession::audioOutputDeviceChanged(), QWindowsMediaDeviceSession::setAudioOutput(), setDevice(), QWasmMediaPlayer::updateAudioDevice(), and QFFmpeg::AudioRenderer::updateOutput().

◆ muted

QAudioOutput::muted

readwrite

\qmlproperty bool QtMultimedia::AudioOutput::muted

This property holds whether the audio output is muted.

Defaults to {false}.

The muted state of the current media.

The value will be true if the output is muted; otherwise {false}.

Definition at line 23 of file qaudiooutput.h.

Referenced by setMuted().

◆ volume

QAudioOutput::volume

readwrite

\qmlproperty real QtMultimedia::AudioOutput::volume

This property holds the volume of the audio output.

The volume is scaled linearly from 0.0 (silence) to 1.0 (full volume). Values outside this range will be clamped: a value lower than 0.0 is set to 0.0, a value higher than 1.0 will set to 1.0.

The default volume is {1.0}.

UI \l{volume controls} should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived \l{loudness}, which is what a user would normally expect from a volume control.

See \l {QtAudio::convertVolume()}{QtMultimedia.convertVolume()} for more details.

The current volume.

The volume is scaled linearly, ranging from 0 (silence) to 1 (full volume).

Note: values outside this range will be clamped.

By default the volume is 1.

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 also: QtAudio::convertVolume()

Definition at line 22 of file qaudiooutput.h.

Referenced by MFPlayerSession::setAudioOutput(), setVolume(), and QFFmpeg::AudioRenderer::updateVolume().

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

qtmultimedia/src/multimedia/audio/qaudiooutput.h (edaec2bf714c98d65f12c8ed9a2ffbd1603635a7)
qtmultimedia/src/multimedia/audio/qaudiooutput.cpp (832ce83750bb870d8433c44c5a0d7e6f18e9c513)

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QAudioOutput() [1/2]

◆ QAudioOutput() [2/2]

◆ ~QAudioOutput()

Member Function Documentation

◆ device()

◆ deviceChanged

◆ isMuted()

◆ mutedChanged

◆ setDevice

◆ setMuted

◆ setVolume

◆ volume()

◆ volumeChanged

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

◆ QMediaPlayer

Property Documentation

◆ device

◆ muted

◆ volume