Navigation
Unreal Engine C++ API Reference > Runtime > AudioExtensions
References
| Module | AudioExtensions |
| Header | /Engine/Source/Runtime/AudioExtensions/Public/IAudioEndpoint.h |
| Include | #include "IAudioEndpoint.h" |
Syntax
class IAudioEndpoint
Remarks
Class that allows audio to be sent to an arbitrary locale. This can be used for multi-device rendering, haptics systems, etc. Note that this only for interleaved audio buffers with no metadata for object-based or soundfield-based rendering. For those, see
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Thread safe function to disconnect everything from this endpoint. | |
   |
bool | 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 GetDesiredNumFrames should be overridden. | |
   |
int32 | ||
   |
int32 | This should return the number of channels we should be sending to this endpoint. | |
   |
float | REQUIRED OVERRIDES: This should return the sample rate we should be sending to this endpoint. | |
  |
bool | Whether this endpoint is of an implemented type | |
  |
bool | OnAudioCallback
(
const TArrayView< const float >& InAudio, |
For endpoints that override EndpointRequiresCallback to return true, this callback will be called every (GetDesiredNumFrames() / GetSampleRate()) seconds. |
 |
Audio::FPatchInput | PatchNewInput
(
float ExpectedDurationPerRender, |
Create a new patch point for this endpoint. |
 |
void | PollSettings
(
TFunctionRef< void(const IAudioEndpointSettingsProxy*)> NewSettingsRetrieved |
Use this as a thread safe way to use the current settings posted to this IAudioEndpoint. |
 |
int32 | PopAudio
(
float* OutAudio, |
METHODS USED BY IMPLEMENTATIONS OF IAudioEndpoint: This is used by the IAudioEndpoint implementation to poll buffered audio to process or send to the endpoint. |
 |
void | If this audio endpoint hasn't spawned a seperate callback thread but requires a callback, this should be executed somewhere. | |
 |
void | If EndpointRequiresCallback() returns true, this can be used to manually run the callback. | |
 |
void | SetNewSettings
(
TUniquePtr< IAudioEndpointSettingsProxy >&& InNewSettings |
Post new settings for this endpoint. |
 |
void | If EndpointRequiresCallback() returns true, this can be used to spawn an async thread and begin calling OnAudioCallback. | |
 |
void |