 |
Qt 6.x
The Qt SDK
|
|
Qt 6.x
The Qt SDK
|
#include <qquick3daudioengine_p.h>
Inheritance diagram for QQuick3DAudioEngine: Collaboration diagram for QQuick3DAudioEngine:Public Types | |
| enum | OutputMode { Surround , Stereo , Headphone } |
Signals | |
| void | outputModeChanged () |
| void | outputDeviceChanged () |
| void | masterVolumeChanged () |
| 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 | |
| QQuick3DAudioEngine () | |
| \qmltype AudioEngine \inqmlmodule QtQuick3D.SpatialAudio | |
| ~QQuick3DAudioEngine () | |
| void | setOutputMode (OutputMode mode) |
| \qmlproperty enumeration AudioEngine::outputMode | |
| OutputMode | outputMode () const |
| void | setOutputDevice (const QAudioDevice &device) |
| \qmlproperty QtMultimedia.AudioDevice AudioEngine::outputDevice | |
| QAudioDevice | outputDevice () const |
| void | setMasterVolume (float volume) |
| \qmlproperty float AudioEngine::masterVolume | |
| float | masterVolume () 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. | |
| void | moveToThread (QThread *thread) |
| Changes the thread affinity for this object and its children. | |
| 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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| template<typename T > | |
| T | findChild (const QString &aName=QString(), 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 (const QString &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 > | |
| 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. | |
Static Public Member Functions | |
| static QAudioEngine * | getEngine () |
| 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) |
Properties | |
| OutputMode | outputMode |
| QAudioDevice | outputDevice |
| float | masterVolume |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
Additional Inherited Members | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| 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) | |
Definition at line 25 of file qquick3daudioengine_p.h.
| Enumerator | |
|---|---|
| Surround | |
| Stereo | |
| Headphone | |
Definition at line 35 of file qquick3daudioengine_p.h.
| QQuick3DAudioEngine::QQuick3DAudioEngine | ( | ) |
\qmltype AudioEngine \inqmlmodule QtQuick3D.SpatialAudio
AudioEngine manages sound objects inside a 3D scene.
AudioEngine manages sound objects inside a 3D scene. You can add SpatialSound objects to the scene to define sounds that happen at a specified location in 3D space. AmbientSound allows you to add a stereo overlay (for example voice over or a sound track).
You can use AudioListener to define the position of the person listening to the sound field relative to the sound sources. Sound sources will be less audible if the listener is further away from source. They will also get mapped to the corresponding loudspeakers depending on the direction between listener and source. In many cases, the AudioListener object can simply be instantiated as a child object of the QtQuick3D.Camera object.
Create AudioRoom objcects to simulate the sound (reflections and reverb) of a room with certain dimensions and different types of walls.
AudioEngine does offer a mode where Qt is using simulating the effects of the ear using head related impulse reponse functions (see also https://en.wikipedia.org/wiki/Sound_localization) to localize the sound in 3D space when using headphones and create a spatial audio effect through headphones.
As the rest of Qt Quick 3D, the audio engine uses a coordinate system that is in centimeters by default. The axes are defined so that positive x points to the right, positive y points up and positive z points backwards.
Definition at line 44 of file qquick3daudioengine.cpp.
References QObject::connect(), e, getEngine(), QAudioEngine::masterVolumeChanged(), masterVolumeChanged(), QAudioEngine::outputDeviceChanged(), outputDeviceChanged(), QAudioEngine::outputModeChanged(), and outputModeChanged().
Here is the call graph for this function:| QQuick3DAudioEngine::~QQuick3DAudioEngine | ( | ) |
Definition at line 52 of file qquick3daudioengine.cpp.
|
static |
Definition at line 117 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::start().
Referenced by QQuick3DAmbientSound::QQuick3DAmbientSound(), QQuick3DAudioEngine(), QQuick3DAudioListener::QQuick3DAudioListener(), QQuick3DAudioRoom::QQuick3DAudioRoom(), and QQuick3DSpatialSound::QQuick3DSpatialSound().
Here is the call graph for this function: Here is the caller graph for this function:| float QQuick3DAudioEngine::masterVolume | ( | ) | const |
Definition at line 112 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::masterVolume.
|
signal |
| QAudioDevice QQuick3DAudioEngine::outputDevice | ( | ) | const |
Definition at line 97 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::outputDevice.
|
signal |
| QQuick3DAudioEngine::OutputMode QQuick3DAudioEngine::outputMode | ( | ) | const |
Definition at line 82 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::outputMode.
|
signal |
| void QQuick3DAudioEngine::setMasterVolume | ( | float | volume | ) |
\qmlproperty float AudioEngine::masterVolume
Sets or returns overall volume being used to render the sound field.
Definition at line 107 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::setMasterVolume().
Here is the call graph for this function:| void QQuick3DAudioEngine::setOutputDevice | ( | const QAudioDevice & | device | ) |
\qmlproperty QtMultimedia.AudioDevice AudioEngine::outputDevice
Sets or returns the device that is being used for outputting the sound field.
Definition at line 92 of file qquick3daudioengine.cpp.
References device, globalEngine, and QAudioEngine::setOutputDevice().
Here is the call graph for this function:| void QQuick3DAudioEngine::setOutputMode | ( | OutputMode | mode | ) |
\qmlproperty enumeration AudioEngine::outputMode
Sets or retrieves the current output mode of the engine.
\table \header
Definition at line 77 of file qquick3daudioengine.cpp.
References globalEngine, and QAudioEngine::setOutputMode().
Here is the call graph for this function:
|
readwrite |
Definition at line 62 of file qquick3daudioengine_p.h.
|
readwrite |
Definition at line 62 of file qquick3daudioengine_p.h.
|
readwrite |
Definition at line 62 of file qquick3daudioengine_p.h.
1.9.7