Navigation
API > API/Runtime > API/Runtime/AudioCaptureCore
Class which handles audio capture internally, implemented with a back-end per platform.
| Name | FAudioCapture |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureCore.h |
| Include Path | #include "AudioCaptureCore.h" |
Syntax
class FAudioCapture
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioCapture() |
AudioCaptureCore.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAudioCapture() |
AudioCaptureCore.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Impl | TUniquePtr< IAudioCaptureStream > | AudioCaptureCore.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AbortStream() |
Abort the audio capture stream (stop and close) | AudioCaptureCore.h | |
bool CloseStream() |
Closes the audio capture stream. | AudioCaptureCore.h | |
bool GetCaptureDeviceInfo
(
FCaptureDeviceInfo& OutInfo, |
Returns the audio capture device information at the given Id. | AudioCaptureCore.h | |
int32 GetCaptureDevicesAvailable
(
TArray< FCaptureDeviceInfo >& OutDevices |
Returns the total amount of audio devices. | AudioCaptureCore.h | |
bool GetIfHardwareFeatureIsSupported
(
EHardwareInputFeature FeatureType |
AudioCaptureCore.h | ||
int32 GetSampleRate() |
Get the sample rate in use by the stream. | AudioCaptureCore.h | |
bool GetStreamTime
(
double& OutStreamTime |
Get the stream time of the audio capture stream. | AudioCaptureCore.h | |
bool IsCapturing() |
Returns true if the audio capture stream is currently capturing audio. | AudioCaptureCore.h | |
bool IsStreamOpen() |
Returns if the audio capture stream has been opened. | AudioCaptureCore.h | |
bool OpenAudioCaptureStream
(
const FAudioCaptureDeviceParams& InParams, |
Opens the audio capture stream with the given parameters. | AudioCaptureCore.h | |
PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream
(
const FAudioCaptureDeviceParams& InParams, |
Opens the audio capture stream with the given parameters. | AudioCaptureCore.h | |
bool RegisterUser
(
const TCHAR* UserId |
Adds a user to the system so we can use its devices. | AudioCaptureCore.h | |
void SetHardwareFeatureEnabled
(
EHardwareInputFeature FeatureType, |
AudioCaptureCore.h | ||
bool StartStream() |
Start the audio capture stream. | AudioCaptureCore.h | |
bool StopStream() |
Stop the audio capture stream. | AudioCaptureCore.h | |
bool UnregisterUser
(
const TCHAR* UserId |
Removes a user added with RegisterUser. | AudioCaptureCore.h |