QSoundEffect Class

QSoundEffect effect;
effect.setSource(QUrl::fromLocalFile("engine.wav"));
effect.setLoopCount(QSoundEffect::Infinite);
effect.setVolume(0.25f);
effect.play();

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;

Member Function Documentation

QSoundEffect::QSoundEffect(QObject *parent = nullptr)

Creates a QSoundEffect with the given parent.

[virtual] QSoundEffect::~QSoundEffect()

Destroys this sound effect.

QString QSoundEffect::category() const

Returns the current category for this sound effect.

Some platforms can perform different audio routing for different categories, or may allow the user to set different volume levels for different categories.

This setting will be ignored on platforms that do not support audio categories.

Note: Getter function for property category.

See also setCategory().

[signal] void QSoundEffect::categoryChanged()

The categoryChanged signal is emitted when the category property has changed.

Note: Notifier signal for property category.

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::setCategory(const QString &category)

Sets the category of this sound effect to category.

Some platforms can perform different audio routing for different categories, or may allow the user to set different volume levels for different categories.

This setting will be ignored on platforms that do not support audio categories.

If this setting is changed while a sound effect is playing it will only take effect when the sound effect has stopped playing.

Note: Setter function for property category.

See also category().

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(qreal 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 nonlinearly. 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 QAudio::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.

qreal 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.