UOdinSynthComponent

Component for playing back audio data received from an Odin Decoder in Unreal.

Declaration

UCLASS(ClassGroup = (Odin), Blueprintable, BlueprintType, meta = (BlueprintSpawnableComponent))
class ODIN_API UOdinSynthComponent : public USynthComponent

• Header: #include "OdinAudio/OdinSynthComponent.h"
• Module: Odin
• Inherits from: USynthComponent
• Blueprint: Blueprint type, Blueprintable · Blueprint reference

Overview

Functions

Name	Description
AdjustAttenuation	This function is used to modify the Attenuation Settings on the targeted ODIN Synth instance.
GetDecoder	Retrieves the Odin Decoder instance associated with this component.
GetConnectedAudioComponent	Returns the internal audio component associated with this synth component.
SetDecoder	Sets the decoder for the Odin Synth Component.

Functions

AdjustAttenuation

Blueprint: Adjust Attenuation

This function is used to modify the Attenuation Settings on the targeted ODIN Synth instance. It is worth noting that Attenuation Settings are only passed to new Active Sounds on start, so modified Attenuation data should be set before sound playback.

UFUNCTION(BlueprintCallable, Category = "Odin|Sound")
void AdjustAttenuation(const FSoundAttenuationSettings& InAttenuationSettings);

Parameter	Type	Description
InAttenuationSettings	const FSoundAttenuationSettings&	New attenuation settings.

GetDecoder

Const · Blueprint: Get Decoder (Synth)

Retrieves the Odin Decoder instance associated with this component.

UFUNCTION(BlueprintPure, Category = "Odin|Sound")
UOdinDecoder* GetDecoder() const;

Returns UOdinDecoder* – A pointer to the UOdinDecoder instance used by the component.

GetConnectedAudioComponent

Blueprint: Get Connected Audio Component

Returns the internal audio component associated with this synth component.

UFUNCTION(BlueprintPure, Category = "Sound")
UAudioComponent* GetConnectedAudioComponent();

Returns UAudioComponent* – The connected UAudioComponent.

SetDecoder

Blueprint: Set Decoder (Synth)

Sets the decoder for the Odin Synth Component. If the provided decoder differs from the current one, the component is restarted to apply the new decoder.

UFUNCTION(BlueprintCallable, Category = "Odin|Sound")
void SetDecoder(UOdinDecoder* InDecoder);

Parameter	Type	Description
InDecoder	UOdinDecoder*	Pointer to the Odin Decoder instance to be set.