IVoiceCapture

Interface for capturing voice data on any platform

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

IVoiceCapture

References

Module

Voice

Header

/Engine/Source/Runtime/Online/Voice/Public/Interfaces/VoiceCapture.h

Include

#include "Interfaces/VoiceCapture.h"

Syntax

class IVoiceCapture : public TSharedFromThis< IVoiceCapture >

Remarks

Interface for capturing voice data on any platform

Variables

Name Description

Protected variable

Audio::FPatchSp...

 

MicrophoneOutput

Optional patch point for MicrophoneOutput.

Constructors

Name Description

Protected function

IVoiceCapture()

Destructors

Name Description

Public function Virtual

~IVoiceCapture()

Functions

Name Description

Public function

bool

 

ChangeDevice

(
    const FString& DeviceName,
    int32 SampleRate,
    int32 NumChannels
)

Change the associated capture device

Public function Const

void

 

DumpState()

Dump the state of the voice capture device

Public function Const

int32

 

GetBufferSize()

Public function Const

EVoiceCaptur...

 

GetCaptureState

(
    uint32& OutAvailableVoiceData
)

Return the state of the voice data and its availability

Public function Virtual Const

float

 

GetCurrentAmplitude()

Public function

Audio::FPatc...

 

GetMicrophoneAudio

(
    int32 MaxExpectedLatencyInSamples,
    float Gain
)

Public function Virtual

EVoiceCaptur...

 

GetVoiceData

(
    uint8* OutVoiceBuffer,
    uint32 InVoiceBufferSize,
    uint32& OutAvailableVoiceData
)

Fill a buffer with all available voice data

Public function Virtual

EVoiceCaptur...

 

GetVoiceData

(
    uint8* OutVoiceBuffer,
    uint32 InVoiceBufferSize,
    uint32& OutAvailableVoiceData,
    uint64& OutSampleCounter
)

Public function

bool

 

Init

(
    const FString& DeviceName,
    int32 SampleRate,
    int32 NumChannels
)

Initialize the voice capture object

Public function

bool

 

IsCapturing()

Is the voice capture object actively capturing

Public function

void

 

Shutdown()

Shutdown the voice capture object

Public function

bool

 

Start()

Start capturing voice

Public function

void

 

Stop()

Stop capturing voice

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss