QSoundEffect¶
The
QSoundEffect
class provides a way to play low latency sound effects. More…
Synopsis¶
Functions¶
def
category
()def
isLoaded
()def
isMuted
()def
isPlaying
()def
loopCount
()def
loopsRemaining
()def
setCategory
(category)def
setLoopCount
(loopCount)def
setMuted
(muted)def
setSource
(url)def
setVolume
(volume)def
source
()def
status
()def
volume
()
Slots¶
Signals¶
def
categoryChanged
()def
loadedChanged
()def
loopCountChanged
()def
loopsRemainingChanged
()def
mutedChanged
()def
playingChanged
()def
sourceChanged
()def
statusChanged
()def
volumeChanged
()
Static functions¶
def
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.
- class PySide2.QtMultimedia.QSoundEffect([parent=None])¶
PySide2.QtMultimedia.QSoundEffect(audioDevice[, parent=None])
- param parent:
- param audioDevice:
Creates a
QSoundEffect
with the givenparent
.Creates a
QSoundEffect
with the givenaudioDevice
andparent
.
- PySide2.QtMultimedia.QSoundEffect.Loop¶
Constant
Description
QSoundEffect.Infinite
Used as a parameter to
setLoopCount()
for infinite looping
- PySide2.QtMultimedia.QSoundEffect.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.
- PySide2.QtMultimedia.QSoundEffect.category()¶
- Return type:
str
This property contains the category of 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.
- PySide2.QtMultimedia.QSoundEffect.categoryChanged()¶
- PySide2.QtMultimedia.QSoundEffect.isLoaded()¶
- Return type:
bool
Returns whether the sound effect has finished loading the
source()
.
- PySide2.QtMultimedia.QSoundEffect.isMuted()¶
- Return type:
bool
This property provides a way to control muting. A value of
true
will mute this effect.
- PySide2.QtMultimedia.QSoundEffect.isPlaying()¶
- Return type:
bool
This property indicates whether the sound effect is playing or not.
- PySide2.QtMultimedia.QSoundEffect.loadedChanged()¶
- PySide2.QtMultimedia.QSoundEffect.loopCount()¶
- Return type:
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.
- PySide2.QtMultimedia.QSoundEffect.loopCountChanged()¶
- PySide2.QtMultimedia.QSoundEffect.loopsRemaining()¶
- Return type:
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 inloops
.
- PySide2.QtMultimedia.QSoundEffect.loopsRemainingChanged()¶
- PySide2.QtMultimedia.QSoundEffect.mutedChanged()¶
- PySide2.QtMultimedia.QSoundEffect.play()¶
Start playback of the sound effect, looping the effect for the number of times as specified in the loops property.
- PySide2.QtMultimedia.QSoundEffect.playingChanged()¶
- PySide2.QtMultimedia.QSoundEffect.setCategory(category)¶
- Parameters:
category – str
This property contains the category of 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.
- PySide2.QtMultimedia.QSoundEffect.setLoopCount(loopCount)¶
- Parameters:
loopCount – 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.
- PySide2.QtMultimedia.QSoundEffect.setMuted(muted)¶
- Parameters:
muted – bool
This property provides a way to control muting. A value of
true
will mute this effect.
- PySide2.QtMultimedia.QSoundEffect.setSource(url)¶
- Parameters:
url –
PySide2.QtCore.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.
- PySide2.QtMultimedia.QSoundEffect.setVolume(volume)¶
- Parameters:
volume – float
This property holds the volume of the sound effect playback, from 0.0 (silence) to 1.0 (full volume).
- PySide2.QtMultimedia.QSoundEffect.source()¶
- Return type:
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.
- PySide2.QtMultimedia.QSoundEffect.sourceChanged()¶
- PySide2.QtMultimedia.QSoundEffect.status()¶
- Return type:
This property indicates the current status of the sound effect from the
Status
enumeration.
- PySide2.QtMultimedia.QSoundEffect.statusChanged()¶
- PySide2.QtMultimedia.QSoundEffect.stop()¶
Stop current playback.
- static PySide2.QtMultimedia.QSoundEffect.supportedMimeTypes()¶
- Return type:
list of strings
Returns a list of the supported mime types for this platform.
- PySide2.QtMultimedia.QSoundEffect.volume()¶
- Return type:
float
This property holds the volume of the sound effect playback, from 0.0 (silence) to 1.0 (full volume).
- PySide2.QtMultimedia.QSoundEffect.volumeChanged()¶
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.