1. Epic GamesDeveloper
  3. IAudioCaptureStream

IAudioCaptureStream

API > API/Runtime > API/Runtime/AudioCaptureCore

   
Name IAudioCaptureStream
Type class
Header File /Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureDeviceInterface.h
Include Path #include "AudioCaptureDeviceInterface.h"

Syntax

class IAudioCaptureStream : public IModularFeature

Constructors

Name Remarks Include Path Unreal Specifiers

IAudioCaptureStream()

   AudioCaptureDeviceInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAudioCaptureStream()

   AudioCaptureDeviceInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AbortStream()

 Abort the audio capture stream (stop and close) AudioCaptureDeviceInterface.h  

bool CloseStream()

 Closes the audio capture stream. AudioCaptureDeviceInterface.h  

bool GetCaptureDeviceInfo ( FCaptureDeviceInfo& OutInfo,
int32 DeviceIndex
)

 Returns the audio capture device information at the given Id. AudioCaptureDeviceInterface.h  

virtual bool GetIfHardwareFeatureIsSupported ( EHardwareInputFeature FeatureType
)

   AudioCaptureDeviceInterface.h  

bool GetInputDevicesAvailable ( TArray< FCaptureDeviceInfo >& OutDevices
)

 Returns the total amount of audio devices. AudioCaptureDeviceInterface.h  

int32 GetSampleRate()

 Get the sample rate in use by the stream. AudioCaptureDeviceInterface.h  

bool GetStreamTime ( double& OutStreamTime
)

 Get the stream time of the audio capture stream. AudioCaptureDeviceInterface.h  

bool IsCapturing()

 Returns true if the audio capture stream is currently capturing audio. AudioCaptureDeviceInterface.h  

bool IsStreamOpen()

 Returns if the audio capture stream has been opened. AudioCaptureDeviceInterface.h  

void OnAudioCapture ( void* InBuffer,
uint32 InBufferFrames,
double StreamTime,
bool bOverflow
)

 This is the callback for querying audio from the input device. AudioCaptureDeviceInterface.h  

bool OpenAudioCaptureStream ( const FAudioCaptureDeviceParams& InParams,
FOnAudioCaptureFunction InOnCapture,
uint32 NumFramesDesired
)

 Opens the audio capture stream with the given parameters and using FOnAudioCaptureFunction for callbacks. AudioCaptureDeviceInterface.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool OpenCaptureStream ( const FAudioCaptureDeviceParams& InParams,
FOnCaptureFunction InOnCapture,
uint32 NumFramesDesired
)

 Opens the audio capture stream with the given parameters. AudioCaptureDeviceInterface.h  

virtual bool RegisterUser ( const TCHAR* UserId
)

 Lets us know which users are in the system. AudioCaptureDeviceInterface.h  

virtual void SetHardwareFeatureEnabled ( EHardwareInputFeature FeatureType,
bool bEnabled
)

   AudioCaptureDeviceInterface.h  

bool StartStream()

 Start the audio capture stream. AudioCaptureDeviceInterface.h  

bool StopStream()

 Stop the audio capture stream. AudioCaptureDeviceInterface.h  

virtual bool UnregisterUser ( const TCHAR* UserId
)

 Call this to remove a user that was added with RegisterUser. AudioCaptureDeviceInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page