FVoiceModule Class Reference

#include <VoiceModule.h>

Inheritance diagram for FVoiceModule:

Public Member Functions
virtual TSharedPtr< IVoiceCapture >	CreateVoiceCapture (const FString &DeviceName, int32 SampleRate=UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels=UVOIPStatics::GetVoiceNumChannels())
virtual TSharedPtr< IVoiceEncoder >	CreateVoiceEncoder (int32 SampleRate=UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels=UVOIPStatics::GetVoiceNumChannels(), EAudioEncodeHint EncodeHint=UVOIPStatics::GetAudioEncodingHint())
virtual TSharedPtr< IVoiceDecoder >	CreateVoiceDecoder (int32 SampleRate=UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels=UVOIPStatics::GetVoiceNumChannels())
virtual bool	DoesPlatformSupportVoiceCapture ()
bool	IsVoiceEnabled () const
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Static Public Member Functions
static FVoiceModule &	Get ()
static bool	IsAvailable ()

Detailed Description

Module for Voice capture/compression/decompression implementations

Member Function Documentation

CreateVoiceCapture()

TSharedPtr< IVoiceCapture > FVoiceModule::CreateVoiceCapture ( const FString &  DeviceName, int32  SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32  NumChannels = UVOIPStatics::GetVoiceNumChannels()  )

virtual

Instantiates a new voice capture object

Parameters

DeviceName	name of device to capture audio data with, empty for default device
SampleRate	sampling rate of voice capture
NumChannels	number of channels to capture

Returns

new voice capture object, possibly NULL

CreateVoiceDecoder()

TSharedPtr< IVoiceDecoder > FVoiceModule::CreateVoiceDecoder ( int32  SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32  NumChannels = UVOIPStatics::GetVoiceNumChannels()  )

virtual

Instantiates a new voice decoder object

Parameters

SampleRate	sampling rate of voice capture
NumChannels	number of channels to capture

Returns

new voice decoder object, possibly NULL

CreateVoiceEncoder()

TSharedPtr< IVoiceEncoder > FVoiceModule::CreateVoiceEncoder ( int32  SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32  NumChannels = UVOIPStatics::GetVoiceNumChannels(), EAudioEncodeHint  EncodeHint = UVOIPStatics::GetAudioEncodingHint()  )

virtual

Instantiates a new voice encoder object

Parameters

SampleRate	sampling rate of voice capture
NumChannels	number of channels to capture
EncodeHint	hint to describe type of audio quality desired

Returns

new voice encoder object, possibly NULL

DoesPlatformSupportVoiceCapture()

bool FVoiceModule::DoesPlatformSupportVoiceCapture ( )

virtual

Checks to see if the current platform supports voice capture.

Returns

True if the current platform support voice capture

Get()

static FVoiceModule & FVoiceModule::Get ( )

inlinestatic

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns

Returns singleton instance, loading the module on demand if needed

IsAvailable()

static bool FVoiceModule::IsAvailable ( )

inlinestatic

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns

True if the module is loaded and ready to use

IsVoiceEnabled()

bool FVoiceModule::IsVoiceEnabled ( ) const

inline

Returns

true if voice is enabled

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Online/Voice/Public/VoiceModule.h
• Engine/Source/Runtime/Online/Voice/Private/VoiceModule.cpp