Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
Builder in charge of building a MetaSound Source
| Name | UMetaSoundSourceBuilder |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundBuilderSubsystem.h |
| Include Path | #include "MetasoundBuilderSubsystem.h" |
Syntax
UCLASS (MinimalAPI, Transient, BlueprintType, Meta=(DisplayName="MetaSound Source Builder"))
class UMetaSoundSourceBuilder : public UMetaSoundBuilderBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMetaSoundBuilderBase → UMetaSoundSourceBuilder
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAuditionableTransaction | TFunctionRef< bool(Metasound::DynamicGraph::FDynamicOperatorTransactor &)> | MetasoundBuilderSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LiveComponentHandle | FDelegateHandle | MetasoundBuilderSubsystem.h | ||
| LiveComponentIDs | TArray< uint64 > | MetasoundBuilderSubsystem.h | ||
| TargetPageID | FGuid | MetasoundBuilderSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Audition
(
UObject* Parent, |
MetasoundBuilderSubsystem.h |
|
|
const Metasound::Engine::FOutputAudioFormatInfoPair * FindOutputAudioFormatInfo() |
MetasoundBuilderSubsystem.h | ||
bool GetLiveUpdatesEnabled() |
Returns whether or not live updates are both globally enabled (via cvar) and are enabled on this builder's last built sound, which may or may not still be playing. | MetasoundBuilderSubsystem.h |
|
void SetBlockRateOverride
(
float BlockRate |
Sets the MetaSound's BlockRate override. | MetasoundBuilderSubsystem.h |
|
void SetFormat
(
EMetaSoundOutputAudioFormat OutputFormat, |
Sets the output audio format of the source. | MetasoundBuilderSubsystem.h |
|
void SetPlatformBlockRateOverride
(
const FPerPlatformFloat& PlatformFloat |
Sets the MetaSound's BlockRate override (editor only, to allow setting per-platform values) | MetasoundBuilderSubsystem.h | |
void SetPlatformSampleRateOverride
(
const FPerPlatformInt& PlatformInt |
Sets the MetaSound's BlockRate override (editor only, to allow setting per-platform values) | MetasoundBuilderSubsystem.h | |
void SetQuality
(
FName Quality |
Sets the MetaSound's Quality level. | MetasoundBuilderSubsystem.h |
|
void SetSampleRateOverride
(
int32 SampleRate |
Sets the MetaSound's SampleRate override. | MetasoundBuilderSubsystem.h |
|
Overridden from UMetaSoundBuilderBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TScriptInterface< IMetaSoundDocumentInterface > BuildNewMetaSound
(
FName NameBase |
Builds a transient MetaSound with the provided builder options, copying the underlying MetaSound managed by this builder and registering it with the MetaSound Node Registry as a unique class. | MetasoundBuilderSubsystem.h | |
virtual const UClass & GetBaseMetaSoundUClass() |
Returns the base class registered with the MetaSound UObject registry. | MetasoundBuilderSubsystem.h |
Protected
Overridden from UMetaSoundBuilderBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildAndOverwriteMetaSoundInternal
(
TScriptInterface< IMetaSoundDocumentInterface > ExistingMetaSound, |
MetasoundBuilderSubsystem.h | ||
virtual void InitDelegates
(
Metasound::Frontend::FDocumentModifyDelegates& OutDocumentDelegates |
MetasoundBuilderSubsystem.h | ||
virtual void OnAssetReferenceAdded
(
TScriptInterface< IMetaSoundDocumentInterface > DocInterface |
MetasoundBuilderSubsystem.h | ||
virtual void OnRemovingAssetReference
(
TScriptInterface< IMetaSoundDocumentInterface > DocInterface |
MetasoundBuilderSubsystem.h |