| IOnlineVoice
|
Module |
|
Header |
/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/VoiceInterface.h |
Include |
#include "Interfaces/VoiceInterface.h" |
class IOnlineVoice
This interface is an abstract mechanism for managing voice data. Each platform implements a specific version of this interface.
Name | Description | ||
---|---|---|---|
|
OnPlayerTalkingStateChangedDelegates |
Delegate called when a player is talking either remotely or locally Called once for each active talker each frame |
Name | Description | |
---|---|---|
|
IOnlineVoice() |
Name | Description | |
---|---|---|
|
~IOnlineVoice() |
Virtual destructor to force proper child cleanup |
Name | Description | ||
---|---|---|---|
|
FDelegateHan... |
AddOnPlayerTalkingStateChangedDelegate_Handle ( |
|
|
ClearOnPlayerTalkingStateChangedDelegate_Handle ( |
||
|
ClearOnPlayerTalkingStateChangedDelegates ( |
||
|
ClearVoicePackets() |
Clears all voice packets currently queued for send |
|
|
IVoiceEngine... |
CreateVoiceEngine() |
|
|
DisconnectAllEndpoints() |
When called, disconnects all additional audio endpoints we patched to using PatchRemoteTalkerOutputToEndpoint(). |
|
|
float |
GetAmplitudeOfRemoteTalker ( |
This returns the current amplitude of a given player's incoming audio. |
|
TSharedPtr< ... |
GetLocalPacket ( |
Get the local voice packet intended for send |
|
Audio::FPatc... |
GetMicrophoneOutput() |
This can be used to get arbitrarily tap outgoing microphone audio from local players to use elsewhere in your application. |
|
GetNumLocalTalkers() |
||
|
Audio::FPatc... |
GetRemoteTalkerOutput() |
This can be used to get arbitrarily tap incoming VOIP audio from remote players to use elsewhere in your application. |
|
GetVoiceDebugState() |
Get information about the voice state for display |
|
|
Init() |
Initialize the voice interface |
|
|
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 |
|
|
IsMuted ( |
Checks that a unique player id is on the specified user's mute list |
|
|
IsRemotePlayerTalking ( |
Determines whether a remote talker is currently talking or not |
|
|
MuteRemoteTalker ( |
Mutes a remote talker for the specified local player. |
|
|
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. |
|
|
ProcessMuteChangeNotification() |
Re-evaluates the muting list for all local talkers |
|
|
RegisterLocalTalker ( |
Registers the user index as a local talker (interested in voice data) |
|
|
RegisterLocalTalkers() |
Registers all signed in local talkers |
|
|
RegisterRemoteTalker ( |
Registers the unique player id as a remote talker (submitted voice data only) |
|
|
RemoveAllRemoteTalkers() |
Iterates the current remote talker list unregistering them with the voice engine and our internal state |
|
|
TSharedPtr< ... |
SerializeRemotePacket ( |
Convert generic network packet data back into voice data |
|
Shutdown() |
||
|
StartNetworkedVoice ( |
Tells the voice layer that networked processing of the voice data is allowed for the specified player. |
|
|
StopNetworkedVoice ( |
Tells the voice layer to stop processing networked voice support for the specified player. |
|
|
Tick ( |
Allows for platform specific servicing of devices, etc. |
|
|
TriggerOnPlayerTalkingStateChangedDelegates ( |
||
|
UnmuteRemoteTalker ( |
Allows a remote talker to talk to the specified local player. |
|
|
UnregisterLocalTalker ( |
Unregisters the user index as a local talker (not interested in voice data) |
|
|
UnregisterLocalTalkers() |
Unregisters all signed in local talkers |
|
|
UnregisterRemoteTalker ( |
Unregisters the unique player id as a remote talker |