1. Epic GamesDeveloper
  3. FMetasoundGenerator

FMetasoundGenerator

API > API/Plugins > API/Plugins/MetasoundGenerator

Inheritance Hierarchy

References

   
Module MetasoundGenerator
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundGenerator/Public/MetasoundGenerator.h
Include #include "MetasoundGenerator.h"

Syntax

class FMetasoundGenerator : public ISoundGenerator

Variables

  Type Name Description
Protected variable TArray< FAudioBufferReadRef > GraphOutputAudio  
Public variable FString MetasoundName  
Protected variable FTriggerReadRef OnFinishedTriggerRef Triggered when metasound is finished.
Public variable FOnOutputChanged OnOutputChanged  
Public variable const FOperatorSettings OperatorSettings  
Protected variable TMap< FName, MetasoundGeneratorPrivate::FParameterPackSetter > ParameterPackSetters This map provides setters for all of the input nodes in the metasound graph.
Protected variable MetasoundGeneratorPrivate::FParameterSetterSortedMap ParameterSetters  
Protected variable FExecuter RootExecuter  
Protected variable FVertexInterfaceData VertexInterfaceData  

Constructors

  Type Name Description
Public function  

FMetasoundGenerator ( const FOperatorSettings& InOperatorSettings
)

 Create the generator with a graph operator and an output audio reference.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FDelegateHandle

AddGraphSetCallback ( FOnSetGraph::FDelegate&& Delegate
)

 Called when a new graph has been "compiled" and set up as this generator's graph.
Public function void Add a vertex analyzer for a named output with the given address info.
Public function void

ApplyToInputValue ( const FVertexName& InName,
TFunctionRef< void(DataType&)> InFunc
)

 Apply a function to the graph's input data.
Protected function void Release the graph operator and remove any references to data owned by the graph operator.
Public function    
Public function Const double Fraction of a single CPU core used to render audio on a scale of 0.0 to 1.0
Public function TOptional< TDataWriteReference< DataType > >

GetInputWriteReference ( const FVertexName InputName
)

 Get a write reference to one of the generator's inputs, if it exists.
Public function Const int32 Return the number of audio channels.
Public function TOptional< TDataReadReference< DataType > >

GetOutputReadReference ( const FVertexName OutputName
)

 Get a read reference to one of the generator's outputs, if it exists.
Protected function void

InitBase ( const FMetasoundGeneratorInitParams& InInitParams
)

  
Public function void  
Protected function Virtual TUniquePtr< IOperator >  
Protected function FInputVertexInterfaceData  
Public function bool  
Public function void Remove a vertex analyzer for a named output
Protected function void SetGraph directly sets graph. Callers must ensure that no race conditions exist.
Public function void

SetInputValue ( const FVertexName& InName,
DataType InData
)

 Set the value of a graph's input data using the assignment operator.
Protected function bool  

Overridden from ISoundGenerator

  Type Name Description
Public function Virtual Const int32 Returns the number of samples to render per callback.
Public function Virtual Const bool Optional. Can be overridden to end the sound when generating is finished.
Public function Virtual int32

OnGenerateAudio ( float* OutAudio,
int32 NumSamples
)

 Called when a new buffer is required.

Typedefs

Name Description
FAudioBufferReadRef  
FOperatorUniquePtr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page