Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AudioMixer > Components > USynthSound > USynthSound::GetGeneratedPCMDataFormat

Light Theme

Dark Theme

USynthSound::GetGeneratedPCMDataFormat

Return the format of the generated PCM data type.

Windows

MacOS

Linux

Override Hierarchy

USoundWave::GetGeneratedPCMDataFormat()

USynthSound::GetGeneratedPCMDataFormat()

References

Module	AudioMixer
Header	/Engine/Source/Runtime/AudioMixer/Public/Components/SynthComponent.h
Include	#include "Components/SynthComponent.h"
Source	/Engine/Source/Runtime/AudioMixer/Private/Components/SynthComponent.cpp

Syntax

virtual Audio::EAudioMixerStreamDataFormat::Type GetGeneratedPCMDataFormat() const

Remarks

Return the format of the generated PCM data type. Used in audio mixer to allow generating float buffers and avoid unnecessary format conversions. This feature is only supported in audio mixer. If your procedural sound wave needs to be used in both audio mixer and old audio engine, it's best to generate int16 data as old audio engine only supports int16 formats. Or check at runtime if the audio mixer is enabled. Audio mixer will convert from int16 to float internally.

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

Take our survey

Dismiss