QSoundEffect Class
The QSoundEffect class provides a way to play low latency sound effects. More...
| Header: | #include <QSoundEffect> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Multimedia)target_link_libraries(mytarget PRIVATE Qt6::Multimedia) |
| qmake: | QT += multimedia |
| In QML: | SoundEffect |
| Inherits: | QObject |
Public Types
Properties
|
Public Functions
| QSoundEffect(QObject *parent = nullptr) | |
| QSoundEffect(const QAudioDevice &audioDevice, QObject *parent = nullptr) | |
| virtual | ~QSoundEffect() |
| QAudioDevice | audioDevice() |
| bool | isLoaded() const |
| bool | isMuted() const |
| bool | isPlaying() const |
| int | loopCount() const |
| int | loopsRemaining() const |
| void | setAudioDevice(const QAudioDevice &device) |
| void | setLoopCount(int loopCount) |
| void | setMuted(bool muted) |
| void | setSource(const QUrl &url) |
| void | setVolume(float volume) |
| QUrl | source() const |
| QSoundEffect::Status | status() const |
| float | volume() const |
Public Slots
Signals
| void | audioDeviceChanged() |
| void | loadedChanged() |
| void | loopCountChanged() |
| void | loopsRemainingChanged() |
| void | mutedChanged() |
| void | playingChanged() |
| void | sourceChanged() |
| void | statusChanged() |
| void | volumeChanged() |
Static Public Members
| QStringList | supportedMimeTypes() |
Detailed Description
This class allows you to play uncompressed audio files (typically WAV files) in a generally lower latency way, and is suitable for "feedback" type sounds in response to user actions (e.g. virtual keyboard sounds, positive or negative feedback for popup dialogs, or game sounds). If low latency is not important, consider using the QMediaPlayer class instead, since it supports a wider variety of media formats and is less resource intensive.
This example shows how a looping, somewhat quiet sound effect can be played:
QSoundEffect effect; effect.setSource(QUrl::fromLocalFile("engine.wav")); effect.setLoopCount(QSoundEffect::Infinite); effect.setVolume(0.25f); effect.play();
Typically the sound effect should be reused, which allows all the parsing and preparation to be done ahead of time, and only triggered when necessary. This assists with lower latency audio playback.
MyGame()
: m_explosion(this)
{
m_explosion.setSource(QUrl::fromLocalFile("explosion.wav"));
m_explosion.setVolume(0.25f);
// Set up click handling etc.
connect(clickSource, &QPushButton::clicked, &m_explosion, &QSoundEffect::play);
}
private:
QSoundEffect m_explosion;
Since QSoundEffect requires slightly more resources to achieve lower latency playback, the platform may limit the number of simultaneously playing sound effects.
Member Type Documentation
enum QSoundEffect::Loop
| Constant | Value | Description |
|---|---|---|
QSoundEffect::Infinite | -2 | Used as a parameter to setLoopCount() for infinite looping |
enum QSoundEffect::Status
| Constant | Value | Description |
|---|---|---|
QSoundEffect::Null | 0 | No source has been set or the source is null. |
QSoundEffect::Loading | 1 | The SoundEffect is trying to load the source. |
QSoundEffect::Ready | 2 | The source is loaded and ready for play. |
QSoundEffect::Error | 3 | An error occurred during operation, such as failure of loading the source. |
Property Documentation
audioDevice : QAudioDevice
Returns the QAudioDevice instance.
Access functions:
| QAudioDevice | audioDevice() |
| void | setAudioDevice(const QAudioDevice &device) |
Notifier signal:
| void | audioDeviceChanged() |
loops : int
This property holds the number of times the sound is played. A value of 0 or 1 means the sound will be played only once; set to SoundEffect.Infinite to enable infinite looping.
The value can be changed while the sound effect is playing, in which case it will update the remaining loops to the new value.
Access functions:
| int | loopCount() const |
| void | setLoopCount(int loopCount) |
Notifier signal:
| void | loopCountChanged() |
[read-only] loopsRemaining : const int
This property contains the number of loops remaining before the sound effect stops by itself, or QSoundEffect::Infinite if that's what has been set in loops.
Access functions:
| int | loopsRemaining() const |
Notifier signal:
| void | loopsRemainingChanged() |
muted : bool
This property provides a way to control muting. A value of true will mute this effect.
Access functions:
Notifier signal:
| void | mutedChanged() |
[read-only] playing : const bool
This property indicates whether the sound effect is playing or not.
Access functions:
| bool | isPlaying() const |
Notifier signal:
| void | playingChanged() |
source : QUrl
This property holds the url for the sound to play. For the SoundEffect to attempt to load the source, the URL must exist and the application must have read permission in the specified directory.
Access functions:
Notifier signal:
| void | sourceChanged() |
[read-only] status : const Status
This property indicates the current status of the sound effect from the QSoundEffect::Status enumeration.
Access functions:
| QSoundEffect::Status | status() const |
Notifier signal:
| void | statusChanged() |
volume : float
This property holds the volume of the sound effect playback, from 0.0 (silence) to 1.0 (full volume).
Access functions:
Notifier signal:
| void | volumeChanged() |
Member Function Documentation
[explicit] QSoundEffect::QSoundEffect(QObject *parent = nullptr)
Creates a QSoundEffect with the given parent.
[explicit] QSoundEffect::QSoundEffect(const QAudioDevice &audioDevice, QObject *parent = nullptr)
Creates a QSoundEffect with the given audioDevice and parent.
[virtual noexcept] QSoundEffect::~QSoundEffect()
Destroys this sound effect.
bool QSoundEffect::isLoaded() const
Returns whether the sound effect has finished loading the source().
bool QSoundEffect::isMuted() const
Returns whether this sound effect is muted
Note: Getter function for property muted.
bool QSoundEffect::isPlaying() const
Returns true if the sound effect is currently playing, or false otherwise
Note: Getter function for property playing.
[signal] void QSoundEffect::loadedChanged()
The loadedChanged signal is emitted when the loading state has changed.
int QSoundEffect::loopCount() const
Returns the total number of times that this sound effect will be played before stopping.
See the loopsRemaining() method for the number of loops currently remaining.
Note: Getter function for property loops.
See also setLoopCount().
[signal] void QSoundEffect::loopCountChanged()
The loopCountChanged signal is emitted when the initial number of loops has changed.
Note: Notifier signal for property loops.
[signal] void QSoundEffect::loopsRemainingChanged()
The loopsRemainingChanged signal is emitted when the remaining number of loops has changed.
Note: Notifier signal for property loopsRemaining.
[signal] void QSoundEffect::mutedChanged()
The mutedChanged signal is emitted when the mute state has changed.
Note: Notifier signal for property muted.
[slot] void QSoundEffect::play()
Start playback of the sound effect, looping the effect for the number of times as specified in the loops property.
[signal] void QSoundEffect::playingChanged()
The playingChanged signal is emitted when the playing property has changed.
Note: Notifier signal for property playing.
void QSoundEffect::setLoopCount(int loopCount)
Set the total number of times to play this sound effect to loopCount.
Setting the loop count to 0 or 1 means the sound effect will be played only once; pass QSoundEffect::Infinite to repeat indefinitely. The loop count can be changed while the sound effect is playing, in which case it will update the remaining loops to the new loopCount.
Note: Setter function for property loops.
See also loopCount() and loopsRemaining().
void QSoundEffect::setMuted(bool muted)
Sets whether to mute this sound effect's playback.
If muted is true, playback will be muted (silenced), and otherwise playback will occur with the currently specified volume().
Note: Setter function for property muted.
See also isMuted().
void QSoundEffect::setSource(const QUrl &url)
Set the current URL to play to url.
Note: Setter function for property source.
See also source().
void QSoundEffect::setVolume(float volume)
Sets the sound effect volume to volume.
The volume is scaled linearly from 0.0 (silence) to 1.0 (full volume). Values outside this range will be clamped.
The default volume is 1.0.
UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. See QtAudio::convertVolume() for more details.
Note: Setter function for property volume.
See also volume().
QUrl QSoundEffect::source() const
Returns the URL of the current source to play
Note: Getter function for property source.
See also setSource().
[signal] void QSoundEffect::sourceChanged()
The sourceChanged signal is emitted when the source has been changed.
Note: Notifier signal for property source.
QSoundEffect::Status QSoundEffect::status() const
Returns the current status of this sound effect.
Note: Getter function for property status.
[signal] void QSoundEffect::statusChanged()
The statusChanged signal is emitted when the status property has changed.
Note: Notifier signal for property status.
[slot] void QSoundEffect::stop()
Stop current playback.
[static] QStringList QSoundEffect::supportedMimeTypes()
Returns a list of the supported mime types for this platform.
float QSoundEffect::volume() const
Returns the current volume of this sound effect, from 0.0 (silent) to 1.0 (maximum volume).
Note: Getter function for property volume.
See also setVolume().
[signal] void QSoundEffect::volumeChanged()
The volumeChanged signal is emitted when the volume has changed.
Note: Notifier signal for property volume.