FSoundWavePCMLoader

[FSoundWavePCMLoader](API\Runtime\Engine\Sound\FSoundWavePCMLoader) This class loads and decodes a [USoundWave](API\Runtime\Engine\Sound\USoundWave) asset into a [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer).

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FSoundWavePCMLoader

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SampleBufferIO.h

Include

#include "Sound/SampleBufferIO.h"

Syntax

class FSoundWavePCMLoader : public FGCObject

Remarks

FSoundWavePCMLoader This class loads and decodes a USoundWave asset into a TSampleBuffer . To use, call LoadSoundWave with the sound wave you'd like to load and call Update on every tick until it returns true, at which point you may call GetSampleBuffer to get the decoded audio.

Constructors

Name Description

Public function

FSoundWavePCMLoader()

Functions

Name Description

Public function

void

 

LoadSoundWave

(
    USoundWave * InSoundWave,
    TFunction < void &#...,
    bool bSynchrounous
)

Loads a USoundWave , call on game thread. Unless called with bSynchnous set to true, this class will require Update() to be called on the game thread.

Public function

void

 

Update()

Update the loading state, should be called on the game thread.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector & Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback