1. Epic GamesDeveloper
  3. FVoiceEngineImpl

FVoiceEngineImpl

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

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

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

  Type Name Description
Protected function   Constructor
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void  
Protected function Virtual TArray< uint8 > &  
Protected function Virtual TArray< uint8 > &  
Protected function Virtual FLocalVoiceData *  
Protected function Virtual int32  
Protected function Virtual IOnlineSubsystem *  
Protected function Virtual FRemoteTalkerData &  
Protected function Virtual Const const TSharedPtr< IVoiceCapture > &  
Protected function Virtual TSharedPtr< IVoiceCapture > &  
Protected function Virtual TSharedPtr< IVoiceEncoder > &  
Protected function Virtual Const const TSharedPtr< IVoiceEncoder > &  
Public function Virtual void

GetVoiceSettingsOverride ( const FUniqueNetIdWrapper& RemoteTalkerId,
FVoiceSettings& VoiceSettings
)

  
Protected function Virtual bool

IsOwningUser ( uint32 UserIndex
)

 Determines if the specified index is the owner or not
Protected function Virtual Const bool  
Protected function Virtual Const void Start capturing voice data
Protected function Virtual Const void Called when "last half second" is over
Protected function Virtual Const void Stop capturing voice data

Overridden from IVoiceEngine

  Type Name Description
Public function Virtual void When called, disconnects all additional audio endpoints we patched to using PatchVoiceOutputToDevice().
Public function Virtual float This can be used to get how loud the given microphone input is, typically on a scale between 0.0 and 1.0.
Public function 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.
Public function Virtual Audio::FPatchOutputStrongPtr This can be used to get arbitrarily tap outgoing microphone audio from local players to use elsewhere in your application.
Public function Virtual Audio::FPatchOutputStrongPtr This can be used to get arbitrarily tap incoming VOIP audio from remote players to use elsewhere in your application.
Public function Virtual Const uint32 Returns which local talkers have data ready to be read from the voice system
Public function Virtual Const FString Get information about the voice state for display
Protected function Virtual bool

Init ( int32 MaxLocalTalkers,
int32 MaxRemoteTalkers
)

 IVoiceEngine.
Public function Virtual bool

IsHeadsetPresent ( uint32 LocalUserNum
)

 Checks whether a local user index has a headset present or not
Public function Virtual bool

IsLocalPlayerTalking ( uint32 LocalUserNum
)

 Determines whether a local user index is currently talking or not
Public function Virtual bool

IsRemotePlayerTalking ( const FUniqueNetId& UniqueId
)

 Determines whether a remote talker is currently talking or not
Public function Virtual bool

PatchLocalTalkerOutputToEndpoint ( const FString& InDeviceName
)

 This can be used to patch outgoing audio to a different audio device.
Public function Virtual bool

PatchRemoteTalkerOutputToEndpoint ( const FString& InDeviceName,
bool bMuteInGameOutput
)

 This can be used to patch incoming audio to a different audio device.
Public function Virtual uint32

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

  
Public function Virtual uint32

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

 Reads local voice data for the specified local talker.
Public function Virtual uint32

RegisterLocalTalker ( uint32 LocalUserNum
)

 Registers the user index as a local talker (interested in voice data)
Public function Virtual uint32

RegisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Registers the unique player id as a remote talker (submitted voice data only)
Public function Virtual uint32

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

 Sets the playback priority of a remote talker for the given user.
Public function 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.
Public function Virtual uint32

StartLocalVoiceProcessing ( uint32 LocalUserNum
)

 IVoiceEngine.
Public function Virtual uint32 Starts remote voice processing for the specified user
Public function Virtual uint32

StopLocalVoiceProcessing ( uint32 LocalUserNum
)

 Stops local voice processing for the specified user index
Public function Virtual uint32 Stops remote voice processing for the specified user
Public function Virtual uint32

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

 Submits remote voice data for playback by the voice system.
Public function Virtual uint32

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

  
Public function Virtual void

Tick ( float DeltaTime
)

 Allows for platform specific servicing of devices, etc.
Public function Virtual uint32

UnregisterLocalTalker ( uint32 LocalUserNum
)

 Unregisters the user index as a local talker (not interested in voice data)
Public function Virtual uint32

UnregisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Unregisters the unique player id as a remote talker

Overridden from FExec

  Type Name Description
Protected function Virtual bool

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

 FSelfRegisteringExec.

Overridden from IDeviceChangedListener

  Type Name Description
Protected function Virtual void  
Protected function Virtual void

OnDeviceRemoved ( FString DeviceID
)

  

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page