KgAudioScene

KgAudioScene Namespace Reference

Typedefs

typedef QFlags< CapabilityCapabilities
 

Enumerations

enum  Capability { SupportsLowLatencyPlayback = 1 << 0, SupportsPositionalPlayback = 1 << 1 }
 

Functions

KDEGAMES_EXPORT Capabilities capabilities ()
 
KDEGAMES_EXPORT bool hasError ()
 
KDEGAMES_EXPORT QPointF listenerPos ()
 
KDEGAMES_EXPORT void setListenerPos (const QPointF &pos)
 
KDEGAMES_EXPORT void setVolume (qreal volume)
 
KDEGAMES_EXPORT qreal volume ()
 

Detailed Description

This class exposes general properties of the audio playback context.

Actual sounds are represented in this context by KgSound instances.

The audio scene basically consists of a listener. The position of this listener is relevant when sounds are played at certain positions: The audio channels will then be balanced to make the sound appear to come from that direction.

Because there can ogly be one listener, all methods in this class are static.

Warning
Not all functionally exposed by the API of this class is guaranteed to be available on the compiled KgAudio backend. Check KgAudioScene::capabilities() if in doubt.

Enumeration Type Documentation

This enumeration represents capabilities which may not be provided by every KgAudio backend.

Enumerator
SupportsLowLatencyPlayback 

Playback starts as soon as KgSound::start is called.

Definition at line 47 of file audio/kgaudioscene.h.

Function Documentation

KgAudioScene::Capabilities KgAudioScene::capabilities ( )
Returns
which capabilities are supported by the compiled KgAudio backend

Definition at line 29 of file kgaudioscene-openal.cpp.

bool KgAudioScene::hasError ( )
Returns
whether an error was detected in the audio backend

Since KgAudio is typically used by games where audio is not an absolutely vital part of the gameplay, we do not need to fail if sound does not work, over even make some sort of deep analysis why something did not work. The user will notice missing sound, and advanced users may investigate the kWarning() messages. That is usually enough. If not, use this method.

The state of hasError() may theoretically change while the application runs, but in practice, this is very unlikely. (The only tricky part is typically the initial allocation of resources.)

See also
KgSound::hasError()

Definition at line 62 of file kgaudioscene-openal.cpp.

QPointF KgAudioScene::listenerPos ( )
Returns
the position of the listener

Definition at line 34 of file kgaudioscene-openal.cpp.

void KgAudioScene::setListenerPos ( const QPointF pos)

Sets the position of the listener.

The default is (0.0, 0.0), the point of origin.

Note
Effective only if positional playback is supported.

Definition at line 39 of file kgaudioscene-openal.cpp.

void KgAudioScene::setVolume ( qreal  volume)

Sets the master volume for sounds outputted by TagaroAudio.

The default is 1.0, which means no volume change, compared to the original sounds. 0.0 means that all sounds are muted.

Definition at line 53 of file kgaudioscene-openal.cpp.

qreal KgAudioScene::volume ( )
Returns
the master volume for sounds outputted by TagaroAudio

Definition at line 48 of file kgaudioscene-openal.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Aug 11 2020 22:38:52 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.