UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FAudioCaptureAudioUnitStream Class Reference

#include <AudioCaptureAudioUnit.h>

+ Inheritance diagram for Audio::FAudioCaptureAudioUnitStream:

Public Member Functions

 FAudioCaptureAudioUnitStream ()
 
virtual bool GetCaptureDeviceInfo (FCaptureDeviceInfo &OutInfo, int32 DeviceIndex) override
 
virtual bool OpenAudioCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnAudioCaptureFunction InOnCapture, uint32 NumFramesDesired) override
 
virtual bool CloseStream () override
 
virtual bool StartStream () override
 
virtual bool StopStream () override
 
virtual bool AbortStream () override
 
virtual bool GetStreamTime (double &OutStreamTime) override
 
virtual int32 GetSampleRate () const override
 
virtual bool IsStreamOpen () const override
 
virtual bool IsCapturing () const override
 
virtual void OnAudioCapture (void *InBuffer, uint32 InBufferFrames, double StreamTime, bool bOverflow) override
 
virtual bool GetInputDevicesAvailable (TArray< FCaptureDeviceInfo > &OutDevices) override
 
virtual void SetHardwareFeatureEnabled (EHardwareInputFeature FeatureType, bool bEnabled)
 
OSStatus OnCaptureCallback (AudioUnitRenderActionFlags *ioActionFlags, const AudioTimeStamp *inTimeStamp, UInt32 inBusNumber, UInt32 inNumberFrames, AudioBufferList *ioData)
 
- Public Member Functions inherited from Audio::IAudioCaptureStream
 IAudioCaptureStream ()
 
virtual ~IAudioCaptureStream ()
 
virtual bool RegisterUser (const TCHAR *UserId)
 
virtual bool UnregisterUser (const TCHAR *UserId)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnCaptureFunction InOnCapture, uint32 NumFramesDesired)
 
virtual bool GetIfHardwareFeatureIsSupported (EHardwareInputFeature FeatureType)
 

Constructor & Destructor Documentation

◆ FAudioCaptureAudioUnitStream()

Audio::FAudioCaptureAudioUnitStream::FAudioCaptureAudioUnitStream ( )

Member Function Documentation

◆ AbortStream()

bool Audio::FAudioCaptureAudioUnitStream::AbortStream ( )
overridevirtual

◆ CloseStream()

bool Audio::FAudioCaptureAudioUnitStream::CloseStream ( )
overridevirtual

◆ GetCaptureDeviceInfo()

bool Audio::FAudioCaptureAudioUnitStream::GetCaptureDeviceInfo ( FCaptureDeviceInfo OutInfo,
int32  DeviceIndex 
)
overridevirtual

◆ GetInputDevicesAvailable()

bool Audio::FAudioCaptureAudioUnitStream::GetInputDevicesAvailable ( TArray< FCaptureDeviceInfo > &  OutDevices)
overridevirtual

◆ GetSampleRate()

virtual int32 Audio::FAudioCaptureAudioUnitStream::GetSampleRate ( ) const
inlineoverridevirtual

◆ GetStreamTime()

bool Audio::FAudioCaptureAudioUnitStream::GetStreamTime ( double OutStreamTime)
overridevirtual

◆ IsCapturing()

bool Audio::FAudioCaptureAudioUnitStream::IsCapturing ( ) const
overridevirtual

◆ IsStreamOpen()

bool Audio::FAudioCaptureAudioUnitStream::IsStreamOpen ( ) const
overridevirtual

◆ OnAudioCapture()

void Audio::FAudioCaptureAudioUnitStream::OnAudioCapture ( void InBuffer,
uint32  InBufferFrames,
double  StreamTime,
bool  bOverflow 
)
overridevirtual

◆ OnCaptureCallback()

OSStatus Audio::FAudioCaptureAudioUnitStream::OnCaptureCallback ( AudioUnitRenderActionFlags ioActionFlags,
const AudioTimeStamp inTimeStamp,
UInt32  inBusNumber,
UInt32  inNumberFrames,
AudioBufferList ioData 
)

◆ OpenAudioCaptureStream()

bool Audio::FAudioCaptureAudioUnitStream::OpenAudioCaptureStream ( const FAudioCaptureDeviceParams InParams,
FOnAudioCaptureFunction  InOnCapture,
uint32  NumFramesDesired 
)
overridevirtual

◆ SetHardwareFeatureEnabled()

void Audio::FAudioCaptureAudioUnitStream::SetHardwareFeatureEnabled ( EHardwareInputFeature  FeatureType,
bool  bEnabled 
)
virtual

Reimplemented from Audio::IAudioCaptureStream.

◆ StartStream()

bool Audio::FAudioCaptureAudioUnitStream::StartStream ( )
overridevirtual

◆ StopStream()

bool Audio::FAudioCaptureAudioUnitStream::StopStream ( )
overridevirtual

The documentation for this class was generated from the following files: