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 > ISoundfieldEndpoint

Light Theme

Dark Theme

ISoundfieldEndpoint

Class that allows soundfield-encoded audio to be sent to an arbitrary locale.

Windows

MacOS

Linux

References

Module	AudioExtensions
Header	/Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldEndpoint.h
Include	#include "ISoundfieldEndpoint.h"

Syntax

class ISoundfieldEndpoint

Remarks

Class that allows soundfield-encoded audio to be sent to an arbitrary locale. For endpoint types that support receiving our downmixed interleaved audio data directly, implement IAudioEndpoint instead.

Constructors

	Name	Description
	ISoundfieldEndpoint ( int32 NumRenderCallbacksToBuffer )

Destructors

	Name	Description
	~ISoundfieldEndpoint()

Functions

	Name	Description
bool	EndpointRequiresCallback()	OPTIONAL OVERRIDES: For endpoints that do not explicitly fire a timed callback to poll audio data, this should be overridden to return true, and OnAudioCallback and GetDesiredCallbackFrequency should be overridden.
float	GetDesiredCallbackPeriodicity()	For endpoints that return true for EndpointRequiresCallback, this should return the duration between OnAudioCallback calls in seconds.
int32	GetNumPacketsBuffer()	Returns the amount of ISoundfieldAudioPackets currently buffered for this endpoint.
int32	GetRemainderInPacketBuffer()	Returns the amount of ISoundfieldAudioPackets that can be buffered for this endpoint before reaching capacity.
void	OnAudioCallback ( TUniquePtr< ISoundfieldAudioPacket ..., const ISoundfieldEndpointSettingsPr... )	For endpoints that override EndpointRequiresCallback to return true, this callback will be called every (GetDesiredNumFrames() / GetSampleRate()) seconds.
void	PollSettings ( TFunctionRef< void... )	Use this as a thread safe way to use the current settings posted to this IAudioEndpoint.
TUniquePtr< ...	PopAudio()	METHODS USED BY IMPLEMENTATIONS OF ISoundfieldEndpoint: This is used by the IAudioEndpoint implementation to poll buffered audio to process or send to the endpoint.
void	ProcessAudioIfNecessary()	If this endpoint hasn't created it's own async callback thread but still requires an explicit callback, this should be called.
bool	PushAudio ( TUniquePtr< ISoundfieldAudioPacket ... )	Push a soundfield packet to the buffer.
void	RunCallbackSynchronously()
void	SetNewSettings ( TUniquePtr< ISoundfieldEndpointSett... )	Post new settings for this endpoint.
void	StartRunningCallback()	If EndpointRequiresCallback() returns true, this will be used to spawn an async thread and begin calling OnAudioCallback.
void	StopRunningCallback()

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

Take our survey

Dismiss