|
Wwise SDK 2023.1.8
|
#include <AkSpeakerConfig.h>
Public Member Functions | |
| AkForceInline | AkChannelConfig () |
| Constructor. Clears / sets the channel config in "invalid" state (IsValid() returns false). More... | |
| AkForceInline | AkChannelConfig (AkUInt32 in_uNumChannels, AkUInt32 in_uChannelMask) |
| Constructor. Sets number of channels, and config type according to whether channel mask is defined or not. If defined, it must be consistent with the number of channels. More... | |
| AkForceInline bool | operator!= (AkUInt32 in_uBitField) |
| Operator != with a 32-bit word. More... | |
| AkForceInline void | Clear () |
| Clear the channel config. Becomes "invalid" (IsValid() returns false). More... | |
| AkForceInline void | SetStandard (AkUInt32 in_uChannelMask) |
| Set channel config as a standard configuration specified with given channel mask. More... | |
| AkForceInline void | SetStandardOrAnonymous (AkUInt32 in_uNumChannels, AkUInt32 in_uChannelMask) |
| Set channel config as either a standard or an anonymous configuration, specified with both a given channel mask (0 if anonymous) and a number of channels (which must match the channel mask if standard). More... | |
| AkForceInline void | SetAnonymous (AkUInt32 in_uNumChannels) |
| Set channel config as an anonymous configuration specified with given number of channels. More... | |
| AkForceInline void | SetAmbisonic (AkUInt32 in_uNumChannels) |
| Set channel config as an ambisonic configuration specified with given number of channels. More... | |
| AkForceInline void | SetObject () |
| Set channel config as an object-based configuration (implies dynamic number of objects). More... | |
| AkForceInline void | SetSameAsMainMix () |
| Set channel config as the main mix channel configuration. More... | |
| AkForceInline void | SetSameAsPassthrough () |
| Set channel config as the passthrough mix channel configuration. More... | |
| AkForceInline bool | IsValid () const |
| Returns true if valid, false otherwise (as when it is constructed, or invalidated using Clear()). More... | |
| AkForceInline AkUInt32 | Serialize () const |
| Serialize channel config into a 32-bit word. More... | |
| AkForceInline void | Deserialize (AkUInt32 in_uChannelConfig) |
| Deserialize channel config from a 32-bit word. More... | |
| AkForceInline AkChannelConfig | RemoveLFE () const |
| Returns a new config based on 'this' with no LFE. More... | |
| AkForceInline AkChannelConfig | RemoveCenter () const |
| Returns a new config based on 'this' with no Front Center channel. More... | |
| AkForceInline bool | operator== (const AkChannelConfig &in_other) const |
| Operator ==. More... | |
| AkForceInline bool | operator!= (const AkChannelConfig &in_other) const |
| Operator !=. More... | |
| AkForceInline bool | HasLFE () const |
| AkForceInline bool | HasCenter () const |
Static Public Member Functions | |
| static AkForceInline AkChannelConfig | Standard (AkUInt32 in_uChannelMask) |
| Construct standard channel config from channel mask. More... | |
| static AkForceInline AkChannelConfig | Anonymous (AkUInt32 in_uNumChannels) |
| static AkForceInline AkChannelConfig | Ambisonic (AkUInt32 in_uNumChannels) |
| Construct ambisonic channel config from number of channels (NOT order) More... | |
| static AkForceInline AkChannelConfig | Object () |
Public Attributes | |
| AkUInt32 | uNumChannels: 8 |
| Number of channels. More... | |
| AkUInt32 | eConfigType: 4 |
| Channel config type (AkChannelConfigType). More... | |
| AkUInt32 | uChannelMask: 20 |
| Channel mask (configuration). More... | |
Defines a channel configuration. Examples:
Definition at line 496 of file AkSpeakerConfig.h.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise