Navigation
Unreal Engine C++ API Reference > Runtime > Voice > Interfaces
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
| Type | Name | Description | |
|---|---|---|---|
 |
Audio::FPatchSplitter | MicrophoneOutput | Optional patch point for MicrophoneOutput. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | ChangeDevice
(
const FString& DeviceName, |
Change the associated capture device |
  |
void | DumpState () |
Dump the state of the voice capture device |
  |
int32 | ||
  |
EVoiceCaptureState::Type | GetCaptureState
(
uint32& OutAvailableVoiceData |
Return the state of the voice data and its availability |
   |
float | ||
 |
Audio::FPatchOutputStrongPtr | GetMicrophoneAudio
(
int32 MaxExpectedLatencyInSamples, |
|
  |
EVoiceCaptureState::Type | GetVoiceData
(
uint8* OutVoiceBuffer, |
Fill a buffer with all available voice data |
  |
EVoiceCaptureState::Type | GetVoiceData
(
uint8* OutVoiceBuffer, |
|
 |
bool | Initialize the voice capture object | |
 |
bool | IsCapturing () |
Is the voice capture object actively capturing |
 |
void | Shutdown () |
Shutdown the voice capture object |
 |
bool | Start () |
Start capturing voice |
 |
void | Stop () |
Stop capturing voice |