UOdinMuteEffect

Codec-Effect for the odin audio pipeline. The effect will mutate the silent flag based on the mute uproperty. Sets the flag for chaining effects in the pipeline as well. Symbolizing silenced audio data without changing the buffer. This results in not necessarily sending the audio packet over the network at all.

Declaration

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

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

Overview

Properties

Name	Description
MuteFlag	Set marks the audio passing through the effect as silent (muted); Unset and None let it pass.
UserData

Functions

ConstructMuteEffect

Static · Blueprint: Construct Mute Effect

Creates a Mute Effect that is not part of a pipeline yet; add it with Insert Custom Effect. Create Mute Effect on a pipeline does both steps.

UFUNCTION(BlueprintCallable, Category = "Odin|Audio Pipeline|Effects")
static UOdinMuteEffect* ConstructMuteEffect(
    UObject* WorldContextObject,
    EOdinMuteEffectOptions Toggle = EOdinMuteEffectOptions::ODIN_EFFECT_TOGGLE_UNCHANGED);

Parameter	Type	Description
WorldContextObject	UObject*
Toggle	EOdinMuteEffectOptions	Initial value of the Mute Flag. Default: EOdinMuteEffectOptions::ODIN_EFFECT_TOGGLE_UNCHANGED.

Returns UOdinMuteEffect*

Properties

MuteFlag

Blueprint: Get/Set

Set marks the audio passing through the effect as silent (muted); Unset and None let it pass.

UPROPERTY(BlueprintReadWrite, Category = "Odin|Audio Pipeline|State")
EOdinMuteEffectOptions MuteFlag = EOdinMuteEffectOptions::ODIN_EFFECT_TOGGLE_UNCHANGED;

UserData

TOdinCustomEffectUserData<UOdinMuteEffect> UserData;