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

Protected variable

EVoiceChatAtten...

 

AttenuationModel

Protected variable

bool

 

bInitialized

Protected variable

EConnectionStat ...

 

ConnectionState

Protected variable

friend

 

FVivoxVoiceChatUser

Protected variable

LogLevel

 

LastLogLevel

Protected variable

FString

 

LastLogMessage

Log spam avoidance.

Protected variable

int

 

LogSpamCount

Protected variable

int

 

MaxDistance

Protected variable

int

 

MinDistance

Protected variable

TArray < FOnVoic...

 

OnVoiceChatConnectCompleteDelegates

Completion delegates.

Protected variable

FOnVoiceChatCon...

 

OnVoiceChatConnectedDelegate

Delegates.

Protected variable

TArray < FOnVoic...

 

OnVoiceChatDisconnectCompleteDelegates

Protected variable

FOnVoiceChatDis...

 

OnVoiceChatDisconnectedDelegate

Protected variable

FOnVoiceChatRec...

 

OnVoiceChatReconnectedDelegate

Protected variable

float

 

Rolloff

Protected variable

TUniquePtr < FVi ...

 

SingleUserVoiceChatUser

Protected variable

VivoxClientApi:...

 

VivoxClientConnection

Protected variable

FString

 

VivoxDomain

Protected variable

FString

 

VivoxInsecureSecret

Protected variable

FString

 

VivoxIssuer

Protected variable

FString

 

VivoxNamespace

Protected variable

FString

 

VivoxServerUrl

Settings.

Protected variable

TArray < FVivoxV ...

 

VoiceChatUsers

Protected variable

FCriticalSectio ...

 

VoiceChatUsersCriticalSection

Constructors

Name Description

Public function

FVivoxVoiceChat()

Destructors

Name Description

Public function Virtual

~FVivoxVoiceChat()

Functions

Name Description

Public function Virtual

void

 

BlockPlayers

(
    const TArray < FString >& PlayerNam...
)

Public function Virtual

void

 

Connect

(
    const FOnVoiceChatConnectCompleteDe...
)

Protected function

VivoxClientA...

 

CreateAccountName

(
    const FString & PlayerName
)

Protected function

VivoxClientA...

 

CreateChannelUri

(
    const FString & ChannelName,
    EVoiceChatChannelType ChannelType,
    TOptional < FVoiceChatChannel3dPrope...
)

Public function Virtual

IVoiceChatUs...

 

CreateUser()

Protected function

VivoxClientA...

 

CreateUserUri

(
    const FString & PlayerName
)

Public function Virtual

void

 

Disconnect

(
    const FOnVoiceChatDisconnectComplet...
)

Protected function

void

 

DispatchAll

(
    const TFn& Fn,
    TArgs&&... Args
)

Protected function

void

 

DispatchUsingAccountName

(
    const TFn& Fn,
    const VivoxClientApi::AccountName&...,
    TArgs&&... Args
)

Public function Virtual Const

bool

 

GetAudioInputDeviceMuted()

Public function Virtual Const

float

 

GetAudioInputVolume()

Public function Virtual Const

bool

 

GetAudioOutputDeviceMuted()

Public function Virtual Const

float

 

GetAudioOutputVolume()

Public function Virtual Const

TArray < FStr ...

 

GetAvailableInputDevices()

Public function Virtual Const

TArray < FStr ...

 

GetAvailableOutputDevices()

Protected function

FString

 

GetChannelNameFromUri

(
    const VivoxClientApi::Uri& Channel...
)

Public function Virtual Const

TArray < FStr ...

 

GetChannels()

Public function Virtual Const

EVoiceChatCh...

 

GetChannelType

(
    const FString & ChannelName
)

Protected function

EVoiceChatCh...

 

GetChannelTypeFromUri

(
    const VivoxClientApi::Uri& Channel...
)

Public function Virtual Const

FString

 

GetDefaultInputDevice()

Public function Virtual Const

FString

 

GetDefaultOutputDevice()

Public function Virtual Const

FString

 

GetInputDevice()

Public function Virtual Const

FString

 

GetLoggedInPlayerName()

Public function Virtual Const

FString

 

GetOutputDevice()

Protected function

FString

 

GetPlayerNameFromAccountName

(
    const VivoxClientApi::AccountName&...
)

Protected function

FString

 

GetPlayerNameFromUri

(
    const VivoxClientApi::Uri& UserUri
)

Public function Virtual Const

TArray < FStr ...

 

GetPlayersInChannel

(
    const FString & ChannelName
)

Public function Virtual Const

float

 

GetPlayerVolume

(
    const FString & PlayerName
)

Public function Virtual

FString

 

GetSetting

(
    const FString & Name
)

Public function Virtual Const

FString

 

GetTransmitChannel()

Public function Virtual Const

EVoiceChatTr...

 

GetTransmitMode()

Protected function

FVivoxVoiceC ...

 

GetVoiceChatUser()

Protected function Const

FVivoxVoiceC ...

 

GetVoiceChatUser()

Public function Virtual

bool

 

Initialize()

Public function Virtual

FString

 

InsecureGetJoinToken

(
    const FString & ChannelName,
    EVoiceChatChannelType ChannelType,
    TOptional < FVoiceChatChannel3dPrope...
)

Public function Virtual

FString

 

InsecureGetLoginToken

(
    const FString & PlayerName
)

Protected function Virtual

void

 

InvokeOnUIThread

(
    void )(void *Arg0),
    void * Arg0
)

Public function Virtual Const

bool

 

IsConnected()

Public function Virtual Const

bool

 

IsConnecting()

Public function Virtual Const

bool

 

IsInitialized()

Public function Virtual Const

bool

 

IsLoggedIn()

Public function Virtual Const

bool

 

IsLoggingIn()

Public function Virtual Const

bool

 

IsPlayerMuted

(
    const FString & PlayerName
)

Public function Virtual Const

bool

 

IsPlayerTalking

(
    const FString & PlayerName
)

Public function Virtual

void

 

JoinChannel

(
    const FString & ChannelName,
    const FString & ChannelCredentials,
    EVoiceChatChannelType ChannelType,
    const FOnVoiceChatChannelJoinComple...,
    TOptional < FVoiceChatChannel3dPrope...
)

Public function Virtual

void

 

LeaveChannel

(
    const FString & Channel,
    const FOnVoiceChatChannelLeaveCompl...
)

Public function Virtual

void

 

Login

(
    FPlatformUserId PlatformId,
    const FString & PlayerName,
    const FString & Credentials,
    const FOnVoiceChatLoginCompleteDele...
)

Public function Virtual

void

 

Logout

(
    const FOnVoiceChatLogoutCompleteDel...
)

Protected function Virtual

void

 

onAudioUnitAfterCaptureAudioRead

(
    const char* SessionGroupHandle,
    const VivoxClientApi::Uri& Initial...,
    short* PcmFrames,
    int PcmFrameCount,
    int AudioFrameRate,
    int ChannelsPerFrame
)

Protected function Virtual

void

 

onAudioUnitBeforeCaptureAudioSent

(
    const char* SessionGroupHandle,
    const VivoxClientApi::Uri& Initial...,
    short* PcmFrames,
    int PcmFrameCount,
    int AudioFrameRate,
    int ChannelsPerFrame,
    bool bSpeaking
)

Protected function Virtual

void

 

onAudioUnitBeforeRecvAudioRendered

(
    const char* SessionGroupHandle,
    const VivoxClientApi::Uri& Initial...,
    short* PcmFrames,
    int PcmFrameCount,
    int AudioFrameRate,
    int ChannelsPerFrame,
    bool bSilence
)

Protected function Virtual

void

 

onAudioUnitStarted

(
    const char* SessionGroupHandle,
    const VivoxClientApi::Uri& Initial...
)

Protected function Virtual

void

 

onAudioUnitStopped

(
    const char* SessionGroupHandle,
    const VivoxClientApi::Uri& Initial...
)

Protected function Virtual

void

 

onAvailableAudioDevicesChanged()

Protected function Virtual

void

 

onCallStatsUpdated

(
    const VivoxClientApi::AccountName&...,
    vx_call_stats_t& Stats,
    bool bIsFinal
)

Protected function Virtual

void

 

onChannelExited

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::VCSStatus& R...
)

Protected function Virtual

void

 

onChannelJoined

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...
)

Protected function Virtual

void

 

onChannelJoinFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onConnectCompleted

(
    const VivoxClientApi::Uri& Server
)

Protected function Virtual

void

 

onConnectFailed

(
    const VivoxClientApi::Uri& Server,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onDisconnected

(
    const VivoxClientApi::Uri& Server,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onInvalidChannelCredentials

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...
)

Protected function Virtual

void

 

onInvalidLoginCredentials

(
    const VivoxClientApi::AccountName&...
)

Protected function Virtual

void

 

onLoginCompleted

(
    const VivoxClientApi::AccountName&...
)

Protected function Virtual

void

 

onLoginFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onLogoutCompleted

(
    const VivoxClientApi::AccountName&...
)

Protected function Virtual

void

 

onLogoutFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onLogStatementEmitted

(
    LogLevel Level,
    long long NativeMillisecondsSinceEp...,
    long ThreadId,
    const char* LogMessage
)

Protected function Virtual

void

 

onOperatingSystemChosenAudioInputDeviceChanged

(
    const VivoxClientApi::AudioDeviceId...
)

Protected function Virtual

void

 

onOperatingSystemChosenAudioOutputDeviceChanged

(
    const VivoxClientApi::AudioDeviceId...
)

Protected function Virtual

void

 

onParticipantAdded

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::Uri& Partici...,
    bool bIsLoggedInUser
)

Protected function Virtual

void

 

onParticipantLeft

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::Uri& Partici...,
    bool bIsLoggedInUser,
    ParticipantLeftReason Reason
)

Protected function Virtual

void

 

onParticipantUpdated

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::Uri& Partici...,
    bool bIsLoggedInUser,
    bool bSpeaking,
    double MeterEnergy,
    bool bMutedForAll
)

Protected function Virtual

void

 

onSessionGroupCreated

(
    const VivoxClientApi::AccountName&...,
    const char* SessionGroupHandle
)

Protected function Virtual

void

 

onSetApplicationChosenAudioInputDeviceCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::AudioDeviceId...
)

Protected function Virtual

void

 

onSetApplicationChosenAudioInputDeviceFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::AudioDeviceId...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetApplicationChosenAudioOutputDeviceCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::AudioDeviceId...
)

Protected function Virtual

void

 

onSetApplicationChosenAudioOutputDeviceFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::AudioDeviceId...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetChannelAudioOutputDeviceVolumeCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    int Volume
)

Protected function Virtual

void

 

onSetChannelAudioOutputDeviceVolumeFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    int Volume,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetChannelTransmissionToAllCompleted

(
    const VivoxClientApi::AccountName&...
)

Protected function Virtual

void

 

onSetChannelTransmissionToAllFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetChannelTransmissionToNoneCompleted

(
    const VivoxClientApi::AccountName&...
)

Protected function Virtual

void

 

onSetChannelTransmissionToNoneFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetChannelTransmissionToSpecificChannelCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...
)

Protected function Virtual

void

 

onSetChannelTransmissionToSpecificChannelFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Channel...,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetParticipantAudioOutputDeviceVolumeForMeCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& TargetU...,
    const VivoxClientApi::Uri& Channel...,
    int Volume
)

Protected function Virtual

void

 

onSetParticipantAudioOutputDeviceVolumeForMeFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& TargetU...,
    const VivoxClientApi::Uri& Channel...,
    int Volume,
    const VivoxClientApi::VCSStatus& S...
)

Protected function Virtual

void

 

onSetParticipantMutedForMeCompleted

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Target,
    const VivoxClientApi::Uri& Channel...,
    bool bMuted
)

Protected function Virtual

void

 

onSetParticipantMutedForMeFailed

(
    const VivoxClientApi::AccountName&...,
    const VivoxClientApi::Uri& Target,
    const VivoxClientApi::Uri& Channel...,
    bool bMuted,
    const VivoxClientApi::VCSStatus& S...
)

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatAvailableAudioDevicesChanged()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatCallStatsUpdated()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatChannelExited()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatChannelJoined()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatConnected()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatDisconnected()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatLoggedIn()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatLoggedOut()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatPlayerAdded()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatPlayerMuteUpdated()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatPlayerRemoved()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatPlayerTalkingUpdated()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatPlayerVolumeUpdated()

Public function Virtual

FOnVoiceChat...

 

OnVoiceChatReconnected()

Public function Virtual

FDelegateHan ...

 

RegisterOnVoiceChatAfterCaptureAudioReadDelegate

(
    const FOnVoiceChatAfterCaptureAudio...
)

Public function Virtual

FDelegateHan ...

 

RegisterOnVoiceChatBeforeCaptureAudioSentDelegate

(
    const FOnVoiceChatBeforeCaptureAudi...
)

Public function Virtual

FDelegateHan ...

 

RegisterOnVoiceChatBeforeRecvAudioRenderedDelegate

(
    const FOnVoiceChatBeforeRecvAudioRe...
)

Protected function

void

 

RegisterVoiceChatUser

(
    FVivoxVoiceChatUser * User
)

Public function Virtual

void

 

Set3DPosition

(
    const FString & ChannelName,
    const FVector & SpeakerPosition,
    const FVector & ListenerPosition,
    const FVector & ListenerForwardDire...,
    const FVector & ListenerUpDirection
)

Public function Virtual

void

 

SetAudioInputDeviceMuted

(
    bool bIsMuted
)

Public function Virtual

void

 

SetAudioInputVolume

(
    float Volume
)

Public function Virtual

void

 

SetAudioOutputDeviceMuted

(
    bool bIsMuted
)

Public function Virtual

void

 

SetAudioOutputVolume

(
    float Volume
)

Public function Virtual

void

 

SetInputDevice

(
    const FString & InputDevice
)

Public function Virtual

void

 

SetOutputDevice

(
    const FString & OutputDevice
)

Public function Virtual

void

 

SetPlayerMuted

(
    const FString & PlayerName,
    bool bMuted
)

Public function Virtual

void

 

SetPlayerVolume

(
    const FString & PlayerName,
    float Volume
)

Public function Virtual

void

 

SetSetting

(
    const FString & Name,
    const FString & Value
)

IVoiceChatUser.

Protected function Virtual

void

 

SetVivoxSdkConfigHints

(
    vx_sdk_config_t& Hints
)

Public function Virtual

FDelegateHan ...

 

StartRecording

(
    const FOnVoiceChatRecordSamplesAvai...
)

Public function Virtual

void

 

StopRecording

(
    FDelegateHandle Handle
)

Protected function Static

FString

 

ToString

(
    EConnectionState State
)

Public function Virtual

void

 

TransmitToAllChannels()

Public function Virtual

void

 

TransmitToNoChannels()

Public function Virtual

void

 

TransmitToSpecificChannel

(
    const FString & ChannelName
)

Public function Virtual

void

 

UnblockPlayers

(
    const TArray < FString >& PlayerNam...
)

Public function Virtual

bool

 

Uninitialize()

Public function Virtual

void

 

UnregisterOnVoiceChatAfterCaptureAudioReadDelegate

(
    FDelegateHandle Handle
)

Public function Virtual

void

 

UnregisterOnVoiceChatBeforeCaptureAudioSentDelegate

(
    FDelegateHandle Handle
)

Public function Virtual

void

 

UnregisterOnVoiceChatBeforeRecvAudioRenderedDelegate

(
    FDelegateHandle Handle
)

Protected function

void

 

UnregisterVoiceChatUser

(
    FVivoxVoiceChatUser * User
)

Overridden from FExec

Name Description

Protected function Virtual

bool

 

Exec

(
    UWorld * InWorld,
    const TCHAR * Cmd,
    FOutputDevice & Ar
)

Exec handler

Enums

Name

Description

Protected enum

EConnectionState

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback