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

#include <AudioCaptureDeviceInterface.h>

+ Inheritance diagram for Audio::IAudioCaptureStream:

Public Member Functions

 IAudioCaptureStream ()
 
virtual ~IAudioCaptureStream ()
 
virtual bool RegisterUser (const TCHAR *UserId)
 
virtual bool UnregisterUser (const TCHAR *UserId)
 
virtual bool GetCaptureDeviceInfo (FCaptureDeviceInfo &OutInfo, int32 DeviceIndex)=0
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnCaptureFunction InOnCapture, uint32 NumFramesDesired)
 
virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool OpenAudioCaptureStream (const FAudioCaptureDeviceParams &InParams, FOnAudioCaptureFunction InOnCapture, uint32 NumFramesDesired)=0
 
virtual bool CloseStream ()=0
 
virtual bool StartStream ()=0
 
virtual bool StopStream ()=0
 
virtual bool AbortStream ()=0
 
virtual bool GetStreamTime (double &OutStreamTime)=0
 
virtual int32 GetSampleRate () const =0
 
virtual bool IsStreamOpen () const =0
 
virtual bool IsCapturing () const =0
 
virtual void OnAudioCapture (void *InBuffer, uint32 InBufferFrames, double StreamTime, bool bOverflow)=0
 
virtual bool GetInputDevicesAvailable (TArray< FCaptureDeviceInfo > &OutDevices)=0
 
virtual bool GetIfHardwareFeatureIsSupported (EHardwareInputFeature FeatureType)
 
virtual void SetHardwareFeatureEnabled (EHardwareInputFeature FeatureType, bool bEnabled)
 

Constructor & Destructor Documentation

◆ IAudioCaptureStream()

Audio::IAudioCaptureStream::IAudioCaptureStream ( )
inline

◆ ~IAudioCaptureStream()

virtual Audio::IAudioCaptureStream::~IAudioCaptureStream ( )
inlinevirtual

Member Function Documentation

◆ AbortStream()

virtual bool Audio::IAudioCaptureStream::AbortStream ( )
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ CloseStream()

virtual bool Audio::IAudioCaptureStream::CloseStream ( )
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ GetCaptureDeviceInfo()

virtual bool Audio::IAudioCaptureStream::GetCaptureDeviceInfo ( FCaptureDeviceInfo &  OutInfo,
int32  DeviceIndex 
)
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ GetIfHardwareFeatureIsSupported()

virtual bool Audio::IAudioCaptureStream::GetIfHardwareFeatureIsSupported ( EHardwareInputFeature  FeatureType)
inlinevirtual

◆ GetInputDevicesAvailable()

virtual bool Audio::IAudioCaptureStream::GetInputDevicesAvailable ( TArray< FCaptureDeviceInfo > &  OutDevices)
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ GetSampleRate()

virtual int32 Audio::IAudioCaptureStream::GetSampleRate ( ) const
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ GetStreamTime()

virtual bool Audio::IAudioCaptureStream::GetStreamTime ( double &  OutStreamTime)
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ IsCapturing()

virtual bool Audio::IAudioCaptureStream::IsCapturing ( ) const
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ IsStreamOpen()

virtual bool Audio::IAudioCaptureStream::IsStreamOpen ( ) const
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ OnAudioCapture()

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

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ OpenAudioCaptureStream()

virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool Audio::IAudioCaptureStream::OpenAudioCaptureStream ( const FAudioCaptureDeviceParams &  InParams,
FOnAudioCaptureFunction  InOnCapture,
uint32  NumFramesDesired 
)
pure virtual

Implemented in Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, Audio::FAudioCaptureWasapiStream, and Audio::FNullAudioCaptureDevice.

◆ OpenCaptureStream()

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool Audio::IAudioCaptureStream::OpenCaptureStream ( const FAudioCaptureDeviceParams &  InParams,
FOnCaptureFunction  InOnCapture,
uint32  NumFramesDesired 
)
inlinevirtual

◆ RegisterUser()

virtual bool Audio::IAudioCaptureStream::RegisterUser ( const TCHAR *  UserId)
inlinevirtual

◆ SetHardwareFeatureEnabled()

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

Reimplemented in Audio::FAudioCaptureAudioUnitStream.

◆ StartStream()

virtual bool Audio::IAudioCaptureStream::StartStream ( )
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ StopStream()

virtual bool Audio::IAudioCaptureStream::StopStream ( )
pure virtual

Implemented in Audio::FNullAudioCaptureDevice, Audio::FAudioCaptureAndroidStream, Audio::FAudioCaptureRtAudioStream, Audio::FAudioCaptureAudioUnitStream, and Audio::FAudioCaptureWasapiStream.

◆ UnregisterUser()

virtual bool Audio::IAudioCaptureStream::UnregisterUser ( const TCHAR *  UserId)
inlinevirtual
The documentation for this class was generated from the following file: