File size: 4,276 Bytes
1e67697 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | // Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "Subsystems/WorldSubsystem.h"
#include "LyraAudioMixEffectsSubsystem.generated.h"
#define UE_API LYRAGAME_API
class FSubsystemCollectionBase;
class UObject;
class USoundControlBus;
class USoundControlBusMix;
class USoundEffectSubmixPreset;
class USoundSubmix;
class UWorld;
USTRUCT()
struct FLyraAudioSubmixEffectsChain
{
GENERATED_BODY()
// Submix on which to apply the Submix Effect Chain Override
UPROPERTY(Transient)
TObjectPtr<USoundSubmix> Submix = nullptr;
// Submix Effect Chain Override (Effects processed in Array index order)
UPROPERTY(Transient)
TArray<TObjectPtr<USoundEffectSubmixPreset>> SubmixEffectChain;
};
/**
* This subsystem is meant to automatically engage default and user control bus mixes
* to retrieve previously saved user settings and apply them to the activated user mix.
* Additionally, this subsystem will automatically apply HDR/LDR Audio Submix Effect Chain Overrides
* based on the user's preference for HDR Audio. Submix Effect Chain Overrides are defined in the
* Lyra Audio Settings.
*/
UCLASS(MinimalAPI)
class ULyraAudioMixEffectsSubsystem : public UWorldSubsystem
{
GENERATED_BODY()
public:
// USubsystem implementation Begin
UE_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
UE_API virtual void Deinitialize() override;
// USubsystem implementation End
UE_API virtual bool ShouldCreateSubsystem(UObject* Outer) const override;
/** Called once all UWorldSubsystems have been initialized */
UE_API virtual void PostInitialize() override;
/** Called when world is ready to start gameplay before the game mode transitions to the correct state and call BeginPlay on all actors */
UE_API virtual void OnWorldBeginPlay(UWorld& InWorld) override;
/** Set whether the HDR Audio Submix Effect Chain Override settings are applied */
UE_API void ApplyDynamicRangeEffectsChains(bool bHDRAudio);
protected:
UE_API void OnLoadingScreenStatusChanged(bool bShowingLoadingScreen);
UE_API void ApplyOrRemoveLoadingScreenMix(bool bWantsLoadingScreenMix);
// Called when determining whether to create this Subsystem
UE_API virtual bool DoesSupportWorldType(const EWorldType::Type WorldType) const override;
// Default Sound Control Bus Mix retrieved from the Lyra Audio Settings
UPROPERTY(Transient)
TObjectPtr<USoundControlBusMix> DefaultBaseMix = nullptr;
// Loading Screen Sound Control Bus Mix retrieved from the Lyra Audio Settings
UPROPERTY(Transient)
TObjectPtr<USoundControlBusMix> LoadingScreenMix = nullptr;
// User Sound Control Bus Mix retrieved from the Lyra Audio Settings
UPROPERTY(Transient)
TObjectPtr<USoundControlBusMix> UserMix = nullptr;
// Overall Sound Control Bus retrieved from the Lyra Audio Settings and linked to the UI and game settings in LyraSettingsLocal
UPROPERTY(Transient)
TObjectPtr<USoundControlBus> OverallControlBus = nullptr;
// Music Sound Control Bus retrieved from the Lyra Audio Settings and linked to the UI and game settings in LyraSettingsLocal
UPROPERTY(Transient)
TObjectPtr<USoundControlBus> MusicControlBus = nullptr;
// SoundFX Sound Control Bus retrieved from the Lyra Audio Settings and linked to the UI and game settings in LyraSettingsLocal
UPROPERTY(Transient)
TObjectPtr<USoundControlBus> SoundFXControlBus = nullptr;
// Dialogue Sound Control Bus retrieved from the Lyra Audio Settings and linked to the UI and game settings in LyraSettingsLocal
UPROPERTY(Transient)
TObjectPtr<USoundControlBus> DialogueControlBus = nullptr;
// VoiceChat Sound Control Bus retrieved from the Lyra Audio Settings and linked to the UI and game settings in LyraSettingsLocal
UPROPERTY(Transient)
TObjectPtr<USoundControlBus> VoiceChatControlBus = nullptr;
// Submix Effect Chain Overrides to apply when HDR Audio is turned on
UPROPERTY(Transient)
TArray<FLyraAudioSubmixEffectsChain> HDRSubmixEffectChain;
// Submix Effect hain Overrides to apply when HDR Audio is turned off
UPROPERTY(Transient)
TArray<FLyraAudioSubmixEffectsChain> LDRSubmixEffectChain;
bool bAppliedLoadingScreenMix = false;
};
#undef UE_API
|