description: Resets internal audio buffers. This pitch detector does not produce any more pitches on Finalize.

code: virtual void Finalize ( [TArray](API\Runtime\Core\Containers\TArray)< [FPitchInfo](API\Plugins\AudioSynesthesiaCore\FPitchInfo) > & OutPitches )


module: AudioSynesthesiaCore

code: virtual ~FFFTPeakPitchDetector()


description: Create an fft pitch detector with settings and a sample rate.

code: FFFTPeakPitchDetector ( const [FFFTPeakPitchDetectorSettings](API\Plugins\AudioSynesthesiaCore\FFFTPeakPitchDetectorSettings) & InSettings, float InSampleRate )


className: FFFTPeakPitchDetector

description: FFT based pitch detector accel at detecting pitches at higher frequencies.

code: class FFFTPeakPitchDetector : public [Audio::IPitchDetector](API\Plugins\AudioSynesthesiaCore\IPitchDetector)


className: FFFTPeakPitchDetectorSettings

description: Settings for FFT base pitch detection

code: struct FFFTPeakPitchDetectorSettings

AnalysisHopSeconds

type: float

description: Number of seconds between analysis windows.

AnalysisWindowSeconds

description: Number of seconds represented in each analysis window.

description: Log 2 size of the FFT

MaximumFrequency

description: Maximum frequency of detected pitches.

MaxStrengthSNRDecibels

description: Reference SNR for calculating strength of signal.

MinimumFrequency

description: Minimum frequency of detected pitches.

Sensitivity

description: Sensitivity of peak detection.


description: Calculate the loudness for the input samples. The number of input samples must be equal to the FFTSize supplied inFLoudnessAnalyzerSettings.

code: float CalculateLoudness ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView )


description: Calculate the perceptual energy for the input samples. The number of input samples must be equal to the FFTSize supplied inFLoudnessAnalyzerSettings.

code: float CalculatePerceptualEnergy ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView )


description: Convert from perceptual energy to loudness [Loudness = 10 * log_10(Energy)]

code: static float ConvertPerceptualEnergyToLoudness ( float InPerceptualEnergy )


description: Return const reference to settings used inside this analyzer.

code: const [FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings) & GetSettings() const


className: FLoudnessAnalyzer

description: FLoudnessAnalyzerwill calculate perceptual energy or loudness one window at a time. This analyzer only handles mono audio. SeeFMultichannelLoudnessAnalyzerfor multichannel support.

code: class FLoudnessAnalyzer


description: Construct analyzer

code: FLoudnessAnalyzer ( float InSampleRate, const [FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings) & InSettings )


description: Default settings

code: FLoudnessAnalyzerSettings()


className: FLoudnessAnalyzerSettings

description: Settings forFLoudnessAnalyzer

code: struct FLoudnessAnalyzerSettings

FFTSize

description: Size of FFT describe in number of samples

LoudnessCurveType

type: ELoudnessCurveT...

description: Type of equal loudness curve to weight power spectrum

MaxAnalysisFrequency

description: Maximum frequency for analyzing audio

MinAnalysisFrequency

description: Minimum frequency for analyzing audio

WindowType

type: EWindowType

description: Type of window to be applied to input audio


className: FLoudnessDatum

description: Holds the loudness values per a time step.

code: struct FLoudnessDatum


className: FLoudnessEntry

code: struct FLoudnessEntry


description: Human readable name of analyzer.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetTitle() const


description: Name of specific analyzer type.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Creates a newFLoudnessNRTResult

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) > NewResult() const


description: Creates a newFLoudnessWorker. This expectsIAnalyzerNRTSettingsto be a valid pointer to aFLoudnessSettingsobject.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker) > NewWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) * InSettings ) const


description: Creates a newFLoudnessNRTResult

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) > NewResult() const


description: Creates a newFLoudnessNRTWorker. This expectsIAnalyzerNRTSettingsto be a valid pointer to aFLoudnessNRTSettingsobject.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTWorker](API\Runtime\AudioAnalyzer\IAnalyzerNRTWorker) > NewWorker ( const [FAnalyzerNRTParameters](API\Runtime\AudioAnalyzer\FAnalyzerNRTParameters) & InParams, const [IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings) * InSettings ) const


description: Appends anFLoudnessDatumto the container.

code: void Add ( const [FLoudnessDatum](API\Plugins\AudioSynesthesiaCore\FLoudnessDatum) & InDatum )


className: FLoudnessNRTFactory

description: Defines the LoudnessNRT analyzer and creates related classes.

code: class FLoudnessNRTFactory : public [Audio::IAnalyzerNRTFactory](API\Runtime\AudioAnalyzer\IAnalyzerNRTFactory)


className: ChannelIndexOverall

description: Denotes the overall loudness channel index as opposed individual channel indices.

code: static const int32 ChannelIndexOverall = INDEX_NONE;


description: Returns true if this object data for the given channel index

code: bool ContainsChannel ( int32 InChannelIndex ) const


description: Returns const reference toFLoudnessDatumarray for individual channel.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLoudnessDatum](API\Plugins\AudioSynesthesiaCore\FLoudnessDatum) > & GetChannelLoudnessArray ( int32 ChannelIdx ) const


description: Returns range in dB of loudness result given the noise floor.

code: float GetChannelLoudnessRange ( int32 InChannelIdx, float InNoiseFloor ) const


description: Returns the channel indices available in result.

code: void GetChannels ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutChannels ) const


className: FLoudnessFactory

description: Defines the Loudness analyzer and creates related classes.

code: class FLoudnessFactory : public [Audio::IAnalyzerFactory](API\Runtime\AudioAnalyzer\IAnalyzerFactory)


description: Gets the duration of the analyzed audio.

code: virtual float GetDurationInSeconds() const


description: Returns const reference toFLoudnessDatumarray associated with overall loudness.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLoudnessDatum](API\Plugins\AudioSynesthesiaCore\FLoudnessDatum) > & GetLoudnessArray() const


description: Returns range in dB of overall loudness result given the noise floor.

code: float GetLoudnessRange ( float InNoiseFloor ) const


description: Returns true ifFLoudnessDatumarrays are sorted in chronologically ascending order via their timestamp.

code: bool IsSortedChronologically() const


description: Defines how to serialize result.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: Sets the duration of the analyzed audio.

code: void SetDurationInSeconds ( float InDuration )


description: SortsFLoudnessDatumarrays in chronologically ascending order via their timestamp.

code: void SortChronologically()


code: FLoudnessNRTResult()


className: FLoudnessNRTResult

description: FLoudnessNRTResultcontains the temporal evolution of loudness.

code: class FLoudnessNRTResult : public [Audio::IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult)


code: FLoudnessNRTSettings()


className: FLoudnessNRTSettings

description: Contains settings for loudness analyzer.

code: class FLoudnessNRTSettings : public [Audio::IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings), public [Audio::FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings)

AnalysisPeriod

description: Number of seconds between loudness measurements


description: Analyzes input sample buffer and updates result.

code: virtual void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


description: Call when all audio data has been analyzed.

code: virtual void Finalize ( [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


description: Construct a worker

code: FLoudnessNRTWorker ( const [FAnalyzerNRTParameters](API\Runtime\AudioAnalyzer\FAnalyzerNRTParameters) & InParams, const [FLoudnessNRTSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessNRTSettings) & InAnalyzerSettings )


className: FLoudnessNRTWorker

description: FLoudnessNRTWorkerperforms loudness analysis on input sample buffers.

code: class FLoudnessNRTWorker : public [Audio::IAnalyzerNRTWorker](API\Runtime\AudioAnalyzer\IAnalyzerNRTWorker)


description: Appends anFLoudnessDatumto the container.

code: void Add ( const [FLoudnessEntry](API\Plugins\AudioSynesthesiaCore\FLoudnessEntry) & InDatum )


description: Returns const reference toFLoudnessDatumarray for individual channel.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLoudnessEntry](API\Plugins\AudioSynesthesiaCore\FLoudnessEntry) > & GetChannelLoudnessArray ( int32 ChannelIdx ) const


description: Denotes the overall loudness as opposed individual channel indices.

code: static const int32 ChannelIndexOverall = INDEX_NONE;


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLoudnessEntry](API\Plugins\AudioSynesthesiaCore\FLoudnessEntry) > & GetLoudnessArray() const


description: Returns the number of channels.

code: int32 GetNumChannels() const


className: FLoudnessSettings

code: class FLoudnessSettings : public [Audio::IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings), public [Audio::FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings)


className: FLoudnessResult

description: FLoudnessResultcontains the temporal evolution of loudness for the last buffer of audio analyzed.

code: class FLoudnessResult : public [Audio::IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult)


code: virtual void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) * OutResult )


description: Construct a worker

code: FLoudnessWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [FLoudnessSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessSettings) & InAnalyzerSettings )


className: FLoudnessWorker

description: FLoudnessWorkerperforms loudness analysis on input sample buffers.

code: class FLoudnessWorker : public [Audio::IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker)


description: Call when all audio has been processed. Appends pitch tracks to OutPitchTracks.

code: virtual void Finalize ( [TArray](API\Runtime\Core\Containers\TArray)< [FPitchTrackInfo](API\Plugins\AudioSynesthesiaCore\FPitchTrackInfo) > & OutPitchTracks )


description: Append pitch tracks to processed audio.

code: virtual void TrackPitches ( const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InMonoAudio, [TArray](API\Runtime\Core\Containers\TArray)< [FPitchTrackInfo](API\Plugins\AudioSynesthesiaCore\FPitchTrackInfo) > & OutPitchTracks )


description: Constructor accepts settings and a unique pointer to the pitch detector.

code: FMaxStrengthPitchTracker ( const [FMaxStrengthPitchTrackerSettings](API\Plugins\AudioSynesthesiaCore\FMaxStrengthPitchTrackerSettings) & InSettings, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IPitchDetector](API\Plugins\AudioSynesthesiaCore\IPitchDetector) > InDetector )


code: virtual ~FMaxStrengthPitchTracker()


className: FMaxStrengthPitchTracker

description: Track the maximum strength pitch.

code: class FMaxStrengthPitchTracker : public [Audio::IPitchTracker](API\Plugins\AudioSynesthesiaCore\IPitchTracker)


className: FMaxStrengthPitchTrackerSettings

description: Settings forFMaxStrengthPitchTracker

code: struct FMaxStrengthPitchTrackerSettings

MaximumFrequencyRatioDeviation

description: Maximum deviation of ratio between two freuqencies to consider them part of the same pitch track.

MinimumStrength

description: Minimum strength of pitch to be included in pitch track.


className: FEnvelopeData

description: State to track the peak data.

code: struct FEnvelopeData

bPriorEnvelopeSlopeIsPositive

type: bool

PriorEnvelopeValue

description: Current slope of the envelope.


className: FClippingData

description: Per-channel clipping data.

code: struct FClippingData

NumSamplesClipping

description: How many samples we've been clipping.


description: Return const reference to settings used inside this analyzer.

code: const [FMeterAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FMeterAnalyzerSettings) & GetSettings() const


description: Calculate the meter results for the input samples. Will return the current meter and the current peak value of the analyzer.

code: [FMeterAnalyzerResults](API\Plugins\AudioSynesthesiaCore\FMeterAnalyzerResults) ProcessAudio ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView )


description: Construct analyzer

code: FMeterAnalyzer ( float InSampleRate, int32 NumChannels, const [FMeterAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FMeterAnalyzerSettings) & InSettings )


className: FMeterAnalyzer

code: class FMeterAnalyzer

ClippingDataPerChannel

type: TArray<FClippi...

EnvelopeBuffer

type: FAlignedFloatBu...

EnvelopeDataPerChannel

type: TArray<FEnvelo...

description: Per-channel peak data.

EnvelopeFollower

type: FEnvelopeFollow...

description: Envelope follower per channel.

Settings

type: FMeterAnalyzerS...


className: FMeterAnalyzerResults

description: Per-channel analyzer results.

code: struct FMeterAnalyzerResults

ClippingValues

type: TArray< float >

NumSamplesClipping

type: TArray< int32 >


className: FMeterAnalyzerSettings

code: struct FMeterAnalyzerSettings

ClippingThreshold

description: The volume threshold to detect clipping.

MeterAttackTime

description: Envelope follower attack time in milliseconds.

MeterPeakMode

description: Envelope follower mode.

MeterReleaseTime

description: Envelope follower release time in milliseconds.

PeakHoldTime

description: Peak detector hold time in milliseconds.


className: FMeterEntry

description: Holds the meter results per a time step for each channel

code: struct FMeterEntry


description: Human readable name of analyzer.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetTitle() const


description: Name of specific analyzer type.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Creates a newFLoudnessNRTResult

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) > NewResult() const


description: Creates a newFLoudnessWorker. This expectsIAnalyzerNRTSettingsto be a valid pointer to aFLoudnessSettingsobject.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker) > NewWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) * InSettings ) const


className: FMeterFactory

description: Defines the meter analyzer and creates related classes.

code: class FMeterFactory : public [Audio::IAnalyzerFactory](API\Runtime\AudioAnalyzer\IAnalyzerFactory)


description: Appends anFMeterEntryto the container.

code: void Add ( const [FMeterEntry](API\Plugins\AudioSynesthesiaCore\FMeterEntry) & InEntry )


className: ChannelIndexOverall

code: static const int32 ChannelIndexOverall = INDEX_NONE;


description: Returns const reference toFMeterEntryarray for individual channel.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FMeterEntry](API\Plugins\AudioSynesthesiaCore\FMeterEntry) > & GetChannelMeterArray ( int32 ChannelIdx ) const


description: Returns const reference toFMeterEntryarray associated with overall loudness.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FMeterEntry](API\Plugins\AudioSynesthesiaCore\FMeterEntry) > & GetMeterArray() const


description: Returns the number of channels.

code: int32 GetNumChannels() const


className: FMeterResult

description: FMeterResultcontains the temporal evolution of loudness for the last buffer of audio analyzed.

code: class FMeterResult : public [Audio::IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult)


description: Analyzes input sample buffer and updates result.

code: virtual void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) * OutResult )


className: FMeterSettings

description: Contains settings for meter analyzer.

code: class FMeterSettings : public [Audio::IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings), public [Audio::FMeterAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FMeterAnalyzerSettings)

AnalysisPeriod

description: Number of seconds between loudness measurements


description: Construct a worker

code: FMeterWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [FMeterSettings](API\Plugins\AudioSynesthesiaCore\FMeterSettings) & InAnalyzerSettings )


description: The overall loudness is returned.

code: float CalculateLoudness ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView, const int32 InNumChannels, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutChannelLoudness )


description: The overall perceptual energy is returned.

code: float CalculatePerceptualEnergy ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView, const int32 InNumChannels, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutChannelEnergies )


className: FMeterWorker

description: FMeterWorkerperforms meter analysis on input sample buffers.

code: class FMeterWorker : public [Audio::IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker)


code: const [FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings) & GetSettings() const


description: Construct analyzer.

code: FMultichannelLoudnessAnalyzer ( float InSampleRate, const [FLoudnessAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FLoudnessAnalyzerSettings) & InSettings )


className: FMultichannelLoudnessAnalyzer

description: FMultichannelLoudnessAnalyzerwill calculate perceptual energy or loudness one window at a time. This module can handle one or more channels at a time. It expects interleaved audio samples.

code: class FMultichannelLoudnessAnalyzer


code: FOnset ( int32 InChannelIndex, float InTimestamp, float InStrength )


className: FOnset

description: Contains data relating to one onset.

code: struct FOnset

Channel

description: Audio channel which produced the data.

Timestamp

description: Timestamp in seconds referring to the center of the audio window.


description: Name of this analyzer type.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Human readable name of this analyzer.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetTitle() const


description: Create a newFOnsetNRTResult.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) > NewResult() const


description: InSettings must be a pointer to FOnsetNRTSetting

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerNRTWorker](API\Runtime\AudioAnalyzer\IAnalyzerNRTWorker) > NewWorker ( const [FAnalyzerNRTParameters](API\Runtime\AudioAnalyzer\FAnalyzerNRTParameters) & InParams, const [IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings) * InSettings ) const


className: FOnsetNRTFactory

description: Factory for creating FOnsetNRT workers and results

code: class FOnsetNRTFactory : public [Audio::IAnalyzerNRTFactory](API\Runtime\AudioAnalyzer\IAnalyzerNRTFactory)


description: Adds an empty channel. Useful if a channel exists without any onsets.

code: void AddChannel ( int32 InChannelIndex )


description: Add a single frame of CQT data

code: void AddOnset ( int32 InChannelIndex, float InTimestamp, float InStrength )


description: Returns true if this result contains the channel index.

code: bool ContainsChannel ( int32 InChannelIndex ) const


description: Retrieve the interval of the maximum and minimum strengths of all onsets in channel.

code: [FFloatInterval](API\Runtime\Core\Math\FFloatInterval) GetChannelOnsetInterval ( int32 InChannelIdx ) const


description: Retrieve the channels available in the result.

code: void GetChannels ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutChannels ) const


description: Retrieve the array of frames for a single channel of audio.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FOnset](API\Plugins\AudioSynesthesiaCore\FOnset) > & GetOnsetsForChannel ( int32 InChannelIndex ) const


description: Returns the duration of the analyzed audio in seconds

code: virtual float GetDurationInSeconds() const


description: Serialize or unserialize object

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: Returns true ifFOnsetarrays are sorted in chronologically ascending order via their timestamp.

code: bool IsSortedChronologically() const


description: Sets the duration of the analyzed audio in seconds

code: void SetDurationInSeconds ( float InDuration )


description: Sorts FOnsetNRTFrame arrays in chronologically ascnding order via their timestamp.

code: void SortChronologically()


className: FOnsetNRTResult

description: FOnsetNRTResultis a container for the output of theFOnsetNRTWorker.

code: class FOnsetNRTResult : public [Audio::IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult)


className: FOnsetNRTSettings

description: Settings for the Constant Q Non-Real-Time Factory.

code: class FOnsetNRTSettings : public [Audio::IAnalyzerNRTSettings](API\Runtime\AudioAnalyzer\IAnalyzerNRTSettings)

bDownmixToMono

description: If true, all channels are mixed together with equal power before analysis.

OnsetStrengthSettings

type: FOnsetStrengthS...

PeakPickerSettings

type: FPeakPickerSett...


description: InAudio is an array view of audio. OutResult is a pointer to a validFOnsetNRTResult

code: virtual void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


description: Called when analysis of audio asset is complete.

code: virtual void Finalize ( [IAnalyzerNRTResult](API\Runtime\AudioAnalyzer\IAnalyzerNRTResult) * OutResult )


description: InParams are the parameters which describe characteristics of the input audio. InAnalyzerSettings are the settings which control various aspects of the algorithm.

code: FOnsetNRTWorker ( const [FAnalyzerNRTParameters](API\Runtime\AudioAnalyzer\FAnalyzerNRTParameters) & InParams, const [FOnsetNRTSettings](API\Plugins\AudioSynesthesiaCore\FOnsetNRTSettings) & InAnalyzerSettings )


className: FOnsetNRTWorker

description: FOnsetNRTWorkercomputes aFOnsetNRTResultfrom audio samples.

code: class FOnsetNRTWorker : public [Audio::IAnalyzerNRTWorker](API\Runtime\AudioAnalyzer\IAnalyzerNRTWorker)


description: Calculates onset strengths from audio and fills OutOnsetStrengths with generated onset strengths

code: void CalculateOnsetStrengths ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSamples, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutOnsetStrengths )


description: Call when done processing audio for an audio analyzer

code: void FlushAudio ( [TArray](API\Runtime\Core\Containers\TArray)< float > & OutEnvelopeStrengths )


description: Call to reset internal counters and lag spectra.

code: void Reset()


description: Converts an onset strength index into a timestamp.

code: static float GetTimestampForIndex ( const [FOnsetStrengthSettings](API\Plugins\AudioSynesthesiaCore\FOnsetStrengthSettings) & InSettings, float InSampleRate, int32 InIndex )


className: FOnsetStrengthAnalyzer

description: [audio]->[fft]->[mel spectrum]->[diff]->[half wave rectify]->[mean]->[onset strength] | | >-[lag]--|

code: class FOnsetStrengthAnalyzer


code: FOnsetStrengthAnalyzer ( const [FOnsetStrengthSettings](API\Plugins\AudioSynesthesiaCore\FOnsetStrengthSettings) & InSettings, float InSampleRate )


className: FOnsetStrengthSettings

description: Onset strength settings

code: struct FOnsetStrengthSettings

ComparisonLag

description: Number of windows to lag when calculating window difference.

FFTSize

description: Size of FFT. Must be greater than or equal to NumWindowFrames.

MelSettings

type: FMelSpectrumKer...

description: Settings for converting FFT to mel spectrum.

NoiseFloorDb

description: Decibel level considered to be silence.

NumHopFrames

description: Number of frames between strength windows.

NumWindowFrames

description: Number of frames used to represent one audio window.

WindowType

description: Type of analysis window to apply to audio.


code: void PickPeaks ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InView, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutPeakIndices )


code: FPeakPicker ( const [FPeakPickerSettings](API\Plugins\AudioSynesthesiaCore\FPeakPickerSettings) & InSettings )


className: FPeakPicker

code: class FPeakPicker


className: FPeakPickerSettings

code: struct FPeakPickerSettings


className: FPitchTrackInfo

description: Contains information about a pitch track observation.

code: struct FPitchTrackInfo

Observations

type: TArray<FPitchI...

description: The array of observations associated with the pitch track.


className: FPitchInfo

description: Contains information about a pitch observation.

code: struct FPitchInfo

Frequency

description: The frequency (in Hz) of the observed pitch.

Strength

description: The strength of the pitch.

Timestamp

type: double

description: The timestamp (in seconds) of the pitch observation.


description: Name of specific analyzer type.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Creates a newFSynesthesiaSpectrumAnalysisWorker. This expectsIAnalyzerNRTSettingsto be a valid pointer to aFSynesthesiaSpectrumAnalysisSettingsobject.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker) > NewWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [IAnalyzerSettings](API\Runtime\AudioAnalyzer\IAnalyzerSettings) * InSettings ) const


description: Human readable name of analyzer.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetTitle() const


description: Creates a newFSynesthesiaSpectrumResult

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) > NewResult() const


className: FSynesthesiaSpectrumAnalysisFactory

description: Defines the Spectrum analyzer and creates related classes.

code: class FSynesthesiaSpectrumAnalysisFactory : public [Audio::IAnalyzerFactory](API\Runtime\AudioAnalyzer\IAnalyzerFactory)


className: FSynesthesiaSpectrumAnalysisSettings

description: Contains settings for Spectrum analyzer.

AnalysisPeriod

description: Number of seconds between spectrum measurements


description: Construct a worker

code: FSynesthesiaSpectrumAnalysisWorker ( const [FAnalyzerParameters](API\Runtime\AudioAnalyzer\FAnalyzerParameters) & InParams, const [FSynesthesiaSpectrumAnalysisSettings](API\Plugins\AudioSynesthesiaCore\FSynesthesiaSpectrumAnalysisSett-) & InAnalyzerSettings )


description: Analyzes input sample buffer and updates result.

code: virtual void Analyze ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InAudio, [IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult) * OutResult )


className: FSynesthesiaSpectrumAnalysisWorker

description: FSynesthesiaSpectrumWorker performs Spectrum analysis on input sample buffers.

code: class FSynesthesiaSpectrumAnalysisWorker : public [Audio::IAnalyzerWorker](API\Runtime\AudioAnalyzer\IAnalyzerWorker)


description: Calculate the spectrum values for the input samples. OutSpectrum should have (num input samples / 2) + 1 values.

code: void ProcessAudio ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleView, [TArrayView](API\Runtime\Core\Containers\TArrayView)< float > OutSpectrum )


description: Return const reference to settings used inside this analyzer.

code: const [FSynesthesiaSpectrumAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FSynesthesiaSpectrumAnalyzerSett-) & GetSettings() const


description: Construct analyzer

code: FSynesthesiaSpectrumAnalyzer ( float InSampleRate, const [FSynesthesiaSpectrumAnalyzerSettings](API\Plugins\AudioSynesthesiaCore\FSynesthesiaSpectrumAnalyzerSett-) & InSettings )


className: FSynesthesiaSpectrumAnalyzer

code: class FSynesthesiaSpectrumAnalyzer

FFT

type: TUniquePtr<IFF...

Settings

type: FSynesthesiaSpe...

Window

type: FWindow


className: FSynesthesiaSpectrumAnalyzerSettings

SpectrumType

type: ESynesthesiaSpe...

WindowType

type: EWindowType


description: Appends anFSynesthesiaSpectrumEntryto the container.

code: void Add ( [FSynesthesiaSpectrumEntry](API\Plugins\AudioSynesthesiaCore\FSynesthesiaSpectrumEntry) && InEntry )


className: FSynesthesiaSpectrumEntry

description: Holds the spectrum results per a time step for each channel

code: struct FSynesthesiaSpectrumEntry

Timestamp

type: float


description: Returns const reference toFSynesthesiaSpectrumEntryarray for individual channel.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSynesthesiaSpectrumEntry](API\Plugins\AudioSynesthesiaCore\FSynesthesiaSpectrumEntry) > & GetChannelSpectrumArray ( int32 ChannelIdx ) const


description: Returns the number of channels.

code: int32 GetNumChannels() const


code: FSynesthesiaSpectrumResult()


className: FSynesthesiaSpectrumResult

description: FSynesthesiaSpectrumResultcontains the temporal evolution of loudness for the last buffer of audio analyzed.

code: class FSynesthesiaSpectrumResult : public [Audio::IAnalyzerResult](API\Runtime\AudioAnalyzer\IAnalyzerResult)


className: IAudioSynesthesiaCoreModule

code: class IAudioSynesthesiaCoreModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Detect pitches from stream of audio.

code: void DetectPitches ( const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InMonoAudio, [TArray](API\Runtime\Core\Containers\TArray)< [FPitchInfo](API\Plugins\AudioSynesthesiaCore\FPitchInfo) > & OutPitches )


description: Pitch detectors which need to know when an audio stream is finished can overload this method to handle the end of an audio stream.

code: void Finalize ( [TArray](API\Runtime\Core\Containers\TArray)< [FPitchInfo](API\Plugins\AudioSynesthesiaCore\FPitchInfo) > & OutPitches )


code: virtual ~IPitchDetector()


className: IPitchDetector

description: A pitch detector identifies pitch information from a stream of input audio. The pitch detector should support multiple calls to `DetectPitches(...)_ originating from the same audio source.

code: class IPitchDetector


description: Pitch trackers which need to know when an audio stream is finished can overload this method to handle the end of an audio stream.

code: void Finalize ( [TArray](API\Runtime\Core\Containers\TArray)< [FPitchTrackInfo](API\Plugins\AudioSynesthesiaCore\FPitchTrackInfo) > & OutPitchTracks )


description: Detect pitche tracks from stream of audio.

code: void TrackPitches ( const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InMonoAudio, [TArray](API\Runtime\Core\Containers\TArray)< [FPitchTrackInfo](API\Plugins\AudioSynesthesiaCore\FPitchTrackInfo) > & OutPitchTracks )


code: virtual ~IPitchTracker()


className: IPitchTracker

description: A pitch tracker idenities multiple pitch tracks from a stream of input audio. The pitch tracker should support multiple calls to `TrackPitches(...)_ originating from the same audio source.

code: class IPitchTracker


description: Registers audio analyzer asset actions.

module: AudioSynesthesiaEditor

code: void RegisterAssetActions()


className: IAudioSynesthesiaEditorModule

description: Audio analyzer editor module interface

code: class IAudioSynesthesiaEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Opens a dialog to configure the factory properties. Return false if user opted out of configuring properties

code: virtual bool ConfigureProperties()


description:
Create a new object by class.
The new object.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * FactoryCreateNew ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags Flags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Context, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )


code: UAudioSynesthesiaNRTFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UAudioSynesthesiaNRTFactory

description: UAudioSynesthesiaNRTFactoryimplements the factory forUAudioSynesthesiaNRTassets.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, HideCategories=Object) class UAudioSynesthesiaNRTFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)

AudioSynesthesiaNRTClass

type: TSubclassOf<UA...

description: The type of audio analyzer settings that will be created


code: UAudioSynesthesiaNRTSettingsFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UAudioSynesthesiaNRTSettingsFactory

description: UAudioSynesthesiaNRTSettingsFactoryimplements the factory forUAudioSynesthesiaNRTSettingsassets.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, HideCategories=Object) class UAudioSynesthesiaNRTSettingsFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)


code: UAudioSynesthesiaSettingsFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UAudioSynesthesiaSettingsFactory

description: UAudioSynesthesiaSettingsFactoryimplements the factory forUAudioSynesthesiaSettingsassets.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, HideCategories=Object) class UAudioSynesthesiaSettingsFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)


description: Propagates a cursor query through an array of widget until that input is handled or all the elements have been iterated

module: AudioWidgets

code: namespace AudioWidgetsUtils { [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) AudioWidgetsUtils::RouteCursorQuery ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> WidgetsStack, const bool bReverse ) }


className: EAudioRadialSliderLayout

code: enum EAudioRadialSliderLayout { Layout_LabelTop, Layout_LabelCenter, Layout_LabelBottom, }


description: Propagates mouse input through an array of widget until that input is handled or all the elements have been iterated

code: namespace AudioWidgetsUtils { [FReply](API\Runtime\SlateCore\Input\FReply) AudioWidgetsUtils::RouteMouseInput ( [WidgetMouseInputFunction](API\Plugins\AudioWidgets\WidgetMouseInputFunction) InputFunction, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> WidgetsStack, const bool bReverse ) }


className: ESampledSequenceDisplayUnit

code: enum ESampledSequenceDisplayUnit { Samples, Seconds, }


code: [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * GetAudioBus() const


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SAudioMeter](API\Plugins\AudioWidgets\SAudioMeter) > GetWidget() const


code: void Init ( int32 InNumChannels, [UWorld](API\Runtime\Engine\Engine\UWorld) & InWorld )


code: void OnMeterOutput ( [UMeterAnalyzer](API\Plugins\AudioSynesthesia\UMeterAnalyzer) * InMeterAnalyzer, int32 ChannelIndex, const [FMeterResults](API\Plugins\AudioSynesthesia\FMeterResults) & InMeterResults )


className: FAudioMeter

code: class FAudioMeter


description: This method must be implemented by inherited structures.

code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


code: static const [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & GetDefault()


description:
This method must be implemented by inherited structures.
Widget style name.

code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetBackgroundImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InBackgroundImage )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetDecibelsPerHash ( float InDecibelsPerHash )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & InFont )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const [FName](API\Runtime\Core\UObject\FName) & InFontName, uint16 InSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const WIDECHAR * InFontName, uint16 InSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const [FString](API\Runtime\Core\Containers\FString) & InFontName, uint16 InSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FCompositeFont](API\Runtime\SlateCore\Fonts\FCompositeFont) > InCompositeFont, const int32 InSize, const [FName](API\Runtime\Core\UObject\FName) & InTypefaceFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InFontObject, const int32 InSize, const [FName](API\Runtime\Core\UObject\FName) & InTypefaceFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFont ( const ANSICHAR * InFontName, uint16 InSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFontName ( const [FName](API\Runtime\Core\UObject\FName) & InFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFontName ( const [FString](API\Runtime\Core\Containers\FString) & InFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFontName ( const WIDECHAR * InFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFontName ( const ANSICHAR * InFontName )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetFontSize ( uint16 InSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterBackgroundImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InMeterBackgroundImage )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterPadding ( const FVector2D & InMeterPadding )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterPeakImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InMeterPeakImage )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterSize ( const FVector2D & InMeterSize )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterValueBackgroundImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InMeterValueBackgroundImage )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterValuePadding ( float InMeterValuePadding )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetMeterValueImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InMeterValueImage )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetPeakValueWidth ( float InPeakValueWidth )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetScaleHashHeight ( float InScaleHashHeight )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetScaleHashOffset ( float InScaleHashOffset )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetScaleHashWidth ( float InScaleHashWidth )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetScaleSide ( bool bInScaleSide )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetShowScale ( bool bInShowScale )


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetTypefaceFontName ( const [FName](API\Runtime\Core\UObject\FName) & InTypefaceFontName )


className: TypeName

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName;


code: [FAudioMeterStyle](API\Plugins\AudioWidgets\FAudioMeterStyle) & SetValueRangeDb ( const FVector2D & InValueRangeDb )


description: FSlateColor::Unlink

code: void UnlinkColors()


className: FAudioMeterStyle

description: Represents the appearance of anSAudioMeter

BackgroundImage

type: FSlateBrush

description: Image to use to represent the background.

bScaleSide

type: bool

description: Which side to show the scale. If vertical, true means left side, false means right side. If horizontal, true means above, false means below.

bShowScale

description: Whether or not to show the decibel scale alongside the meter.

DecibelsPerHash

description: How wide to draw the decibel scale, if it's enabled.

Font

type: FSlateFontInfo

description: Font family and size to be used when displaying the meter scale.

MeterBackgroundImage

description: Image to use to represent the meter background.

MeterPadding

description: How much padding to add around the meter.

MeterPeakImage

description: Image to use to represent the meter peak.

MeterSize

description: How thick to draw the meter.

MeterValueBackgroundImage

description: Image to use to draw behind the meter value.

MeterValueImage

description: Image to use to represent the meter value.

MeterValuePadding

description: How much padding to add around the meter value.

PeakValueWidth

description: How wide to draw the peak value indicator.

ScaleHashHeight

description: The height of each hash mark.

ScaleHashOffset

description: Offset for the hashes.

ScaleHashWidth

description: The width of each hash mark.

ValueRangeDb

description: The minimum and maximum value to display in dB (values are clamped in this range)


code: static const [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & GetDefault()


code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetCenterBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InCenterBackgroundColor )


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetDefaultSliderRadius ( const float & InDefaultSliderRadius )


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetLabelPadding ( const float & InLabelPadding )


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetSliderBarColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InSliderBarColor )


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetSliderProgressColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InSliderProgressColor )


code: [FAudioRadialSliderStyle](API\Plugins\AudioWidgets\FAudioRadialSliderStyle) & SetTextBoxStyle ( const [FAudioTextBoxStyle](API\Plugins\AudioWidgets\FAudioTextBoxStyle) & InTextBoxStyle )


code: virtual ~FAudioRadialSliderStyle()


className: FAudioRadialSliderStyle

description: Represents the appearance of an Audio Radial Slider

CenterBackgroundColor

type: FSlateColor

description: Color used to draw the slider center background

DefaultSliderRadius

description: Default size of the slider itself (not including label)

LabelPadding

description: Size of the padding between the label and the slider

SliderBarColor

description: Color used to draw the unprogressed slider bar

SliderProgressColor

description: Color used to draw the progress bar

TextBoxStyle

type: FAudioTextBoxSt...

description: The style to use for the audio text box widget.


code: static const [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & GetDefault()


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetLabelPadding ( const float & InLabelPadding )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetSliderBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InSliderBackgroundColor )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetSliderBackgroundSize ( const FVector2D & InSliderBackgroundSize )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetSliderBarColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InSliderBarColor )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetSliderStyle ( const [FSliderStyle](API\Runtime\SlateCore\Styling\FSliderStyle) & InSliderStyle )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetSliderThumbColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InSliderThumbColor )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetTextBoxStyle ( const [FAudioTextBoxStyle](API\Plugins\AudioWidgets\FAudioTextBoxStyle) & InTextBoxStyle )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetWidgetBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InWidgetBackgroundColor )


code: [FAudioSliderStyle](API\Plugins\AudioWidgets\FAudioSliderStyle) & SetWidgetBackgroundImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InWidgetBackgroundImage )


description: FSlateColor::Unlink

code: void UnlinkColors()


code: static const [FName](API\Runtime\Core\UObject\FName) TypeName;


code: virtual ~FAudioSliderStyle()


className: FAudioSliderStyle

description: Represents the appearance of an Audio Slider

SliderBackgroundColor

description: Color used to draw the slider background

SliderBackgroundSize

description: Size of the slider background (slider default is vertical)

SliderBarColor

description: Color used to draw the slider bar

SliderStyle

type: FSliderStyle

description: The style to use for the underlyingSSlider.

SliderThumbColor

description: Color used to draw the slider thumb (handle)

WidgetBackgroundColor

description: Color used to draw the widget background

WidgetBackgroundImage

description: Image for the widget background


code: static const [FAudioTextBoxStyle](API\Plugins\AudioWidgets\FAudioTextBoxStyle) & GetDefault()


description: This method must be implemented by inherited structures.

code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


description:
This method must be implemented by inherited structures.
Widget style name.

code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FAudioTextBoxStyle](API\Plugins\AudioWidgets\FAudioTextBoxStyle) & SetBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InBackgroundColor )


code: [FAudioTextBoxStyle](API\Plugins\AudioWidgets\FAudioTextBoxStyle) & SetBackgroundImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InBackgroundImage )


code: virtual ~FAudioTextBoxStyle()


className: FAudioTextBoxStyle

description: Represents the appearance of an Audio Text Box

BackgroundColor

description: Color used to draw the label background

BackgroundImage

description: Image for the label border


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FAudioWidgetsModule

code: class FAudioWidgetsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Access the singleton instance for this style set

code: static [FAudioWidgetsStyle](API\Plugins\AudioWidgets\FAudioWidgetsStyle) & Get()


className: FAudioWidgetsStyle

description: No destructors are accessible with public or protected access.

code: class FAudioWidgetsStyle : public [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet)


code: FDimensionSlot ( const uint16 DimensionToDraw, const uint16 TotalNumDimensions, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const [FSampledSequenceDrawingParams](API\Plugins\AudioWidgets\FSampledSequenceDrawingParams) & Params )


className: FDimensionSlot

description: Represents a dimensional slot in which samples, sample bins or a grid can be drawn

code: struct FDimensionSlot


code: virtual const [FFixedSampledSequenceGridMetrics](API\Plugins\AudioWidgets\FFixedSampledSequenceGridMetrics) GetGridMetrics() const


code: void SetTicksTimeFont ( const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) * InNewFont )


code: virtual const float SnapPositionToClosestFrame ( const float InPixelPosition ) const


code: void UpdateDisplayRange ( const [TRange](API\Runtime\Core\Math\TRange)< uint32 > InDisplayRange )


code: bool UpdateGridMetrics ( const float InGridSizePixels )


code: FFixedSampledSequenceGridData ( const uint32 InTotalFrames, const uint32 InSampleRateHz, const float InGridSizePixels, const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) * InTicksTimeFont )


className: FFixedSampledSequenceGridData

code: class FFixedSampledSequenceGridData : public [IFixedSampledSequenceGridService](API\Plugins\AudioWidgets\IFixedSampledSequenceGridService)

OnGridMetricsUpdated

type: FOnWaveformEdit...


className: FFixedSampledSequenceGridMetrics

code: struct FFixedSampledSequenceGridMetrics


className: FFixedSampledSequenceView

code: struct FFixedSampledSequenceView

SampleData

type: TArrayView< con...


code: static const [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & GetDefault()


code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetBackgroundBrush ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InBackgroundBrush )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InBackgroundColor )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetDesiredHeight ( const float InDesiredHeight )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetDesiredWidth ( const float InDesiredWidth )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetFontSize ( const float InFontSize )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetHandleBrush ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InHandleBrush )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetHandleColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InHandleColor )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetHandleWidth ( const float InHandleWidth )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetTicksColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InTicksColor )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetTicksTextFont ( const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & InTicksTextFont )


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetTicksTextColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InTicksTextColor )


code: static const [FName](API\Runtime\Core\UObject\FName) TypeName;


code: [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) & SetTicksTextOffset ( const float InTicksTextOffset )


code: FFixedSampleSequenceRulerStyle()


className: FFixedSampleSequenceRulerStyle

description: Represents the appearance of a Sampled Sequence Time Ruler


className: FGridData

description: DrawCoordinates: Coordinates of different grid lines PositionRatios: the Ratio of each grid line position in relationship to the main axis length

code: struct FGridData

PositionRatios

type: TArray< float >


className: FMeterChannelInfo


className: FOnAudioRadialSliderValueChangedEvent


className: FOnDisplayRangeUpdated

code: typedef TMulticastDelegate_OneParam< void, const [TRange](API\Runtime\Core\Math\TRange)< double > > FOnDisplayRangeUpdated


className: FOnFocusPointMoved

code: typedef TMulticastDelegate_OneParam< void, const float > FOnFocusPointMoved


className: FOnFocusPointScrubUpdate

code: typedef TMulticastDelegate_TwoParams< void, const float, const bool > FOnFocusPointScrubUpdate


className: FOnTimeUnitMenuSelection

code: typedef TMulticastDelegate_OneParam< void, const [ESampledSequenceDisplayUnit](API\Plugins\AudioWidgets\ESampledSequenceDisplayUnit) > FOnTimeUnitMenuSelection


className: FOnWaveformEditorGridUpdated

code: typedef TMulticastDelegate_NoParams< void > FOnWaveformEditorGridUpdated


code: static const [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) & GetDefault()


code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) & SetDesiredHeight ( const float InDesiredHeight )


code: [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) & SetDesiredWidth ( const float InDesiredWidth )


code: [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) & SetPlayheadColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InPlayheadColor )


code: [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) & SetPlayheadWidth ( const float InPlayheadWidth )


className: TypeName


className: FPlayheadOverlayStyle

description: Represents the appearance of a Waveform Viewer Overlay style


className: FSampledSequenceDrawingParams

code: struct FSampledSequenceDrawingParams

MaxDisplayedValue

type: double

Orientation

type: ESampledSequenc...


code: static const [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & GetDefault()


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetDesiredHeight ( const float InDesiredHeight )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetDesiredWidth ( const float InDesiredWidth )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetGridColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InGridColor )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetGridThickness ( const float InGridThickness )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetLabelTextColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InLabelTextColor )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetLabelTextFont ( const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & InLabelTextFont )


code: [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) & SetLabelTextFontSize ( const float InFontSize )


code: FSampledSequenceValueGridOverlayStyle()


className: FSampledSequenceValueGridOverlayStyle

description: Represents the appearance of a Sampled Sequence Value Grid Overlay


code: static const [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & GetDefault()


code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetBackgroundBrush ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) InBackgroundBrush )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetBackgroundColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InBackgroundColor )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetDesiredHeight ( const float InDesiredHeight )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetDesiredWidth ( const float InDesiredWidth )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetMajorGridLineColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMajorGridLineColor )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetMinorGridLineColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMinorGridLineColor )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetSampleMarkersSize ( const float InSampleMarkersSize )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetSequenceColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InSequenceColor )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetSequenceLineThickness ( const float InSequenceLineThickness )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetZeroCrossingLineThickness ( const float InZeroCrossingLineThickness )


code: [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) & SetZeroCrossingLineColor ( const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InZeroCrossingLineColor )


code: static const [FName](API\Runtime\Core\UObject\FName) TypeName;


code: FSampledSequenceViewerStyle()


className: FSampledSequenceViewerStyle

description: Represents the appearance of a Sampled Sequence Viewer


code: virtual float ConvertAbsoluteRatioToZoomed ( const float InAbsoluteRatio ) const


code: virtual float ConvertZoomedRatioToAbsolute ( const float InZoomedRatio ) const


description: ISparseSampledSequenceTransportCoordinatorinterface

code: virtual const [TRange](API\Runtime\Core\Math\TRange)< double > GetDisplayRange() const


code: virtual const float GetFocusPoint() const


code: virtual const bool IsScrubbing() const


code: virtual void ScrubFocusPoint ( const float InTargetFocusPoint, const bool bIsMoving )


code: virtual void SetProgressRatio ( const float NewRatio )


code: virtual void SetZoomRatio ( const float NewRatio )


description: Zoom is defined as a ratio = displayed length / total length

code: void UpdatePlaybackRange ( const [TRange](API\Runtime\Core\Math\TRange)< double > & NewRange )


OnDisplayRangeUpdated

type: FOnDisplayRange...

description: Called when the display range is updated

OnFocusPointMoved

type: FOnFocusPointMo...

description: Called when the focus point is set to a new location

OnFocusPointScrubUpdate

type: FOnFocusPointSc...

description: Called when the focus point is scrubbed


code: const float SnapPositionToClosestFrame ( const float InPixelPosition ) const


className: IFixedSampledSequenceGridService

code: class IFixedSampledSequenceGridService


code: [FFixedSampledSequenceView](API\Plugins\AudioWidgets\FFixedSampledSequenceView) RequestSequenceView ( const [TRange](API\Runtime\Core\Math\TRange)< double > DataRatioRange )


className: IFixedSampledSequenceViewProvider

code: class IFixedSampledSequenceViewProvider


description: Receives and handles a sequence view.

code: void ReceiveSequenceView ( const [FFixedSampledSequenceView](API\Plugins\AudioWidgets\FFixedSampledSequenceView) InView, const uint32 FirstSampleIndex )


className: IFixedSampledSequenceViewReceiver

code: class IFixedSampledSequenceViewReceiver


code: float ConvertAbsoluteRatioToZoomed ( const float InAbsoluteRatio ) const


code: float ConvertZoomedRatioToAbsolute ( const float InZoomedRatio ) const


code: const [TRange](API\Runtime\Core\Math\TRange)< double > GetDisplayRange() const


code: const float GetFocusPoint() const


code: const bool IsScrubbing() const


code: void ScrubFocusPoint ( const float InTargetFocusPoint, const bool bIsMoving )


code: void SetProgressRatio ( const float NewRatio )


code: void SetZoomRatio ( const float NewRatio )


className: operator==

code: bool operator== ( const [FMeterChannelInfo](API\Plugins\AudioWidgets\FMeterChannelInfo) & lhs, const [FMeterChannelInfo](API\Plugins\AudioWidgets\FMeterChannelInfo) & rhs )


description: Params for drawing sequences of samples/sample bins

code: namespace SampledSequenceDrawingUtils { enum ESampledSequenceDrawOrientation { Horizontal = 0, Vertical, COUNT, } }


description: Groups samples evenly into a number of desired bins. Each bin contains the min and max values of the grouped samples.

code: namespace SampledSequenceDrawingUtils { template<typename SamplesType> void SampledSequenceDrawingUtils::GroupInterleavedSamplesIntoMinMaxBins ( [TArray](API\Runtime\Core\Containers\TArray)< [TRange](API\Runtime\Core\Math\TRange)< SamplesType >> & OutBins, const uint32 NumDesiredBins, const SamplesType * RawDataPtr, const uint32 TotalNumSamples, const uint16 NDimensions, const double StartRatio, double EndRatio ) }


description: Note: With a negative EndTime, the method will calculate automatically the EndTime by doing TotalNumSamples / (SampleRate * NDimensions)

code: namespace SampledSequenceDrawingUtils { template<typename SamplesType> void SampledSequenceDrawingUtils::GroupInterleavedSampledTSIntoMinMaxBins ( [TArray](API\Runtime\Core\Containers\TArray)< [TRange](API\Runtime\Core\Math\TRange)< SamplesType >> & OutBins, const uint32 NumDesiredBins, const SamplesType * RawDataPtr, const uint32 TotalNumSamples, const uint32 SampleRate, const uint16 NDimensions, const float StartTime, float EndTime ) }


description: Generates an array of coordinates to draw binned samples as vertical lines. Coordinates will be generated for an horizontal view

code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateSampleBinsCoordinatesForGeometry ( [TArray](API\Runtime\Core\Containers\TArray)< [F2DLineCoordinates](API\Plugins\AudioWidgets\F2DLineCoordinates) > & OutDrawCoordinates, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const [TArray](API\Runtime\Core\Containers\TArray)< [TRange](API\Runtime\Core\Math\TRange)< float >> & InSampleBins, const uint16 NDimensions, const [FSampledSequenceDrawingParams](API\Plugins\AudioWidgets\FSampledSequenceDrawingParams) Params ) }


description: Generates an array of coordinates to draw single samples in succession horizontally.

code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateSequencedSamplesCoordinatesForGeometry ( [TArray](API\Runtime\Core\Containers\TArray)< FVector2D > & OutDrawCoordinates, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleData, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const uint16 NDimensions, const [FFixedSampledSequenceGridMetrics](API\Plugins\AudioWidgets\FFixedSampledSequenceGridMetrics) InGridMetrics, const [FSampledSequenceDrawingParams](API\Plugins\AudioWidgets\FSampledSequenceDrawingParams) Params ) }


description: Generates an evenly divided grid from a given geometry, following the orientation provided in the Params struct argument.

code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateEvenlySplitGridForGeometry ( [TArray](API\Runtime\Core\Containers\TArray)< [FGridData](API\Plugins\AudioWidgets\FGridData) > & OutGridData, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const uint16 NDimensions, const uint32 NumGridDivisions, const [FSampledSequenceDrawingParams](API\Plugins\AudioWidgets\FSampledSequenceDrawingParams) Params ) }


code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateEvenlySplitGridForLine ( [TArray](API\Runtime\Core\Containers\TArray)< double > & OutDrawCoordinates, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutLinePositionRatios, const float LineLength, const uint32 NumGridDivisions, bool bEmptyOutArrays ) }


description: Generates a midline divided grid from a given geometry, following the orientation provided in the Params struct argument. The grid space will be divided in half, with the resulting halves being divided again and so on until the desired Division Depth is reached.

code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateMidpointSplitGridForGeometry ( [TArray](API\Runtime\Core\Containers\TArray)< [FGridData](API\Plugins\AudioWidgets\FGridData) > & OutGridData, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const uint16 NDimensions, const uint32 DivisionDepth, const [FSampledSequenceDrawingParams](API\Plugins\AudioWidgets\FSampledSequenceDrawingParams) Params ) }


code: namespace SampledSequenceDrawingUtils { void SampledSequenceDrawingUtils::GenerateMidpointSplitGridForLine ( [TArray](API\Runtime\Core\Containers\TArray)< double > & OutDrawCoordinates, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutLinePositionRatios, const float LineLength, const uint32 DivisionDepth, bool bEmptyOutArrays ) }


code: namespace SampledSequenceValueGridOverlay { enum EGridDivideMode { EvenSplit = 0, MidSplit, COUNT, } }


className: SampleRange

code: typedef [TRange](API\Runtime\Core\Math\TRange)< float > SampleRange


code: virtual void Construct ( const [SAudioRadialSlider::FArguments](API\Plugins\AudioWidgets\SAudioRadialSlider\FArguments) & InArgs )


code: virtual const float GetOutputValue ( const float InSliderValue )


code: SAudioFrequencyRadialSlider()


code: virtual const float GetSliderValue ( const float OutputValue )


className: SAudioFrequencyRadialSlider

description: An Audio Radial Slider widget with default logarithmic conversion intended to be used for frequency (Hz).

code: class SAudioFrequencyRadialSlider : public [SAudioRadialSlider](API\Plugins\AudioWidgets\SAudioRadialSlider)


description: Construct the widget.

code: virtual void Construct ( const [SAudioSlider::FArguments](API\Plugins\AudioWidgets\SAudioSliderBase\FArguments) & InDeclaration )


className: SAudioFrequencySlider

description: An Audio Slider widget intended to be used for frequency output, with output frequency range but no customizable curves.

code: class SAudioFrequencySlider : public [SAudioSliderBase](API\Plugins\AudioWidgets\SAudioSliderBase)


code: const float GetOutputValue ( const float InSliderValue )


code: const float GetSliderValue ( const float OutputValue )


code: void SetDesiredSizeOverride ( const FVector2D DesiredSize )


code: void SetLabelBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: void SetOutputRange ( const FVector2D Range )


code: void SetShowUnitsText ( const bool bShowUnitsText )


description: Set the slider's linear (0-1 normalized) value.

code: void SetSliderValue ( float InSliderValue )


code: void SetUnitsText ( const [FText](API\Runtime\Core\Internationalization\FText) Units )


code: void SetUnitsTextReadOnly ( const bool bIsReadOnly )


className: SAudioInputWidget

description: Abstract class for use by audio sliders and knobs that consists of a visual representation of a float value and a text label.

code: class SAudioInputWidget : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

code: virtual bool ComputeVolatility() const


description: Construct the widget.

code: void Construct ( const [SAudioMeter::FArguments](API\Plugins\AudioWidgets\SAudioMeter\FArguments) & InDeclaration )


description: The color to draw the background in.

code: WidgetArgsType & BackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Whether the slidable area should be indented to fit the handle.

code: WidgetArgsType & IndentHandle &40; const TAttribute< bool > & InAttribute &41;


description: The color to draw the meter background in.

code: WidgetArgsType & MeterBackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: A value representing the audio meter value.

code: WidgetArgsType & MeterChannelInfo &40; const TAttribute< TArray< FMeterChannelInfo > > & InAttribute &41;


description: The color to draw the clipping value in.

code: WidgetArgsType & MeterClippingColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the meter peak.

code: WidgetArgsType & MeterPeakColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the scale in.

code: WidgetArgsType & MeterScaleColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the scale in.

code: WidgetArgsType & MeterScaleLabelColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the meter value in.

code: WidgetArgsType & MeterValueColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The slider's orientation.

code: WidgetArgsType & Orientation &40; EOrientation InArg &41;


description: The style used to draw the slider.

code: WidgetArgsType & Style &40; const FAudioMeterStyle &42; InArg &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


code: [TArray](API\Runtime\Core\Containers\TArray)< [FMeterChannelInfo](API\Plugins\AudioWidgets\FMeterChannelInfo) > GetMeterChannelInfo() const


description: Returns the scale height based off font size and hash height.

code: float GetScaleHeight() const


description: Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: void SetBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InBackgroundColor )


code: void SetMeterBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterBackgroundColor )


code: void SetMeterClippingColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterPeakColor )


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SAudioMeter >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: void SetMeterChannelInfo ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TArray](API\Runtime\Core\Containers\TArray)< [FMeterChannelInfo](API\Plugins\AudioWidgets\FMeterChannelInfo) >> & InMeterChannelInfo )


code: void SetMeterPeakColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterPeakColor )


code: void SetMeterScaleColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterScaleColor )


code: void SetMeterScaleLabelColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterScaleLabelColor )


code: void SetMeterValueColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InMeterValueColor )


description: Set the Orientation attribute

code: void SetOrientation ( EOrientation InOrientation )


className: SAudioMeter

description: A Slate slider control is a linear scale and draggable handle.

code: class SAudioMeter : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)

BackgroundColor

type: TAttribute<FSl...

description: Various colors.

bIsActiveTimerRegistered

description: Is the active timer registered to refresh the meter channel info.

MeterChannelInfoAttribute

type: TAttribute<TAr...

Orientation

type: EOrientation

description: Holds the slider's orientation.

Style

type: constFAudioMet...

description: Holds the style passed to the widget upon construction.


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


code: virtual void Construct ( const [SAudioRadialSlider::FArguments](API\Plugins\AudioWidgets\SAudioRadialSlider\FArguments) & InArgs )


description: The color to draw the center background in.

code: WidgetArgsType & CenterBackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: When specified, use this as the slider's desired size

code: WidgetArgsType & DesiredSizeOverride &40; const TAttribute< TOptional< FVector2D > > & InAttribute &41;


description: Start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).

code: WidgetArgsType & HandStartEndRatio &40; const TAttribute< FVector2D > & InAttribute &41;


description: Invoked when the mouse is pressed and a capture begins.

code: WidgetArgsType & OnMouseCaptureBegin &40; const FSimpleDelegate & InDelegate &41;


description: Invoked when the mouse is released and a capture ends.

code: WidgetArgsType & OnMouseCaptureEnd &40; const FSimpleDelegate & InDelegate &41;


description: Called when the value is changed by slider or typing

code: WidgetArgsType & OnValueChanged &40; const FOnFloatValueChanged & InDelegate &41;


description: The color to draw the slider bar in.

code: WidgetArgsType & SliderBarColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: A curve that defines how the slider should be sampled. Default is linear.

code: WidgetArgsType & SliderCurve &40; FRuntimeFloatCurve InArg &41;


description: The color to draw the progress bar in.

code: WidgetArgsType & SliderProgressColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: A value representing the normalized linear (0 - 1) audio slider value position.

code: WidgetArgsType & SliderValue &40; const TAttribute< float > & InAttribute &41;


description: The style used to draw the audio radial slider.

code: WidgetArgsType & Style &40; const FAudioRadialSliderStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


description: The widget layout.

code: WidgetArgsType & WidgetLayout &40; const TAttribute< EAudioRadialSliderLayout > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SAudioRadialSlider >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: virtual const float GetOutputValue ( const float InSliderValue )


code: virtual const float GetOutputValueForText ( const float InSliderValue )


code: virtual const float GetSliderValue ( const float OutputValue )


code: virtual const float GetSliderValueForText ( const float OutputValue )


code: void SetCenterBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: virtual void SetDesiredSizeOverride ( const FVector2D DesiredSize )


code: void SetHandStartEndRatio ( const FVector2D InHandStartEndRatio )


description: Text label functions.

code: virtual void SetLabelBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: virtual void SetOutputRange ( const FVector2D Range )


className: NormalizedLinearSliderRange

code: static const FVector2D NormalizedLinearSliderRange = FVector2D(0.0f, 1.0f);


code: void SetShowLabelOnlyOnHover ( const bool bShowLabelOnlyOnHover )


code: virtual void SetShowUnitsText ( const bool bShowUnitsText )


code: void SetSliderProgressColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: void SetSliderBarColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: void SetSliderThickness ( const float Thickness )


description: Set the slider's linear (0-1 normalized) value.

code: virtual void SetSliderValue ( float InSliderValue )


code: virtual void SetUnitsTextReadOnly ( const bool bIsReadOnly )


code: virtual void SetUnitsText ( const [FText](API\Runtime\Core\Internationalization\FText) Units )


code: void SetValueTextReadOnly ( const bool bIsReadOnly )


code: void SetWidgetLayout ( [EAudioRadialSliderLayout](API\Plugins\AudioWidgets\EAudioRadialSliderLayout) InLayout )


code: virtual ~SAudioRadialSlider()


className: SAudioRadialSlider

description: Slate audio radial sliders that wrapSRadialSliderand provides additional audio specific functionality. This is a nativized version of the previous Audio Knob Small/Large widgets.

code: class SAudioRadialSlider : public [SAudioInputWidget](API\Plugins\AudioWidgets\SAudioInputWidget)

CenterBackgroundImage

type: TSharedPtr<SIm...

DesiredSizeOverride

type: TAttribute<TOp...

HandStartEndRatio

type: TAttribute< FVe...

Label

type: TSharedPtr<SAu...

LayoutWidgetSwitcher

type: TSharedPtr<SWi...

description: Overall widget layout.

OnMouseCaptureBegin

type: FSimpleDelegate

description: Holds a delegate that is executed when the mouse is pressed and a capture begins.

OnMouseCaptureEnd

description: Holds a delegate that is executed when the mouse is let up and a capture ends.

OnValueChanged

type: FOnFloatValueCh...

description: Holds a delegate that is executed when the slider's value changed.

OutputRange

description: Range for output.

RadialSlider

type: TSharedPtr<SRa...

SliderCurve

type: FRuntimeFloatCu...

SliderValue

type: TAttribute< flo...

type: constFAudioRad...

WidgetLayout

type: TAttribute<EAu...


description: Construct the widget.

code: virtual void Construct ( const [SAudioSliderBase::FArguments](API\Plugins\AudioWidgets\SAudioSliderBase\FArguments) & InDeclaration )


code: const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UCurveFloat](API\Runtime\Engine\Curves\UCurveFloat) > GetLinToOutputCurve()


code: const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UCurveFloat](API\Runtime\Engine\Curves\UCurveFloat) > GetOutputToLinCurve()


code: virtual const float GetOutputValue ( const float InSliderValue )


code: virtual const float GetSliderValue ( const float OutputValue )


code: void SetLinToOutputCurve ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UCurveFloat](API\Runtime\Engine\Curves\UCurveFloat) > LinToOutputCurve )


code: void SetOutputToLinCurve ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [UCurveFloat](API\Runtime\Engine\Curves\UCurveFloat) > OutputToLinCurve )


className: SAudioSlider

description: An Audio Slider widget with customizable curves.

code: class SAudioSlider : public [SAudioSliderBase](API\Plugins\AudioWidgets\SAudioSliderBase)

LinToOutputCurve

type: TWeakObjectPtr<...

description: Curves for mapping linear (0.0 - 1.0) to output (ex. dB for volume)


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


description: Whether the text label is always shown or only on hover.

code: WidgetArgsType & AlwaysShowLabel &40; const TAttribute< bool > & InAttribute &41;


description: When specified, use this as the slider's desired size

code: WidgetArgsType & DesiredSizeOverride &40; const TAttribute< TOptional< FVector2D > > & InAttribute &41;


code: WidgetArgsType & OnValueChanged &40; const FOnFloatValueChanged & InDelegate &41;


description: Called when the value is committed by mouse capture ending

code: WidgetArgsType & OnValueCommitted &40; const FOnFloatValueChanged & InDelegate &41;


description: The orientation of the slider.

code: WidgetArgsType & Orientation &40; EOrientation InArg &41;


description: The color to draw the slider background in.

code: WidgetArgsType & SliderBackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the slider bar in.

code: WidgetArgsType & SliderBarColor &40; const TAttribute< FSlateColor > & InAttribute &41;


code: WidgetArgsType & SliderValue &40; const TAttribute< float > & InAttribute &41;


description: The color to draw the slider thumb in.

code: WidgetArgsType & SliderThumbColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The style used to draw the audio slider.

code: WidgetArgsType & Style &40; const FAudioSliderStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


description: The color to draw the widget background in.

code: WidgetArgsType & WidgetBackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SAudioSliderBase >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: virtual const float GetOutputValue ( const float InSliderValue )


code: virtual const float GetOutputValueForText ( const float InSliderValue )


code: virtual const float GetSliderValue ( const float OutputValue )


code: virtual const float GetSliderValueForText ( const float OutputValue )


code: static const FVector2D NormalizedLinearSliderRange = FVector2D(0.0f, 1.0f);


code: virtual void SetDesiredSizeOverride ( const FVector2D DesiredSize )


description: Text label functions.

code: virtual void SetLabelBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: void SetOrientation ( EOrientation InOrientation )


code: void SetShowLabelOnlyOnHover ( const bool bShowLabelOnlyOnHover )


code: virtual void SetOutputRange ( const FVector2D Range )


code: virtual void SetShowUnitsText ( const bool bShowUnitsText )


code: void SetSliderBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InSliderBackgroundColor )


code: void SetSliderBarColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InSliderBarColor )


code: void SetSliderThumbColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InSliderThumbColor )


code: virtual void SetSliderValue ( float InSliderValue )


code: void SetValueTextReadOnly ( const bool bIsReadOnly )


code: virtual void SetUnitsText ( const [FText](API\Runtime\Core\Internationalization\FText) Units )


code: virtual void SetUnitsTextReadOnly ( const bool bIsReadOnly )


code: void SetWidgetBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InWidgetBackgroundColor )


className: SAudioSliderBase

description: Slate audio sliders that wrapSSliderand provides additional audio specific functionality. This is a nativized version of the previous Audio Fader widget.

code: class SAudioSliderBase : public [SAudioInputWidget](API\Plugins\AudioWidgets\SAudioInputWidget)

DesiredSizeOverride

description: Optional override for desired size.

LabelBackgroundColor

type: TAttribute<FSl...

description: Various colors.

OnValueCommitted

description: Holds a delegate that is executed when the slider's value is committed (mouse capture ends).

Orientation

type: TAttribute< EOr...

description: Holds the slider's orientation.

OutputRange

description: Range for output, currently only used for frequency sliders and sliders without curves.

Slider

type: TSharedPtr<SSl...

description: Widget components.

SliderValueAttribute

description: Holds the slider's current linear value, from 0.0 - 1.0f.

Style

type: constFAudioSli...


code: virtual void Construct ( const [SAudioTextBox::FArguments](API\Plugins\AudioWidgets\SAudioTextBox\FArguments) & InArgs )


description: The color to draw the label background in.

code: WidgetArgsType & LabelBackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Delegate to call when the value text is committed.

code: WidgetArgsType & OnValueTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: If true, show label only on hover; if false always show label.

code: WidgetArgsType & ShowLabelOnlyOnHover &40; const TAttribute< bool > & InAttribute &41;


description: Whether to show the units part of the text label.

code: WidgetArgsType & ShowUnitsText &40; const TAttribute< bool > & InAttribute &41;


description: The style used to draw the audio text box.

code: WidgetArgsType & Style &40; const FAudioTextBoxStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SAudioTextBox >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: NumericInterface

description: Used to convert and format value text strings

code: static const [FVariablePrecisionNumericInterface](API\Editor\PropertyEditor\FVariablePrecisionNumericInterfa-) NumericInterface = FVariablePrecisionNumericInterface();


code: void SetLabelBackgroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColor )


code: void SetShowLabelOnlyOnHover ( const bool bShowLabelOnlyOnHover )


code: void SetShowUnitsText ( const bool bShowUnitsText )


code: void SetUnitsText ( const [FText](API\Runtime\Core\Internationalization\FText) Units )


code: void SetUnitsTextReadOnly ( const bool bIsReadOnly )


code: void SetValueText ( const float OutputValue )


code: void SetValueTextReadOnly ( const bool bIsReadOnly )


code: void UpdateValueTextWidth ( const FVector2D OutputRange )


className: SAudioTextBox

code: class SAudioTextBox : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

LabelBorder

type: TSharedPtr<SBo...

OnValueTextCommitted

type: FOnTextCommitte...

ShowLabelOnlyOnHover

type: TAttribute< boo...

type: constFAudioTex...

UnitsText

type: TSharedPtr<SEd...


code: virtual void Construct ( const [SAudioRadialSlider::FArguments](API\Plugins\AudioWidgets\SAudioRadialSlider\FArguments) & InArgs )


code: virtual const float GetOutputValue ( const float InSliderValue )


code: virtual const float GetOutputValueForText ( const float InSliderValue )


code: virtual const float GetSliderValue ( const float OutputValue )


code: virtual const float GetSliderValueForText ( const float OutputValue )


className: MaxDbValue

code: static const float MaxDbValue = 770.0f;


className: MinDbValue

description: Min/max possible values for output range, derived to avoid Audio::ConvertToLinear/dB functions returning NaN.

code: static const float MinDbValue = -160.0f;


code: virtual void SetOutputRange ( const FVector2D Range )


code: void SetUseLinearOutput ( bool InUseLinearOutput )


className: SAudioVolumeRadialSlider

description: An Audio Radial Slider widget with default conversion for volume (dB).

code: class SAudioVolumeRadialSlider : public [SAudioRadialSlider](API\Plugins\AudioWidgets\SAudioRadialSlider)


description: Construct the widget.

code: virtual void Construct ( const [SAudioSlider::FArguments](API\Plugins\AudioWidgets\SAudioSliderBase\FArguments) & InDeclaration )


className: SAudioVolumeSlider

description: An Audio Slider widget intended to be used for volume output, with output decibel range but no customizable curves.

code: class SAudioVolumeSlider : public [SAudioSliderBase](API\Plugins\AudioWidgets\SAudioSliderBase)


code: void Construct ( const [FArguments](API\Plugins\AudioWidgets\SFixedSampledSequenceRuler\FArguments) & InArgs, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IFixedSampledSequenceGridService](API\Plugins\AudioWidgets\IFixedSampledSequenceGridService) > InGridService )


description: Whether the playhead should be drawn or not

code: WidgetArgsType & DisplayPlayhead &40; const TAttribute< bool > & InAttribute &41;


code: WidgetArgsType & DisplayUnit &40; ESampledSequenceDisplayUnit InArg &41;


code: WidgetArgsType & Style &40; const FFixedSampleSequenceRulerStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SFixedSampledSequenceRuler >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: void OnStyleUpdated ( const [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) UpdatedStyle )


code: void SetPlayheadPosition ( const float InNewPosition )


code: void UpdateDisplayUnit ( const [ESampledSequenceDisplayUnit](API\Plugins\AudioWidgets\ESampledSequenceDisplayUnit) InDisplayUnit )


code: void Construct ( const [FArguments](API\Plugins\AudioWidgets\SFixedSampledSequenceViewer\FArguments) & InArgs, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleData, const uint8 InNumChannels, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IFixedSampledSequenceGridService](API\Plugins\AudioWidgets\IFixedSampledSequenceGridService) > InGridService )


className: SFixedSampledSequenceRuler

code: class SFixedSampledSequenceRuler : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

OnTimeUnitMenuSelection

type: FOnTimeUnitMenu...

description: Delegate sent when the user selects a new display unit from the RMB menu


className: ESequenceDrawMode

code: enum ESequenceDrawMode { BinnedPeaks = 0, SequenceLine, }


code: WidgetArgsType & HideBackground &40; bool InArg &41;


code: WidgetArgsType & HideGrid &40; bool InArg &41;


code: WidgetArgsType & SequenceDrawingParams &40; SampledSequenceDrawingUtils::FSampledSequenceDrawingParams InArg &41;


code: WidgetArgsType & Style &40; const FSampledSequenceViewerStyle &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SFixedSampledSequenceViewer >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: void OnStyleUpdated ( const [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) UpdatedStyle )


code: void SetHideGrid ( const bool InHideGrid )


code: void UpdateView ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSampleData, const uint8 InNumChannels )


className: SFixedSampledSequenceViewer

code: class SFixedSampledSequenceViewer : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)


code: void Construct ( const [FArguments](API\Plugins\AudioWidgets\SFixedSampledSequenceViewerPanel\FArguments) & InArgs, const [FFixedSampledSequenceView](API\Plugins\AudioWidgets\FFixedSampledSequenceView) & InData )


description: Whether the samples grid should be drawn or not

code: WidgetArgsType & HideSamplesGrid &40; const TAttribute< bool > & InAttribute &41;


code: WidgetArgsType & HidePlayhead &40; const TAttribute< bool > & InAttribute &41;


description: Whether the samples ruler should be drawn or not

code: WidgetArgsType & HideSamplesRuler &40; const TAttribute< bool > & InAttribute &41;


description: Whether the value grid should be drawn or not

code: WidgetArgsType & HideValueGrid &40; const TAttribute< bool > & InAttribute &41;


code: NamedSlotProperty< FArguments > InArgs&40;&41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


description: Playhead overlay widget style

code: WidgetArgsType & PlayheadOverlayStyle &40; const FPlayheadOverlayStyle &42; InArg &41;


description: Samples ruler display unit

code: WidgetArgsType & SamplesRulerDisplayUnit &40; ESampledSequenceDisplayUnit InArg &41;


description: Time Ruler widget style

code: WidgetArgsType & SamplesRulerStyle &40; const FFixedSampleSequenceRulerStyle &42; InArg &41;


description: Sequence drawing params

code: WidgetArgsType & SequenceDrawingParams &40; SampledSequenceDrawingUtils::FSampledSequenceDrawingParams InArg &41;


description: Sequence viewer widget style

code: WidgetArgsType & SequenceViewerStyle &40; const FSampledSequenceViewerStyle &42; InArg &41;


description: Regulates how the value grid is divided

code: WidgetArgsType & ValueGridDivideMode &40; SampledSequenceValueGridOverlay::EGridDivideMode InArg &41;


description: Allows customization of labels displayed in the value grid

code: WidgetArgsType & ValueGridLabelGenerator &40; TFunction< FText(const double)> InArg &41;


description: Maximum number of divisions in the value grid

code: WidgetArgsType & ValueGridMaxDivisionParameter &40; uint32 InArg &41;


description: Value grid widget style

code: WidgetArgsType & ValueGridStyle &40; const FSampledSequenceValueGridOverlayStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SFixedSampledSequenceViewerPanel >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: IFixedSampledSequenceViewReceiverInterface

code: virtual void ReceiveSequenceView ( const [FFixedSampledSequenceView](API\Plugins\AudioWidgets\FFixedSampledSequenceView) InData, const uint32 FirstSampleIndex )


code: void SetPlayheadRatio ( const float InRatio )


description: Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


code: void UpdatePlayheadOverlayStyle ( const [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) UpdatedStyle )


code: void UpdateRulerStyle ( const [FFixedSampleSequenceRulerStyle](API\Plugins\AudioWidgets\FFixedSampleSequenceRulerStyle) UpdatedStyle )


code: void UpdateSequenceViewerStyle ( const [FSampledSequenceViewerStyle](API\Plugins\AudioWidgets\FSampledSequenceViewerStyle) UpdatedStyle )


code: void UpdateValueGridOverlayStyle ( const [FSampledSequenceValueGridOverlayStyle](API\Plugins\AudioWidgets\FSampledSequenceValueGridOverlay-) UpdatedStyle )


className: SFixedSampledSequenceViewerPanel

code: class SFixedSampledSequenceViewerPanel : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget), public [IFixedSampledSequenceViewReceiver](API\Plugins\AudioWidgets\IFixedSampledSequenceViewReceive-)


code: void Construct ( const [FArguments](API\Plugins\AudioWidgets\SPlayheadOverlay\FArguments) & InArgs )


code: WidgetArgsType & Style &40; const FPlayheadOverlayStyle &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SPlayheadOverlay >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: void OnStyleUpdated ( const [FPlayheadOverlayStyle](API\Plugins\AudioWidgets\FPlayheadOverlayStyle) UpdatedStyle )


code: void SetPlayheadPosition ( const float InNewPosition )


className: SPlayheadOverlay

code: class SPlayheadOverlay : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)


description: LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


code: void Construct ( const [FArguments](API\Plugins\AudioWidgets\SSampledSequenceValueGridOverlay\FArguments) & InArgs )


code: WidgetArgsType & DivideMode &40; SampledSequenceValueGridOverlay::EGridDivideMode InArg &41;