IOnlineVoice


Name	IOnlineVoice
Type	class
Header File	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/VoiceInterface.h
Include Path	#include "Interfaces/VoiceInterface.h"

Name	Remarks	Include Path	Unreal Specifiers
IOnlineVoice()		Interfaces/VoiceInterface.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IOnlineVoice()	Virtual destructor to force proper child cleanup	Interfaces/VoiceInterface.h

Name	Type	Remarks	Include Path	Unreal Specifiers
OnPlayerTalkingStateChangedDelegates	FOnPlayerTalkingStateChanged	Delegate called when a player is talking either remotely or locally Called once for each active talker each frame	Interfaces/VoiceInterface.h

Name	Remarks	Include Path
virtual FDelegateHandle AddOnPlayerTalkingStateChangedDelegate_Handle ( const FOnPlayerTalkingStateChangedDelegate& Delegate )		Interfaces/VoiceInterface.h
virtual void ClearOnPlayerTalkingStateChangedDelegate_Handle ( FDelegateHandle& Handle )		Interfaces/VoiceInterface.h
virtual void ClearOnPlayerTalkingStateChangedDelegates ( FDelegateUserObject Object )		Interfaces/VoiceInterface.h
void ClearVoicePackets()	Clears all voice packets currently queued for send	Interfaces/VoiceInterface.h
virtual void DisconnectAllEndpoints()	When called, disconnects all additional audio endpoints we patched to using PatchRemoteTalkerOutputToEndpoint().	Interfaces/VoiceInterface.h
virtual float GetAmplitudeOfRemoteTalker ( const FUniqueNetId& PlayerId )	This returns the current amplitude of a given player's incoming audio.	Interfaces/VoiceInterface.h
TSharedPtr< class FVoicePacket > GetLocalPacket ( uint32 LocalUserNum )	Get the local voice packet intended for send	Interfaces/VoiceInterface.h
virtual Audio::FPatchOutputStrongPtr GetMicrophoneOutput ()	This can be used to get arbitrarily tap outgoing microphone audio from local players to use elsewhere in your application.	Interfaces/VoiceInterface.h
int32 GetNumLocalTalkers()		Interfaces/VoiceInterface.h
virtual Audio::FPatchOutputStrongPtr GetRemoteTalkerOutput ()	This can be used to get arbitrarily tap incoming VOIP audio from remote players to use elsewhere in your application.	Interfaces/VoiceInterface.h
FString GetVoiceDebugState()	Get information about the voice state for display	Interfaces/VoiceInterface.h
virtual bool Init()	Initialize the voice interface	Interfaces/VoiceInterface.h
bool IsHeadsetPresent ( uint32 LocalUserNum )	Checks whether a local user index has a headset present or not	Interfaces/VoiceInterface.h
bool IsLocalPlayerTalking ( uint32 LocalUserNum )	Determines whether a local user index is currently talking or not	Interfaces/VoiceInterface.h
bool IsMuted ( uint32 LocalUserNum, const FUniqueNetId& UniqueId ) const	Checks that a unique player id is on the specified user's mute list	Interfaces/VoiceInterface.h
bool IsRemotePlayerTalking ( const FUniqueNetId& UniqueId )	Determines whether a remote talker is currently talking or not	Interfaces/VoiceInterface.h
bool MuteRemoteTalker ( uint8 LocalUserNum, const FUniqueNetId& PlayerId, bool bIsSystemWide )	Mutes a remote talker for the specified local player.	Interfaces/VoiceInterface.h
virtual bool PatchLocalTalkerOutputToEndpoint ( const FString& InDeviceName )	This can be used to patch outgoing audio to a different audio device.	Interfaces/VoiceInterface.h
virtual bool PatchRemoteTalkerOutputToEndpoint ( const FString& InDeviceName, bool bMuteInGameOutput )	This can be used to patch incoming audio to a different audio device.	Interfaces/VoiceInterface.h
bool RegisterLocalTalker ( uint32 LocalUserNum )	Registers the user index as a local talker (interested in voice data)	Interfaces/VoiceInterface.h
void RegisterLocalTalkers()	Registers all signed in local talkers	Interfaces/VoiceInterface.h
bool RegisterRemoteTalker ( const FUniqueNetId& UniqueId )	Registers the unique player id as a remote talker (submitted voice data only)	Interfaces/VoiceInterface.h
void RemoveAllRemoteTalkers()	Iterates the current remote talker list unregistering them with the voice engine and our internal state	Interfaces/VoiceInterface.h
TSharedPtr< class FVoicePacket > SerializeRemotePacket ( FArchive& Ar )	Convert generic network packet data back into voice data	Interfaces/VoiceInterface.h
virtual void Shutdown()		Interfaces/VoiceInterface.h
void StartNetworkedVoice ( uint8 LocalUserNum )	Tells the voice layer that networked processing of the voice data is allowed for the specified player.	Interfaces/VoiceInterface.h
void StopNetworkedVoice ( uint8 LocalUserNum )	Tells the voice layer to stop processing networked voice support for the specified player.	Interfaces/VoiceInterface.h
void Tick ( float DeltaTime )	Allows for platform specific servicing of devices, etc.	Interfaces/VoiceInterface.h
virtual void TriggerOnPlayerTalkingStateChangedDelegates ( FUniqueNetIdRef Param1, bool Param2 )		Interfaces/VoiceInterface.h
bool UnmuteRemoteTalker ( uint8 LocalUserNum, const FUniqueNetId& PlayerId, bool bIsSystemWide )	Allows a remote talker to talk to the specified local player.	Interfaces/VoiceInterface.h
bool UnregisterLocalTalker ( uint32 LocalUserNum )	Unregisters the user index as a local talker (not interested in voice data)	Interfaces/VoiceInterface.h
void UnregisterLocalTalkers()	Unregisters all signed in local talkers	Interfaces/VoiceInterface.h
bool UnregisterRemoteTalker ( const FUniqueNetId& UniqueId )	Unregisters the unique player id as a remote talker	Interfaces/VoiceInterface.h

Name	Remarks	Include Path	Unreal Specifiers
IVoiceEnginePtr CreateVoiceEngine()		Interfaces/VoiceInterface.h
void ProcessMuteChangeNotification()	Re-evaluates the muting list for all local talkers	Interfaces/VoiceInterface.h

Navigation

Syntax

Derived Classes

Constructors

Destructors

Variables

Public

Functions

Public

Protected