IVoiceChat

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

VivoxVoiceChat

Header

/Engine/Plugins/Online/VoiceChat/VivoxVoiceChat/Source/Public/VoiceChat.h

Include

#include "VoiceChat.h"

Syntax

class IVoiceChat : public IModularFeature

Functions

Name Description

Public function

void

 

BlockPlayers

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

Block communication with players

Public function

void

 

Connect

(
    const FOnVoiceChatConnectCompleteDe...
)

Connect to a voice server

Public function

void

 

Disconnect

(
    const FOnVoiceChatDisconnectComplet...
)

Disconnect from a voice server

Public function Static

IVoiceChat &...

 

Get()

Get the IVoiceChat modular feature instance

Public function Const

bool

 

GetAudioInputDeviceMuted()

Is the input device muted?

Public function Const

float

 

GetAudioInputVolume()

Get volume of audio input device

Public function Const

bool

 

GetAudioOutputDeviceMuted()

Is the output device muted?

Public function Const

float

 

GetAudioOutputVolume()

Get volume of audio output device

Public function Const

TArray< FStr...

 

GetAvailableInputDevices()

Get a list of available audio input devices

Public function Const

TArray< FStr...

 

GetAvailableOutputDevices()

Get a list of available audio output devices

Public function Const

TArray< FStr...

 

GetChannels()

Get an array of channels the user is in

Public function Const

EVoiceChatCh...

 

GetChannelType

(
    const FString& ChannelName
)

Get an array of players in a channel

Public function Const

FString

 

GetDefaultInputDevice()

Get the default audio input device

Public function Const

FString

 

GetDefaultOutputDevice()

Get the default audio output device

Public function Const

FString

 

GetInputDevice()

Get the audio input device that is being used

Public function Const

FString

 

GetLoggedInPlayerName()

Get the player name used to log in

Public function Const

FString

 

GetOutputDevice()

Get the audio output device that is being used

Public function Const

TArray< FStr...

 

GetPlayersInChannel

(
    const FString& ChannelName
)

Get an array of players in a channel

Public function Const

float

 

GetPlayerVolume

(
    const FString& PlayerName
)

Public function Const

FString

 

GetTransmitChannel()

Get the specific channel we are transmitting to

Public function Const

EVoiceChatTr...

 

GetTransmitMode()

Get the current transmit mode

Public function

bool

 

Initialize()

Initialize VoiceChat

Public function

FString

 

InsecureGetJoinToken

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

Public function

FString

 

InsecureGetLoginToken

(
    const FString& PlayerName
)

Generate Login/Join tokens. Should be used for development purposes only

Public function Const

bool

 

IsConnected()

Are we connected to the voice server?

Public function Const

bool

 

IsConnecting()

Are we connecting to the voice server?

Public function Const

bool

 

IsInitialized()

Is voice chat initialized?

Public function Const

bool

 

IsLoggedIn()

Are we logged in?

Public function Const

bool

 

IsLoggingIn()

Are we logging in?

Public function Const

bool

 

IsPlayerMuted

(
    const FString& PlayerName
)

Public function Const

bool

 

IsPlayerTalking

(
    const FString& PlayerName
)

Public function

void

 

JoinChannel

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

Join a voice channel

Public function

void

 

LeaveChannel

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

Leave a voice channel

Public function

void

 

Login

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

Login to the connected voice server

Public function

void

 

Logout

(
    const FOnVoiceChatLogoutCompleteDel...
)

Logout from the connected voice server

Public function

FOnVoiceChat...

 

OnVoiceChatAvailableAudioDevicesChanged()

Delegate broadcast whenever the available audio devices change.

Public function

FOnVoiceChat...

 

OnVoiceChatCallStatsUpdated()

Delegate triggered when a call is ended, providing the stats for the call.

Public function

FOnVoiceChat...

 

OnVoiceChatChannelExited()

Delegate triggered when we leave a voice channel

Public function

FOnVoiceChat...

 

OnVoiceChatChannelJoined()

Delegate triggered when we join a voice channel

Public function

FOnVoiceChat...

 

OnVoiceChatConnected()

Delegate triggered when we are connected to voice chat

Public function

FOnVoiceChat...

 

OnVoiceChatDisconnected()

Delegate triggered when we are disconnected from voice chat

Public function

FOnVoiceChat...

 

OnVoiceChatLoggedIn()

Delegate triggered when we are logged in to voice chat

Public function

FOnVoiceChat...

 

OnVoiceChatLoggedOut()

Delegate triggered when we are logged out from voice chat

Public function

FOnVoiceChat...

 

OnVoiceChatPlayerAdded()

Delegate triggered when a player is added to a channel

Public function

FOnVoiceChat...

 

OnVoiceChatPlayerMuteUpdated()

Delegate triggered when a player's muted state is updated, usually as a result of calling SetPlayerMuted

Public function

FOnVoiceChat...

 

OnVoiceChatPlayerRemoved()

Delegate triggered when a player is removed from a channel

Public function

FOnVoiceChat...

 

OnVoiceChatPlayerTalkingUpdated()

Delegate triggered when a player's talking state is updated

Public function

FOnVoiceChat...

 

OnVoiceChatPlayerVolumeUpdated()

Delegate triggered when a player's volume is updated, usually as a result of calling SetPlayerVolume

Public function

FOnVoiceChat...

 

OnVoiceChatReconnected()

Delegate triggered when we are reconnected to voice chat in cases where the underlying implementation disconnected and then reconnected.

Public function

FDelegateHan...

 

RegisterOnVoiceChatAfterCaptureAudioReadDelegate

(
    const FOnVoiceChatAfterCaptureAudio...
)

Delegates called from audio thread.

Public function

FDelegateHan...

 

RegisterOnVoiceChatBeforeCaptureAudioSentDelegate

(
    const FOnVoiceChatBeforeCaptureAudi...
)

Public function

FDelegateHan...

 

RegisterOnVoiceChatBeforeRecvAudioRenderedDelegate

(
    const FOnVoiceChatBeforeRecvAudioRe...
)

Public function

void

 

Set3DPosition

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

Set the 3d position of the player

Public function

void

 

SetAudioInputDeviceMuted

(
    bool bIsMuted
)

Mute or unmute the audio input device

Public function

void

 

SetAudioInputVolume

(
    float Volume
)

Set record volume

Public function

void

 

SetAudioOutputDeviceMuted

(
    bool bIsMuted
)

Mute or unmute the audio output device

Public function

void

 

SetAudioOutputVolume

(
    float Volume
)

Set playback volume

Public function

void

 

SetInputDevice

(
    const FString& InputDevice
)

Set the audio input device to use

Public function

void

 

SetOutputDevice

(
    const FString& OutputDevice
)

Set the audio output device to use

Public function

void

 

SetPlayerMuted

(
    const FString& PlayerName,
    bool bMuted
)

Mute or unmute a player

Public function

void

 

SetPlayerVolume

(
    const FString& PlayerName,
    float Volume
)

Set player volume

Public function

FDelegateHan...

 

StartRecording

(
    const FOnVoiceChatRecordSamplesAvai...
)

Start recording

Public function

void

 

StopRecording

(
    FDelegateHandle Handle
)

Stop recording

Public function

void

 

TransmitToAllChannels()

Transmit to all channels that you are currently in

Public function

void

 

TransmitToNoChannels()

Stop transmitting to all channels that you are currently in.

Public function

void

 

TransmitToSpecificChannel

(
    const FString& ChannelName
)

Transmit to a specific channel

Public function

void

 

UnblockPlayers

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

Unblock communication with players

Public function

bool

 

Uninitialize()

Uninitialize VoiceChat

Public function

void

 

UnregisterOnVoiceChatAfterCaptureAudioReadDelegate

(
    FDelegateHandle Handle
)

Public function

void

 

UnregisterOnVoiceChatBeforeCaptureAudioSentDelegate

(
    FDelegateHandle Handle
)

Public function

void

 

UnregisterOnVoiceChatBeforeRecvAudioRenderedDelegate

(
    FDelegateHandle Handle
)

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