USynthSamplePlayer

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/SynthComponentWaveTable.h

Include

#include "SynthComponents/SynthComponentWaveTable.h"

Syntax

UCLASS(ClassGroup=Synth, Meta=(BlueprintSpawnableComponent))
class USynthSamplePlayer : public USynthComponent

Variables

Name Description

Protected variable

bool

 

bIsLoaded

Public variable UProperty Category BlueprintAssignable

FOnSampleLoaded

 

OnSampleLoaded

Public variable UProperty Category BlueprintAssignable

FOnSamplePlayba...

 

OnSamplePlaybackProgress

Protected variable

Audio::TSampleB...

 

SampleBuffer

Protected variable

Audio::FSampleB...

 

SampleBufferReader

Protected variable

float

 

SampleDurationSec

Protected variable

float

 

SamplePlaybackProgressSec

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

USoundWave *...

 

SoundWave

Protected variable

Audio::FSoundWa...

 

SoundWaveLoader

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

float

 

GetCurrentPlaybackProgressPercent()

Public function Const UFunction BlueprintCallable, Category

float

 

GetCurrentPlaybackProgressTime()

Public function Const UFunction BlueprintCallable, Category

float

 

GetSampleDuration()

Public function Const UFunction BlueprintCallable, Category

bool

 

IsLoaded()

Protected function

void

 

LoadSoundWaveInternal()

Public function UFunction BlueprintCallable, Category

void

 

SeekToTime

(
    float TimeSec,
    ESamplePlayerSeekType SeekType,
    bool bWrap
)

Public function UFunction BlueprintCallable, Category

void

 

SetPitch

(
    float InPitch,
    float TimeSec
)

Public function UFunction BlueprintCallable, Category

void

 

SetScrubMode

(
    bool bScrubMode
)

Public function UFunction BlueprintCallable, Category

void

 

SetScrubTimeWidth

(
    float InScrubTimeWidthSec
)

Public function UFunction BlueprintCallable, Category

void

 

SetSoundWave

(
    USoundWave* InSoundWave
)

This will override the current sound wave if one is set, stop audio, and reload the new sound wave.

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