summaryrefslogtreecommitdiffstats
path: root/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc')
-rw-r--r--examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc28
1 files changed, 28 insertions, 0 deletions
diff --git a/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc b/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
new file mode 100644
index 000000000..ebb18e5c7
--- /dev/null
+++ b/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
@@ -0,0 +1,28 @@
+// Copyright (C) 2022 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+
+\example audiopanning
+\title Spatial Audio Panning Example
+\ingroup spatialaudio_examples
+\ingroup audio_examples
+\examplecategory {Multimedia}
+\meta {tag} {widgets}
+\brief Shows some of the capabilities of the spatial audio engine in Qt.
+
+The Spatial Audio Example demonstrates how you can use \l{Qt Spatial Audio} to
+place sound sources in 3D space and how positioning of the sound source and
+room properties affect the listening experience.
+
+The example lets you specify a sound file to be played back at a certain
+position in 3D space relative to the listener. Using sliders you can change
+the distance and the azimuth and elevation angles to the source. You can also
+change dimensions of a virtual room, the intensity of the room reflections
+and reverb.
+
+Various other properties can also be modified such as the dimensions of a virtual
+room and the intensity of the room reflections and reverb.
+
+\image audiopanning-example.png
+
+*/