Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UVOIPTalker |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Net/VoiceConfig.h |
| Include Path | #include "Net/VoiceConfig.h" |
Syntax
UCLASS (Blueprintable, BlueprintType, ClassGroup=VOIP,
Meta=(BlueprintSpawnableComponent, ShortTooltip="A VOIPTalker is a component that can be used to control the audio characteristics of a player's voice."),
MinimalAPI)
class UVOIPTalker : public UActorComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UVOIPTalker
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVOIPTalker
(
const FObjectInitializer& ObjectInitializer |
Constructor and destructor. | Net/VoiceConfig.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UVOIPTalker() |
Net/VoiceConfig.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Settings | FVoiceSettings | Configurable settings for this player's voice. When set, this will update the next time the player speaks. | Net/VoiceConfig.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRegistered | uint8 | Whether this component has been registered. | Net/VoiceConfig.h | |
| CachedVolumeLevel | float | This volume level is set by the Audio Component's OnEnvelopeValueSet delegate. | Net/VoiceConfig.h | |
| PlayerId | FUniqueNetIdWrapper | Cached player ID from the APlayerController. | Net/VoiceConfig.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetVoiceLevel () |
Get the current level of how loud this player is speaking. | Net/VoiceConfig.h |
|
void OnAudioComponentEnvelopeValue
(
const UAudioComponent* InAudioComponent, |
This is used by the VoiceEngineImpl to notify this VOIPTalker what the voice audio component's current level is. | Net/VoiceConfig.h | |
virtual void OnTalkingBegin
(
UAudioComponent* AudioComponent |
Override this function to implement custom functionality when this player begins talking. | Net/VoiceConfig.h | |
virtual void OnTalkingEnd() |
Override this function to implement custom functionality when this player stops talking. | Net/VoiceConfig.h | |
void RegisterWithPlayerState
(
APlayerState* OwningState |
This function sets up this talker with a specific player. | Net/VoiceConfig.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnComponentDestroyed
(
bool bDestroyingHierarchy |
Overridden to ensure that instances of UVOIPTalker unregister themselves from the static VoiceTalkerMap. | Net/VoiceConfig.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BPOnTalkingBegin
(
UAudioComponent* AudioComponent |
Blueprint native event for when this player starts speaking. | Net/VoiceConfig.h |
|
void BPOnTalkingEnd() |
Blueprint native event for when this player stops speaking. | Net/VoiceConfig.h |
|
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UVOIPTalker * CreateTalkerForPlayer
(
APlayerState* OwningState |
Function for creating and registering a UVOIPTalker. | Net/VoiceConfig.h |
|