IAudioCaptureStream

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModularFeature

IAudioCaptureStream

References

Module

AudioCaptureCore

Header

/Engine/Source/Runtime/AudioCaptureCore/Public/AudioCaptureDeviceInterface.h

Include

#include "AudioCaptureDeviceInterface.h"

Syntax

class IAudioCaptureStream : public IModularFeature

Constructors

Name Description

Public function

IAudioCaptureStream()

Destructors

Name Description

Public function Virtual

~IAudioCaptureStream()

Functions

Name Description

Public function

bool

 

AbortStream()

Abort the audio capture stream (stop and close)

Public function

bool

 

CloseStream()

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

 

GetIfHardwareFeatureIsSupported

(
    EHardwareInputFeature FeatureType
)

Public function

bool

 

GetInputDevicesAvailable

(
    TArray< FCaptureDeviceInfo >& OutD...
)

Returns the total amount of audio devices.

Public function Const

int32

 

GetSampleRate()

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

 

IsCapturing()

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

Public function Const

bool

 

IsStreamOpen()

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

 

OpenCaptureStream

(
    const FAudioCaptureDeviceParams& I...,
    FOnCaptureFunction InOnCapture,
    uint32 NumFramesDesired
)

Opens the audio capture stream with the given parameters.

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

 

StartStream()

Start the audio capture stream.

Public function

bool

 

StopStream()

Stop the audio capture stream.

Public function Virtual

bool

 

UnregisterUser

(
    const TCHAR* UserId
)

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