UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::FNullAudioCaptureDevice Class Reference

#include <AudioCaptureInternal.h>

+ Inheritance diagram for Audio::FNullAudioCaptureDevice:

Public Member Functions

 FNullAudioCaptureDevice ()
 
virtual bool GetCaptureDeviceInfo (FCaptureDeviceInfo &OutInfo, int32 DeviceIndex) override
 
virtual bool OpenAudioCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnAudioCaptureFunction OnCapture, 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
 
- 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)
 
virtual void SetHardwareFeatureEnabled (EHardwareInputFeature FeatureType, bool bEnabled)
 

Constructor & Destructor Documentation

◆ FNullAudioCaptureDevice()

Audio::FNullAudioCaptureDevice::FNullAudioCaptureDevice ( )
inline

Member Function Documentation

◆ AbortStream()

virtual bool Audio::FNullAudioCaptureDevice::AbortStream ( )
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ CloseStream()

virtual bool Audio::FNullAudioCaptureDevice::CloseStream ( )
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetCaptureDeviceInfo()

virtual bool Audio::FNullAudioCaptureDevice::GetCaptureDeviceInfo ( FCaptureDeviceInfo &  OutInfo,
int32  DeviceIndex 
)
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetInputDevicesAvailable()

virtual bool Audio::FNullAudioCaptureDevice::GetInputDevicesAvailable ( TArray< FCaptureDeviceInfo > &  OutDevices)
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ GetSampleRate()

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

Implements Audio::IAudioCaptureStream.

◆ GetStreamTime()

virtual bool Audio::FNullAudioCaptureDevice::GetStreamTime ( double &  OutStreamTime)
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ IsCapturing()

virtual bool Audio::FNullAudioCaptureDevice::IsCapturing ( ) const
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ IsStreamOpen()

virtual bool Audio::FNullAudioCaptureDevice::IsStreamOpen ( ) const
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ OnAudioCapture()

virtual void Audio::FNullAudioCaptureDevice::OnAudioCapture ( void *  InBuffer,
uint32  InBufferFrames,
double  StreamTime,
bool  bOverflow 
)
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ OpenAudioCaptureStream()

virtual bool Audio::FNullAudioCaptureDevice::OpenAudioCaptureStream ( const FAudioCaptureDeviceParams &  InParams,
FOnAudioCaptureFunction  OnCapture,
uint32  NumFramesDesired 
)
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ StartStream()

virtual bool Audio::FNullAudioCaptureDevice::StartStream ( )
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

◆ StopStream()

virtual bool Audio::FNullAudioCaptureDevice::StopStream ( )
inlineoverridevirtual

Implements Audio::IAudioCaptureStream.

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