AkChannelConfig

Wwise SDK 2023.1.3

#include <AkSpeakerConfig.h>

公開メンバ関数
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 void	SetObject ()
	Set channel config as an object-based configuration (implies dynamic number of objects). [詳解]

AkForceInline void	SetSameAsMainMix ()
	Set channel config as the main mix channel configuration [詳解]

AkForceInline void	SetSameAsPassthrough ()
	Set channel config as the passthrough mix channel configuration [詳解]

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	HasLFE () const

AkForceInline bool	HasCenter () const

静的公開メンバ関数
static AkForceInline AkChannelConfig	Standard (AkUInt32 in_uChannelMask)
	Construct standard channel config from channel mask [詳解]

static AkForceInline AkChannelConfig	Anonymous (AkUInt32 in_uNumChannels)

static AkForceInline AkChannelConfig	Ambisonic (AkUInt32 in_uNumChannels)
	Construct ambisonic channel config from number of channels (NOT order) [詳解]

static AkForceInline AkChannelConfig	Object ()

公開変数類
AkUInt32	uNumChannels: 8
	Number of channels. [詳解]

AkUInt32	eConfigType: 4
	Channel config type (AkChannelConfigType). [詳解]

AkUInt32	uChannelMask: 20
	Channel mask (configuration). [詳解]

詳解

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();