summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2022-09-29 12:44:00 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-10-07 12:33:17 +0000
commite920f72ebdefd976de9071a933ca19e5fd68a455 (patch)
treeeffcc397158710b5025867c8f5da86e01fb9e14e
parent5a6e631a51d22b30529d7e2776b0c26598aa5d8f (diff)
downloadqtmultimedia-e920f72ebdefd976de9071a933ca19e5fd68a455.tar.gz
Doc: Fix undocumented members warning for spatialaudio API
Change-Id: Ib304d542d49f28f3a53ad1cb15593ad5f7f599b2 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 990137a2d50beab43c6faac53e7e590ab92abdc0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/spatialaudio/qambientsound.cpp7
-rw-r--r--src/spatialaudio/qaudioengine.cpp19
-rw-r--r--src/spatialaudio/qaudioroom.cpp5
-rw-r--r--src/spatialaudio/qspatialsound.cpp8
4 files changed, 39 insertions, 0 deletions
diff --git a/src/spatialaudio/qambientsound.cpp b/src/spatialaudio/qambientsound.cpp
index 03846638f..4ea67b2bf 100644
--- a/src/spatialaudio/qambientsound.cpp
+++ b/src/spatialaudio/qambientsound.cpp
@@ -81,7 +81,14 @@ QUrl QAmbientSound::source() const
{
return d->url;
}
+/*!
+ \enum QAmbientSound::Loops
+
+ Lets you control the playback loop using the following values:
+ \value Infinite Loops infinitely
+ \value Once Stops playback after running once
+*/
/*!
\property QAmbientSound::loops
diff --git a/src/spatialaudio/qaudioengine.cpp b/src/spatialaudio/qaudioengine.cpp
index df6112adb..9020bae54 100644
--- a/src/spatialaudio/qaudioengine.cpp
+++ b/src/spatialaudio/qaudioengine.cpp
@@ -636,6 +636,25 @@ void QAmbientSoundPrivate::finished()
m_loading = false;
}
+/*!
+ \fn void QAudioEngine::pause()
+
+ Pauses playback.
+*/
+/*!
+ \fn void QAudioEngine::resume()
+
+ Resumes playback.
+*/
+/*!
+ \variable QAudioEngine::DistanceScaleCentimeter
+ \internal
+*/
+/*!
+ \variable QAudioEngine::DistanceScaleMeter
+ \internal
+*/
+
QT_END_NAMESPACE
#include "moc_qaudioengine.cpp"
diff --git a/src/spatialaudio/qaudioroom.cpp b/src/spatialaudio/qaudioroom.cpp
index b111936fa..87419a46f 100644
--- a/src/spatialaudio/qaudioroom.cpp
+++ b/src/spatialaudio/qaudioroom.cpp
@@ -260,6 +260,11 @@ QQuaternion QAudioRoom::rotation() const
}
/*!
+ \fn void QAudioRoom::wallsChanged()
+
+ Signals when the wall material changes.
+*/
+/*!
Sets \a wall to \a material.
Different wall materials have different reflection and reverb properties
diff --git a/src/spatialaudio/qspatialsound.cpp b/src/spatialaudio/qspatialsound.cpp
index ed6242d75..5451d0af9 100644
--- a/src/spatialaudio/qspatialsound.cpp
+++ b/src/spatialaudio/qspatialsound.cpp
@@ -481,6 +481,14 @@ QUrl QSpatialSound::source() const
}
/*!
+ \enum QSpatialSound::Loops
+
+ Lets you control the sound playback loop using the following values:
+
+ \value Infinite Playback infinitely
+ \value Once Playback once
+*/
+/*!
\property QSpatialSound::loops
Determines how many times the sound is played before the player stops.