Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > VivoxVoiceChat > FVivoxVoiceChat

Light Theme

Dark Theme

FVivoxVoiceChat

Windows

MacOS

Linux

Inheritance Hierarchy

FSelfRegisteringExec

IVoiceChat

DebugClientApiEventHandler

FVivoxVoiceChat

References

Module	VivoxVoiceChat
Header	/Engine/Plugins/Online/VoiceChat/VivoxVoiceChat/Source/Public/VivoxVoiceChat.h
Include	#include "VivoxVoiceChat.h"

Syntax

class FVivoxVoiceChat :
    public FSelfRegisteringExec,
    public IVoiceChat,
    protected DebugClientApiEventHandler

Variables

	Name	Description
EVoiceChatAtten...	AttenuationModel
bool	bInitialized
EConnectionStat...	ConnectionState
friend	FVivoxVoiceChatUser
LogLevel	LastLogLevel
FString	LastLogMessage	Log spam avoidance.
int	LogSpamCount
int	MaxDistance
int	MinDistance
TArray< FOnVoic...	OnVoiceChatConnectCompleteDelegates	Completion delegates.
FOnVoiceChatCon...	OnVoiceChatConnectedDelegate	Delegates.
TArray< FOnVoic...	OnVoiceChatDisconnectCompleteDelegates
FOnVoiceChatDis...	OnVoiceChatDisconnectedDelegate
FOnVoiceChatRec...	OnVoiceChatReconnectedDelegate
float	Rolloff
TUniquePtr< FVi...	SingleUserVoiceChatUser
VivoxClientApi:...	VivoxClientConnection
FString	VivoxDomain
FString	VivoxInsecureSecret
FString	VivoxIssuer
FString	VivoxNamespace
FString	VivoxServerUrl	Settings.
TArray< FVivoxV...	VoiceChatUsers
FCriticalSectio...	VoiceChatUsersCriticalSection

Constructors

	Name	Description
	FVivoxVoiceChat()

Destructors

	Name	Description
	~FVivoxVoiceChat()

Functions

	Name	Description
void	BlockPlayers ( const TArray< FString >& PlayerNam... )
void	Connect ( const FOnVoiceChatConnectCompleteDe... )
VivoxClientA...	CreateAccountName ( const FString& PlayerName )
VivoxClientA...	CreateChannelUri ( const FString& ChannelName, EVoiceChatChannelType ChannelType, TOptional< FVoiceChatChannel3dPrope... )
IVoiceChatUs...	CreateUser()
VivoxClientA...	CreateUserUri ( const FString& PlayerName )
void	Disconnect ( const FOnVoiceChatDisconnectComplet... )
void	DispatchAll ( const TFn& Fn, TArgs&&... Args )
void	DispatchUsingAccountName ( const TFn& Fn, const VivoxClientApi::AccountName&..., TArgs&&... Args )
bool	GetAudioInputDeviceMuted()
float	GetAudioInputVolume()
bool	GetAudioOutputDeviceMuted()
float	GetAudioOutputVolume()
TArray< FStr...	GetAvailableInputDevices()
TArray< FStr...	GetAvailableOutputDevices()
FString	GetChannelNameFromUri ( const VivoxClientApi::Uri& Channel... )
TArray< FStr...	GetChannels()
EVoiceChatCh...	GetChannelType ( const FString& ChannelName )
EVoiceChatCh...	GetChannelTypeFromUri ( const VivoxClientApi::Uri& Channel... )
FString	GetDefaultInputDevice()
FString	GetDefaultOutputDevice()
FString	GetInputDevice()
FString	GetLoggedInPlayerName()
FString	GetOutputDevice()
FString	GetPlayerNameFromAccountName ( const VivoxClientApi::AccountName&... )
FString	GetPlayerNameFromUri ( const VivoxClientApi::Uri& UserUri )
TArray< FStr...	GetPlayersInChannel ( const FString& ChannelName )
float	GetPlayerVolume ( const FString& PlayerName )
FString	GetSetting ( const FString& Name )
FString	GetTransmitChannel()
EVoiceChatTr...	GetTransmitMode()
FVivoxVoiceC...	GetVoiceChatUser()
FVivoxVoiceC...	GetVoiceChatUser()
bool	Initialize()
FString	InsecureGetJoinToken ( const FString& ChannelName, EVoiceChatChannelType ChannelType, TOptional< FVoiceChatChannel3dPrope... )
FString	InsecureGetLoginToken ( const FString& PlayerName )
void	InvokeOnUIThread ( void)(voidArg0), void Arg0 )
bool	IsConnected()
bool	IsConnecting()
bool	IsInitialized()
bool	IsLoggedIn()
bool	IsLoggingIn()
bool	IsPlayerMuted ( const FString& PlayerName )
bool	IsPlayerTalking ( const FString& PlayerName )
void	JoinChannel ( const FString& ChannelName, const FString& ChannelCredentials, EVoiceChatChannelType ChannelType, const FOnVoiceChatChannelJoinComple..., TOptional< FVoiceChatChannel3dPrope... )
void	LeaveChannel ( const FString& Channel, const FOnVoiceChatChannelLeaveCompl... )
void	Login ( FPlatformUserId PlatformId, const FString& PlayerName, const FString& Credentials, const FOnVoiceChatLoginCompleteDele... )
void	Logout ( const FOnVoiceChatLogoutCompleteDel... )
void	onAudioUnitAfterCaptureAudioRead ( const char* SessionGroupHandle, const VivoxClientApi::Uri& Initial..., short* PcmFrames, int PcmFrameCount, int AudioFrameRate, int ChannelsPerFrame )
void	onAudioUnitBeforeCaptureAudioSent ( const char* SessionGroupHandle, const VivoxClientApi::Uri& Initial..., short* PcmFrames, int PcmFrameCount, int AudioFrameRate, int ChannelsPerFrame, bool bSpeaking )
void	onAudioUnitBeforeRecvAudioRendered ( const char* SessionGroupHandle, const VivoxClientApi::Uri& Initial..., short* PcmFrames, int PcmFrameCount, int AudioFrameRate, int ChannelsPerFrame, bool bSilence )
void	onAudioUnitStarted ( const char* SessionGroupHandle, const VivoxClientApi::Uri& Initial... )
void	onAudioUnitStopped ( const char* SessionGroupHandle, const VivoxClientApi::Uri& Initial... )
void	onAvailableAudioDevicesChanged()
void	onCallStatsUpdated ( const VivoxClientApi::AccountName&..., vx_call_stats_t& Stats, bool bIsFinal )
void	onChannelExited ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::VCSStatus& R... )
void	onChannelJoined ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel... )
void	onChannelJoinFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::VCSStatus& S... )
void	onConnectCompleted ( const VivoxClientApi::Uri& Server )
void	onConnectFailed ( const VivoxClientApi::Uri& Server, const VivoxClientApi::VCSStatus& S... )
void	onDisconnected ( const VivoxClientApi::Uri& Server, const VivoxClientApi::VCSStatus& S... )
void	onInvalidChannelCredentials ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel... )
void	onInvalidLoginCredentials ( const VivoxClientApi::AccountName&... )
void	onLoginCompleted ( const VivoxClientApi::AccountName&... )
void	onLoginFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::VCSStatus& S... )
void	onLogoutCompleted ( const VivoxClientApi::AccountName&... )
void	onLogoutFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::VCSStatus& S... )
void	onLogStatementEmitted ( LogLevel Level, long long NativeMillisecondsSinceEp..., long ThreadId, const char* LogMessage )
void	onOperatingSystemChosenAudioInputDeviceChanged ( const VivoxClientApi::AudioDeviceId... )
void	onOperatingSystemChosenAudioOutputDeviceChanged ( const VivoxClientApi::AudioDeviceId... )
void	onParticipantAdded ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::Uri& Partici..., bool bIsLoggedInUser )
void	onParticipantLeft ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::Uri& Partici..., bool bIsLoggedInUser, ParticipantLeftReason Reason )
void	onParticipantUpdated ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::Uri& Partici..., bool bIsLoggedInUser, bool bSpeaking, double MeterEnergy, bool bMutedForAll )
void	onSessionGroupCreated ( const VivoxClientApi::AccountName&..., const char* SessionGroupHandle )
void	onSetApplicationChosenAudioInputDeviceCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::AudioDeviceId... )
void	onSetApplicationChosenAudioInputDeviceFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::AudioDeviceId..., const VivoxClientApi::VCSStatus& S... )
void	onSetApplicationChosenAudioOutputDeviceCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::AudioDeviceId... )
void	onSetApplicationChosenAudioOutputDeviceFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::AudioDeviceId..., const VivoxClientApi::VCSStatus& S... )
void	onSetChannelAudioOutputDeviceVolumeCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., int Volume )
void	onSetChannelAudioOutputDeviceVolumeFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., int Volume, const VivoxClientApi::VCSStatus& S... )
void	onSetChannelTransmissionToAllCompleted ( const VivoxClientApi::AccountName&... )
void	onSetChannelTransmissionToAllFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::VCSStatus& S... )
void	onSetChannelTransmissionToNoneCompleted ( const VivoxClientApi::AccountName&... )
void	onSetChannelTransmissionToNoneFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::VCSStatus& S... )
void	onSetChannelTransmissionToSpecificChannelCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel... )
void	onSetChannelTransmissionToSpecificChannelFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Channel..., const VivoxClientApi::VCSStatus& S... )
void	onSetParticipantAudioOutputDeviceVolumeForMeCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& TargetU..., const VivoxClientApi::Uri& Channel..., int Volume )
void	onSetParticipantAudioOutputDeviceVolumeForMeFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& TargetU..., const VivoxClientApi::Uri& Channel..., int Volume, const VivoxClientApi::VCSStatus& S... )
void	onSetParticipantMutedForMeCompleted ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Target, const VivoxClientApi::Uri& Channel..., bool bMuted )
void	onSetParticipantMutedForMeFailed ( const VivoxClientApi::AccountName&..., const VivoxClientApi::Uri& Target, const VivoxClientApi::Uri& Channel..., bool bMuted, const VivoxClientApi::VCSStatus& S... )
FOnVoiceChat...	OnVoiceChatAvailableAudioDevicesChanged()
FOnVoiceChat...	OnVoiceChatCallStatsUpdated()
FOnVoiceChat...	OnVoiceChatChannelExited()
FOnVoiceChat...	OnVoiceChatChannelJoined()
FOnVoiceChat...	OnVoiceChatConnected()
FOnVoiceChat...	OnVoiceChatDisconnected()
FOnVoiceChat...	OnVoiceChatLoggedIn()
FOnVoiceChat...	OnVoiceChatLoggedOut()
FOnVoiceChat...	OnVoiceChatPlayerAdded()
FOnVoiceChat...	OnVoiceChatPlayerMuteUpdated()
FOnVoiceChat...	OnVoiceChatPlayerRemoved()
FOnVoiceChat...	OnVoiceChatPlayerTalkingUpdated()
FOnVoiceChat...	OnVoiceChatPlayerVolumeUpdated()
FOnVoiceChat...	OnVoiceChatReconnected()
FDelegateHan...	RegisterOnVoiceChatAfterCaptureAudioReadDelegate ( const FOnVoiceChatAfterCaptureAudio... )
FDelegateHan...	RegisterOnVoiceChatBeforeCaptureAudioSentDelegate ( const FOnVoiceChatBeforeCaptureAudi... )
FDelegateHan...	RegisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( const FOnVoiceChatBeforeRecvAudioRe... )
void	RegisterVoiceChatUser ( FVivoxVoiceChatUser* User )
void	Set3DPosition ( const FString& ChannelName, const FVector& SpeakerPosition, const FVector& ListenerPosition, const FVector& ListenerForwardDire..., const FVector& ListenerUpDirection )
void	SetAudioInputDeviceMuted ( bool bIsMuted )
void	SetAudioInputVolume ( float Volume )
void	SetAudioOutputDeviceMuted ( bool bIsMuted )
void	SetAudioOutputVolume ( float Volume )
void	SetInputDevice ( const FString& InputDevice )
void	SetOutputDevice ( const FString& OutputDevice )
void	SetPlayerMuted ( const FString& PlayerName, bool bMuted )
void	SetPlayerVolume ( const FString& PlayerName, float Volume )
void	SetSetting ( const FString& Name, const FString& Value )	IVoiceChatUser.
void	SetVivoxSdkConfigHints ( vx_sdk_config_t& Hints )
FDelegateHan...	StartRecording ( const FOnVoiceChatRecordSamplesAvai... )
void	StopRecording ( FDelegateHandle Handle )
FString	ToString ( EConnectionState State )
void	TransmitToAllChannels()
void	TransmitToNoChannels()
void	TransmitToSpecificChannel ( const FString& ChannelName )
void	UnblockPlayers ( const TArray< FString >& PlayerNam... )
bool	Uninitialize()
void	UnregisterOnVoiceChatAfterCaptureAudioReadDelegate ( FDelegateHandle Handle )
void	UnregisterOnVoiceChatBeforeCaptureAudioSentDelegate ( FDelegateHandle Handle )
void	UnregisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( FDelegateHandle Handle )
void	UnregisterVoiceChatUser ( FVivoxVoiceChatUser* User )

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Enums

	Name	Description
	EConnectionState

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss