FAudioCaptureSynth

Class which contains an [FAudioCapture](API\Runtime\AudioCaptureCore\FAudioCapture) object and performs analysis on the audio stream, only outputing audio if it matches a detection criteria.

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioCaptureCore

Header

/Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureCore.h

Include

#include "AudioCaptureCore.h"

Syntax

class FAudioCaptureSynth

Remarks

Class which contains an FAudioCapture object and performs analysis on the audio stream, only outputing audio if it matches a detection criteria.

Constructors

Name Description

Public function

FAudioCaptureSynth()

Destructors

Name Description

Public function Virtual

~FAudioCaptureSynth()

Functions

Name Description

Public function

void

 

AbortCapturing()

Immediately stop capturing audio.

Public function

bool

 

GetAudioData

(
    TArray< float >& OutAudioData
)

Retrieves audio data from the capture synth.

Public function

bool

 

GetDefaultCaptureDeviceInfo

(
    FCaptureDeviceInfo& OutInfo
)

Gets the default capture device info.

Public function

int32

 

GetNumSamplesEnqueued()

Returns the number of samples enqueued in the capture synth.

Public function Const

bool

 

IsCapturing()

Returns true if the capture synth is capturing audio.

Public function Const

bool

 

IsStreamOpen()

Returned if the capture synth is closed.

Public function

bool

 

OpenDefaultStream()

Opens up a stream to the default capture device.

Public function

bool

 

StartCapturing()

Starts capturing audio.

Public function

void

 

StopCapturing()

Stops capturing audio.