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 > AudioExtensions > IAudioEndpoint > IAudioEndpoint::PopAudio

Light Theme

Dark Theme

IAudioEndpoint::PopAudio

METHODS USED BY IMPLEMENTATIONS OF [IAudioEndpoint](API\Runtime\AudioExtensions\IAudioEndpoint): This is used by the [IAudioEndpoint](API\Runtime\AudioExtensions\IAudioEndpoint) implementation to poll buffered audio to process or send to the endpoint.

Windows

MacOS

Linux

References

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

Syntax

int32 PopAudio
(
float * OutAudio,
int32 NumSamples
)

Remarks

METHODS USED BY IMPLEMENTATIONS OF IAudioEndpoint: This is used by the IAudioEndpoint implementation to poll buffered audio to process or send to the endpoint.

that this is NOT thread safe if EndpointRequiresCallback() is overridden to return true. If that is the case, use an override of OnAudioCallback instead.

Returns

[out] the number of samples polled from this thing.

Parameters

Parameter	Description
OutAudio	Pointer to already allocated buffer of floats, at least NumSamples long. This will be filled with interleaved audio based on GetNumChannels().
NumSamples	The number of samples to fill OutAudio with.

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

Take our survey

Dismiss