UOdinActivityEffect

Codec-Effect for the odin audio pipeline. The effect will invoke activity event and field based on the silent flag. Event is dispatched to the GameThread.

Declaration

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

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

Overview

Properties

Name	Description
HasActivity	True while the audio passing through the effect is active (not silent).
UserData

Functions

ConstructActivityEffect

Static · Blueprint: Construct Activity Effect

Creates an Activity Effect that is not part of a pipeline yet; add it with Insert Custom Effect. It raises Activity Callback whenever the audio switches between silent and active. Create Activity Effect on a pipeline does both steps.

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

Parameter	Type	Description
WorldContextObject	UObject*

Returns UOdinActivityEffect*

Properties

HasActivity

Blueprint: Get

True while the audio passing through the effect is active (not silent).

UPROPERTY(BlueprintReadOnly, Category = "Odin|Audio Pipeline|State")
bool HasActivity;

UserData

TOdinCustomEffectUserData<UOdinActivityEffect> UserData;

Events

ActivityCallback

Blueprint: Activity Callback

Raised on the game thread when the audio passing through the effect switches between silent and active.

UPROPERTY(BlueprintAssignable, Category = "Odin|Audio Pipeline|Events")
FOdinActivityEffectCallback ActivityCallback;

Signature: FOdinActivityEffectCallback void(const bool isActive, const UOdinActivityEffect* userData) (multicast)