FAudioCapture | Unreal Engine 4.27 Documentation

References


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

class FAudioCapture

Class which handles audio capture internally, implemented with a back-end per platform.

	Type	Name	Description
		FAudioCapture ()

	Type	Name	Description
		~FAudioCapture ()

Type	Name	Description
bool	AbortStream ()	Abort the audio capture stream (stop and close)
bool	CloseStream ()	Closes the audio capture stream.
bool	GetCaptureDeviceInfo ( FCaptureDeviceInfo& OutInfo, int32 DeviceIndex )	Returns the audio capture device information at the given Id.
int32	GetCaptureDevicesAvailable ( TArray< FCaptureDeviceInfo >& OutDevices )	Returns the total amount of audio devices.
bool	GetIfHardwareFeatureIsSupported ( EHardwareInputFeature FeatureType )
int32	GetSampleRate ()	Get the sample rate in use by the stream.
bool	GetStreamTime ( double& OutStreamTime )	Get the stream time of the audio capture stream.
bool	IsCapturing ()	Returns true if the audio capture stream is currently capturing audio.
bool	IsStreamOpen ()	Returns if the audio capture stream has been opened.
bool	OpenAudioCaptureStream ( const FAudioCaptureDeviceParams& InParams, FOnAudioCaptureFunction OnCapture, uint32 NumFramesDesired )	Opens the audio capture stream with the given parameters.
bool	RegisterUser ( const TCHAR* UserId )	Adds a user to the system so we can use its devices.
void	SetHardwareFeatureEnabled ( EHardwareInputFeature FeatureType, bool bIsEnabled )
bool	StartStream ()	Start the audio capture stream.
bool	StopStream ()	Stop the audio capture stream.
bool	UnregisterUser ( const TCHAR* UserId )	Removes a user added with RegisterUser.

	Type	Name	Description
	PRAGMA_DISABLE_DEPRECATION_WARNINGS bool	OpenCaptureStream ( const FAudioCaptureDeviceParams& InParams, FOnCaptureFunction OnCapture, uint32 NumFramesDesired )	OpenCaptureStream is deprecated, please use OpenAudioCaptureStream instead.