Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | USynthSamplePlayer |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/SynthComponentWaveTable.h |
| Include Path | #include "SynthComponents/SynthComponentWaveTable.h" |
Syntax
UCLASS (MinimalAPI, ClassGroup=Synth, Meta=(BlueprintSpawnableComponent))
class USynthSamplePlayer : public USynthComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → USynthComponent → USynthSamplePlayer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USynthSamplePlayer
(
const FObjectInitializer& ObjInitializer |
SynthComponents/SynthComponentWaveTable.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~USynthSamplePlayer() |
SynthComponents/SynthComponentWaveTable.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnSampleLoaded | FOnSampleLoaded | SynthComponents/SynthComponentWaveTable.h |
|
|
| OnSamplePlaybackProgress | FOnSamplePlaybackProgress | SynthComponents/SynthComponentWaveTable.h |
|
|
| SoundWave | TObjectPtr< USoundWave > | SynthComponents/SynthComponentWaveTable.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetCurrentPlaybackProgressPercent() |
SynthComponents/SynthComponentWaveTable.h |
|
|
float GetCurrentPlaybackProgressTime() |
SynthComponents/SynthComponentWaveTable.h |
|
|
float GetSampleDuration() |
SynthComponents/SynthComponentWaveTable.h |
|
|
bool IsLoaded() |
SynthComponents/SynthComponentWaveTable.h |
|
|
void SeekToTime
(
float TimeSec, |
SynthComponents/SynthComponentWaveTable.h |
|
|
void SetPitch
(
float InPitch, |
SynthComponents/SynthComponentWaveTable.h |
|
|
void SetScrubMode
(
bool bScrubMode |
SynthComponents/SynthComponentWaveTable.h |
|
|
void SetScrubTimeWidth
(
float InScrubTimeWidthSec |
SynthComponents/SynthComponentWaveTable.h |
|
|
void SetSoundWave
(
USoundWave* InSoundWave |
This will override the current sound wave if one is set, stop audio, and reload the new sound wave. | SynthComponents/SynthComponentWaveTable.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void LoadSoundWaveInternal() |
SynthComponents/SynthComponentWaveTable.h |