Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.8

◆ GetSpeakerConfiguration()

AKSOUNDENGINE_API AkChannelConfig AK::SoundEngine::GetSpeakerConfiguration ( AkOutputDeviceID  in_idOutput = 0 )

Gets the output speaker configuration of the specified output. Call this function to get the speaker configuration of the output (which may not correspond to the physical output format of the platform, in the case of downmixing provided by the platform itself). You may initialize the sound engine with a user-specified configuration, but the resulting configuration is determined by the sound engine, based on the platform, output type and platform settings (for e.g. system menu or control panel option). If the speaker configuration of the output is object-based, the speaker configuration of the main mix is returned. To query more information on object-based output devices, see AK::SoundEngine::GetOutputDeviceConfiguration.

It is recommended to call GetSpeakerConfiguration anytime after receiving a callback from RegisterAudioDeviceStatusCallback to know if the channel configuration has changed.

Warning
Call this function only after the sound engine has been properly initialized. If you are initializing the sound engine with AkInitSettings::bUseLEngineThread to false, it is required to call RenderAudio() at least once before calling this function to complete the sound engine initialization. The Init.bnk must be loaded prior to this call.
Returns
The output configuration. An empty AkChannelConfig not AkChannelConfig::IsValid() if device does not exist or if the Init.bnk was not loaded yet.
See also
Parameters
in_idOutput Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output