Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystemUtils > FVoiceEngineImpl

Light Theme

Dark Theme

FVoiceEngineImpl

Generic implementation of voice engine, using Voice module for capture/codec

Windows

MacOS

Linux

Inheritance Hierarchy

IVoiceEngine

FSelfRegisteringExec

IDeviceChangedListener

FVoiceEngineImpl

References

Module	OnlineSubsystemUtils
Header	/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoiceEngineImpl.h
Include	#include "VoiceEngineImpl.h"

Syntax

class FVoiceEngineImpl :
    public IVoiceEngine,
    public FSelfRegisteringExec,
    public IDeviceChangedListener

Remarks

Generic implementation of voice engine, using Voice module for capture/codec

Constructors

	Name	Description
	FVoiceEngineImpl()	Constructor
	FVoiceEngineImpl ( IOnlineSubsystem* InSubsystem )

Destructors

	Name	Description
	~FVoiceEngineImpl()

Functions

	Name	Description
void	CreateSerializeHelper()
TArray< uint...	GetCompressedVoiceBuffer()
TArray< uint...	GetDecompressedVoiceBuffer()
FLocalVoiceD...	GetLocalPlayerVoiceData()
int32	GetMaxVoiceRemainderSize()
IOnlineSubsy...	GetOnlineSubSystem()
FRemoteTalke...	GetRemoteTalkerBuffers()
const TShare...	GetVoiceCapture()
TSharedPtr< ...	GetVoiceCapture()
TSharedPtr< ...	GetVoiceEncoder()
const TShare...	GetVoiceEncoder()
void	GetVoiceSettingsOverride ( const FUniqueNetIdWrapper& RemoteT..., FVoiceSettings& VoiceSettings )
bool	IsOwningUser ( uint32 UserIndex )	Get Audio Device Changes on Windows.
bool	IsRecording()
void	StartRecording()	Start capturing voice data
void	StoppedRecording()	Called when "last half second" is over
void	StopRecording()	Stop capturing voice data

Overridden from IVoiceEngine

	Name	Description
void	DisconnectAllEndpoints()	When called, disconnects all additional audio endpoints we patched to using PatchVoiceOutputToDevice().
float	GetIncomingAudioAmplitude ( const FUniqueNetIdWrapper& RemoteU... )	This can be used to get how loud the given microphone input is, typically on a scale between 0.0 and 1.0.
float	GetMicrophoneAmplitude ( int32 LocalUserNum )	This can be used to get how loud the given microphone input is, typically on a scale between 0.0 and 1.0.
Audio::FPatc...	GetMicrophoneOutput()	This can be used to get arbitrarily tap outgoing microphone audio from local players to use elsewhere in your application.
Audio::FPatc...	GetRemoteTalkerOutput()	This can be used to get arbitrarily tap incoming VOIP audio from remote players to use elsewhere in your application.
uint32	GetVoiceDataReadyFlags()	Returns which local talkers have data ready to be read from the voice system
FString	GetVoiceDebugState()	Get information about the voice state for display
bool	Init ( int32 MaxLocalTalkers, int32 MaxRemoteTalkers )	IVoiceEngine.
bool	IsHeadsetPresent ( uint32 LocalUserNum )	Checks whether a local user index has a headset present or not
bool	IsLocalPlayerTalking ( uint32 LocalUserNum )	Determines whether a local user index is currently talking or not
bool	IsRemotePlayerTalking ( const FUniqueNetId& UniqueId )	Determines whether a remote talker is currently talking or not
bool	PatchLocalTalkerOutputToEndpoint ( const FString& InDeviceName )	This can be used to patch outgoing audio to a different audio device.
bool	PatchRemoteTalkerOutputToEndpoint ( const FString& InDeviceName, bool bMuteInGameOutput )	This can be used to patch incoming audio to a different audio device.
uint32	ReadLocalVoiceData ( uint32 LocalUserNum, uint8* Data, uint32* Size, uint64* OutSampleCount )
uint32	ReadLocalVoiceData ( uint32 LocalUserNum, uint8* Data, uint32* Size )	Reads local voice data for the specified local talker.
uint32	RegisterLocalTalker ( uint32 LocalUserNum )	Registers the user index as a local talker (interested in voice data)
uint32	RegisterRemoteTalker ( const FUniqueNetId& UniqueId )	Registers the unique player id as a remote talker (submitted voice data only)
uint32	SetPlaybackPriority ( uint32 LocalUserNum, const FUniqueNetId& RemoteTalkerId, uint32 Priority )	Sets the playback priority of a remote talker for the given user.
uint32	SetRemoteVoiceAmplitude ( const FUniqueNetIdWrapper& RemoteT..., float InAmplitude )	Used when receiving remote voice data to set the amplitude of a remote talker's incoming audio.
uint32	StartLocalVoiceProcessing ( uint32 LocalUserNum )	IVoiceEngine.
uint32	StartRemoteVoiceProcessing ( const FUniqueNetId& UniqueId )	Starts remote voice processing for the specified user
uint32	StopLocalVoiceProcessing ( uint32 LocalUserNum )	Stops local voice processing for the specified user index
uint32	StopRemoteVoiceProcessing ( const FUniqueNetId& UniqueId )	Stops remote voice processing for the specified user
uint32	SubmitRemoteVoiceData ( const FUniqueNetId& RemoteTalkerId, uint8* Data, uint32* Size )	Submits remote voice data for playback by the voice system.
uint32	SubmitRemoteVoiceData ( const FUniqueNetIdWrapper& RemoteT..., uint8* Data, uint32* Size, uint64& InSampleCount )
void	Tick ( float DeltaTime )	Allows for platform specific servicing of devices, etc.
uint32	UnregisterLocalTalker ( uint32 LocalUserNum )	Unregisters the user index as a local talker (not interested in voice data)
uint32	UnregisterRemoteTalker ( const FUniqueNetId& UniqueId )	Unregisters the unique player id as a remote talker

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	FSelfRegisteringExec.

Overridden from IDeviceChangedListener

		Name	Description
	void	OnDefaultDeviceChanged()	Get Audio Device Changes on Windows.
	void	OnDeviceRemoved ( FString DeviceID )

Typedefs

Name	Description
FRemoteTalkerData	Mapping of UniqueIds to the incoming voice data and their audio component

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

Take our survey

Dismiss