| IVoiceEngine
|
Module |
|
Header |
/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/VoiceInterface.h |
Include |
#include "Interfaces/VoiceInterface.h" |
class IVoiceEngine
This interface is an abstract mechanism for acquiring voice data from a hardware source. Each platform implements a specific version of this interface.
Name | Description | |
---|---|---|
|
IVoiceEngine() |
Name | Description | |
---|---|---|
|
~IVoiceEngine() |
Virtual destructor to force proper child cleanup |
Name | Description | ||
---|---|---|---|
|
DisconnectAllEndpoints() |
When called, disconnects all additional audio endpoints we patched to using PatchVoiceOutputToDevice(). |
|
|
float |
GetIncomingAudioAmplitude ( |
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 ( |
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. |
|
GetVoiceDataReadyFlags() |
Returns which local talkers have data ready to be read from the voice system |
|
|
GetVoiceDebugState() |
Get information about the voice state for display |
|
|
Init |
Initialize the voice engine |
|
|
IsHeadsetPresent ( |
Checks whether a local user index has a headset present or not |
|
|
IsLocalPlayerTalking ( |
Determines whether a local user index is currently talking or not |
|
|
IsRemotePlayerTalking ( |
Determines whether a remote talker is currently talking or not |
|
|
PatchLocalTalkerOutputToEndpoint ( |
This can be used to patch outgoing audio to a different audio device. |
|
|
PatchRemoteTalkerOutputToEndpoint |
This can be used to patch incoming audio to a different audio device. |
|
|
ReadLocalVoiceData |
Reads local voice data for the specified local talker. |
|
|
ReadLocalVoiceData |
||
|
RegisterLocalTalker ( |
Registers the user index as a local talker (interested in voice data) |
|
|
RegisterRemoteTalker ( |
Registers the unique player id as a remote talker (submitted voice data only) |
|
|
SetPlaybackPriority ( |
Sets the playback priority of a remote talker for the given user. |
|
|
SetRemoteVoiceAmplitude ( |
Used when receiving remote voice data to set the amplitude of a remote talker's incoming audio. |
|
|
StartLocalVoiceProcessing ( |
Starts local voice processing for the specified user index |
|
|
StartRemoteVoiceProcessing ( |
Starts remote voice processing for the specified user |
|
|
StopLocalVoiceProcessing ( |
Stops local voice processing for the specified user index |
|
|
StopRemoteVoiceProcessing ( |
Stops remote voice processing for the specified user |
|
|
SubmitRemoteVoiceData ( |
Submits remote voice data for playback by the voice system. |
|
|
SubmitRemoteVoiceData ( |
||
|
Tick ( |
Allows for platform specific servicing of devices, etc. |
|
|
UnregisterLocalTalker ( |
Unregisters the user index as a local talker (not interested in voice data) |
|
|
UnregisterRemoteTalker ( |
Unregisters the unique player id as a remote talker |