A stereo overlay sound. More...
| Header: | #include <QAmbientSound> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS SpatialAudio) target_link_libraries(mytarget PRIVATE Qt6::SpatialAudio) |
| qmake: | QT += spatialaudio |
| Inherits: | QObject |
| enum | Loops { Infinite, Once } |
| QAmbientSound(QAudioEngine *engine) | |
| bool | autoPlay() const |
| QAudioEngine * | engine() const |
| int | loops() const |
| void | setAutoPlay(bool autoPlay) |
| void | setLoops(int loops) |
| void | setSource(const QUrl &url) |
| void | setVolume(float volume) |
| QUrl | source() const |
| float | volume() const |
| void | autoPlayChanged() |
| void | loopsChanged() |
| void | sourceChanged() |
| void | volumeChanged() |
QAmbientSound 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.
Lets you control the playback loop using the following values:
| Constant | Value | Description |
|---|---|---|
QAmbientSound::Infinite |
-1 |
Loops infinitely |
QAmbientSound::Once |
1 |
Stops playback after running once |
Determines whether the sound should automatically start playing when a source gets specified.
The default value is true.
Access functions:
| bool | autoPlay() const |
| void | setAutoPlay(bool autoPlay) |
Notifier signal:
| void | autoPlayChanged() |
Determines how many times the sound is played before the player stops. Set to QAmbientSound::Infinite to play the current sound in a loop forever.
The default value is 1.
Access functions:
| int | loops() const |
| void | setLoops(int loops) |
Notifier signal:
| void | loopsChanged() |
The source file for the sound to be played.
Access functions:
| QUrl | source() const |
| void | setSource(const QUrl &url) |
Notifier signal:
| void | sourceChanged() |
Defines the volume of the sound.
Values between 0 and 1 will attenuate the sound, while values above 1 provide an additional gain boost.
Access functions:
| float | volume() const |
| void | setVolume(float volume) |
Notifier signal:
| void | volumeChanged() |
Creates a stereo sound source for engine.
[slot] void QAmbientSound::pause()Pauses sound playback. Calling play() will continue playback.
[slot] void QAmbientSound::play()Starts playing back the sound. Does nothing if the sound is already playing.
[slot] void QAmbientSound::stop()Stops sound playback and resets the current position and current loop count to 0. Calling play() will start playback at the beginning of the sound file.
Returns the engine associated with this sound.
