Navigation
API > API/Runtime > API/Runtime/AudioCaptureCore
Class which contains an FAudioCapture object and performs analysis on the audio stream, only outputing audio if it matches a detection criteria.
| Name | FAudioCaptureSynth |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureCore.h |
| Include Path | #include "AudioCaptureCore.h" |
Syntax
class FAudioCaptureSynth
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioCaptureSynth() |
AudioCaptureCore.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAudioCaptureSynth() |
AudioCaptureCore.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioCapture | FAudioCapture | Audio capture object dealing with getting audio callbacks. | AudioCaptureCore.h | |
| AudioCaptureData | TArray< float > | Buffer of audio capture data, yet to be copied to the output. | AudioCaptureCore.h | |
| bInitialized | bool | If the object has been initialized. | AudioCaptureCore.h | |
| bIsCapturing | bool | If we're capturing data. | AudioCaptureCore.h | |
| CaptureCriticalSection | FCriticalSection | Critical section to prevent reading and writing from the captured buffer at the same time. | AudioCaptureCore.h | |
| CaptureInfo | FCaptureDeviceInfo | Information about the default capture device we're going to use. | AudioCaptureCore.h | |
| NumSamplesEnqueued | int32 | Number of samples enqueued. | AudioCaptureCore.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AbortCapturing() |
Immediately stop capturing audio. | AudioCaptureCore.h | |
bool GetAudioData
(
TArray< float >& OutAudioData |
Retrieves audio data from the capture synth. | AudioCaptureCore.h | |
bool GetDefaultCaptureDeviceInfo
(
FCaptureDeviceInfo& OutInfo |
Gets the default capture device info. | AudioCaptureCore.h | |
int32 GetNumSamplesEnqueued() |
Returns the number of samples enqueued in the capture synth. | AudioCaptureCore.h | |
bool IsCapturing() |
Returns true if the capture synth is capturing audio. | AudioCaptureCore.h | |
bool IsStreamOpen() |
Returned if the capture synth is closed. | AudioCaptureCore.h | |
bool OpenDefaultStream() |
Opens up a stream to the default capture device. | AudioCaptureCore.h | |
bool StartCapturing() |
Starts capturing audio. | AudioCaptureCore.h | |
void StopCapturing() |
Stops capturing audio. | AudioCaptureCore.h |