UAudio::ESoundFileFormat::Flags

Specifies the major format type of the sound source.

Windows
MacOS
Linux

References

Module

UnrealAudio

Header

/Engine/Source/Runtime/UnrealAudio/Public/UnrealAudioSoundFile.h

Include

#include "UnrealAudioSoundFile.h"

Syntax

namespace UAudio
{
    namespace ESoundFileFormat
    {
        enum Flags
        {
            WAV                  = 0x010000,
            AIFF                 = 0x020000,
            FLAC                 = 0x170000,
            OGG                  = 0x200000,
            PCM_SIGNED_8         = 0x0001,
            PCM_SIGNED_16        = 0x0002,
            PCM_SIGNED_24        = 0x0003,
            PCM_SIGNED_32        = 0x0004,
            PCM_UNSIGNED_8       = 0x0005,
            PCM_FLOAT            = 0x0006,
            PCM_DOUBLE           = 0x0007,
            MU_LAW               = 0x0010,
            A_LAW                = 0x0011,
            IMA_ADPCM            = 0x0012,
            MS_ADPCM             = 0x0013,
            GSM_610              = 0x0020,
            G721_32              = 0x0030,
            G723_24              = 0x0031,
            G723_40              = 0x0032,
            DWVW_12              = 0x0040,
            DMVW_16              = 0x0041,
            DMVW_24              = 0x0042,
            DMVW_N               = 0x0043,
            VORBIS               = 0x0060,
            ENDIAN_FILE          = 0x00000000,
            ENDIAN_LITTLE        = 0x10000000,
            ENDIAN_BIG           = 0x20000000,
            ENDIAN_CPU           = 0x30000000,
            MINOR_FORMAT_MASK    = 0x0000FFFF,
            MAJOR_FORMAT_MASK    = 0x0FFF0000,
            ENDIAN_MASK          = 0x30000000,
        }
    }
}

Values

Name

Description

WAV

Major Formats.

AIFF

FLAC

OGG

PCM_SIGNED_8

Uncompressed Minor Formats.

PCM_SIGNED_16

PCM_SIGNED_24

PCM_SIGNED_32

PCM_UNSIGNED_8

PCM_FLOAT

PCM_DOUBLE

MU_LAW

Compressed Minor Formats.

A_LAW

IMA_ADPCM

MS_ADPCM

GSM_610

G721_32

G723_24

G723_40

DWVW_12

DMVW_16

DMVW_24

DMVW_N

VORBIS

ENDIAN_FILE

Endian opts.

ENDIAN_LITTLE

ENDIAN_BIG

ENDIAN_CPU

MINOR_FORMAT_MASK

Masks.

MAJOR_FORMAT_MASK

ENDIAN_MASK

Remarks

Specifies the major format type of the sound source. File formats are fully specified by a major/minor format.

For example, a Ogg-Vorbis encoding would use: uint32 FormatFlags = ESoundFormatFlags::OGG | ESoundFormatFlags::VORBIS;

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss