QAmbientSound Class

A stereo overlay sound. 更多...

头: #include <QAmbientSound>
CMake: find_package(Qt6 REQUIRED COMPONENTS SpatialAudio)
target_link_libraries(mytarget PRIVATE Qt6::SpatialAudio)
qmake: QT += spatialaudio
继承: QObject

公共类型

enum Loops { Infinite, Once }

特性

公共函数

QAmbientSound (QAudioEngine * engine )
bool autoPlay () const
QAudioEngine * engine () const
int loops () const
void setAutoPlay (bool autoPlay )
void setLoops (int loops )
void setSource (const QUrl & url )
void setVolume (float volume )
QUrl source () const
float volume () const

公共槽

void pause ()
void play ()
void stop ()

信号

void autoPlayChanged ()
void loopsChanged ()
void sourceChanged ()
void volumeChanged ()

详细描述

QAmbientSound represents a position and orientation independent sound. It's commonly used for background sounds (e.g. music) that is supposed to be independent of the listeners position and orientation.

成员类型文档编制

enum QAmbientSound:: Loops

Lets you control the playback loop using the following values:

常量 描述
QAmbientSound::Infinite -1 Loops infinitely
QAmbientSound::Once 1 Stops playback after running once

特性文档编制

autoPlay : bool

Determines whether the sound should automatically start playing when a source gets specified.

默认值为 true .

访问函数:

bool autoPlay () const
void setAutoPlay (bool autoPlay )

通知程序信号:

void autoPlayChanged ()

loops : int

Determines how many times the sound is played before the player stops. Set to QAmbientSound::Infinite to play the current sound in a loop forever.

默认值为 1 .

访问函数:

int loops () const
void setLoops (int loops )

通知程序信号:

void loopsChanged ()

source : QUrl

The source file for the sound to be played.

访问函数:

QUrl source () const
void setSource (const QUrl & url )

通知程序信号:

void sourceChanged ()

volume : float

Defines the volume of the sound.

Values between 0 and 1 will attenuate the sound, while values above 1 provide an additional gain boost.

访问函数:

float volume () const
void setVolume (float volume )

通知程序信号:

void volumeChanged ()

成员函数文档编制

[explicit] QAmbientSound:: QAmbientSound ( QAudioEngine * engine )

Creates a stereo sound source for engine .

QAudioEngine *QAmbientSound:: engine () const

Returns the engine associated with this sound.

[slot] void QAmbientSound:: pause ()

Pauses sound playback. Calling play () will continue playback.

[slot] void QAmbientSound:: play ()

Starts playing back the sound. Does nothing if the sound is already playing.

[slot] void QAmbientSound:: stop ()

Stops sound playback and resets the current position and current loop count to 0. Calling play () will start playback at the beginning of the sound file.