#include <qquick3dambientsound_p.h>

Inheritance diagram for QQuick3DAmbientSound:

Collaboration diagram for QQuick3DAmbientSound:

Public Types
enum	Loops { Infinite = -1 , Once = 1 }

Public Slots
void	play ()
	\qmlmethod AmbientSound::play()

void	pause ()
	\qmlmethod AmbientSound::pause()

void	stop ()
	\qmlmethod AmbientSound::stop()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	sourceChanged ()

void	volumeChanged ()

void	loopsChanged ()

void	autoPlayChanged ()

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
	QQuick3DAmbientSound ()
	\qmltype AmbientSound \inqmlmodule QtQuick3D.SpatialAudio

	~QQuick3DAmbientSound ()

void	setSource (QUrl source)

QUrl	source () const
	\qmlproperty url AmbientSound::source

void	setVolume (float volume)
	\qmlproperty float AmbientSound::volume

float	volume () const

int	loops () const
	\qmlproperty int AmbientSound::loops

void	setLoops (int loops)

bool	autoPlay () const
	\qmlproperty bool AmbientSound::autoPlay

void	setAutoPlay (bool autoPlay)

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

float	volume

int	loops

bool	autoPlay

Properties inherited from QObject
QString	objectName
	the name of this object

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

Definition at line 25 of file qquick3dambientsound_p.h.

Member Enumeration Documentation

◆ Loops

enum QQuick3DAmbientSound::Loops

Enumerator
Infinite
Once

Definition at line 44 of file qquick3dambientsound_p.h.

Constructor & Destructor Documentation

◆ QQuick3DAmbientSound()

QT_BEGIN_NAMESPACE QQuick3DAmbientSound::QQuick3DAmbientSound ( )

\qmltype AmbientSound \inqmlmodule QtQuick3D.SpatialAudio

A stereo overlay sound.

A AmbientSound 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 26 of file qquick3dambientsound.cpp.

References QAmbientSound::autoPlayChanged(), autoPlayChanged(), QObject::connect(), QQuick3DAudioEngine::getEngine(), QAmbientSound::loopsChanged(), loopsChanged(), QAmbientSound::sourceChanged(), sourceChanged(), QAmbientSound::volumeChanged(), and volumeChanged().

Here is the call graph for this function:

◆ ~QQuick3DAmbientSound()

QQuick3DAmbientSound::~QQuick3DAmbientSound ( )

Definition at line 36 of file qquick3dambientsound.cpp.

Member Function Documentation

◆ autoPlay()

bool QQuick3DAmbientSound::autoPlay ( ) const

\qmlproperty bool AmbientSound::autoPlay

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

The default value is true.

Definition at line 105 of file qquick3dambientsound.cpp.

References QAmbientSound::autoPlay.

◆ autoPlayChanged

void QQuick3DAmbientSound::autoPlayChanged ( )

signal

Referenced by QQuick3DAmbientSound().

Here is the caller graph for this function:

◆ loops()

int QQuick3DAmbientSound::loops ( ) const

\qmlproperty int AmbientSound::loops

Determines how often the sound is played before the player stops. Set to QAmbienSound::Infinite to loop the current sound forever.

The default value is 1.

Definition at line 87 of file qquick3dambientsound.cpp.

References QAmbientSound::loops.

◆ loopsChanged

void QQuick3DAmbientSound::loopsChanged ( )

signal

Referenced by QQuick3DAmbientSound().

Here is the caller graph for this function:

◆ pause

void QQuick3DAmbientSound::pause ( )

slot

\qmlmethod AmbientSound::pause()

Pauses sound playback at the current position. Calling play() will continue playback.

Definition at line 130 of file qquick3dambientsound.cpp.

References QAmbientSound::pause().

Here is the call graph for this function:

◆ play

void QQuick3DAmbientSound::play ( )

slot

\qmlmethod AmbientSound::play()

Starts playing back the sound. Does nothing if the sound is already playing.

Definition at line 120 of file qquick3dambientsound.cpp.

References QAmbientSound::play().

Here is the call graph for this function:

◆ setAutoPlay()

void QQuick3DAmbientSound::setAutoPlay ( bool autoPlay )

Definition at line 110 of file qquick3dambientsound.cpp.

References autoPlay, and QAmbientSound::setAutoPlay().

Here is the call graph for this function:

◆ setLoops()

void QQuick3DAmbientSound::setLoops ( int loops )

Definition at line 92 of file qquick3dambientsound.cpp.

References loops, and QAmbientSound::setLoops().

Here is the call graph for this function:

◆ setSource()

void QQuick3DAmbientSound::setSource ( QUrl source )

Definition at line 51 of file qquick3dambientsound.cpp.

References context, QDir::currentPath(), QUrl::fromLocalFile(), qmlContext(), QUrl::resolved(), QAmbientSound::setSource(), and url.

Here is the call graph for this function:

◆ setVolume()

void QQuick3DAmbientSound::setVolume ( float volume )

\qmlproperty float AmbientSound::volume

Defines an overall volume for this sound source.

Definition at line 69 of file qquick3dambientsound.cpp.

References QAmbientSound::setVolume(), and volume.

Here is the call graph for this function:

◆ source()

QUrl QQuick3DAmbientSound::source ( ) const

\qmlproperty url AmbientSound::source

The source file for the sound to be played.

Definition at line 46 of file qquick3dambientsound.cpp.

References QAmbientSound::source.

◆ sourceChanged

void QQuick3DAmbientSound::sourceChanged ( )

signal

Referenced by QQuick3DAmbientSound().

Here is the caller graph for this function:

◆ stop

void QQuick3DAmbientSound::stop ( )

slot

\qmlmethod AmbientSound::stop()

Stops sound playback and resets the current position and loop count to 0. Calling play() will begin playback at the beginning of the sound file.

Definition at line 141 of file qquick3dambientsound.cpp.

References QAmbientSound::stop().

Here is the call graph for this function:

◆ volume()

float QQuick3DAmbientSound::volume ( ) const

Definition at line 74 of file qquick3dambientsound.cpp.

References QAmbientSound::volume.

◆ volumeChanged

void QQuick3DAmbientSound::volumeChanged ( )

signal

Referenced by QQuick3DAmbientSound().

Here is the caller graph for this function:

Property Documentation

◆ autoPlay

bool QQuick3DAmbientSound::autoPlay

readwrite

Definition at line 31 of file qquick3dambientsound_p.h.

Referenced by setAutoPlay().

◆ loops

int QQuick3DAmbientSound::loops

readwrite

Definition at line 30 of file qquick3dambientsound_p.h.

Referenced by setLoops().

◆ source

QUrl QQuick3DAmbientSound::source

readwrite

Definition at line 28 of file qquick3dambientsound_p.h.

◆ volume

float QQuick3DAmbientSound::volume

readwrite

Definition at line 29 of file qquick3dambientsound_p.h.

Referenced by setVolume().

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

qtmultimedia/src/spatialaudioquick3d/qquick3dambientsound_p.h (af230ee4c9437f8aba59b79f33c8716592de8a26)
qtmultimedia/src/spatialaudioquick3d/qquick3dambientsound.cpp (428d059141f9f2a01b44f8f66909a9447582d74a)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Loops

Constructor & Destructor Documentation

◆ QQuick3DAmbientSound()

◆ ~QQuick3DAmbientSound()

Member Function Documentation

◆ autoPlay()

◆ autoPlayChanged

◆ loops()

◆ loopsChanged

◆ pause

◆ play

◆ setAutoPlay()

◆ setLoops()

◆ setSource()

◆ setVolume()

◆ source()

◆ sourceChanged

◆ stop

◆ volume()

◆ volumeChanged

Property Documentation

◆ autoPlay

◆ loops

◆ source

◆ volume