Navigation
API > API/Plugins > API/Plugins/OnlineSubsystemUtils
The generic implementation of the voice interface
| Name | FOnlineVoiceImpl |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoiceInterfaceImpl.h |
| Include Path | #include "VoiceInterfaceImpl.h" |
Syntax
class FOnlineVoiceImpl : public IOnlineVoice
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| VoiceInterfaceImpl.h | |||
FOnlineVoiceImpl
(
IOnlineSubsystem* InOnlineSubsystem |
Constructor | VoiceInterfaceImpl.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineVoiceImpl() |
Virtual destructor to force proper child cleanup | VoiceInterfaceImpl.h |
Functions
Public
Overridden from IOnlineVoice
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearVoicePackets() |
VoiceInterfaceImpl.h | ||
virtual void DisconnectAllEndpoints() |
VoiceInterfaceImpl.h | ||
virtual float GetAmplitudeOfRemoteTalker
(
const FUniqueNetId& PlayerId |
VoiceInterfaceImpl.h | ||
virtual TSharedPtr< class FVoicePacket > GetLocalPacket
(
uint32 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual Audio::FPatchOutputStrongPtr GetMicrophoneOutput() |
VoiceInterfaceImpl.h | ||
virtual int32 GetNumLocalTalkers() |
VoiceInterfaceImpl.h | ||
virtual Audio::FPatchOutputStrongPtr GetRemoteTalkerOutput() |
VoiceInterfaceImpl.h | ||
virtual FString GetVoiceDebugState() |
VoiceInterfaceImpl.h | ||
virtual bool IsHeadsetPresent
(
uint32 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual bool IsLocalPlayerTalking
(
uint32 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual bool IsMuted
(
uint32 LocalUserNum, |
VoiceInterfaceImpl.h | ||
virtual bool IsRemotePlayerTalking
(
const FUniqueNetId& UniqueId |
VoiceInterfaceImpl.h | ||
virtual bool MuteRemoteTalker
(
uint8 LocalUserNum, |
VoiceInterfaceImpl.h | ||
virtual bool PatchLocalTalkerOutputToEndpoint
(
const FString& InDeviceName |
VoiceInterfaceImpl.h | ||
virtual bool PatchRemoteTalkerOutputToEndpoint
(
const FString& InDeviceName, |
VoiceInterfaceImpl.h | ||
virtual bool RegisterLocalTalker
(
uint32 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual void RegisterLocalTalkers() |
VoiceInterfaceImpl.h | ||
virtual bool RegisterRemoteTalker
(
const FUniqueNetId& UniqueId |
VoiceInterfaceImpl.h | ||
virtual void RemoveAllRemoteTalkers() |
VoiceInterfaceImpl.h | ||
virtual TSharedPtr< class FVoicePacket > SerializeRemotePacket
(
FArchive& Ar |
VoiceInterfaceImpl.h | ||
virtual void StartNetworkedVoice
(
uint8 LocalUserNum |
IOnlineVoice. | VoiceInterfaceImpl.h | |
virtual void StopNetworkedVoice
(
uint8 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual void Tick
(
float DeltaTime |
VoiceInterfaceImpl.h | ||
virtual bool UnmuteRemoteTalker
(
uint8 LocalUserNum, |
VoiceInterfaceImpl.h | ||
virtual bool UnregisterLocalTalker
(
uint32 LocalUserNum |
VoiceInterfaceImpl.h | ||
virtual void UnregisterLocalTalkers() |
VoiceInterfaceImpl.h | ||
virtual bool UnregisterRemoteTalker
(
const FUniqueNetId& UniqueId |
VoiceInterfaceImpl.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FRemoteTalker * FindRemoteTalker
(
const FUniqueNetId& UniqueId |
Finds a remote talker in the cached list | VoiceInterfaceImpl.h | |
virtual bool IsLocallyMuted
(
const FUniqueNetId& UniqueId |
Is a given id presently muted (either by system mute or game server) | VoiceInterfaceImpl.h | |
virtual bool IsSystemWideMuted
(
const FUniqueNetId& UniqueId |
Does a given id exist in the system wide mute list | VoiceInterfaceImpl.h | |
virtual void ProcessLocalVoicePackets() |
Reads any data that is currently queued | VoiceInterfaceImpl.h | |
virtual void ProcessRemoteVoicePackets() |
Submits network packets to audio system for playback | VoiceInterfaceImpl.h | |
virtual void ProcessTalkingDelegates
(
float DeltaTime |
Processes any talking delegates that need to be fired off | VoiceInterfaceImpl.h | |
virtual void UpdateMuteListForLocalTalker
(
int32 TalkerIndex |
Figures out which remote talkers need to be muted for a given local talker | VoiceInterfaceImpl.h |
Overridden from IOnlineVoice
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual IVoiceEnginePtr CreateVoiceEngine() |
VoiceInterfaceImpl.h | ||
virtual bool Init() |
IOnlineVoice. | VoiceInterfaceImpl.h | |
virtual void ProcessMuteChangeNotification() |
VoiceInterfaceImpl.h | ||
virtual void Shutdown() |
Cleanup voice interface | VoiceInterfaceImpl.h |