UOdinRmsEffect

Codec-Effect for the odin audio pipeline. The effect will calculate Root Mean Square (RMS) averaging with the decibels relative to full scale (dBFS)

Declaration

UCLASS(ClassGroup = Odin)
class ODIN_API UOdinRmsEffect : public UOdinCustomEffect

• Header: #include "OdinAudio/Effects/OdinRmsEffect.h"
• Module: Odin
• Inherits from: UOdinCustomEffect
• Blueprint: Reflected (UCLASS) · Blueprint reference

Overview

Properties

Name	Description
RmsDbfs	Loudness of the last processed audio as RMS in dBFS.
UserData

Functions

ConstructRmsEffect

Static · Blueprint: Construct RMS Effect

Creates an RMS Effect that is not part of a pipeline yet; add it with Insert Custom Effect. It stores the loudness of the audio as RMS in dBFS in Rms Dbfs. Create Rms Effect on a pipeline does both steps.

UFUNCTION(BlueprintCallable, Category = "Odin|Audio Pipeline|Effects")
static UOdinRmsEffect* ConstructRmsEffect(UObject* WorldContextObject);

Parameter	Type	Description
WorldContextObject	UObject*

Returns UOdinRmsEffect*

Properties

RmsDbfs

Blueprint: Get

Loudness of the last processed audio as RMS in dBFS.

UPROPERTY(BlueprintReadOnly, Category = "Odin|Audio Pipeline|State")
float RmsDbfs = 0;

UserData

TOdinCustomEffectUserData<UOdinRmsEffect> UserData;