QSound Class

The QSound class provides a method to play .wav sound files. 更多...

头: #include <QSound>
qmake: QT += multimedia
继承: QObject

公共类型

enum Loop { Infinite }

公共函数

QSound (const QString & filename , QObject * parent = nullptr)
virtual ~QSound ()
QString fileName () const
bool isFinished () const
int loops () const
int loopsRemaining () const
void setLoops (int number )

公共槽

void play ()
void stop ()

静态公共成员

void play (const QString & filename )
const QMetaObject staticMetaObject

额外继承成员

详细描述

The QSound class provides a method to play .wav sound files.

Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most easily accomplished using the static play () 函数:

QSound::play("mysounds/bells.wav");
					

Alternatively, create a QSound object from the sound file first and then call the play () slot:

QSound bells("mysounds/bells.wav");
bells.play();
					

In both cases, the file may either be a local file or in a resource .

Once created a QSound object can be queried for its fileName () and total number of loops () (i.e. the number of times the sound will play). The number of repetitions can be altered using the setLoops () function. While playing the sound, the loopsRemaining () function returns the remaining number of repetitions. Use the isFinished () function to determine whether the sound has finished playing.

Sounds played using a QSound object may use more memory than the static play () function, but it may also play more immediately (depending on the underlying platform audio facilities).

If you require finer control over playing sounds, consider the QSoundEffect or QAudioOutput 类。

另请参阅 QSoundEffect .

成员类型文档编制

enum QSound:: Loop

常量 描述
QSound::Infinite -1 Can be used as a parameter to setLoops () to loop infinitely.

成员函数文档编制

QSound:: QSound (const QString & filename , QObject * parent = nullptr)

构造 QSound object from the file specified by the given filename and with the given parent .

The file can either be a local file or in a resource .

另请参阅 play ().

[虚拟] QSound:: ~QSound ()

Destroys this sound object. If the sound is not finished playing, the stop () function is called before the sound object is destroyed.

另请参阅 stop () 和 isFinished ().

QString QSound:: fileName () const

Returns the filename associated with this QSound 对象。

另请参阅 QSound ().

bool QSound:: isFinished () const

Returns true if the sound has finished playing; otherwise returns false.

int QSound:: loops () const

Returns the number of times the sound will play. Return value of QSound::Infinite indicates infinite number of loops

另请参阅 loopsRemaining () 和 setLoops ().

int QSound:: loopsRemaining () const

Returns the remaining number of times the sound will loop (for all positive values this value decreases each time the sound is played). Return value of QSound::Infinite indicates infinite number of loops

另请参阅 loops () 和 isFinished ().

[static] void QSound:: play (const QString & filename )

Plays the sound stored in the file specified by the given filename .

The file can either be a local file or in a resource .

另请参阅 stop (), loopsRemaining (),和 isFinished ().

[slot] void QSound:: play ()

这是重载函数。

Starts playing the sound specified by this QSound 对象。

The function returns immediately. Depending on the platform audio facilities, other sounds may stop or be mixed with the new sound. The sound can be played again at any time, possibly mixing or replacing previous plays of the sound.

另请参阅 fileName ().

void QSound:: setLoops ( int number )

Sets the sound to repeat the given number of times when it is played.

Note that passing the value QSound::Infinite will cause the sound to loop indefinitely.

另请参阅 loops ().

[slot] void QSound:: stop ()

Stops the sound playing.

另请参阅 play ().