Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UnrealAudio > IVoice

Light Theme

Dark Theme

IVoice

An [IVoice](API\Runtime\UnrealAudio\IVoice) interface

Windows

MacOS

Linux

References

Module	UnrealAudio
Header	/Engine/Source/Runtime/UnrealAudio/Public/UnrealAudioVoice.h
Include	#include "UnrealAudioVoice.h"

Syntax

class IVoice

Remarks

An IVoice interface

Destructors

	Name	Description
	~IVoice()	Destructor.

Functions

	Name	Description
EVoiceError:...	AddVoiceListener ( IVoiceListener* Listener )	Adds the given notifier to the voice. The notifier will receive callbacks on various voice events.
EVoiceError:...	GetBaselinePitchScale ( float& OutBaselinePitchScale )	Gets the baseline pitch scale of this voice.
EVoiceError:...	GetBaselineVolumeScale ( float& OutBaselineVolumeScale )	Gets baseline volume scale.
EVoiceError:...	GetDuration ( float& OutDurationSec )	Gets a duration.
EVoiceError:...	GetId ( uint32& OutVoiceId )
EVoiceError:...	GetPitchProduct ( float& OutPitchProduct )	Gets the pitch product.
EVoiceError:...	GetPitchScale ( float& OutPitchScale )	Gets dynamic pitch scale of this voice.
EVoiceError:...	GetPlayingState ( EVoicePlayingState::Type& OutPlayi... )
EVoiceError:...	GetVoiceState ( EVoiceState::Type& OutVoicestate )
EVoiceError:...	GetVolumeAttenuation ( float& OutAttenuation )	Gets volume attenuation (due to 3d spatialization).
EVoiceError:...	GetVolumeProduct ( float& OutVolumeProduct )	Gets the volume product.
EVoiceError:...	GetVolumeScale ( float& OutVolumeScale )	Gets volume scale.
EVoiceError:...	IsPlaying ( bool& OutIsplaying )
EVoiceError:...	IsValid ( bool& bOutIsValid )	Is valid.
EVoiceError:...	Pause ( float InFadeTimeSec )	Pauses this voice.
EVoiceError:...	Play()	Plays this voice.
EVoiceError:...	RemoveVoiceListener ( IVoiceListener* Listener )	Removes the voice listener described by Listener.
EVoiceError:...	SetPitchScale ( float InPitchScale, float InFadeTimeSec )	Sets the pitch scale for this voice using linear volume scale.
EVoiceError:...	SetVolumeScale ( float InVolumeLinear, float InFadeTimeSec )	Sets the volume scale for this voice using linear volume scale.
EVoiceError:...	Stop ( float InFadeTimeSec )	Stops this voice. @note The voice is automatically released (i.e. freed) when the voice stops.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss