|
Module |
|
|
Header |
/Engine/Source/Runtime/AudioExtensions/Public/IAudioEndpoint.h |
|
Include |
#include "IAudioEndpoint.h" |
class IAudioEndpoint
Class that allows audio to be sent to an arbitrary locale. This can be used for multi-device rendering, haptics systems, etc.
that this only for interleaved audio buffers with no metadata for object-based or soundfield-based rendering. For those, see
| Name | Description | |
|---|---|---|
|
|
~IAudioEndpoint() |
| Name | Description | ||
|---|---|---|---|
|
|
DisconnectAllInputs() |
Thread safe function to disconnect everything from this endpoint. |
|
|
|
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 GetDesiredNumFrames should be overridden. |
|
|
|
GetDesiredNumFrames() |
||
|
|
GetNumChannels() |
This should return the number of channels we should be sending to this endpoint. |
|
|
|
float |
GetSampleRate() |
REQUIRED OVERRIDES: This should return the sample rate we should be sending to this endpoint. |
|
|
OnAudioCallback ( |
For endpoints that override EndpointRequiresCallback to return true, this callback will be called every (GetDesiredNumFrames() / GetSampleRate()) seconds. |
|
|
|
Audio::FPatc... |
PatchNewInput ( |
Create a new patch point for this endpoint. |
|
|
PollSettings ( |
Use this as a thread safe way to use the current settings posted to this IAudioEndpoint. |
|
|
|
PopAudio ( |
METHODS USED BY IMPLEMENTATIONS OF IAudioEndpoint: This is used by the IAudioEndpoint implementation to poll buffered audio to process or send to the endpoint. |
|
|
|
ProcessAudioIfNeccessary() |
If this audio endpoint hasn't spawned a seperate callback thread but requires a callback, this should be executed somewhere. |
|
|
|
RunCallbackSynchronously() |
If EndpointRequiresCallback() returns true, this can be used to manually run the callback. |
|
|
|
SetNewSettings |
Post new settings for this endpoint. |
|
|
|
StartRunningAsyncCallback() |
If EndpointRequiresCallback() returns true, this can be used to spawn an async thread and begin calling OnAudioCallback. |
|
|
|
StopRunningAsyncCallback() |
