AudioVirtualLoop.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "ActiveSound.h"
#include "AudioMixerTrace.h"
#include "Sound/SoundModulationDestination.h"
 
struct FAudioVirtualLoop
{
private:
    float TimeSinceLastUpdate;
    float TimeVirtualized;
    float UpdateInterval;
 
#if UE_AUDIO_PROFILERTRACE_ENABLED
    float IsVirtualizedPingTimeSec = 0.0;
    static constexpr float IsVirtualizedPingWaitTimeSec = 1.0;
#endif // UE_AUDIO_PROFILERTRACE_ENABLED
 
    FActiveSound* ActiveSound;
 
    TArray<Audio::FModulationDestination> VolumeConcurrencyDestinations;
 
    struct FWaveInstanceData
    {
        float EffectivePitch;
        Audio::FModulationDestination PitchModulationDestination;
        USoundClass* SoundClass;
        
    };
    
    TSortedMap<UPTRINT, float> EffectivePlaybackTimes;
    TSortedMap<UPTRINT, FWaveInstanceData> WaveInstanceData;
 
    static bool IsInAudibleRange(const FActiveSound& InActiveSound, const FAudioDevice* InAudioDevice = nullptr);
 
public:
    ENGINE_API FAudioVirtualLoop();
 
    static ENGINE_API bool ShouldListenerMoveForceUpdate(const FTransform& LastTransform, const FTransform& CurrentTransform);
 
    static ENGINE_API bool Virtualize(const FActiveSound& InActiveSound, bool bDoRangeCheck, FAudioVirtualLoop& OutVirtualLoop);
    static ENGINE_API bool Virtualize(const FActiveSound& InActiveSound, FAudioDevice& AudioDevice, bool bDoRangeCheck, FAudioVirtualLoop& OutVirtualLoop);
 
    static ENGINE_API bool IsEnabled();
 
    ENGINE_API FActiveSound& GetActiveSound();
 
    ENGINE_API float GetTimeVirtualized() const;
 
    const TSortedMap<UPTRINT, float>& GetEffectivePlaybackTimes();
    
    ENGINE_API float GetUpdateInterval() const;
 
    ENGINE_API const FActiveSound& GetActiveSound() const;
 
    ENGINE_API void CalculateUpdateInterval();
 
    ENGINE_API void UpdateFocusData(float DeltaTime);
 
    ENGINE_API bool Update(float DeltaTime, bool bForceUpdate);
 
#if UE_AUDIO_PROFILERTRACE_ENABLED
    ENGINE_API void OnTraceStarted();
#endif
};