1. Epic GamesDeveloper
  3. FOnlineVoiceImpl

FOnlineVoiceImpl

The generic implementation of the voice interface

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

   
Module OnlineSubsystemUtils
Header /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoiceInterfaceImpl.h
Include #include "VoiceInterfaceImpl.h"

Syntax

class FOnlineVoiceImpl : public IOnlineVoice

Remarks

The generic implementation of the voice interface

Variables

  Type Name Description
Protected variable IOnlineIdentity * IdentityInt Reference to the profile interface
Protected variable TArray< FLocalTalker > LocalTalkers State of all possible local talkers
Protected variable int32 MaxLocalTalkers Maximum permitted local talkers
Protected variable int32 MaxRemoteTalkers Maximum permitted remote talkers
Protected variable TArray< FUniqueNetIdWrapper > MuteList All remote players locally muted (super set of SystemMuteList)
Protected variable IOnlineSubsystem * OnlineSubsystem Reference to the main online subsystem
Protected variable TArray< FRemoteTalker > RemoteTalkers State of all possible remote talkers
Protected variable IOnlineSession * SessionInt Reference to the sessions interface
Protected variable TArray< FUniqueNetIdWrapper > SystemMuteList Remote players locally muted explicitly
Protected variable FVoiceDataImpl VoiceData Buffered voice data I/O
Protected variable IVoiceEnginePtr VoiceEngine Reference to the voice engine for acquiring voice data
Protected variable float VoiceNotificationDelta Time to wait for new data before triggering "not talking"

Constructors

  Type Name Description
Protected function    
Public function  

FOnlineVoiceImpl ( IOnlineSubsystem* InOnlineSubsystem
)

 Constructor

Destructors

  Type Name Description
Public function Virtual   Virtual destructor to force proper child cleanup

Functions

  Type Name Description
Protected function Virtual FRemoteTalker *

FindRemoteTalker ( const FUniqueNetId& UniqueId
)

 Finds a remote talker in the cached list
Protected function Virtual Const bool

IsLocallyMuted ( const FUniqueNetId& UniqueId
)

 Is a given id presently muted (either by system mute or game server)
Protected function Virtual Const bool

IsSystemWideMuted ( const FUniqueNetId& UniqueId
)

 Does a given id exist in the system wide mute list
Protected function Virtual void Reads any data that is currently queued
Protected function Virtual void Submits network packets to audio system for playback
Protected function Virtual void

ProcessTalkingDelegates ( float DeltaTime
)

 Processes any talking delegates that need to be fired off
Protected function Virtual void

UpdateMuteListForLocalTalker ( int32 TalkerIndex
)

 Figures out which remote talkers need to be muted for a given local talker

Overridden from IOnlineVoice

  Type Name Description
Public function Virtual void Clears all voice packets currently queued for send
Protected function Virtual IVoiceEnginePtr  
Public function Virtual void When called, disconnects all additional audio endpoints we patched to using PatchRemoteTalkerOutputToEndpoint().
Public function Virtual float This returns the current amplitude of a given player's incoming audio.
Public function Virtual TSharedPtr< class FVoicePacket >

GetLocalPacket ( uint32 LocalUserNum
)

 Get the local voice packet intended for send
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 int32  
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 FString Get information about the voice state for display
Protected function Virtual bool

Init ()

 IOnlineVoice.
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 Const bool

IsMuted ( uint32 LocalUserNum,
const FUniqueNetId& UniqueId
)

 Checks that a unique player id is on the specified user's mute list
Public function Virtual bool

IsRemotePlayerTalking ( const FUniqueNetId& UniqueId
)

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

MuteRemoteTalker ( uint8 LocalUserNum,
const FUniqueNetId& PlayerId,
bool bIsSystemWide
)

 Mutes a remote talker for the specified local player.
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.
Protected function Virtual void Re-evaluates the muting list for all local talkers
Public function Virtual bool

RegisterLocalTalker ( uint32 LocalUserNum
)

 Registers the user index as a local talker (interested in voice data)
Public function Virtual void Registers all signed in local talkers
Public function Virtual bool

RegisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Registers the unique player id as a remote talker (submitted voice data only)
Public function Virtual void Iterates the current remote talker list unregistering them with the voice engine and our internal state
Public function Virtual TSharedPtr< class FVoicePacket > Convert generic network packet data back into voice data
Protected function Virtual void Cleanup voice interface
Public function Virtual void

StartNetworkedVoice ( uint8 LocalUserNum
)

 IOnlineVoice.
Public function Virtual void

StopNetworkedVoice ( uint8 LocalUserNum
)

 Tells the voice layer to stop processing networked voice support for the specified player.
Public function Virtual void

Tick ( float DeltaTime
)

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

UnmuteRemoteTalker ( uint8 LocalUserNum,
const FUniqueNetId& PlayerId,
bool bIsSystemWide
)

 Allows a remote talker to talk to the specified local player.
Public function Virtual bool

UnregisterLocalTalker ( uint32 LocalUserNum
)

 Unregisters the user index as a local talker (not interested in voice data)
Public function Virtual void Unregisters all signed in local talkers
Public function Virtual bool

UnregisterRemoteTalker ( const FUniqueNetId& UniqueId
)

 Unregisters the unique player id as a remote talker

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page