UVOIPTalker

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 UVOIPTalker : public UActorComponent

Variables

Name Description

Public variable

FVoiceSettings

 

Settings

Configurable settings for this player's voice. When set, this will update the next time the player speaks.

Constructors

Name Description

Public function

UVOIPTalker

(
    const FObjectInitializer& ObjectIn...
)

Constructor and destructor.

Destructors

Name Description

Public function Virtual

~UVOIPTalker()

Functions

Name Description

Protected function

void

 

BPOnTalkingBegin

(
    UAudioComponent* AudioComponen...
)

Blueprint native event for when this player starts speaking.

Protected function

void

 

BPOnTalkingEnd()

Blueprint native event for when this player stops speaking.

Public function Static

UVOIPTalker ...

 

CreateTalkerForPlayer

(
    APlayerState* OwningState
)

Function for creating and registering a UVOIPTalker.

Public function

float

 

GetVoiceLevel()

Get the current level of how loud this player is speaking.

Public function

void

 

OnAudioComponentEnvelopeValue

(
    const UAudioComponent* InAudio...,
    const float EnvelopeValue
)

This is used by the VoiceEngineImpl to notify this VOIPTalker what the voice audio component's current level is.

Public function Virtual

void

 

OnTalkingBegin

(
    UAudioComponent* AudioComponen...
)

Override this function to implement custom functionality when this player begins talking.

Public function Virtual

void

 

OnTalkingEnd()

Override this function to implement custom functionality when this player stops talking.

Public function

void

 

RegisterWithPlayerState

(
    APlayerState* OwningState
)

This function sets up this talker with a specific player.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

OnComponentDestroyed

(
    bool bDestroyingHierarchy
)

Overridden to ensure that instances of UVOIPTalker unregister themselves from the static VoiceTalkerMap.