UVoipListenerSynthComponent::IsIdling

Thread safe way to get whether this synth component still has buffered packets of audio to play back.

Windows
MacOS
Linux

References

Module

OnlineSubsystemUtils

Header

/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoipListenerSynthComponent.h

Include

#include "VoipListenerSynthComponent.h"

Source

/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Private/VoipListenerSynthComponent.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio|Voice|Sender")
bool IsIdling()

Remarks

Thread safe way to get whether this synth component still has buffered packets of audio to play back. This function is used by the Voice Engine to clean up voice sounds when they are not playing back audio to make space for other sounds to be rendered.

Returns

true if this synth component is out of audio to play.

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