Navigation
API > API/Runtime > API/Runtime/Voice
Interface for capturing voice data on any platform
| Name | IVoiceCapture |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/Voice/Public/Interfaces/VoiceCapture.h |
| Include Path | #include "Interfaces/VoiceCapture.h" |
Syntax
class IVoiceCapture : public TSharedFromThis< IVoiceCapture >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IVoiceCapture
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IVoiceCapture() |
Interfaces/VoiceCapture.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IVoiceCapture() |
Interfaces/VoiceCapture.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ChangeDevice
(
const FString& DeviceName, |
Change the associated capture device | Interfaces/VoiceCapture.h | |
void DumpState() |
Dump the state of the voice capture device | Interfaces/VoiceCapture.h | |
int32 GetBufferSize() |
Interfaces/VoiceCapture.h | ||
EVoiceCaptureState::Type GetCaptureState
(
uint32& OutAvailableVoiceData |
Return the state of the voice data and its availability | Interfaces/VoiceCapture.h | |
virtual float GetCurrentAmplitude() |
Interfaces/VoiceCapture.h | ||
Audio::FPatchOutputStrongPtr GetMicrophoneAudio
(
int32 MaxExpectedLatencyInSamples, |
Interfaces/VoiceCapture.h | ||
virtual EVoiceCaptureState::Type GetVoiceData
(
uint8* OutVoiceBuffer, |
Fill a buffer with all available voice data | Interfaces/VoiceCapture.h | |
virtual EVoiceCaptureState::Type GetVoiceData
(
uint8* OutVoiceBuffer, |
Interfaces/VoiceCapture.h | ||
bool Init
(
const FString& DeviceName, |
Initialize the voice capture object | Interfaces/VoiceCapture.h | |
bool IsCapturing() |
Is the voice capture object actively capturing | Interfaces/VoiceCapture.h | |
void Shutdown() |
Shutdown the voice capture object | Interfaces/VoiceCapture.h | |
bool Start() |
Start capturing voice | Interfaces/VoiceCapture.h | |
void Stop() |
Stop capturing voice | Interfaces/VoiceCapture.h |