CriWare Unreal Engine
Plug-ins for CriWare solutions.
Loading...
Searching...
No Matches
Atom::FMixerSource Class Referenceabstract

#include <AtomMixerSource.h>

Inheritance diagram for Atom::FMixerSource:

Public Member Functions

 FMixerSource (FAtomRuntime *InAtomRuntime)
virtual ~FMixerSource ()
virtual void OnBeginGenerate () override
virtual void OnDone () override
Public Member Functions inherited from FAtomSource
CRIWARECORE_API FAtomSource (FAtomRuntime *InAtomRuntime)
virtual CRIWARECORE_API ~FAtomSource ()=0
virtual CRIWARECORE_API FString Describe (bool bUseLongName)
CRIWARECORE_API void GetChannelLocations (FVector &Left, FVector &Right) const
virtual CRIWARECORE_API float GetEnvelopeValue () const
virtual void * GetNativeHandle () const =0
const FAtomPlaybackInstance * GetPlaybackInstance () const
virtual CRIWARECORE_API float GetPlaybackPercent () const
CRIWARECORE_API FAtomSpatializationParams GetSpatializationParams ()
const FAtomWaveInfo & GetWaveInfo () const
virtual bool Init (FAtomPlaybackInstance *InPlaybackInstance)=0
virtual bool IsFinished ()=0
bool IsGameOnly () const
virtual bool IsInitialized () const
bool IsPaused () const
bool IsPausedByGame () const
bool IsPausedManually () const
bool IsPlaying () const
virtual bool IsPreparedToInit ()
virtual bool IsStopping ()
virtual bool IsVoiceSource () const
void NotifyPlaybackData ()
virtual void Play ()=0
virtual bool PrepareForInitialization (FAtomPlaybackInstance *InPlaybackInstance)
CRIWARECORE_API void SetFilterFrequency ()
void SetPauseByGame (bool bInIsPauseByGame)
void SetPauseManually (bool bInIsPauseManually)
void SetVirtual ()
virtual CRIWARECORE_API void Stop ()
virtual CRIWARECORE_API void StopNow ()
virtual void Update ()=0
CRIWARECORE_API void UpdateStereoEmitterPositions ()
Public Member Functions inherited from Atom::ISourceListener
virtual ~ISourceListener ()=default

Protected Types

enum  EFreeReason { Deleter , Stop , Error }

Protected Member Functions

virtual void FreeResources (EFreeReason InFreeReason)=0
int64 GetNumFramesPlayed () const
bool InitSourceVoice (FAtomPlaybackInstance *InPlaybackInstance)
bool IsUsingObjectBasedSpatialization () const
virtual void SetupSourceBusData (TArray< FInitAudioBusSend > *OutAudioBusSends=nullptr, bool bEnableBusSends=true)
const TCHAR * ToString (EFreeReason Value)
bool UseObjectBasedSpatialization () const
bool UseSourceDataOverridePlugin () const
Protected Member Functions inherited from FAtomSource
CRIWARECORE_API float GetDebugVolume (const float InVolume)
CRIWARECORE_API void InitCommon ()
virtual void Pause ()=0
CRIWARECORE_API void UpdateCommon ()
void UpdatePause ()

Protected Attributes

bool bDebugMode = false
FMixerSourcePlayer MixerSourcePlayer
FMixerSourceVoice * MixerSourceVoice = nullptr
Protected Attributes inherited from FAtomSource
FAtomRuntime * AtomRuntime
uint8 bIsInitialized: 1
uint8 bIsManuallyPaused: 1
uint8 bIsPaused: 1
uint8 bIsPausedByGame: 1
FThreadSafeBool bIsPlaying
uint8 bIsPreviewSound: 1
uint32 bIsVirtual: 1
friend FAtomActiveSound
friend FAtomRuntime
float HPFFrequency
int32 LastHeardUpdate
float LastHPFFrequency
float LastLPFFrequency
int32 LastUpdate
FVector LeftChannelSourceLocation
float LPFFrequency
int32 NumFramesPlayed
int32 NumTotalFrames
float Pitch
FAtomPlaybackInstance * PlaybackInstance
float PlaybackTime
FVector RightChannelSourceLocation
int32 StartFrame
int32 TickCount
FAtomWaveInfo WaveInfo

Detailed Description

Base class for sound sources that uses mixer ("Ex" in CriAtom) and source voices.

Member Enumeration Documentation

◆ EFreeReason

enum Atom::FMixerSource::EFreeReason
protected
Enumerator
Deleter 
Stop 
Error 

Constructor & Destructor Documentation

◆ FMixerSource()

Atom::FMixerSource::FMixerSource ( FAtomRuntime * InAtomRuntime)

◆ ~FMixerSource()

Atom::FMixerSource::~FMixerSource ( )
virtual

Member Function Documentation

◆ FreeResources()

virtual void Atom::FMixerSource::FreeResources ( EFreeReason InFreeReason)
protectedpure virtual

Implemented in Atom::FAtomExPlayback.

◆ GetNumFramesPlayed()

int64 Atom::FMixerSource::GetNumFramesPlayed ( ) const
protected

◆ InitSourceVoice()

bool Atom::FMixerSource::InitSourceVoice ( FAtomPlaybackInstance * InPlaybackInstance)
protected

◆ IsUsingObjectBasedSpatialization()

bool Atom::FMixerSource::IsUsingObjectBasedSpatialization ( ) const
protected

Whether or not existing or new sources will use the HRTF spatializer.

◆ OnBeginGenerate()

virtual void Atom::FMixerSource::OnBeginGenerate ( )
inlineoverridevirtual

Implements Atom::ISourceListener.

◆ OnDone()

virtual void Atom::FMixerSource::OnDone ( )
inlineoverridevirtual

Implements Atom::ISourceListener.

◆ SetupSourceBusData()

virtual void Atom::FMixerSource::SetupSourceBusData ( TArray< FInitAudioBusSend > * OutAudioBusSends = nullptr,
bool bEnableBusSends = true )
inlineprotectedvirtual

Reimplemented in Atom::FAtomExPlayback.

◆ ToString()

const TCHAR * Atom::FMixerSource::ToString ( EFreeReason Value)
inlineprotected

◆ UseObjectBasedSpatialization()

bool Atom::FMixerSource::UseObjectBasedSpatialization ( ) const
protected

Whether or not we should create the source voice with the HRTF spatializer.

◆ UseSourceDataOverridePlugin()

bool Atom::FMixerSource::UseSourceDataOverridePlugin ( ) const
protected

Whether or not to use the source data override plugin

Member Data Documentation

◆ bDebugMode

bool Atom::FMixerSource::bDebugMode = false
protected

◆ MixerSourcePlayer

FMixerSourcePlayer Atom::FMixerSource::MixerSourcePlayer
protected

the explayer object that play may be null in case of using atomPlayer.

◆ MixerSourceVoice

FMixerSourceVoice* Atom::FMixerSource::MixerSourceVoice = nullptr
protected
The documentation for this class was generated from the following files:
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Mixer/AtomMixerSource.h
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Mixer/AtomMixerSource.cpp