FLoudnessNRTResult

[FLoudnessNRTResult](API\Plugins\AudioSynesthesiaCore\FLoudnessNRTResult)

Windows
MacOS
Linux

Inheritance Hierarchy

IAnalyzerNRTResult

FLoudnessNRTResult

References

Module

AudioSynesthesiaCore

Header

/Engine/Plugins/Runtime/AudioSynesthesia/Source/AudioSynesthesiaCore/Public/LoudnessNRTFactory.h

Include

#include "LoudnessNRTFactory.h"

Syntax

class FLoudnessNRTResult : public Audio::IAnalyzerNRTResult

Remarks

FLoudnessNRTResult

FLoudnessNRTResult contains the temporal evolution of loudness.

Constructors

Name Description

Public function

FLoudnessNRTResult()

Functions

Name Description

Public function

void

 

Add

(
    const FLoudnessDatum & InDatum
)

Appends an FLoudnessDatum to the container.

Public function Const

bool

 

ContainsChannel

(
    int32 InChannelIndex
)

Returns true if this object data for the given channel index

Public function Const

const TArray ...

 

GetChannelLoudnessArray

(
    int32 ChannelIdx
)

Returns const reference to FLoudnessDatum array for individual channel.

Public function Const

float

 

GetChannelLoudnessRange

(
    int32 InChannelIdx,
    float InNoiseFloor
)

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

Public function Const

void

 

GetChannels

(
    TArray < int32 >& OutChannels
)

Returns the channel indices availabe in result.

Public function Const

const TArray ...

 

GetLoudnessArray()

Returns const reference to FLoudnessDatum array associated with overall loudness.

Public function Const

float

 

GetLoudnessRange

(
    float InNoiseFloor
)

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

Public function Const

bool

 

IsSortedChronologically()

Returns true if FLoudnessDatum arrays are sorted in chronologically ascending order via their timestamp.

Public function

void

 

SetDurationInSeconds

(
    float InDuration
)

Sets the duration of the anlayzed audio.

Public function

void

 

SortChronologically()

Sorts FLoudnessDatum arrays in chronologically ascnding order via their timestamp.

Overridden from IAnalyzerNRTResult

Name Description

Public function Virtual Const

float

 

GetDurationInSeconds()

Gets the duration of the anlayzed audio.

Public function Virtual

void

 

Serialize

(
    FArchive & Archive
)

Defines how to serialize result.

Constants

Name

Description

ChannelIndexOverall

ChannelIndexOverall

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback