UVOIPStatics

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Net/VoiceConfig.h

Include

#include "Net/VoiceConfig.h"

Syntax

class UVOIPStatics : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static

void

 

ClearAllSettings()

Clear all pointers to VOIPTalkers.

Public function Static

EAudioEncode...

 

GetAudioEncodingHint()

Returns the desired encoding type. Currently not exposed as a configured settings.

Public function Static

float

 

GetBufferingDelay()

Returns the amount of seconds to spend buffering specified by AudioSettings.

Public function Static

uint32

 

GetMaxCompressedVoiceDataSize()

Public function Static

uint32

 

GetMaxUncompressedVoiceDataSizePerChannel()

Public function Static

uint32

 

GetMaxVoiceDataSize()

Returns the max voice data size per packet, uncompressed, and compressed based on the voice sample rate specified in Audio Settings.

Public function Static

int32

 

GetNumBufferedPackets()

Returns the amount of packets to allocate memory for based on the buffering delay.

Public function Static

APlayerState...

 

GetPlayerStateFromUniqueNetId

(
    UWorld* InWorld,
    const FUniqueNetIdWrapper& InPlaye...
)

Returns pointer to a player state

Public function Static

float

 

GetRemoteTalkerTimeoutDuration()

Returns the amount of time that must pass since a VOIP talker has been updated before it's queued data is reset.

Public function Static

float

 

GetVoiceNoiseGateLevel()

Returns the noise gate threshold we use for incoming audio.

Public function Static

int32

 

GetVoiceNumChannels()

Public function Static

int32

 

GetVoiceSampleRate()

Returns the voice sample rate specified in Audio Settings.

Public function Static

UVOIPTalker ...

 

GetVOIPTalkerForPlayer

(
    const FUniqueNetIdWrapper& InPlaye...
)

These functions retrieve a pointer to a VOIPTalker associated with a specific player, if there is one available.

Public function Static

UVOIPTalker ...

 

GetVOIPTalkerForPlayer

(
    const FUniqueNetIdWrapper& InUniqu...,
    FVoiceSettings& OutSettings,
    UWorld* InWorld,
    APlayerState** OutPlayerSt...
)

These functions retrieve a pointer to a VOIPTalker associated with a specific player, if there is one available.

Public function Static

bool

 

IsVOIPTalkerStillAlive

(
    UVOIPTalker* InTalker
)

This is used to check whether a VOIPTalker has been removed from the TalkerMap before using it.

Public function Static

void

 

ResetPlayerVoiceTalker

(
    APlayerState* InPlayerState
)

Removes a player's voice talker. This is done by a UVOIPTalker on destruction.

Public function Static

void

 

ResetPlayerVoiceTalker

(
    const FUniqueNetIdWrapper& InPlaye...
)

Removes a player's voice talker. This is done by a UVOIPTalker on destruction.

Public function Static

void

 

SetMicThreshold

(
    float InThreshold
)

This function sets the Mic threshold for VOIP chat.

Public function Static

void

 

SetVOIPTalkerForPlayer

(
    const FUniqueNetIdWrapper& InPlaye...,
    UVOIPTalker* InTalker
)

Sets up a VOIP talker to be accessed for a specific player when they are talking.

Constants

Name

Description

VoiceTalkerMap