UGlobalAudioSubsystem 클래스 참조

#include <GlobalAudioSubsystem.h>

UGlobalAudioSubsystem에 대한 상속 다이어그램 :

UGlobalAudioSubsystem에 대한 협력 다이어그램:

클래스
struct	FActiveBGMEntry

Public 멤버 함수
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	Deinitialize () override
bool	PlayBGM (UAudioData *SourceAudioData, FGameplayTag BGMTag, bool bStopOtherBGM=true)
void	StopBGM ()
bool	IsPlayingBGM (FGameplayTag BGMTag) const
void	SetBGMVolume (float NewVolume)
void	SetSFXVolume (float NewVolume)
void	SetAMBVolume (float NewVolume)
bool	PlayAudioTagAtLocation (UAudioData *SourceAudioData, FGameplayTag AudioTag, FVector Location)
UFMODAudioComponent *	StartLoopAudioTag (UAudioData *SourceAudioData, FGameplayTag AudioTag, USceneComponent *AttachToComponent)
void	StopLoopAudio (UFMODAudioComponent *LoopAudioComponent)
FORCEINLINE float	GetBGMVolume () const
FORCEINLINE float	GetSFXVolume () const
FORCEINLINE float	GetAMBVolume () const

Private 멤버 함수
FORCEINLINE UFMODBus *	GetBGMBus ()
FORCEINLINE UFMODBus *	GetSFXBus ()
FORCEINLINE UFMODBus *	GetAMBBus ()
FORCEINLINE UFMODBus *	LoadBus (const TSoftObjectPtr< UFMODBus > &SourceBus, TObjectPtr< UFMODBus > &CachedBus)
bool	IsEventInstancePlaying (const FFMODEventInstance &EventInstance) const
void	StopEventInstance (const FFMODEventInstance &EventInstance) const
void	OnPostLoadMap (UWorld *LoadedWorld)
void	StopBGMByTag (FGameplayTag BGMTag)

Private 속성
TObjectPtr< UFMODBus >	CachedBGMBus
TObjectPtr< UFMODBus >	CachedSFXBus
TObjectPtr< UFMODBus >	CachedAMBBus
TMap< FGameplayTag, FActiveBGMEntry >	ActiveBGMs
FDelegateHandle	PostLoadMapHandle
float	BGMVolume = 1.0f
float	SFXVolume = 1.0f
float	AMBVolume = 1.0f

멤버 함수 문서화

Deinitialize()

void UGlobalAudioSubsystem::Deinitialize ( )

overridevirtual

{
    FCoreUObjectDelegates::PostLoadMapWithWorld.Remove(PostLoadMapHandle);
    PostLoadMapHandle.Reset();
 
    StopBGM();
 
    Super::Deinitialize();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

GetAMBBus()

FORCEINLINE UFMODBus * UGlobalAudioSubsystem::GetAMBBus ( )

inlineprivate

    {
        if (const UGlobalAudioSettings* Settings = GetDefault<UGlobalAudioSettings>())
        {
            return LoadBus(Settings->GetAMBBus(), CachedAMBBus);
        }
        else
        {
            return nullptr;
        }
    }

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetAMBVolume()

FORCEINLINE float UGlobalAudioSubsystem::GetAMBVolume ( ) const

inline

    {
        return AMBVolume;
    }

GetBGMBus()

FORCEINLINE UFMODBus * UGlobalAudioSubsystem::GetBGMBus ( )

inlineprivate

    {
        if (const UGlobalAudioSettings* Settings = GetDefault<UGlobalAudioSettings>())
        {
            return LoadBus(Settings->GetBGMBus(), CachedBGMBus);
        }
        else
        {
            return nullptr;
        }
    }

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetBGMVolume()

FORCEINLINE float UGlobalAudioSubsystem::GetBGMVolume ( ) const

inline

    {
        return BGMVolume;
    }

GetSFXBus()

FORCEINLINE UFMODBus * UGlobalAudioSubsystem::GetSFXBus ( )

inlineprivate

    {
        if (const UGlobalAudioSettings* Settings = GetDefault<UGlobalAudioSettings>())
        {
            return LoadBus(Settings->GetSFXBus(), CachedSFXBus);
        }
        else
        {
            return nullptr;
        }
    }

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetSFXVolume()

FORCEINLINE float UGlobalAudioSubsystem::GetSFXVolume ( ) const

inline

    {
        return SFXVolume;
    }

Initialize()

void UGlobalAudioSubsystem::Initialize ( FSubsystemCollectionBase &  Collection )

overridevirtual

{
    Super::Initialize(Collection);
 
    PostLoadMapHandle = FCoreUObjectDelegates::PostLoadMapWithWorld.AddUObject(this, &UGlobalAudioSubsystem::OnPostLoadMap);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

IsEventInstancePlaying()

bool UGlobalAudioSubsystem::IsEventInstancePlaying ( const FFMODEventInstance &  EventInstance ) const

private

{
    if (EventInstance.Instance == nullptr || EventInstance.Instance->isValid() == false)
    {
        return false;
    }
 
    FMOD_STUDIO_PLAYBACK_STATE PlaybackState = FMOD_STUDIO_PLAYBACK_STOPPED;
 
    if (EventInstance.Instance->getPlaybackState(&PlaybackState) != FMOD_OK)
    {
        return false;
    }
 
    return PlaybackState != FMOD_STUDIO_PLAYBACK_STOPPED;
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

IsPlayingBGM()

bool UGlobalAudioSubsystem::IsPlayingBGM

(

FGameplayTag

BGMTag

)

const

{
    if (const FActiveBGMEntry* ActiveEntry = ActiveBGMs.Find(BGMTag))
    {
        return IsEventInstancePlaying(ActiveEntry->Instance);
    }
    else
    {
        return false;
    }
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

LoadBus()

FORCEINLINE UFMODBus * UGlobalAudioSubsystem::LoadBus ( const TSoftObjectPtr< UFMODBus > &  SourceBus, TObjectPtr< UFMODBus > &  CachedBus  )

inlineprivate

    {
        if (CachedBus)
        {
            return CachedBus;
        }
 
        if (SourceBus.IsNull())
        {
            return nullptr;
        }
 
        CachedBus = SourceBus.LoadSynchronous();
        return CachedBus;
    }

OnPostLoadMap()

void UGlobalAudioSubsystem::OnPostLoadMap ( UWorld *  LoadedWorld )

private

{
    TArray<FGameplayTag> ActiveTags;
    ActiveBGMs.GetKeys(ActiveTags);
 
    for (const FGameplayTag& ActiveTag : ActiveTags)
    {
        const FActiveBGMEntry* ActiveEntry = ActiveBGMs.Find(ActiveTag);
 
        if (ActiveEntry == nullptr || ActiveEntry->bLevelChangeContinue)
        {
            continue;
        }
 
        StopBGMByTag(ActiveTag);
    }
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

PlayAudioTagAtLocation()

bool UGlobalAudioSubsystem::PlayAudioTagAtLocation	(	UAudioData *	SourceAudioData,
		FGameplayTag	AudioTag,
		FVector	Location
	)

{
    if (SourceAudioData == nullptr || AudioTag.IsValid() == false)
    {
        return false;
    }
 
    FAudioTagData Entry;
 
    if (SourceAudioData->FindAudioData(AudioTag, Entry) == false)
    {
        return false;
    }
 
    const FFMODEventInstance NewInstance = UFMODBlueprintStatics::PlayEventAtLocation(this, Entry.AudioData.SoundEvent, FTransform(Location), true);
    return NewInstance.Instance != nullptr;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

PlayBGM()

bool UGlobalAudioSubsystem::PlayBGM	(	UAudioData *	SourceAudioData,
		FGameplayTag	BGMTag,
		bool	bStopOtherBGM = true
	)

{
    if (SourceAudioData == nullptr || BGMTag.IsValid() == false)   
    {
        return false;
    }
 
    FAudioTagData Entry;
 
    if (SourceAudioData->FindAudioData(BGMTag, Entry) == false)
    {
        return false;
    }
    
    if (Entry.bIsBgm == false)
    {
        return false;
    }
 
    const bool bAlreadyPlaying = IsPlayingBGM(BGMTag);
 
    if (bStopOtherBGM)
    {
        TArray<FGameplayTag> ActiveTags;
        ActiveBGMs.GetKeys(ActiveTags);
 
        for (const FGameplayTag& ActiveTag : ActiveTags)
        {
            if (ActiveTag != BGMTag)
            {
                StopBGMByTag(ActiveTag);
            }
        }
    }
 
    if (bAlreadyPlaying && Entry.bCanQuickRestart == false)
    {
        return true;
    }
 
    // 같은 곡을 다시 트는 경우는 즉시 끊는다.
    if (bAlreadyPlaying)
    {
        StopBGMByTag(BGMTag);
    }
 
    const FFMODEventInstance NewInstance = UFMODBlueprintStatics::PlayEvent2D(this, Entry.AudioData.SoundEvent, false);
 
    if (NewInstance.Instance == nullptr)
    {
        return false;
    }
 
    FActiveBGMEntry ActiveEntry;
    ActiveEntry.Instance = NewInstance;
    ActiveEntry.bLevelChangeContinue = Entry.bLevelChangeContinue;
 
    UFMODBlueprintStatics::EventInstancePlay(NewInstance);
 
    ActiveBGMs.Add(BGMTag, ActiveEntry);
 
    return true;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

SetAMBVolume()

void UGlobalAudioSubsystem::SetAMBVolume

(

float

NewVolume

)

{
    AMBVolume = FMath::Clamp(NewVolume, 0.0f, 1.0f);
    UFMODBlueprintStatics::BusSetVolume(GetAMBBus(), AMBVolume);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

SetBGMVolume()

void UGlobalAudioSubsystem::SetBGMVolume

(

float

NewVolume

)

{
    BGMVolume = FMath::Clamp(NewVolume, 0.0f, 1.0f);
    UFMODBlueprintStatics::BusSetVolume(GetBGMBus(), BGMVolume);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

SetSFXVolume()

void UGlobalAudioSubsystem::SetSFXVolume

(

float

NewVolume

)

{
    SFXVolume = FMath::Clamp(NewVolume, 0.0f, 1.0f);
    UFMODBlueprintStatics::BusSetVolume(GetSFXBus(), SFXVolume);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

StartLoopAudioTag()

UFMODAudioComponent * UGlobalAudioSubsystem::StartLoopAudioTag	(	UAudioData *	SourceAudioData,
		FGameplayTag	AudioTag,
		USceneComponent *	AttachToComponent
	)

{
    if (SourceAudioData == nullptr || AudioTag.IsValid() == false || AttachToComponent == nullptr)
    {
        return nullptr;
    }
 
    FAudioTagData Entry;
 
    if (SourceAudioData->FindAudioData(AudioTag, Entry) == false)
    {
        return nullptr;
    }
 
    return UFMODBlueprintStatics::PlayEventAttached
    (
        Entry.AudioData.SoundEvent,
        AttachToComponent,
        NAME_None,
        FVector::ZeroVector,
        EAttachLocation::KeepRelativeOffset,
        true,
        true,
        false
    );
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

StopBGM()

void UGlobalAudioSubsystem::StopBGM

(

)

{
    TArray<FGameplayTag> ActiveTags;
    ActiveBGMs.GetKeys(ActiveTags);
 
    for (const FGameplayTag& ActiveTag : ActiveTags)
    {
        StopBGMByTag(ActiveTag);
    }
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

StopBGMByTag()

void UGlobalAudioSubsystem::StopBGMByTag ( FGameplayTag  BGMTag )

private

{
    FActiveBGMEntry ActiveEntry;
 
    if (ActiveBGMs.RemoveAndCopyValue(BGMTag, ActiveEntry) == false)
    {
        return;
    }
 
    StopEventInstance(ActiveEntry.Instance);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

StopEventInstance()

void UGlobalAudioSubsystem::StopEventInstance ( const FFMODEventInstance &  EventInstance ) const

private

{
    if (EventInstance.Instance == nullptr || EventInstance.Instance->isValid() == false)
    {
        return;
    }
 
    EventInstance.Instance->stop(FMOD_STUDIO_STOP_IMMEDIATE);
    EventInstance.Instance->release();
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

StopLoopAudio()

void UGlobalAudioSubsystem::StopLoopAudio

(

UFMODAudioComponent *

LoopAudioComponent

)

{
    if (LoopAudioComponent == nullptr)
    {
        return;
    }
 
    LoopAudioComponent->Stop();
    LoopAudioComponent->DestroyComponent();
}

멤버 데이터 문서화

ActiveBGMs

TMap<FGameplayTag, FActiveBGMEntry> UGlobalAudioSubsystem::ActiveBGMs

private

AMBVolume

float UGlobalAudioSubsystem::AMBVolume = 1.0f

private

BGMVolume

float UGlobalAudioSubsystem::BGMVolume = 1.0f

private

CachedAMBBus

TObjectPtr<UFMODBus> UGlobalAudioSubsystem::CachedAMBBus

private

CachedBGMBus

TObjectPtr<UFMODBus> UGlobalAudioSubsystem::CachedBGMBus

private

CachedSFXBus

TObjectPtr<UFMODBus> UGlobalAudioSubsystem::CachedSFXBus

private

PostLoadMapHandle

FDelegateHandle UGlobalAudioSubsystem::PostLoadMapHandle

private

SFXVolume

float UGlobalAudioSubsystem::SFXVolume = 1.0f

private

---

이 클래스에 대한 문서화 페이지는 다음의 파일들로부터 생성되었습니다.:

• Source/CK_UE/Subsystem/GameInstance/GlobalAudioSubsystem.h
• Source/CK_UE/Subsystem/GameInstance/GlobalAudioSubsystem.cpp