FVoiceModule

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Voice

Header

/Engine/Source/Runtime/Online/Voice/Public/VoiceModule.h

Include

#include "VoiceModule.h"

Syntax

class FVoiceModule :
    public IModuleInterface,
    public FSelfRegisteringExec

Remarks

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

Functions

Name Description

Public function Virtual

TSharedPtr< ...

 

CreateVoiceCapture

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

Instantiates a new voice capture object

Public function Virtual

TSharedPtr< ...

 

CreateVoiceDecoder

(
    int32 SampleRate,
    int32 NumChannels
)

Instantiates a new voice decoder object

Public function Virtual

TSharedPtr< ...

 

CreateVoiceEncoder

(
    int32 SampleRate,
    int32 NumChannels,
    EAudioEncodeHint EncodeHint
)

Instantiates a new voice encoder object

Public function Virtual

bool

 

DoesPlatformSupportVoiceCapture()

Checks to see if the current platform supports voice capture.

Public function Static

FVoiceModule...

 

Get()

Singleton-like access to this module's interface.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function Const

bool

 

IsVoiceEnabled()

Overridden from FExec

Name Description

Public function Virtual

bool

 

Exec

(
    UWorld* InWorld,
    const TCHAR* Cmd,
    FOutputDevice& Ar
)

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