Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuick3DSpatialSound Class Reference

#include <qquick3dspatialsound_p.h>

+ Inheritance diagram for QQuick3DSpatialSound:
+ Collaboration diagram for QQuick3DSpatialSound:

Public Types

enum  DistanceModel { Logarithmic , Linear , ManualAttenuation }
 
enum  Loops { Infinite = -1 , Once = 1 }
 
- Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
 
enum  StaticFlags { None }
 

Public Slots

void play ()
 \qmlmethod SpatialSound::play()
 
void pause ()
 \qmlmethod SpatialSound::pause()
 
void stop ()
 \qmlmethod SpatialSound::stop()
 
- Public Slots inherited from QQuick3DNode
void setX (float x)
 
void setY (float y)
 
void setZ (float z)
 
void setRotation (const QQuaternion &rotation)
 
void setEulerRotation (const QVector3D &eulerRotation)
 
void setPosition (const QVector3D &position)
 
void setScale (const QVector3D &scale)
 
void setPivot (const QVector3D &pivot)
 
void setLocalOpacity (float opacity)
 
void setVisible (bool visible)
 
void setStaticFlags (int staticFlags)
 
- Public Slots inherited from QQuick3DObject
void update ()
 
void setParentItem (QQuick3DObject *parentItem)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void sourceChanged ()
 
void volumeChanged ()
 
void distanceModelChanged ()
 
void sizeChanged ()
 
void distanceCutoffChanged ()
 
void manualAttenuationChanged ()
 
void occlusionIntensityChanged ()
 
void directivityChanged ()
 
void directivityOrderChanged ()
 
void nearFieldGainChanged ()
 
void loopsChanged ()
 
void autoPlayChanged ()
 
- Signals inherited from QQuick3DNode
void xChanged ()
 
void yChanged ()
 
void zChanged ()
 
void rotationChanged ()
 
void eulerRotationChanged ()
 
void positionChanged ()
 
void scaleChanged ()
 
void pivotChanged ()
 
void localOpacityChanged ()
 
void visibleChanged ()
 
void forwardChanged ()
 
void upChanged ()
 
void rightChanged ()
 
void sceneTransformChanged ()
 
void scenePositionChanged ()
 
void sceneRotationChanged ()
 
void sceneScaleChanged ()
 
void staticFlagsChanged ()
 
- Signals inherited from QQuick3DObject
void parentChanged ()
 
void childrenChanged ()
 
void stateChanged ()
 
- 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

 QQuick3DSpatialSound ()
 \qmltype SpatialSound \inqmlmodule QtQuick3D.SpatialAudio
 
 ~QQuick3DSpatialSound ()
 
void setSource (QUrl source)
 
QUrl source () const
 \qmlproperty url SpatialSound::source
 
void setVolume (float volume)
 \qmlproperty float SpatialSound::volume
 
float volume () const
 
 Q_ENUM (DistanceModel)
 
void setDistanceModel (DistanceModel model)
 \qmlproperty enumeration SpatialSound::distanceModel
 
DistanceModel distanceModel () const
 
void setSize (float min)
 \qmlproperty float SpatialSound::size
 
float size () const
 
void setDistanceCutoff (float max)
 \qmlproperty float SpatialSound::distanceCutoff
 
float distanceCutoff () const
 
void setManualAttenuation (float attenuation)
 \qmlproperty float SpatialSound::manualAttenuation
 
float manualAttenuation () const
 
void setOcclusionIntensity (float occlusion)
 \qmlproperty float SpatialSound::occlusionIntensity
 
float occlusionIntensity () const
 
void setDirectivity (float alpha)
 \qmlproperty float SpatialSound::directivity
 
float directivity () const
 
void setDirectivityOrder (float alpha)
 \qmlproperty float SpatialSound::directivityOrder
 
float directivityOrder () const
 
void setNearFieldGain (float gain)
 \qmlproperty float SpatialSound::nearFieldGain
 
float nearFieldGain () const
 
int loops () const
 \qmlproperty int SpatialSound::loops
 
void setLoops (int loops)
 
bool autoPlay () const
 \qmlproperty bool SpatialSound::autoPlay
 
void setAutoPlay (bool autoPlay)
 
- Public Member Functions inherited from QQuick3DNode
 QQuick3DNode (QQuick3DNode *parent=nullptr)
 \qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
 
 ~QQuick3DNode () override
 
float x () const
 \qmlproperty real QtQuick3D::Node::x
 
float y () const
 \qmlproperty real QtQuick3D::Node::y
 
float z () const
 \qmlproperty real QtQuick3D::Node::z
 
QQuaternion rotation () const
 \qmlproperty quaternion QtQuick3D::Node::rotation
 
QVector3D eulerRotation () const
 \qmlproperty vector3d QtQuick3D::Node::eulerRotation
 
QVector3D position () const
 \qmlproperty vector3d QtQuick3D::Node::position
 
QVector3D scale () const
 \qmlproperty vector3d QtQuick3D::Node::scale
 
QVector3D pivot () const
 \qmlproperty vector3d QtQuick3D::Node::pivot
 
float localOpacity () const
 \qmlproperty real QtQuick3D::Node::opacity
 
bool visible () const
 \qmlproperty bool QtQuick3D::Node::visible
 
int staticFlags () const
 \qmlproperty int QtQuick3D::Node::staticFlags
 
QQuick3DNodeparentNode () const
 
QVector3D forward () const
 \qmlproperty vector3d QtQuick3D::Node::forward \readonly
 
QVector3D up () const
 \qmlproperty vector3d QtQuick3D::Node::up \readonly
 
QVector3D right () const
 \qmlproperty vector3d QtQuick3D::Node::right \readonly
 
QVector3D scenePosition () const
 \qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
 
QQuaternion sceneRotation () const
 \qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
 
QVector3D sceneScale () const
 \qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
 
QMatrix4x4 sceneTransform () const
 \qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
 
Q_INVOKABLE void rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
 \qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
 
Q_INVOKABLE QVector3D mapPositionToScene (const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromScene (const QVector3D &scenePosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
 
Q_INVOKABLE QVector3D mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapDirectionToScene (const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromScene (const QVector3D &sceneDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
 
Q_INVOKABLE QVector3D mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
 
void markAllDirty () override
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Member Functions

QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *) override
 
- Protected Member Functions inherited from QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
 
void disconnectNotify (const QMetaMethod &signal) override
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
 
virtual void itemChange (ItemChange, const ItemChangeData &) override
 
- Protected Member Functions inherited from QQuick3DObject
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
bool isComponentComplete () const
 
virtual void preSync ()
 
- Protected Member Functions inherited from QObject
QObjectsender () 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.
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Properties

QUrl source
 
float volume
 
DistanceModel distanceModel
 
float size
 
float distanceCutoff
 
float manualAttenuation
 
float occlusionIntensity
 
float directivity
 
float directivityOrder
 
float nearFieldGain
 
int loops
 
bool autoPlay
 
- Properties inherited from QQuick3DNode
float x
 
float y
 
float z
 
QQuaternion rotation
 
QVector3D eulerRotation
 
QVector3D position
 
QVector3D scale
 
QVector3D pivot
 
float opacity
 
bool visible
 
QVector3D forward
 
QVector3D up
 
QVector3D right
 
QVector3D scenePosition
 
QQuaternion sceneRotation
 
QVector3D sceneScale
 
QMatrix4x4 sceneTransform
 
int staticFlags
 
- Properties inherited from QQuick3DObject
QQuick3DObjectparent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
 
- 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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 24 of file qquick3dspatialsound_p.h.

Member Enumeration Documentation

◆ DistanceModel

Enumerator
Logarithmic 
Linear 
ManualAttenuation 

Definition at line 51 of file qquick3dspatialsound_p.h.

◆ Loops

Enumerator
Infinite 
Once 

Definition at line 82 of file qquick3dspatialsound_p.h.

Constructor & Destructor Documentation

◆ QQuick3DSpatialSound()

QT_BEGIN_NAMESPACE QQuick3DSpatialSound::QQuick3DSpatialSound ( )

\qmltype SpatialSound \inqmlmodule QtQuick3D.SpatialAudio

A sound object in 3D space.

A SpatialSound represents an audible object in 3D space. You can define it's position and orientation in space, set the sound it is playing and define a volume for the object.

The object can have different attenuation behavior, emit sound mainly in one direction or spherically, and behave as if occluded by some other object.

Definition at line 29 of file qquick3dspatialsound.cpp.

References QSpatialSound::autoPlayChanged(), autoPlayChanged(), QObject::connect(), QSpatialSound::directivityChanged(), directivityChanged(), QSpatialSound::directivityOrderChanged(), directivityOrderChanged(), QSpatialSound::distanceCutoffChanged(), distanceCutoffChanged(), QSpatialSound::distanceModelChanged(), distanceModelChanged(), QQuick3DAudioEngine::getEngine(), QSpatialSound::loopsChanged(), loopsChanged(), QSpatialSound::manualAttenuationChanged(), manualAttenuationChanged(), QSpatialSound::nearFieldGainChanged(), nearFieldGainChanged(), QSpatialSound::occlusionIntensityChanged(), occlusionIntensityChanged(), QQuick3DNode::scenePositionChanged(), QQuick3DNode::sceneRotationChanged(), QSpatialSound::sizeChanged(), sizeChanged(), QSpatialSound::sourceChanged(), sourceChanged(), QSpatialSound::volumeChanged(), and volumeChanged().

+ Here is the call graph for this function:

◆ ~QQuick3DSpatialSound()

QQuick3DSpatialSound::~QQuick3DSpatialSound ( )

Definition at line 49 of file qquick3dspatialsound.cpp.

Member Function Documentation

◆ autoPlay()

bool QQuick3DSpatialSound::autoPlay ( ) const

\qmlproperty bool SpatialSound::autoPlay

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

The default value is true.

Definition at line 282 of file qquick3dspatialsound.cpp.

References QSpatialSound::autoPlay.

◆ autoPlayChanged

void QQuick3DSpatialSound::autoPlayChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ directivity()

float QQuick3DSpatialSound::directivity ( ) const

Definition at line 206 of file qquick3dspatialsound.cpp.

References QSpatialSound::directivity.

◆ directivityChanged

void QQuick3DSpatialSound::directivityChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ directivityOrder()

float QQuick3DSpatialSound::directivityOrder ( ) const

Definition at line 224 of file qquick3dspatialsound.cpp.

References QSpatialSound::directivityOrder.

◆ directivityOrderChanged

void QQuick3DSpatialSound::directivityOrderChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ distanceCutoff()

float QQuick3DSpatialSound::distanceCutoff ( ) const

Definition at line 153 of file qquick3dspatialsound.cpp.

References QSpatialSound::distanceCutoff.

◆ distanceCutoffChanged

void QQuick3DSpatialSound::distanceCutoffChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ distanceModel()

QQuick3DSpatialSound::DistanceModel QQuick3DSpatialSound::distanceModel ( ) const

Definition at line 119 of file qquick3dspatialsound.cpp.

References QSpatialSound::distanceModel.

◆ distanceModelChanged

void QQuick3DSpatialSound::distanceModelChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ loops()

int QQuick3DSpatialSound::loops ( ) const

\qmlproperty int SpatialSound::loops

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

The default value is 1.

Definition at line 264 of file qquick3dspatialsound.cpp.

References QSpatialSound::loops.

◆ loopsChanged

void QQuick3DSpatialSound::loopsChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ manualAttenuation()

float QQuick3DSpatialSound::manualAttenuation ( ) const

Definition at line 169 of file qquick3dspatialsound.cpp.

References QSpatialSound::manualAttenuation.

◆ manualAttenuationChanged

void QQuick3DSpatialSound::manualAttenuationChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ nearFieldGain()

float QQuick3DSpatialSound::nearFieldGain ( ) const

Definition at line 241 of file qquick3dspatialsound.cpp.

References QSpatialSound::nearFieldGain.

◆ nearFieldGainChanged

void QQuick3DSpatialSound::nearFieldGainChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ occlusionIntensity()

float QQuick3DSpatialSound::occlusionIntensity ( ) const

Definition at line 187 of file qquick3dspatialsound.cpp.

References QSpatialSound::occlusionIntensity.

◆ occlusionIntensityChanged

void QQuick3DSpatialSound::occlusionIntensityChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ pause

void QQuick3DSpatialSound::pause ( )
slot

\qmlmethod SpatialSound::pause()

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

Definition at line 307 of file qquick3dspatialsound.cpp.

References QSpatialSound::pause().

+ Here is the call graph for this function:

◆ play

void QQuick3DSpatialSound::play ( )
slot

\qmlmethod SpatialSound::play()

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

Definition at line 297 of file qquick3dspatialsound.cpp.

References QSpatialSound::play().

+ Here is the call graph for this function:

◆ Q_ENUM()

QQuick3DSpatialSound::Q_ENUM ( DistanceModel )

◆ setAutoPlay()

void QQuick3DSpatialSound::setAutoPlay ( bool autoPlay)

Definition at line 287 of file qquick3dspatialsound.cpp.

References autoPlay, and QSpatialSound::setAutoPlay().

+ Here is the call graph for this function:

◆ setDirectivity()

void QQuick3DSpatialSound::setDirectivity ( float alpha)

\qmlproperty float SpatialSound::directivity

Defines the directivity of the sound source. A value of 0 implies that the sound is emitted equally in all directions, while a value of 1 implies that the source mainly emits sound in the forward direction.

Valid values are between 0 and 1, the default is 0.

Definition at line 201 of file qquick3dspatialsound.cpp.

References QSpatialSound::setDirectivity().

+ Here is the call graph for this function:

◆ setDirectivityOrder()

void QQuick3DSpatialSound::setDirectivityOrder ( float alpha)

\qmlproperty float SpatialSound::directivityOrder

Defines the order of the directivity of the sound source. A higher order implies a sharper localization of the sound cone.

The minimum value and default for this property is 1.

Definition at line 219 of file qquick3dspatialsound.cpp.

References QSpatialSound::setDirectivityOrder().

+ Here is the call graph for this function:

◆ setDistanceCutoff()

void QQuick3DSpatialSound::setDistanceCutoff ( float max)

\qmlproperty float SpatialSound::distanceCutoff

Defines a distance beyond which sound coming from the source will cutoff. If the listener is further away from the sound object than the cutoff distance it won't be audible anymore.

Definition at line 148 of file qquick3dspatialsound.cpp.

References QSpatialSound::setDistanceCutoff().

+ Here is the call graph for this function:

◆ setDistanceModel()

void QQuick3DSpatialSound::setDistanceModel ( DistanceModel model)

\qmlproperty enumeration SpatialSound::distanceModel

Defines how the volume of the sound scales with distance to the listener. The volume starts scaling down from \l size to \l distanceCutoff. The volume is constant for distances smaller than size and zero for distances larger than the cutoff distance.

\table \header

  • Property value
  • Description \row
  • Logarithmic
  • Volume decreases logarithmically with distance. \row
  • Linear
  • Volume decreases linearly with distance. \row
  • ManualAttenuation
  • Attenuation is defined manually using the \l manualAttenuation property. \endtable

Definition at line 114 of file qquick3dspatialsound.cpp.

References model, and QSpatialSound::setDistanceModel().

+ Here is the call graph for this function:

◆ setLoops()

void QQuick3DSpatialSound::setLoops ( int loops)

Definition at line 269 of file qquick3dspatialsound.cpp.

References loops, and QSpatialSound::setLoops().

+ Here is the call graph for this function:

◆ setManualAttenuation()

void QQuick3DSpatialSound::setManualAttenuation ( float attenuation)

\qmlproperty float SpatialSound::manualAttenuation

Defines a manual attenuation factor if \l distanceModel is set to SpatialSound.ManualAttenuation.

Definition at line 164 of file qquick3dspatialsound.cpp.

References QSpatialSound::setManualAttenuation().

+ Here is the call graph for this function:

◆ setNearFieldGain()

void QQuick3DSpatialSound::setNearFieldGain ( float gain)

\qmlproperty float SpatialSound::nearFieldGain

Defines the near field gain for the sound source. Valid values are between 0 and 1. A near field gain of 1 will raise the volume of the sound signal by approx 20 dB for distances very close to the listener.

Definition at line 236 of file qquick3dspatialsound.cpp.

References QSpatialSound::setNearFieldGain().

+ Here is the call graph for this function:

◆ setOcclusionIntensity()

void QQuick3DSpatialSound::setOcclusionIntensity ( float occlusion)

\qmlproperty float SpatialSound::occlusionIntensity

Defines how much the object is occluded. 0 implies the object is not occluded at all, while a large number implies a large occlusion.

The default is 0.

Definition at line 182 of file qquick3dspatialsound.cpp.

References QSpatialSound::setOcclusionIntensity().

+ Here is the call graph for this function:

◆ setSize()

void QQuick3DSpatialSound::setSize ( float min)

\qmlproperty float SpatialSound::size

Defines the size of the sound source. If the listener is closer to the sound object than the size, volume will stay constant. The size is also used to for occlusion calculations, where large sources can be partially occluded by a wall.

Definition at line 131 of file qquick3dspatialsound.cpp.

References QSpatialSound::setSize().

+ Here is the call graph for this function:

◆ setSource()

void QQuick3DSpatialSound::setSource ( QUrl source)

Definition at line 64 of file qquick3dspatialsound.cpp.

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

+ Here is the call graph for this function:

◆ setVolume()

void QQuick3DSpatialSound::setVolume ( float volume)

\qmlproperty float SpatialSound::volume

Defines an overall volume for this sound source.

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

Definition at line 85 of file qquick3dspatialsound.cpp.

References QSpatialSound::setVolume(), and volume.

+ Here is the call graph for this function:

◆ size()

float QQuick3DSpatialSound::size ( ) const

Definition at line 136 of file qquick3dspatialsound.cpp.

References QSpatialSound::size.

◆ sizeChanged

void QQuick3DSpatialSound::sizeChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ source()

QUrl QQuick3DSpatialSound::source ( ) const

\qmlproperty url SpatialSound::source

The source file for the sound to be played.

Definition at line 59 of file qquick3dspatialsound.cpp.

References QSpatialSound::source.

◆ sourceChanged

void QQuick3DSpatialSound::sourceChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

◆ stop

void QQuick3DSpatialSound::stop ( )
slot

\qmlmethod SpatialSound::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 318 of file qquick3dspatialsound.cpp.

References QSpatialSound::stop().

+ Here is the call graph for this function:

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DSpatialSound::updateSpatialNode ( QSSGRenderGraphObject * )
inlineoverrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 119 of file qquick3dspatialsound_p.h.

◆ volume()

float QQuick3DSpatialSound::volume ( ) const

Definition at line 90 of file qquick3dspatialsound.cpp.

References QSpatialSound::volume.

◆ volumeChanged

void QQuick3DSpatialSound::volumeChanged ( )
signal

Referenced by QQuick3DSpatialSound().

+ Here is the caller graph for this function:

Property Documentation

◆ autoPlay

bool QQuick3DSpatialSound::autoPlay
readwrite

Definition at line 38 of file qquick3dspatialsound_p.h.

Referenced by setAutoPlay().

◆ directivity

float QQuick3DSpatialSound::directivity
readwrite

Definition at line 34 of file qquick3dspatialsound_p.h.

◆ directivityOrder

float QQuick3DSpatialSound::directivityOrder
readwrite

Definition at line 35 of file qquick3dspatialsound_p.h.

◆ distanceCutoff

float QQuick3DSpatialSound::distanceCutoff
readwrite

Definition at line 31 of file qquick3dspatialsound_p.h.

◆ distanceModel

DistanceModel QQuick3DSpatialSound::distanceModel
readwrite

Definition at line 29 of file qquick3dspatialsound_p.h.

◆ loops

int QQuick3DSpatialSound::loops
readwrite

Definition at line 37 of file qquick3dspatialsound_p.h.

Referenced by setLoops().

◆ manualAttenuation

float QQuick3DSpatialSound::manualAttenuation
readwrite

Definition at line 32 of file qquick3dspatialsound_p.h.

◆ nearFieldGain

float QQuick3DSpatialSound::nearFieldGain
readwrite

Definition at line 36 of file qquick3dspatialsound_p.h.

◆ occlusionIntensity

float QQuick3DSpatialSound::occlusionIntensity
readwrite

Definition at line 33 of file qquick3dspatialsound_p.h.

◆ size

float QQuick3DSpatialSound::size
readwrite

Definition at line 30 of file qquick3dspatialsound_p.h.

◆ source

QUrl QQuick3DSpatialSound::source
readwrite

Definition at line 27 of file qquick3dspatialsound_p.h.

◆ volume

float QQuick3DSpatialSound::volume
readwrite

Definition at line 28 of file qquick3dspatialsound_p.h.

Referenced by setVolume().


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