QtMobility Reference Documentation

QML SoundEffect Element

The SoundEffect element provides a way to play sound effects in QML. More...

Properties

Signals

Methods

Detailed Description

This element is part of the QtMultimediaKit 1.1 module.

The following example plays a WAV file on mouse click.

 import Qt 4.7
 import QtMultimediaKit 1.1

 Text {
     text: "Click Me!";
     font.pointSize: 24;
     width: 150; height: 50;

     SoundEffect {
         id: playSound
         source: "soundeffect.wav"
     }
     MouseArea {
         id: playArea
         anchors.fill: parent
         onPressed: { playSound.play() }
     }
 }

Property Documentation

loops : int

This property provides a way to control the number of times to repeat the sound on each play().

Set to -1 (infinite) to enable infinite loop.


muted : bool

This property provides a way to control muting.


read-onlyplaying : bool

This property indicates if the soundeffect is playing or not.


source : url

This property provides a way to control the sound to play.


read-onlystatus : int

This property indicates the following status of the soundeffect.

Null: no source has been set or is null. Loading: the soundeffect is trying to load the source. Ready: the source is loaded and ready for play. Error: some error happened during operation, such as failure of loading the source.


volume : qreal

This property holds the volume of the playback, from 0.0 (silent) to 1.0 (maximum volume). Note: Currently this has no effect on Mac OS X and Symbian.


Signal Documentation

SoundEffect::loopsChanged ()

This handler is called when the number of loops has changed.


SoundEffect::mutedChanged ()

This handler is called when the mute state has changed.


SoundEffect::playingChanged ()

This handler is called when the playing property has changed.


SoundEffect::sourceChanged ()

This handler is called when the source has changed.


SoundEffect::statusChanged ()

This handler is called when the status property has changed.


SoundEffect::volumeChanged ()

This handler is called when the volume has changed.


Method Documentation

SoundEffect::play ()

Start playback of the sound effect, looping the effect for the number of times as specificed in the loops property.

This is the default method for SoundEffect.

 SoundEffect {
     id: playSound
     source: "soundeffect.wav"
 }
 MouseArea {
     id: playArea
     anchors.fill: parent
     onPressed: { playSound.play() }
 }

SoundEffect::stop ()

Stop current playback. Note that if the backend is PulseAudio, due to the limitation of the underlying API, tis stop will only prevent next looping but will not be able to stop current playback immediately.


X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.

[0]; s.parentNode.insertBefore(ga, s); })();