FOdinChannelMask

Declaration

USTRUCT(BlueprintType)
struct ODIN_API FOdinChannelMask

• Header: #include "OdinAudio/OdinChannelMask.h"
• Module: Odin
• Blueprint: Blueprint type · Blueprint reference

Constructors

FOdinChannelMask();

FOdinChannelMask(uint64 InitialMask);

Parameter	Type	Description
InitialMask	uint64

Functions

CreateFull

Static

Creates a mask with all 64 channels enabled.

static FOdinChannelMask CreateFull();

Returns FOdinChannelMask

note

Do not pass a full mask to UOdinEncoder::SetPosition: an encoder can only hold positions for 12 channels, so setting a position for all 64 channels fails with ODIN_ERROR_AUDIO_POSITION_LIMIT_REACHED. Build a mask containing just the channels that are actually transmitted on instead (usually only channel 0).

CreateEmpty

Static

Creates a mask with no channels enabled.

static FOdinChannelMask CreateEmpty();

Returns FOdinChannelMask

IsSet

Const

bool IsSet(uint64 mask) const;

Parameter	Type	Description
mask	uint64

Returns bool

Set

uint64 Set(int32 index, bool set);

Parameter	Type	Description
index	int32
set	bool

Returns uint64

Flip

uint64 Flip(int32 index);

Parameter	Type	Description
index	int32

Returns uint64

GetChannelMask

Const

uint64 GetChannelMask() const;

Returns uint64

SetChannelMask

Overload 1

uint64 SetChannelMask(uint64 mask);

Parameter	Type	Description
mask	uint64

Returns uint64

Overload 2

uint64 SetChannelMask(uint32 lower, uint32 higher);

Parameter	Type	Description
lower	uint32
higher	uint32

Returns uint64

Operators

operator[]

Const · Inline

bool operator[](int32 index) const;

Parameter	Type	Description
index	int32

Returns bool

operator uint64

Const · Inline

operator uint64() const;