1. Epic GamesDeveloper
  3. IAudioCaptureStream

IAudioCaptureStream

API > API/Runtime > API/Runtime/AudioCaptureCore

Inheritance Hierarchy

References

   
Module AudioCaptureCore
Header /Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureDeviceInterface.h
Include #include "AudioCaptureDeviceInterface.h"

Syntax

class IAudioCaptureStream : public IModularFeature

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool Abort the audio capture stream (stop and close)
Public function bool Closes the audio capture stream.
Public function bool

GetCaptureDeviceInfo ( FCaptureDeviceInfo& OutInfo,
int32 DeviceIndex
)

 Returns the audio capture device information at the given Id.
Public function Virtual bool  
Public function bool Returns the total amount of audio devices.
Public function Const int32 Get the sample rate in use by the stream.
Public function bool

GetStreamTime ( double& OutStreamTime
)

 Get the stream time of the audio capture stream.
Public function Const bool Returns true if the audio capture stream is currently capturing audio.
Public function Const bool Returns if the audio capture stream has been opened.
Public function void

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

 This is the callback for querying audio from the input device.
Public function bool

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

 Opens the audio capture stream with the given parameters and using FOnAudioCaptureFunction for callbacks.
Public function Virtual bool

RegisterUser ( const TCHAR* UserId
)

 Lets us know which users are in the system.
Public function Virtual void

SetHardwareFeatureEnabled ( EHardwareInputFeature FeatureType,
bool bEnabled
)

  
Public function bool Start the audio capture stream.
Public function bool Stop the audio capture stream.
Public function Virtual bool

UnregisterUser ( const TCHAR* UserId
)

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

Deprecated Functions

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool

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

 OpenCaptureStream is deprecated, please use OpenAudioCaptureStream instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page