Atom::FAtomExternalExPlayback类 参考

#include <AtomMixerSource.h>

类 Atom::FAtomExternalExPlayback 继承关系图:

Public 成员函数
	FAtomExternalExPlayback (FAtomRuntime *InAtomRuntime, FCriAtomExPlayerPtr &&InExternalExPlayer)
	~FAtomExternalExPlayback ()
virtual FString	Describe (bool bUseLongName) override
virtual bool	IsVoiceSource () const override
virtual bool	PrepareForInitialization (FAtomPlaybackInstance *InPlaybackInstance) override
Public 成员函数 继承自 Atom::FAtomExPlayback
	FAtomExPlayback (FAtomRuntime *InAtomRuntime)
	~FAtomExPlayback ()
FAtomRuntime *	GetAtomRuntime () const
virtual float	GetEnvelopeValue () const override
virtual void *	GetNativeHandle () const override
virtual float	GetPlaybackPercent () const override
virtual bool	Init (FAtomPlaybackInstance *InPlaybackInstance) override
virtual bool	IsFinished () override
bool	IsPlaybackFinished ()
virtual bool	IsPreparedToInit () override
virtual bool	IsStopping () override
virtual void	Pause () override
virtual void	Play () override
virtual void	Stop () override
virtual void	StopNow () override
virtual void	Update () override
Public 成员函数 继承自 Atom::FMixerSource
	FMixerSource (FAtomRuntime *InAtomRuntime)
virtual	~FMixerSource ()
virtual void	OnBeginGenerate () override
virtual void	OnDone () override
Public 成员函数 继承自 FAtomSource
CRIWARECORE_API	FAtomSource (FAtomRuntime *InAtomRuntime)
virtual CRIWARECORE_API	~FAtomSource ()=0
CRIWARECORE_API void	GetChannelLocations (FVector &Left, FVector &Right) const
const FAtomPlaybackInstance *	GetPlaybackInstance () const
CRIWARECORE_API FAtomSpatializationParams	GetSpatializationParams ()
const FAtomWaveInfo &	GetWaveInfo () const
bool	IsGameOnly () const
virtual bool	IsInitialized () const
bool	IsPaused () const
bool	IsPausedByGame () const
bool	IsPausedManually () const
bool	IsPlaying () const
void	NotifyPlaybackData ()
CRIWARECORE_API void	SetFilterFrequency ()
void	SetPauseByGame (bool bInIsPauseByGame)
void	SetPauseManually (bool bInIsPauseManually)
void	SetVirtual ()
CRIWARECORE_API void	UpdateStereoEmitterPositions ()
Public 成员函数 继承自 Atom::ISourceListener
virtual	~ISourceListener ()=default

Private 属性
FCriAtomExPlayerPtr	TempExternalExPlayer

额外继承的成员函数
Protected 类型 继承自 Atom::FMixerSource
enum	EFreeReason { Deleter , Stop , Error }
Protected 成员函数 继承自 Atom::FAtomExPlayback
void	AttachAisacPatches ()
bool	ComputeChannelMap (const int32 NumSourceChannels)
bool	ComputeMonoChannelMap ()
bool	ComputeStereoChannelMap ()
void	DetachAisacPatches ()
virtual void	FreeResources (EFreeReason InReason) override
bool	LoadSoundInternal (FAtomPlaybackInstance *InPlaybackInstance)
bool	PrepareSoundInternal ()
void	SetCategories ()
void	SetCueFirstBlockIndex ()
void	SetCueSelectorLabels ()
void	SetLooping ()
virtual void	SetupSourceBusData (TArray< FInitAudioBusSend > *OutAudioBusSends=nullptr, bool bEnableBusSends=true) override
void	UnsetCategories ()
void	UpdateBusSends ()
void	UpdateChannelMap ()
void	UpdateCueParameters ()
void	UpdateEffects ()
void	UpdateModulation ()
void	UpdatePitch ()
void	UpdateSourceBusSends ()
void	UpdateSpatialization ()
void	UpdateVolume ()
Protected 成员函数 继承自 Atom::FMixerSource
int64	GetNumFramesPlayed () const
bool	InitSourceVoice (FAtomPlaybackInstance *InPlaybackInstance)
bool	IsUsingObjectBasedSpatialization () const
const TCHAR *	ToString (EFreeReason Value)
bool	UseObjectBasedSpatialization () const
bool	UseSourceDataOverridePlugin () const
Protected 成员函数 继承自 FAtomSource
CRIWARECORE_API float	GetDebugVolume (const float InVolume)
CRIWARECORE_API void	InitCommon ()
CRIWARECORE_API void	UpdateCommon ()
void	UpdatePause ()
Protected 属性 继承自 Atom::FAtomExPlayback
TSharedPtr< FAtomExPlaybackListener, ESPMode::ThreadSafe >	AtomListener
uint32	bAttenuationReady: 1
uint32	bDebugMode: 1
uint32	bIs3D: 1
FThreadSafeBool	bIsExternal
FThreadSafeBool	bIsLoadingResource
FThreadSafeBool	bIsPrepareFailed
FThreadSafeBool	bIsPreparingForInit
FThreadSafeBool	bIsPreparingPlayer
FThreadSafeBool	bIsStopping
uint32	bPreviousBaseRackEnablement: 1
uint32	bPreviousSourceBusEnablement: 1
uint32	bSendingAudioToSourceBuses: 1
TSharedPtr< FAtomBeatSyncInfo, ESPMode::ThreadSafe >	CueBeatSyncInfo
TArray< FDynamicSourceBusSendInfo >	DynamicSourceBusSendInfos
friend	FAtomExPlaybackListener
EAtomExPlaybackInitializationState	InitializationState
TSharedRef< FAtomExPlayer, ESPMode::ThreadSafe >	MixerPlayer
FAtomPlaybackId	PlaybackID
float	PreviousAzimuth
TArray< FAtomSoundToBusSend >	PreviousBusSendSettings
int32	PreviousCueNextBlockIndex
TArray< FAtomSelectorParam >	PreviousCueSelectorParams
float	PreviousPlaybackPercent
CriAtomExPlaybackStatus	Status
Protected 属性 继承自 Atom::FMixerSource
bool	bDebugMode = false
FMixerSourcePlayer	MixerSourcePlayer
FMixerSourceVoice *	MixerSourceVoice = nullptr
Protected 属性 继承自 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

详细描述

FAtomExternalExPlayback class

Class which implements a mixer sound source object using an external AtomExPlayer.

构造及析构函数说明

FAtomExternalExPlayback()

Atom::FAtomExternalExPlayback::FAtomExternalExPlayback	(	FAtomRuntime *	InAtomRuntime,
		FCriAtomExPlayerPtr &&	InExternalExPlayer )

~FAtomExternalExPlayback()

Atom::FAtomExternalExPlayback::~FAtomExternalExPlayback

(

)

成员函数说明

Describe()

virtual FString Atom::FAtomExternalExPlayback::Describe ( bool bUseLongName )

inlineoverridevirtual

Returns a string describing the source (subclass can override, but it should call the base and append).

重载 Atom::FAtomExPlayback .

IsVoiceSource()

virtual bool Atom::FAtomExternalExPlayback::IsVoiceSource ( ) const

inlineoverridevirtual

重载 Atom::FAtomExPlayback .

PrepareForInitialization()

bool Atom::FAtomExternalExPlayback::PrepareForInitialization ( FAtomPlaybackInstance * InPlaybackInstance )

overridevirtual

Prepares the source for initialization.

重载 Atom::FAtomExPlayback .

类成员变量说明

TempExternalExPlayer

FCriAtomExPlayerPtr Atom::FAtomExternalExPlayback::TempExternalExPlayer

private

---

该类的文档由以下文件生成:

• 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