Navigation
API > API/Runtime > API/Runtime/Voice
Logging related to general voice chat flow (muting/registration/etc) Logging related to encoding of local voice packets Logging related to decoding of remote voice packets Internal voice capture logging Module for Voice capture/compression/decompression implementations
| Name | FVoiceModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/Voice/Public/VoiceModule.h |
| Include Path | #include "VoiceModule.h" |
Syntax
class FVoiceModule : public IModuleInterface
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnabled | bool | Is voice interface enabled | VoiceModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< IVoiceCapture > CreateVoiceCapture
(
const FString& DeviceName, |
Instantiates a new voice capture object | VoiceModule.h | |
virtual TSharedPtr< IVoiceDecoder > CreateVoiceDecoder
(
int32 SampleRate, |
Instantiates a new voice decoder object | VoiceModule.h | |
virtual TSharedPtr< IVoiceEncoder > CreateVoiceEncoder
(
int32 SampleRate, |
Instantiates a new voice encoder object | VoiceModule.h | |
virtual bool DoesPlatformSupportVoiceCapture() |
Checks to see if the current platform supports voice capture. | VoiceModule.h | |
bool IsVoiceEnabled() |
VoiceModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FVoiceModule & Get () |
Singleton-like access to this module's interface. | VoiceModule.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | VoiceModule.h |