Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FAudioDevice > SoundIsAudible > FAudioDevice::SoundIsAudible

Light Theme

Dark Theme

FAudioDevice::SoundIsAudible

Checks if the given sound would be audible.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/AudioDevice.h
Include	#include "AudioDevice.h"
Source	/Engine/Source/Runtime/Engine/Private/AudioDevice.cpp

Syntax

bool SoundIsAudible
(
    USoundBase * Sound,
    const UWorld * World,
    const FVector & Location,
    const FSoundAttenuationSettings * AttenuationSettingsToApply,
    float MaxDistance,
    float FocusFactor
) const

Remarks

Checks if the given sound would be audible.

Returns

Returns true if the sound is audible, false otherwise.

Parameters

Parameter	Description
Sound	The sound to check if it would be audible
World	The world the sound is playing in
Location	The location the sound is playing in the world
AttenuationSettings	The (optional) attenuation settings the sound is using
MaxDistance	The computed max distance of the sound.
FocusFactor	The focus factor of the sound.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss