UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FMixerSourceVoice Class Reference

#include <AudioMixerSourceVoice.h>

Public Member Functions

 FMixerSourceVoice ()
 
 ~FMixerSourceVoice ()
 
void Reset (FMixerDevice *InMixerDevice)
 
bool Init (const FMixerSourceVoiceInitParams &InFormat)
 
void Release ()
 
void SetPitch (const float InPitch)
 
void SetVolume (const float InVolume)
 
void SetDistanceAttenuation (const float InDistanceAttenuation)
 
void SetLPFFrequency (const float InFrequency)
 
void SetHPFFrequency (const float InFrequency)
 
void SetModPitch (const float InPitch)
 
void SetModVolume (const float InVolume)
 
void SetModLPFFrequency (const float InFrequency)
 
void SetModHPFFrequency (const float InFrequency)
 
void SetModulationRouting (FSoundModulationDefaultRoutingSettings &RoutingSettings)
 
void SetSourceBufferListener (FSharedISourceBufferListenerPtr &InSourceBufferListener, bool InShouldSourceBufferListenerZeroBuffer)
 
void SetChannelMap (const uint32 NumInputChannels, const Audio::FAlignedFloatBuffer &InChannelMap, const bool bInIs3D, const bool bInIsCenterChannelOnly)
 
void SetSpatializationParams (const FSpatializationParams &InParams)
 
void Play ()
 
void Pause ()
 
void Stop ()
 
void StopFade (int32 NumFrames)
 
int32 GetSourceId () const
 
float GetDistanceAttenuation () const
 
float GetDistance () const
 
bool IsPlaying () const
 
bool IsPaused () const
 
bool IsActive () const
 
bool IsStopFadedOut () const
 
bool NeedsSpeakerMap () const
 
bool IsUsingHRTFSpatializer (bool bDefaultValue) const
 
int64 GetNumFramesPlayed () const
 
float GetEnvelopeValue () const
 
float GetVolumeModulationValue () const
 
float GetRelativeRenderCost () const
 
void MixOutputBuffers (int32 InNumChannels, const float SendLevel, EMixerSourceSubmixSendStage InSubmixSendStage, FAlignedFloatBuffer &OutWetBuffer) const
 
const ISoundfieldAudioPacketGetEncodedOutput (const FSoundfieldEncodingKey &InKey) const
 
const FQuat GetListenerRotationForVoice () const
 
void SetSubmixSendInfo (FMixerSubmixWeakPtr Submix, const float SendLevel, const EMixerSourceSubmixSendStage SendStage=EMixerSourceSubmixSendStage::PostDistanceAttenuation)
 
void ClearSubmixSendInfo (FMixerSubmixWeakPtr Submix)
 
void SetOutputToBusOnly (bool bInOutputToBusOnly)
 
void SetEnablement (bool bInEnableBusSendRouting, bool bInEnableMainSubmixOutput, bool bInEnableSubmixSendRouting)
 
void SetAudioBusSendInfo (EBusSendType InBusSendType, uint32 AudioBusId, float BusSendLevel, const FString &InBusName)
 

Friends

class FMixerSourceManager
 

Constructor & Destructor Documentation

◆ FMixerSourceVoice()

Audio::FMixerSourceVoice::FMixerSourceVoice ( )

FMixerSourceVoice Implementation

◆ ~FMixerSourceVoice()

Audio::FMixerSourceVoice::~FMixerSourceVoice ( )

Member Function Documentation

◆ ClearSubmixSendInfo()

void Audio::FMixerSourceVoice::ClearSubmixSendInfo ( FMixerSubmixWeakPtr  Submix)

◆ GetDistance()

float Audio::FMixerSourceVoice::GetDistance ( ) const

◆ GetDistanceAttenuation()

float Audio::FMixerSourceVoice::GetDistanceAttenuation ( ) const

◆ GetEncodedOutput()

const ISoundfieldAudioPacket * Audio::FMixerSourceVoice::GetEncodedOutput ( const FSoundfieldEncodingKey InKey) const

◆ GetEnvelopeValue()

float Audio::FMixerSourceVoice::GetEnvelopeValue ( ) const

◆ GetListenerRotationForVoice()

const FQuat Audio::FMixerSourceVoice::GetListenerRotationForVoice ( ) const

◆ GetNumFramesPlayed()

int64 Audio::FMixerSourceVoice::GetNumFramesPlayed ( ) const

◆ GetRelativeRenderCost()

float Audio::FMixerSourceVoice::GetRelativeRenderCost ( ) const

◆ GetSourceId()

int32 Audio::FMixerSourceVoice::GetSourceId ( ) const

◆ GetVolumeModulationValue()

float Audio::FMixerSourceVoice::GetVolumeModulationValue ( ) const

◆ Init()

bool Audio::FMixerSourceVoice::Init ( const FMixerSourceVoiceInitParams InFormat)

◆ IsActive()

bool Audio::FMixerSourceVoice::IsActive ( ) const

◆ IsPaused()

bool Audio::FMixerSourceVoice::IsPaused ( ) const

◆ IsPlaying()

bool Audio::FMixerSourceVoice::IsPlaying ( ) const

◆ IsStopFadedOut()

bool Audio::FMixerSourceVoice::IsStopFadedOut ( ) const
inline

◆ IsUsingHRTFSpatializer()

bool Audio::FMixerSourceVoice::IsUsingHRTFSpatializer ( bool  bDefaultValue) const

◆ MixOutputBuffers()

void Audio::FMixerSourceVoice::MixOutputBuffers ( int32  InNumChannels,
const float  SendLevel,
EMixerSourceSubmixSendStage  InSubmixSendStage,
FAlignedFloatBuffer OutWetBuffer 
) const

◆ NeedsSpeakerMap()

bool Audio::FMixerSourceVoice::NeedsSpeakerMap ( ) const

◆ Pause()

void Audio::FMixerSourceVoice::Pause ( )

◆ Play()

void Audio::FMixerSourceVoice::Play ( )

◆ Release()

void Audio::FMixerSourceVoice::Release ( )

◆ Reset()

void Audio::FMixerSourceVoice::Reset ( FMixerDevice InMixerDevice)

◆ SetAudioBusSendInfo()

void Audio::FMixerSourceVoice::SetAudioBusSendInfo ( EBusSendType  InBusSendType,
uint32  AudioBusId,
float  BusSendLevel,
const FString &  InBusName 
)

◆ SetChannelMap()

void Audio::FMixerSourceVoice::SetChannelMap ( const uint32  NumInputChannels,
const Audio::FAlignedFloatBuffer InChannelMap,
const bool  bInIs3D,
const bool  bInIsCenterChannelOnly 
)

◆ SetDistanceAttenuation()

void Audio::FMixerSourceVoice::SetDistanceAttenuation ( const float  InDistanceAttenuation)

◆ SetEnablement()

void Audio::FMixerSourceVoice::SetEnablement ( bool  bInEnableBusSendRouting,
bool  bInEnableMainSubmixOutput,
bool  bInEnableSubmixSendRouting 
)

◆ SetHPFFrequency()

void Audio::FMixerSourceVoice::SetHPFFrequency ( const float  InFrequency)

◆ SetLPFFrequency()

void Audio::FMixerSourceVoice::SetLPFFrequency ( const float  InFrequency)

◆ SetModHPFFrequency()

void Audio::FMixerSourceVoice::SetModHPFFrequency ( const float  InFrequency)

◆ SetModLPFFrequency()

void Audio::FMixerSourceVoice::SetModLPFFrequency ( const float  InFrequency)

◆ SetModPitch()

void Audio::FMixerSourceVoice::SetModPitch ( const float  InPitch)

◆ SetModulationRouting()

void Audio::FMixerSourceVoice::SetModulationRouting ( FSoundModulationDefaultRoutingSettings RoutingSettings)

◆ SetModVolume()

void Audio::FMixerSourceVoice::SetModVolume ( const float  InVolume)

◆ SetOutputToBusOnly()

void Audio::FMixerSourceVoice::SetOutputToBusOnly ( bool  bInOutputToBusOnly)

◆ SetPitch()

void Audio::FMixerSourceVoice::SetPitch ( const float  InPitch)

◆ SetSourceBufferListener()

void Audio::FMixerSourceVoice::SetSourceBufferListener ( FSharedISourceBufferListenerPtr InSourceBufferListener,
bool  InShouldSourceBufferListenerZeroBuffer 
)

◆ SetSpatializationParams()

void Audio::FMixerSourceVoice::SetSpatializationParams ( const FSpatializationParams InParams)

◆ SetSubmixSendInfo()

void Audio::FMixerSourceVoice::SetSubmixSendInfo ( FMixerSubmixWeakPtr  Submix,
const float  SendLevel,
const EMixerSourceSubmixSendStage  SendStage = EMixerSourceSubmixSendStage::PostDistanceAttenuation 
)

◆ SetVolume()

void Audio::FMixerSourceVoice::SetVolume ( const float  InVolume)

◆ Stop()

void Audio::FMixerSourceVoice::Stop ( )

◆ StopFade()

void Audio::FMixerSourceVoice::StopFade ( int32  NumFrames)

Friends And Related Symbol Documentation

◆ FMixerSourceManager


The documentation for this class was generated from the following files: