IVoiceChatUser

API > API/Plugins > API/Plugins/VoiceChat

   
Name IVoiceChatUser
Type class
Header File /Engine/Plugins/Online/VoiceChat/VoiceChat/Source/Public/VoiceChat.h
Include Path #include "VoiceChat.h"

Syntax

class IVoiceChatUser

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IVoiceChatUser()

   VoiceChat.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BlockPlayers ( const TArray< FString >& PlayerNames
)

 Block communication with players VoiceChat.h  

bool GetAudioInputDeviceMuted()

 Is the input device muted? VoiceChat.h  

float GetAudioInputVolume()

 Get volume of audio input device VoiceChat.h  

bool GetAudioOutputDeviceMuted()

 Is the output device muted? VoiceChat.h  

float GetAudioOutputVolume()

 Get volume of audio output device VoiceChat.h  

TArray< FVoiceChatDeviceInfo > GetAvailableInputDeviceInfos()

 Get a list of available audio input devices VoiceChat.h  

TArray< FString > GetAvailableInputDevices()

 Get a list of available audio input device names VoiceChat.h  

TArray< FVoiceChatDeviceInfo > GetAvailableOutputDeviceInfos()

 Get a list of available audio output devices VoiceChat.h  

TArray< FString > GetAvailableOutputDevices()

 Get a list of available audio output device names VoiceChat.h  

TOptional< FVoiceChatCallStats > GetChannelCallStats ( const FString& ChannelName
) const

 Returns the current cumulative call-quality stats for the named channel, if available, or an empty optional if the channel is not currently joined or if the implementation does not produce stats. VoiceChat.h  

TArray< FString > GetChannels()

 Get an array of channels the user is in VoiceChat.h  

EVoiceChatChannelType GetChannelType ( const FString& ChannelName
) const

 Get an array of players in a channel VoiceChat.h  

FString GetDefaultInputDevice()

 Get the display name of the default audio input device VoiceChat.h  

FVoiceChatDeviceInfo GetDefaultInputDeviceInfo()

 Get the device info of the default audio input device VoiceChat.h  

FString GetDefaultOutputDevice()

 Get the display name of the default audio output device VoiceChat.h  

FVoiceChatDeviceInfo GetDefaultOutputDeviceInfo()

 Get the device info of the default audio output device VoiceChat.h  

FString GetInputDevice()

 Get the display name of the audio input device that is being used VoiceChat.h  

FVoiceChatDeviceInfo GetInputDeviceInfo()

 Get the device info of the audio input device that is being used VoiceChat.h  

FString GetLoggedInPlayerName()

 Get the player name used to log in VoiceChat.h  

FString GetOutputDevice()

 Get the display name of the audio output device that is being used VoiceChat.h  

FVoiceChatDeviceInfo GetOutputDeviceInfo()

 Get the device info of the audio output device that is being used VoiceChat.h  

TArray< FString > GetPlayersInChannel ( const FString& ChannelName
) const

 Get an array of players in a channel VoiceChat.h  

float GetPlayerVolume ( const FString& PlayerName
) const

   VoiceChat.h  

FString GetSetting ( const FString& Name
)

 Get an implementation specific setting VoiceChat.h  

TSet< FString > GetTransmitChannels()

 Get all channels we are transmitting to VoiceChat.h  

EVoiceChatTransmitMode GetTransmitMode()

 Get the current transmit mode VoiceChat.h  

FString InsecureGetJoinToken ( const FString& ChannelName,
EVoiceChatChannelType ChannelType,
TOptional< FVoiceChatChannel3dProperties > Channel3dProperties
)

   VoiceChat.h  

FString InsecureGetLoginToken ( const FString& PlayerName
)

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

bool IsChannelPlayerMuted ( const FString& ChannelName,
const FString& PlayerName
) const

   VoiceChat.h  

bool IsLoggedIn()

 Are we logged in? VoiceChat.h  

bool IsLoggingIn()

 Are we logging in? VoiceChat.h  

bool IsPlayerMuted ( const FString& PlayerName
) const

   VoiceChat.h  

bool IsPlayerTalking ( const FString& PlayerName
) const

   VoiceChat.h  

void JoinChannel ( const FString& ChannelName,
const FString& ChannelCredentials,
EVoiceChatChannelType ChannelType,
const FOnVoiceChatChannelJoinCompleteDelegate& Delegate,
TOptional< FVoiceChatChannel3dProperties > Channel3dProperties
)

 Join a voice channel VoiceChat.h  

void LeaveChannel ( const FString& ChannelName,
const FOnVoiceChatChannelLeaveCompleteDelegate& Delegate
)

 Leave a voice channel VoiceChat.h  

void Login ( FPlatformUserId PlatformId,
const FString& PlayerName,
const FString& Credentials,
const FOnVoiceChatLoginCompleteDelegate& Delegate
)

 Login to the connected voice server VoiceChat.h  

void Logout ( const FOnVoiceChatLogoutCompleteDelegate& Delegate
)

 Logout from the connected voice server VoiceChat.h  

FOnVoiceChatAvailableAudioDevicesChangedDelegate & OnVoiceChatAvailableAudioDevicesChanged ()

 Delegate broadcast whenever the available audio devices change. VoiceChat.h  

FOnVoiceChatCallStatsUpdatedDelegate & OnVoiceChatCallStatsUpdated()

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

FOnVoiceChatCallStatsUpdatedDelegate2 & OnVoiceChatCallStatsUpdated2 ()

 Delegate triggered when a call ends on a specific channel, providing the cumulative stats for the call. VoiceChat.h  

FOnVoiceChatChannelExitedDelegate & OnVoiceChatChannelExited()

 Delegate triggered when we leave a voice channel VoiceChat.h  

FOnVoiceChatChannelJoinedDelegate & OnVoiceChatChannelJoined()

 Delegate triggered when we join a voice channel VoiceChat.h  

FOnVoiceChatLoggedInDelegate & OnVoiceChatLoggedIn()

 Delegate triggered when we are logged in to voice chat VoiceChat.h  

FOnVoiceChatLoggedOutDelegate & OnVoiceChatLoggedOut()

 Delegate triggered when we are logged out from voice chat VoiceChat.h  

FOnVoiceChatPlayerAddedDelegate & OnVoiceChatPlayerAdded()

 Delegate triggered when a player is added to a channel VoiceChat.h  

FOnVoiceChatPlayerMuteUpdatedDelegate & OnVoiceChatPlayerMuteUpdated()

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

FOnVoiceChatPlayerRemovedDelegate & OnVoiceChatPlayerRemoved()

 Delegate triggered when a player is removed from a channel VoiceChat.h  

FOnVoiceChatPlayerTalkingUpdatedDelegate & OnVoiceChatPlayerTalkingUpdated()

 Delegate triggered when a player's talking state is updated VoiceChat.h  

FOnVoiceChatPlayerVolumeUpdatedDelegate & OnVoiceChatPlayerVolumeUpdated()

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

FDelegateHandle RegisterOnVoiceChatAfterCaptureAudioReadDelegate ( const FOnVoiceChatAfterCaptureAudioReadDelegate2::FDelegate& Delegate
)

 Delegates called from audio thread. VoiceChat.h  

FDelegateHandle RegisterOnVoiceChatBeforeCaptureAudioSentDelegate ( const FOnVoiceChatBeforeCaptureAudioSentDelegate2::FDelegate& Delegate
)

   VoiceChat.h  

FDelegateHandle RegisterOnVoiceChatBeforeRecvMixedAudioRenderedDelegate ( const FOnVoiceChatBeforeRecvAudioRenderedDelegate::FDelegate& Delegate
)

   VoiceChat.h  

FDelegateHandle RegisterOnVoiceChatBeforeRecvUnmixedAudioRenderedDelegate ( const FOnVoiceChatBeforeRecvAudioRenderedDelegate::FDelegate& Delegate
)

   VoiceChat.h  

void Set3DPosition ( const FString& ChannelName,
const FVector& Position
)

 Set the 3d position of the player VoiceChat.h  

void SetAudioInputDeviceMuted ( bool bIsMuted
)

 Mute or unmute the audio input device VoiceChat.h  

void SetAudioInputVolume ( float Volume
)

 Set record volume VoiceChat.h  

void SetAudioOutputDeviceMuted ( bool bIsMuted
)

 Mute or unmute the audio output device VoiceChat.h  

void SetAudioOutputVolume ( float Volume
)

 Set playback volume VoiceChat.h  

void SetChannelPlayerMuted ( const FString& ChannelName,
const FString& PlayerName,
bool bAudioMuted
)

 Mute or unmute a player in a given channel. VoiceChat.h  

void SetInputDevice ( const FString& InputDeviceName
)

 Set the audio input device to use VoiceChat.h  

void SetInputDeviceId ( const FString& InputDeviceId
)

 Set the audio input device to use VoiceChat.h  

void SetOutputDevice ( const FString& OutputDeviceName
)

 Set the audio output device to use VoiceChat.h  

void SetOutputDeviceId ( const FString& OutputDeviceId
)

 Set the audio output device to use VoiceChat.h  

void SetPlayerMuted ( const FString& PlayerName,
bool bMuted
)

 Mute or unmute a player VoiceChat.h  

void SetPlayerVolume ( const FString& PlayerName,
float Volume
)

 Set player volume VoiceChat.h  

void SetSetting ( const FString& Name,
const FString& Value
)

 Set an implementation specific setting VoiceChat.h  

FDelegateHandle StartRecording ( const FOnVoiceChatRecordSamplesAvailableDelegate::FDelegate& Delegate
)

 Start recording VoiceChat.h  

void StopRecording ( FDelegateHandle Handle
)

 Stop recording VoiceChat.h  

void TransmitToAllChannels()

 Transmit to all channels that you are currently in VoiceChat.h  
Stop transmitting to all channels that you are currently in. VoiceChat.h  

void TransmitToSpecificChannels ( const TSet< FString >& ChannelNames
)

 Transmit to Specified set of channels VoiceChat.h  

void UnblockPlayers ( const TArray< FString >& PlayerNames
)

 Unblock communication with players VoiceChat.h  

void UnregisterOnVoiceChatAfterCaptureAudioReadDelegate ( FDelegateHandle Handle
)

   VoiceChat.h  

void UnregisterOnVoiceChatBeforeCaptureAudioSentDelegate ( FDelegateHandle Handle
)

   VoiceChat.h  

void UnregisterOnVoiceChatBeforeRecvMixedAudioRenderedDelegate ( FDelegateHandle Handle
)

   VoiceChat.h  

void UnregisterOnVoiceChatBeforeRecvUnmixedAudioRenderedDelegate ( FDelegateHandle Handle
)

   VoiceChat.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void AddSpecificChannelsToTransmit ( const TSet< FString >& ChannelNames
)

 Add specific channels to transmit VoiceChat.h  

virtual FDelegateHandle RegisterOnVoiceChatAfterCaptureAudioReadDelegate ( const FOnVoiceChatAfterCaptureAudioReadDelegate::FDelegate& Delegate
)

   VoiceChat.h  

virtual FDelegateHandle RegisterOnVoiceChatBeforeCaptureAudioSentDelegate ( const FOnVoiceChatBeforeCaptureAudioSentDelegate::FDelegate& Delegate
)

   VoiceChat.h  

virtual FDelegateHandle RegisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( const FOnVoiceChatBeforeRecvAudioRenderedDelegate::FDelegate& Delegate
)

   VoiceChat.h  

virtual void RemoveSpecificChannelsFromTransmit ( const TSet< FString >& ChannelNames
)

 Remove specific channels from transmit VoiceChat.h  

virtual void UnregisterOnVoiceChatBeforeRecvAudioRenderedDelegate ( FDelegateHandle Handle
)

   VoiceChat.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page