Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/USoundWave
Holds the uncompressed wav data that was imported. This is guaranteed to be 16 bit, and is mono or stereo - stereo not allowed for multichannel data. For multichannel data, there are distinct RIFF files concatenated in the RawData - one for each channel. These can be accessed with ChannelOffsets and ChannelSizes (see GetImportedSoundWaveData for example).
This structure is a pass-through for editor bulk data. It does an in-place conversion on the audio bits to allow the audio to compress significantly better when the underlying bulk data compression hits it.
If you need access to the underlying audio data, use GetImportedSoundWaveData and avoid touching this.
| Name | FEditorAudioBulkData |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundWave.h |
| Include Path | #include "Sound/SoundWave.h" |
Syntax
struct FEditorAudioBulkData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEditorAudioBulkData
(
USoundWave* Owner |
Sound/SoundWave.h | ||
| Sound/SoundWave.h |
Enums
Public
| Name | Remarks |
|---|---|
| EPayloadFlags |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| RawData | UE::Serialization::FEditorBulkData | Sound/SoundWave.h | ||
| SoundWave | USoundWave * | The container soundwave for this raw data. | Sound/SoundWave.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanSaveForRegistry() |
Sound/SoundWave.h | ||
UE::Serialization::FEditorBulkData CopyTornOff() |
Sound/SoundWave.h | ||
| Sound/SoundWave.h | |||
void CreateLegacyUniqueIdentifier
(
UObject* Owner |
Deprecated unused API forwarding for potential backwards compatability issues. | Sound/SoundWave.h | |
void DetachFromDisk
(
FArchive* Ar, |
Sound/SoundWave.h | ||
bool DoesPayloadNeedLoading() |
Sound/SoundWave.h | ||
void GetBulkDataVersions
(
FArchive& InlineArchive, |
Sound/SoundWave.h | ||
TFuture< FCompressedBuffer > GetCompressedPayload() |
Sound/SoundWave.h | ||
FGuid GetIdentifier() |
Sound/SoundWave.h | ||
TFuture< FSharedBuffer > GetPayload
(
const EPayloadFlags Flags |
Sound/SoundWave.h | ||
const FIoHash & GetPayloadId() |
Sound/SoundWave.h | ||
int64 GetPayloadSize() |
Sound/SoundWave.h | ||
bool HasPayloadData() |
Sound/SoundWave.h | ||
bool HasPlaceholderPayloadId() |
Sound/SoundWave.h | ||
bool IsMemoryOnlyPayload() |
Sound/SoundWave.h | ||
bool LocationMatches
(
const UE::Serialization::FEditorBulkData& Other |
Sound/SoundWave.h | ||
void Reset() |
Sound/SoundWave.h | ||
| Sound/SoundWave.h | |||
void SerializeForRegistry
(
FArchive& Ar |
Sound/SoundWave.h | ||
void SetCompressionOptions
(
UE::Serialization::ECompressionOptions Option |
Sound/SoundWave.h | ||
void SetCompressionOptions
(
ECompressedBufferCompressor Compressor, |
Sound/SoundWave.h | ||
void TearOff() |
Sound/SoundWave.h | ||
void UnloadData() |
Sound/SoundWave.h | ||
void UpdatePayload
(
FCompressedBuffer InPayload, |
Sound/SoundWave.h | ||
void UpdatePayload
(
FSharedBuffer InPayload, |
Sound/SoundWave.h | ||
void UpdatePayload
(
UE::Serialization::FEditorBulkData::FSharedBufferWithID InPayload, |
Sound/SoundWave.h | ||
void UpdatePayloadId() |
Sound/SoundWave.h | ||
void UpdateRegistrationOwner
(
UObject* Owner |
Sound/SoundWave.h |