FOnsetNRTResult

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

Windows
MacOS
Linux

Inheritance Hierarchy

IAnalyzerNRTResult

FOnsetNRTResult

References

Module

AudioSynesthesiaCore

Header

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

Include

#include "OnsetNRTFactory.h"

Syntax

class FOnsetNRTResult : public Audio::IAnalyzerNRTResult

Remarks

FOnsetNRTResult

FOnsetNRTResult is a container for the output of the FOnsetNRTWorker.

Constructors

Name Description

Public function

FOnsetNRTResult()

Functions

Name Description

Public function

void

 

AddChannel

(
    int32 InChannelIndex
)

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

Public function

void

 

AddOnset

(
    int32 InChannelIndex,
    float InTimestamp,
    float InStrength
)

Add a single frame of CQT data

Public function Const

bool

 

ContainsChannel

(
    int32 InChannelIndex
)

Returns true if this result contains the channel index.

Public function Const

FFloatInterv...

 

GetChannelOnsetInterval

(
    int32 InChannelIdx
)

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

Public function Const

void

 

GetChannels

(
    TArray< int32 >& OutChannels
)

Retrieve the channels available in the result.

Public function Const

const TArray...

 

GetOnsetsForChannel

(
    int32 InChannelIndex
)

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

Public function Const

bool

 

IsSortedChronologically()

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

Public function

void

 

SetDurationInSeconds

(
    float InDuration
)

Sets the duration of the analyzed audio in seconds

Public function

void

 

SortChronologically()

Sorts FOnset arrays in chronologically ascnding order via their timestamp.

Overridden from IAnalyzerNRTResult

Name Description

Public function Virtual Const

float

 

GetDurationInSeconds()

Returns the duration of the analyzed audio in seconds

Public function Virtual

void

 

Serialize

(
    FArchive& Archive
)

Serialize or unserialize object
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss