1. Epic GamesDeveloper
  3. IVoiceEngine

IVoiceEngine

This interface is an abstract mechanism for acquiring voice data from a hardware source.

API > API/Plugins > API/Plugins/OnlineSubsystem

This interface is an abstract mechanism for acquiring voice data from a hardware source. Each platform implements a specific version of this interface.

   
Name IVoiceEngine
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/VoiceInterface.h
Include Path #include "Interfaces/VoiceInterface.h"

Syntax

class IVoiceEngine

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

IVoiceEngine()

   Interfaces/VoiceInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IVoiceEngine()

 Virtual destructor to force proper child cleanup Interfaces/VoiceInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void DisconnectAllEndpoints()

 When called, disconnects all additional audio endpoints we patched to using PatchVoiceOutputToDevice(). Interfaces/VoiceInterface.h  

virtual float GetIncomingAudioAmplitude ( const FUniqueNetIdWrapper& RemoteUserId
)

 This can be used to get how loud the given microphone input is, typically on a scale between 0.0 and 1.0. Interfaces/VoiceInterface.h  

virtual 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. Interfaces/VoiceInterface.h  

virtual Audio::FPatchOutputStrongPtr GetMicrophoneOutput ()

 This can be used to get arbitrarily tap outgoing microphone audio from local players to use elsewhere in your application. Interfaces/VoiceInterface.h  

virtual Audio::FPatchOutputStrongPtr GetRemoteTalkerOutput ()

 This can be used to get arbitrarily tap incoming VOIP audio from remote players to use elsewhere in your application. Interfaces/VoiceInterface.h  

uint32 GetVoiceDataReadyFlags()

 Returns which local talkers have data ready to be read from the voice system Interfaces/VoiceInterface.h  

FString GetVoiceDebugState()

 Get information about the voice state for display Interfaces/VoiceInterface.h  

bool IsHeadsetPresent ( uint32 LocalUserNum
)

 Checks whether a local user index has a headset present or not Interfaces/VoiceInterface.h  

bool IsLocalPlayerTalking ( uint32 LocalUserNum
)

 Determines whether a local user index is currently talking or not Interfaces/VoiceInterface.h  

bool IsRemotePlayerTalking ( const FUniqueNetId& UniqueId
)

 Determines whether a remote talker is currently talking or not Interfaces/VoiceInterface.h  

virtual bool PatchLocalTalkerOutputToEndpoint ( const FString& InDeviceName
)

 This can be used to patch outgoing audio to a different audio device. Interfaces/VoiceInterface.h  

virtual bool PatchRemoteTalkerOutputToEndpoint ( const FString& InDeviceName,
bool bMuteInGameOutput
)

 This can be used to patch incoming audio to a different audio device. Interfaces/VoiceInterface.h  

uint32 ReadLocalVoiceData ( uint32 LocalUserNum,
uint8* Data,
uint32* Size
)

 Reads local voice data for the specified local talker. Interfaces/VoiceInterface.h  

virtual uint32 ReadLocalVoiceData ( uint32 LocalUserNum,
uint8* Data,
uint32* Size,
uint64* OutSampleCount
)

   Interfaces/VoiceInterface.h  

uint32 RegisterLocalTalker ( uint32 LocalUserNum
)

 Registers the user index as a local talker (interested in voice data) Interfaces/VoiceInterface.h  

uint32 RegisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Registers the unique player id as a remote talker (submitted voice data only) Interfaces/VoiceInterface.h  

uint32 SetPlaybackPriority ( uint32 LocalUserNum,
const FUniqueNetId& RemoteTalkerId,
uint32 Priority
)

 Sets the playback priority of a remote talker for the given user. Interfaces/VoiceInterface.h  

virtual uint32 SetRemoteVoiceAmplitude ( const FUniqueNetIdWrapper& RemoteTalkerId,
float InAmplitude
)

 Used when receiving remote voice data to set the amplitude of a remote talker's incoming audio. Interfaces/VoiceInterface.h  

uint32 StartLocalVoiceProcessing ( uint32 LocalUserNum
)

 Starts local voice processing for the specified user index Interfaces/VoiceInterface.h  

uint32 StartRemoteVoiceProcessing ( const FUniqueNetId& UniqueId
)

 Starts remote voice processing for the specified user Interfaces/VoiceInterface.h  

uint32 StopLocalVoiceProcessing ( uint32 LocalUserNum
)

 Stops local voice processing for the specified user index Interfaces/VoiceInterface.h  

uint32 StopRemoteVoiceProcessing ( const FUniqueNetId& UniqueId
)

 Stops remote voice processing for the specified user Interfaces/VoiceInterface.h  

uint32 SubmitRemoteVoiceData ( const FUniqueNetId& RemoteTalkerId,
uint8* Data,
uint32* Size
)

 Submits remote voice data for playback by the voice system. Interfaces/VoiceInterface.h  

virtual uint32 SubmitRemoteVoiceData ( const FUniqueNetIdWrapper& RemoteTalkerId,
uint8* Data,
uint32* Size,
uint64& InSampleCount
)

   Interfaces/VoiceInterface.h  

void Tick ( float DeltaTime
)

 Allows for platform specific servicing of devices, etc. Interfaces/VoiceInterface.h  

uint32 UnregisterLocalTalker ( uint32 LocalUserNum
)

 Unregisters the user index as a local talker (not interested in voice data) Interfaces/VoiceInterface.h  

uint32 UnregisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Unregisters the unique player id as a remote talker Interfaces/VoiceInterface.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool Init ( int32 MaxLocalTalkers,
int32 MaxRemoteTalkers
)

 Initialize the voice engine Interfaces/VoiceInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page