| IOnlineVoice
|
Module |
|
Header |
/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoiceInterfaceImpl.h |
Include |
#include "VoiceInterfaceImpl.h" |
class FOnlineVoiceImpl : public IOnlineVoice
The generic implementation of the voice interface
Name | Description | ||
---|---|---|---|
|
IdentityInt |
Reference to the profile interface |
|
|
LocalTalkers |
State of all possible local talkers |
|
|
MaxLocalTalkers |
Maximum permitted local talkers |
|
|
MaxRemoteTalkers |
Maximum permitted remote talkers |
|
|
MuteList |
All remote players locally muted (super set of SystemMuteList) |
|
|
OnlineSubsystem |
Reference to the main online subsystem |
|
|
RemoteTalkers |
State of all possible remote talkers |
|
|
IOnlineSession ... |
SessionInt |
Reference to the sessions interface |
|
SystemMuteList |
Remote players locally muted explicitly |
|
|
VoiceData |
Buffered voice data I/O |
|
|
VoiceEngine |
Reference to the voice engine for acquiring voice data |
|
|
float |
VoiceNotificationDelta |
Time to wait for new data before triggering "not talking" |
Name | Description | |
---|---|---|
|
FOnlineVoiceImpl() |
|
|
FOnlineVoiceImpl ( |
Constructor |
Name | Description | |
---|---|---|
|
~FOnlineVoiceImpl() |
Virtual destructor to force proper child cleanup |
Name | Description | ||
---|---|---|---|
|
FRemoteTalke... |
FindRemoteTalker ( |
Finds a remote talker in the cached list |
|
IsLocallyMuted ( |
Is a given id presently muted (either by system mute or game server) |
|
|
IsSystemWideMuted ( |
Does a given id exist in the system wide mute list |
|
|
ProcessLocalVoicePackets() |
Reads any data that is currently queued |
|
|
ProcessRemoteVoicePackets() |
Submits network packets to audio system for playback |
|
|
ProcessTalkingDelegates ( |
Processes any talking delegates that need to be fired off |
|
|
UpdateMuteListForLocalTalker ( |
Figures out which remote talkers need to be muted for a given local talker |
Name | Description | ||
---|---|---|---|
|
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() |
||
|
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() |
Cleanup voice interface |
|
|
StartNetworkedVoice ( |
||
|
StopNetworkedVoice ( |
Tells the voice layer to stop processing networked voice support for the specified player. |
|
|
Tick ( |
Allows for platform specific servicing of devices, etc. |
|
|
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 |