class QSoundEffect#

The QSoundEffect class provides a way to play low latency sound effects. More…

Synopsis#

Properties#

audioDeviceᅟ
loopsᅟ
loopsRemainingᅟ
mutedᅟ
playingᅟ
sourceᅟ
statusᅟ
volumeᅟ

Methods#

def __init__()
def audioDevice()
def isLoaded()
def isMuted()
def isPlaying()
def loopCount()
def loopsRemaining()
def setAudioDevice()
def setLoopCount()
def setMuted()
def setSource()
def setVolume()
def source()
def status()
def volume()

Slots#

def play()
def stop()

Static functions#

def supportedMimeTypes()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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:

effect = QSoundEffect()
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()
    self.m_explosion = self

        m_explosion.setSource(QUrl.fromLocalFile("explosion.wav"))
        m_explosion.setVolume(0.25f)
        # Set up click handling etc.
        clickSource.clicked.connect(m_explosion.play)

# private
    m_explosion = QSoundEffect()

Since QSoundEffect requires slightly more resources to achieve lower latency playback, the platform may limit the number of simultaneously playing sound effects.

class Loop#

Constant	Description
QSoundEffect.Infinite	Used as a parameter to `setLoopCount()` for infinite looping

class Status#

Constant	Description
QSoundEffect.Null	No source has been set or the source is null.
QSoundEffect.Loading	The SoundEffect is trying to load the source.
QSoundEffect.Ready	The source is loaded and ready for play.
QSoundEffect.Error	An error occurred during operation, such as failure of loading the source.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property audioDeviceᅟ: QAudioDevice#

Returns the QAudioDevice instance.

Access functions:

audioDevice()
setAudioDevice()
Signal audioDeviceChanged()

property 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:

loopCount()
setLoopCount()
Signal loopCountChanged()

property loopsRemainingᅟ: int#

This property contains the number of loops remaining before the sound effect stops by itself, or Infinite if that’s what has been set in loops .

Access functions:

loopsRemaining()
Signal loopsRemainingChanged()

property mutedᅟ: bool#

This property provides a way to control muting. A value of true will mute this effect.

Access functions:

isMuted()
setMuted()
Signal mutedChanged()

property playingᅟ: bool#

This property indicates whether the sound effect is playing or not.

Access functions:

isPlaying()
Signal playingChanged()

property 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:

source()
setSource()
Signal sourceChanged()

property statusᅟ: QSoundEffect.Status#

This property indicates the current status of the sound effect from the Status enumeration.

Access functions:

status()
Signal statusChanged()

property volumeᅟ: float#

This property holds the volume of the sound effect playback, from 0.0 (silence) to 1.0 (full volume).

Access functions:

volume()
setVolume()
Signal volumeChanged()

__init__(audioDevice[, parent=None])#

Parameters:

audioDevice – QAudioDevice
parent – QObject

Creates a QSoundEffect with the given audioDevice and parent.

__init__([parent=None])

Parameters:: parent – QObject

Creates a QSoundEffect with the given parent.

audioDevice()#

Return type:: QAudioDevice