Version
menu_open

AkChannelConfig Struct Reference

List of all members.

Public Member Functions

AkForceInline  AkChannelConfig ()
  Constructor. Clears / sets the channel config in "invalid" state (IsValid() returns false).
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.
AkForceInline bool  operator!= (AkUInt32 in_uBitField)
  Operator != with a 32-bit word.
AkForceInline void  Clear ()
  Clear the channel config. Becomes "invalid" (IsValid() returns false).
AkForceInline void  SetStandard (AkUInt32 in_uChannelMask)
  Set channel config as a standard configuration specified with given channel mask.
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).
AkForceInline void  SetAnonymous (AkUInt32 in_uNumChannels)
  Set channel config as an anonymous configuration specified with given number of channels.
AkForceInline void  SetAmbisonic (AkUInt32 in_uNumChannels)
  Set channel config as an ambisonic configuration specified with given number of channels.
AkForceInline bool  IsValid () const
  Returns true if valid, false otherwise (as when it is constructed, or invalidated using Clear()).
AkForceInline AkUInt32  Serialize () const
  Serialize channel config into a 32-bit word.
AkForceInline void  Deserialize (AkUInt32 in_uChannelConfig)
  Deserialize channel config from a 32-bit word.
AkForceInline AkChannelConfig  RemoveLFE () const
  Returns a new config based on 'this' with no LFE.
AkForceInline AkChannelConfig  RemoveCenter () const
  Returns a new config based on 'this' with no Front Center channel.
AkForceInline bool  operator== (const AkChannelConfig &in_other) const
  Operator ==.
AkForceInline bool  operator!= (const AkChannelConfig &in_other) const
  Operator !=.
AkForceInline bool  IsChannelConfigSupported () const
AkForceInline bool  HasLFE () const
AkForceInline bool  HasCenter () const

Public Attributes

AkUInt32  uNumChannels: 8
  Number of channels.
AkUInt32  eConfigType: 4
  Channel config type (AkChannelConfigType).
AkUInt32  uChannelMask: 20
  Channel mask (configuration).

Detailed Description

Defines a channel configuration. Examples: 

 AkChannelConfig cfg;
 
 // Create a stereo configuration.
 cfg.SetStandard(AK_SPEAKER_SETUP_STEREO);

 // Create a 7.1.4 configuration (7.1 plus 4 height channels).
 cfg.SetStandard(AK_SPEAKER_SETUP_AURO_11POINT1_740);
 // or
 cfg.SetStandard(AK_SPEAKER_SETUP_DOLBY_7_1_4);

 // Create a 3rd order ambisonic configuration.
 cfg.SetAmbisonic(16);  // pass in the number of spherical harmonics, (N+1)^2, where N is the ambisonics order.

 // Invalidate (usually means "As Parent")
 cfg.Clear();

Definition at line 509 of file AkSpeakerConfig.h.

The documentation for this struct was generated from the following file:

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise