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 > FVivoxVoiceChatUser

Light Theme

Dark Theme

FVivoxVoiceChatUser

Windows

MacOS

Linux

Inheritance Hierarchy

IVoiceChatUser

FVivoxVoiceChatUser

References

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

Syntax

class FVivoxVoiceChatUser : public IVoiceChatUser

Variables

	Name	Description
FCriticalSectio...	AfterCaptureAudioReadLock
AudioOptions	AudioInputOptions
AudioOptions	AudioOutputOptions
FCriticalSectio...	AudioRecordLock	Recording Delegates and Critical sections.
FCriticalSectio...	BeforeCaptureAudioSentLock
FCriticalSectio...	BeforeRecvAudioRenderedLock
bool	bReleased
FLoginSession	LoginSession
FOnVoiceChatAft...	OnVoiceChatAfterCaptureAudioReadDelegate
FOnVoiceChatAva...	OnVoiceChatAvailableAudioDevicesChangedDelegate	Delegates.
FOnVoiceChatBef...	OnVoiceChatBeforeCaptureAudioSentDelegate
FOnVoiceChatBef...	OnVoiceChatBeforeRecvAudioRenderedDelegate
FOnVoiceChatCal...	OnVoiceChatCallStatsUpdatedDelegate
FOnVoiceChatCha...	OnVoiceChatChannelExitedDelegate
FOnVoiceChatCha...	OnVoiceChatChannelJoinedDelegate
FOnVoiceChatLog...	OnVoiceChatLoggedInDelegate
FOnVoiceChatLog...	OnVoiceChatLoggedOutDelegate
FOnVoiceChatLog...	OnVoiceChatLoginCompleteDelegate	Completion delegates.
FOnVoiceChatLog...	OnVoiceChatLogoutCompleteDelegate
FOnVoiceChatPla...	OnVoiceChatPlayerAddedDelegate
FOnVoiceChatPla...	OnVoiceChatPlayerMuteUpdatedDelegate
FOnVoiceChatPla...	OnVoiceChatPlayerRemovedDelegate
FOnVoiceChatPla...	OnVoiceChatPlayerTalkingUpdatedDelegate
FOnVoiceChatPla...	OnVoiceChatPlayerVolumeUpdatedDelegate
FOnVoiceChatRec...	OnVoiceChatRecordSamplesAvailableDelegate
FString	SessionGroup
VivoxClientApi:...	VivoxClientConnection
FVivoxVoiceChat...	VivoxVoiceChat

Constructors

	Name	Description
	FVivoxVoiceChatUser ( FVivoxVoiceChat& InVivoxVoiceChat )

Destructors

	Name	Description
	~FVivoxVoiceChatUser()

Functions

		Name	Description
	void	ApplyAudioInputDevicePolicy()
	void	ApplyAudioInputOptions()
	void	ApplyAudioOutputDevicePolicy()
	void	ApplyAudioOutputOptions()
	void	BlockPlayers ( const TArray< FString >& PlayerNam... )
	void	ClearChannelSessions()
	void	ClearLoginSession()
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )
	bool	GetAudioInputDeviceMuted()
	float	GetAudioInputVolume()
	bool	GetAudioOutputDeviceMuted()
	float	GetAudioOutputVolume()
	TArray< FVoi...	GetAvailableInputDeviceInfos()
	TArray< FVoi...	GetAvailableOutputDeviceInfos()
	TArray< FStr...	GetChannels()
	FChannelSess...	GetChannelSession ( const VivoxClientApi::Uri& Channel... )
	const FChann...	GetChannelSession ( const FString& ChannelName )
	FChannelSess...	GetChannelSession ( const FString& ChannelName )
	EVoiceChatCh...	GetChannelType ( const FString& ChannelName )
	FVoiceChatDe...	GetDefaultInputDeviceInfo()
	FVoiceChatDe...	GetDefaultOutputDeviceInfo()
	FVoiceChatDe...	GetInputDeviceInfo()
	FString	GetLoggedInPlayerName()
	FVoiceChatDe...	GetOutputDeviceInfo()
	const FParti...	GetParticipant ( const FString& PlayerName )
	FParticipant...	GetParticipant ( const FString& PlayerName )
	TArray< FStr...	GetPlayersInChannel ( const FString& ChannelName )
	float	GetPlayerVolume ( const FString& PlayerName )
	FString	GetSetting ( const FString& Name )
	FString	GetTransmitChannel()
	EVoiceChatTr...	GetTransmitMode()
	FString	InsecureGetJoinToken ( const FString& ChannelName, EVoiceChatChannelType ChannelType, TOptional< FVoiceChatChannel3dPrope... )
	FString	InsecureGetLoginToken ( const FString& PlayerName )
	bool	IsConnected()
	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	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, VivoxClientApi::IClientApiEventHand... )
	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...	OnVoiceChatLoggedIn()
	FOnVoiceChat...	OnVoiceChatLoggedOut()
	FOnVoiceChat...	OnVoiceChatPlayerAdded()
	FOnVoiceChat...	OnVoiceChatPlayerMuteUpdated()
	FOnVoiceChat...	OnVoiceChatPlayerRemoved()
	FOnVoiceChat...	OnVoiceChatPlayerTalkingUpdated()
	FOnVoiceChat...	OnVoiceChatPlayerVolumeUpdated()
	FDelegateHan...	RegisterOnVoiceChatAfterCaptureAudioReadDelegate ( const FOnVoiceChatAfterCaptureAudio... )
	FDelegateHan...	RegisterOnVoiceChatBeforeCaptureAudioSentDelegate ( const FOnVoiceChatBeforeCaptureAudi... )
	FDelegateHan...	RegisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( const FOnVoiceChatBeforeRecvAudioRe... )
	void	RemoveChannelSession ( const FString& ChannelName )
	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	SetInputDeviceId ( const FString& InputDevice )
	void	SetOutputDeviceId ( 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 )
	FDelegateHan...	StartRecording ( const FOnVoiceChatRecordSamplesAvai... )
	void	StopRecording ( FDelegateHandle Handle )
	FString	ToString ( FLoginSession::EState State )
	FString	ToString ( FChannelSession::EState State )
	void	TransmitToAllChannels()
	void	TransmitToNoChannels()
	void	TransmitToSpecificChannel ( const FString& ChannelName )
	void	UnblockPlayers ( const TArray< FString >& PlayerNam... )
	void	UnregisterOnVoiceChatAfterCaptureAudioReadDelegate ( FDelegateHandle Handle )
	void	UnregisterOnVoiceChatBeforeCaptureAudioSentDelegate ( FDelegateHandle Handle )
	void	UnregisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( FDelegateHandle Handle )

Classes

	Name	Description
	AudioOptions
	FChannelSession
	FLoginSession
	FParticipant

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

Take our survey

Dismiss