Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
Namespace enum pattern creates scope for the masks while also keeping them loosely typed The benefits: easier to read, easier type (auto complete and search), ESpeakerMask::Type can be used as parameter
| Name | ESpeakerMask::Type |
| Type | enum |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/AudioBufferConstants.h |
| Include Path | #include "HarmonixDsp/AudioBufferConstants.h" |
Syntax
namespace ESpeakerMask
{
enum Type
{
LeftFront = 1 << (uint32)ESpeakerChannelAssignment::LeftFront,
RightFront = 1 << (uint32)ESpeakerChannelAssignment::RightFront,
Center = 1 << (uint32)ESpeakerChannelAssignment::Center,
LFE = 1 << (uint32)ESpeakerChannelAssignment::LFE,
LeftSurround = 1 << (uint32)ESpeakerChannelAssignment::LeftSurround,
RightSurround = 1 << (uint32)ESpeakerChannelAssignment::RightSurround,
LeftRear = 1 << (uint32)ESpeakerChannelAssignment::LeftRear,
RightRear = 1 << (uint32)ESpeakerChannelAssignment::RightRear,
AmbisonicWAssigned = 1 << (uint32)ESpeakerChannelAssignment::AmbisonicW,
AmbisonicXAssigned = 1 << (uint32)ESpeakerChannelAssignment::AmbisonicX,
AmbisonicYAssigned = 1 << (uint32)ESpeakerChannelAssignment::AmbisonicY,
AmbisonicZAssigned = 1 << (uint32)ESpeakerChannelAssignment::AmbisonicZ,
AmbisonicWRemapped = 1 << (uint32)ESpeakerChannelAssignment::LeftFront,
AmbisonicXRemapped = 1 << (uint32)ESpeakerChannelAssignment::RightFront,
AmbisonicYRemapped = 1 << (uint32)ESpeakerChannelAssignment::Center,
AmbisonicZRemapped = 1 << (uint32)ESpeakerChannelAssignment::LFE,
UnspecifiedMono = 1 << (uint32)ESpeakerChannelAssignment::UnspecifiedMono,
Stereo = LeftFront | RightFront,
AmbisonicAssigned = AmbisonicWAssigned | AmbisonicXAssigned | AmbisonicYAssigned | AmbisonicZAssigned,
AmbisonicRemapped = AmbisonicWRemapped | AmbisonicXRemapped | AmbisonicYRemapped | AmbisonicZRemapped,
FourDotZero = LeftFront | RightFront | LeftSurround | RightSurround,
FourDotOne = LeftFront | RightFront | LFE | LeftSurround | RightSurround,
FiveDotZero = LeftFront | Center | RightFront | LeftSurround | RightSurround,
FiveDotOne = LeftFront | Center | RightFront | LFE | LeftSurround | RightSurround,
SevenDotOne = LeftFront | Center | RightFront | LFE | LeftSurround | RightSurround | LeftRear | RightRear,
AllSpeakers = 0xFFFFFFFF,
}
}
Values
| Name | Remarks |
|---|---|
| LeftFront | |
| RightFront | |
| Center | |
| LFE | |
| LeftSurround | |
| RightSurround | |
| LeftRear | |
| RightRear | |
| AmbisonicWAssigned | |
| AmbisonicXAssigned | |
| AmbisonicYAssigned | |
| AmbisonicZAssigned | |
| AmbisonicWRemapped | NOTE: Ambisonics live in the first 4 channels of an audio buffer, so here we play a game with the mask! |
| AmbisonicXRemapped | NOTE: Ambisonics live in the first 4 channels of an audio buffer, so here we play a game with the mask! |
| AmbisonicYRemapped | NOTE: Ambisonics live in the first 4 channels of an audio buffer, so here we play a game with the mask! |
| AmbisonicZRemapped | NOTE: Ambisonics live in the first 4 channels of an audio buffer, so here we play a game with the mask! |
| UnspecifiedMono | |
| Stereo | |
| AmbisonicAssigned | |
| AmbisonicRemapped | |
| FourDotZero | |
| FourDotOne | |
| FiveDotZero | |
| FiveDotOne | |
| SevenDotOne | |
| AllSpeakers |