\inmodule QtSpatialAudio More...

#include <qambientsound.h>

Inheritance diagram for QAmbientSound:

Collaboration diagram for QAmbientSound:

Public Types
enum	Loops { Infinite = -1 , Once = 1 }
	Lets you control the playback loop using the following values: More...

Public Slots
void	play ()
	Starts playing back the sound.

void	pause ()
	Pauses sound playback.

void	stop ()
	Stops sound playback and resets the current position and current loop count to 0.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	sourceChanged ()

void	loopsChanged ()

void	autoPlayChanged ()

void	volumeChanged ()

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
	QAmbientSound (QAudioEngine *engine)
	Creates a stereo sound source for engine.

	~QAmbientSound ()

void	setSource (const QUrl &url)

QUrl	source () const

int	loops () const

void	setLoops (int loops)

bool	autoPlay () const

void	setAutoPlay (bool autoPlay)

void	setVolume (float volume)

float	volume () const

QAudioEngine *	engine () const
	Returns the engine associated with this sound.

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
QUrl	source
	The source file for the sound to be played.

float	volume
	Defines the volume of the sound.

int	loops
	Determines how many times the sound is played before the player stops.

bool	autoPlay
	Determines whether the sound should automatically start playing when a source gets specified.

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QAmbientSoundPrivate

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

\inmodule QtSpatialAudio

A stereo overlay sound.

QAmbientSound represents a position and orientation independent sound. It's commonly used for background sounds (e.g. music) that is supposed to be independent of the listeners position and orientation.

Definition at line 16 of file qambientsound.h.

Member Enumeration Documentation

◆ Loops

enum QAmbientSound::Loops

Lets you control the playback loop using the following values:

\value Infinite Loops infinitely \value Once Stops playback after running once

Enumerator
Infinite
Once

Definition at line 31 of file qambientsound.h.

Constructor & Destructor Documentation

◆ QAmbientSound()

QAmbientSound::QAmbientSound ( QAudioEngine * engine )

explicit

Creates a stereo sound source for engine.

Definition at line 121 of file qambientsound.cpp.

References engine().

Here is the call graph for this function:

◆ ~QAmbientSound()

QAmbientSound::~QAmbientSound ( )

Definition at line 127 of file qambientsound.cpp.

Member Function Documentation

◆ autoPlay()

bool QAmbientSound::autoPlay ( ) const

Definition at line 213 of file qambientsound.cpp.

References QBasicAtomicInteger< T >::loadRelaxed(), and QAmbientSoundPrivate::m_autoPlay.

Here is the call graph for this function:

◆ autoPlayChanged

void QAmbientSound::autoPlayChanged ( )

signal

Referenced by QQuick3DAmbientSound::QQuick3DAmbientSound(), and setAutoPlay().

Here is the caller graph for this function:

◆ engine()

QAudioEngine * QAmbientSound::engine ( ) const

Returns the engine associated with this sound.

Definition at line 276 of file qambientsound.cpp.

References QAmbientSoundPrivate::engine.

Referenced by QAmbientSound().

Here is the caller graph for this function:

◆ loops()

int QAmbientSound::loops ( ) const

Definition at line 193 of file qambientsound.cpp.

References QBasicAtomicInteger< T >::loadRelaxed(), and QAmbientSoundPrivate::m_loops.

Here is the call graph for this function:

◆ loopsChanged

void QAmbientSound::loopsChanged ( )

signal

Referenced by QQuick3DAmbientSound::QQuick3DAmbientSound(), and setLoops().

Here is the caller graph for this function:

◆ pause

void QAmbientSound::pause ( )

slot

Pauses sound playback.

Calling play() will continue playback.

Definition at line 236 of file qambientsound.cpp.

References QAmbientSoundPrivate::pause().

Referenced by QQuick3DAmbientSound::pause().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ play

void QAmbientSound::play ( )

slot

Starts playing back the sound.

Does nothing if the sound is already playing.

Definition at line 228 of file qambientsound.cpp.

References QAmbientSoundPrivate::play().

Referenced by QQuick3DAmbientSound::play().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoPlay()

void QAmbientSound::setAutoPlay ( bool autoPlay )

Definition at line 218 of file qambientsound.cpp.

References autoPlay, autoPlayChanged(), emit, QBasicAtomicInteger< T >::fetchAndStoreRelaxed(), and QAmbientSoundPrivate::m_autoPlay.

Referenced by QQuick3DAmbientSound::setAutoPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLoops()

void QAmbientSound::setLoops ( int loops )

Definition at line 198 of file qambientsound.cpp.

References emit, QBasicAtomicInteger< T >::fetchAndStoreRelaxed(), loops, loopsChanged(), and QAmbientSoundPrivate::m_loops.

Referenced by QQuick3DAmbientSound::setLoops().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSource()

void QAmbientSound::setSource ( const QUrl & url )

Definition at line 157 of file qambientsound.cpp.

References emit, QAmbientSoundPrivate::load(), sourceChanged(), url, and QAmbientSoundPrivate::url.

Referenced by QQuick3DAmbientSound::setSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVolume()

void QAmbientSound::setVolume ( float volume )

Definition at line 141 of file qambientsound.cpp.

References emit, QAmbientSoundPrivate::engine, QAudioEnginePrivate::get(), QAmbientSoundPrivate::sourceId, volume, QAmbientSoundPrivate::volume, and volumeChanged().

Referenced by QQuick3DAmbientSound::setVolume().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ source()

QUrl QAmbientSound::source ( ) const

Definition at line 172 of file qambientsound.cpp.

References QAmbientSoundPrivate::url.

◆ sourceChanged

void QAmbientSound::sourceChanged ( )

signal

Referenced by QQuick3DAmbientSound::QQuick3DAmbientSound(), and setSource().

Here is the caller graph for this function:

◆ stop

void QAmbientSound::stop ( )

slot

Stops sound playback and resets the current position and current loop count to 0.

Calling play() will start playback at the beginning of the sound file.

Definition at line 245 of file qambientsound.cpp.

References QAmbientSoundPrivate::stop().

Referenced by QQuick3DAmbientSound::stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ volume()

float QAmbientSound::volume ( ) const

Definition at line 152 of file qambientsound.cpp.

References QAmbientSoundPrivate::volume.

◆ volumeChanged

void QAmbientSound::volumeChanged ( )

signal

Referenced by QQuick3DAmbientSound::QQuick3DAmbientSound(), and setVolume().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QAmbientSoundPrivate

friend class QAmbientSoundPrivate

friend

Definition at line 62 of file qambientsound.h.

Property Documentation

◆ autoPlay

QAmbientSound::autoPlay

readwrite

Determines whether the sound should automatically start playing when a source gets specified.

The default value is true.

Definition at line 22 of file qambientsound.h.

Referenced by QQuick3DAmbientSound::autoPlay(), and setAutoPlay().

◆ loops

QAmbientSound::loops

readwrite

Determines how many times the sound is played before the player stops.

Set to QAmbientSound::Infinite to play the current sound in a loop forever.

The default value is 1.

Definition at line 21 of file qambientsound.h.

Referenced by QQuick3DAmbientSound::loops(), and setLoops().

◆ source

QAmbientSound::source

readwrite

The source file for the sound to be played.

Definition at line 19 of file qambientsound.h.

Referenced by QQuick3DAmbientSound::source().

◆ volume

QAmbientSound::volume

readwrite

Defines the volume of the sound.

Values between 0 and 1 will attenuate the sound, while values above 1 provide an additional gain boost.

Definition at line 20 of file qambientsound.h.

Referenced by setVolume(), and QQuick3DAmbientSound::volume().

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

qtmultimedia/src/spatialaudio/qambientsound.h (e9abd242abfbc368478f7be3e2923e7b100a9386)
qtmultimedia/src/spatialaudio/qambientsound.cpp (649d7ada752792ca0b3ec5d1cc1077ca4426443d)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Loops

Constructor & Destructor Documentation

◆ QAmbientSound()

◆ ~QAmbientSound()

Member Function Documentation

◆ autoPlay()

◆ autoPlayChanged

◆ engine()

◆ loops()

◆ loopsChanged

◆ pause

◆ play

◆ setAutoPlay()

◆ setLoops()

◆ setSource()

◆ setVolume()

◆ source()

◆ sourceChanged

◆ stop

◆ volume()

◆ volumeChanged

Friends And Related Symbol Documentation

◆ QAmbientSoundPrivate

Property Documentation

◆ autoPlay

◆ loops

◆ source

◆ volume