1. Epic GamesDeveloper
  3. IStretcherAndPitchShifterFactory

IStretcherAndPitchShifterFactory

API > API/Plugins > API/Plugins/HarmonixDsp

   
Name IStretcherAndPitchShifterFactory
Type class
Header File /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/StretcherAndPitchShifterFactory.h
Include Path #include "HarmonixDsp/StretcherAndPitchShifterFactory.h"

Syntax

class IStretcherAndPitchShifterFactory : public IModularFeature

Constructors

Name Remarks Include Path Unreal Specifiers

IStretcherAndPitchShifterFactory()

   HarmonixDsp/StretcherAndPitchShifterFactory.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IStretcherAndPitchShifterFactory()

   HarmonixDsp/StretcherAndPitchShifterFactory.h  

Constants

Name Type Remarks Include Path
ClientLock FCriticalSection   HarmonixDsp/StretcherAndPitchShifterFactory.h
Clients TArray< IFeatureClient * >   HarmonixDsp/StretcherAndPitchShifterFactory.h
MemoryHandle FAudioStreamCacheMemoryHandle   HarmonixDsp/StretcherAndPitchShifterFactory.h
TotalMemoryUsed size_t   HarmonixDsp/StretcherAndPitchShifterFactory.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< FName > & GetFactoryNames ()

 Gets the name of this factory type. HarmonixDsp/StretcherAndPitchShifterFactory.h  

TSharedPtr< IStretcherAndPitchShifter, ESPMode::ThreadSafe > GetFreePitchShifter ( const FTimeStretchConfig& InConfig
)

 The factory has the ability to pool pitch shifters HarmonixDsp/StretcherAndPitchShifterFactory.h  

size_t GetMemoryUsedByPool()

 Should return number of bytes used by all of the shifters in the pool. HarmonixDsp/StretcherAndPitchShifterFactory.h  

bool HasFreePitchShifters ( const FTimeStretchConfig& InConfig
) const

 The factory has the ability to pool pitch shifters. HarmonixDsp/StretcherAndPitchShifterFactory.h  
The factory has the ability to pool pitch shifters. HarmonixDsp/StretcherAndPitchShifterFactory.h  

virtual void SetFormantVolumeCorrection ( float DBPerHalfStepUp,
float DBPerHalfStepDown,
float DBMaxUp,
float DBMaxDown
)

 Update the pitch shifters formant and volume correction settings for this factory TODO: Need to rethink how we expose pitch shifter settings HarmonixDsp/StretcherAndPitchShifterFactory.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnClientAdded ( IFeatureClient* Client,
float SampleRate
)

 Override this method to do custom setup when a client is added Clients are added statically and managed by the IStretcherAndPitchShifterFactory HarmonixDsp/StretcherAndPitchShifterFactory.h  

void OnClientRemoved ( IFeatureClient* Client
)

 Override this method to do custom teardown when a client is removed Clients are added statically and managed by the IStretcherAndPitchShifterFactory HarmonixDsp/StretcherAndPitchShifterFactory.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddClient ( IFeatureClient* Client,
float SampleRate
)

 Statically adds a client to the factory module (if it hasn't already beed added) lets each instance of the factory module know about the client allowing them to do any necessary setup HarmonixDsp/StretcherAndPitchShifterFactory.h  

static IStretcherAndPitchShifterFactory * FindBestFactory ( const FTimeStretchConfig& InConfig
)

 Finds a factory with available pitch shifters HarmonixDsp/StretcherAndPitchShifterFactory.h  

static IStretcherAndPitchShifterFactory * FindFactory ( const FName InFactoryName
)

 Returns the instance of the factory with the registered name null if a factory has not been registerred with the given name HarmonixDsp/StretcherAndPitchShifterFactory.h  

static TArray< IStretcherAndPitchShifterFactory * > GetAllRegisteredFactories()

 Gets all registered factory instances. HarmonixDsp/StretcherAndPitchShifterFactory.h  

static TArray< FName > GetAllRegisteredFactoryNames()

 Gets all registered factory names HarmonixDsp/StretcherAndPitchShifterFactory.h  

static FName GetModularFeatureName()

 Get the name of all StretcherAndPitchShifter factories in the Modular Features registry. HarmonixDsp/StretcherAndPitchShifterFactory.h  

static int32 GetNumClients()

   HarmonixDsp/StretcherAndPitchShifterFactory.h  

static bool HasClient ( IFeatureClient* Client
)

   HarmonixDsp/StretcherAndPitchShifterFactory.h  

static void RemoveClient ( IFeatureClient* Client
)

 Statically removes a client from the factory module (if it hasn't already been removed) lets each instance know about the removed client allowing them to do any shut down if necessary HarmonixDsp/StretcherAndPitchShifterFactory.h  

static void ResetMemoryUsageBytes ( uint64 MemoryUsageBytes
)

   HarmonixDsp/StretcherAndPitchShifterFactory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page