FAtomSource类 参考

#include <Atom.h>

类 FAtomSource 继承关系图:

Public 成员函数
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 ()

Protected 成员函数
CRIWARECORE_API float	GetDebugVolume (const float InVolume)
CRIWARECORE_API void	InitCommon ()
virtual void	Pause ()=0
CRIWARECORE_API void	UpdateCommon ()
void	UpdatePause ()

Protected 属性
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

详细描述

This represent a Voice

Note: AtomExPlayer starts and stops mutiples voices, so it represnted also as a single playback voice in Unreal. but it can add playback voices.

构造及析构函数说明

FAtomSource()

CRIWARECORE_API FAtomSource::FAtomSource ( FAtomRuntime * InAtomRuntime )

inline

~FAtomSource()

FAtomSource::~FAtomSource ( )

pure virtual

成员函数说明

Describe()

FString FAtomSource::Describe ( bool bUseLongName )

virtual

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

被 Atom::FAtomExPlayback, Atom::FAtomExternalExPlayback , 以及 Atom::FAtomPlayer 重载.

GetChannelLocations()

void FAtomSource::GetChannelLocations	(	FVector &	Left,
		FVector &	Right ) const

GetDebugVolume()

float FAtomSource::GetDebugVolume ( const float InVolume )

protected

Returns the volume of the sound source after evaluating debug commands

GetEnvelopeValue()

virtual CRIWARECORE_API float FAtomSource::GetEnvelopeValue ( ) const

inlinevirtual

Returns the source's envelope at the callback block rate. Only implemented in audio mixer.

被 Atom::FAtomExPlayback 重载.

GetNativeHandle()

virtual void * FAtomSource::GetNativeHandle ( ) const

pure virtual

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

GetPlaybackInstance()

const FAtomPlaybackInstance * FAtomSource::GetPlaybackInstance ( ) const

inline

Returns the playback instance of this sound source.

GetPlaybackPercent()

float FAtomSource::GetPlaybackPercent ( ) const

virtual

Returns the source's playback percent.

被 Atom::FAtomExPlayback 重载.

GetSpatializationParams()

FAtomSpatializationParams FAtomSource::GetSpatializationParams

(

)

Gets parameters necessary for computing 3d spatialization of sources.

GetWaveInfo()

const FAtomWaveInfo & FAtomSource::GetWaveInfo ( ) const

inline

Init()

virtual bool FAtomSource::Init ( FAtomPlaybackInstance * InPlaybackInstance )

pure virtual

Initializes the Atom source.

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

InitCommon()

void FAtomSource::InitCommon ( )

protected

Initializes common data for all sound source types.

IsFinished()

virtual bool FAtomSource::IsFinished ( )

pure virtual

Returns true if the sound source has finished playing.

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

IsGameOnly()

bool FAtomSource::IsGameOnly

(

)

const

Returns source is an in-game only. Will pause when in UI.

IsInitialized()

virtual bool FAtomSource::IsInitialized ( ) const

inlinevirtual

Returns whether or not the sound source has initialized.

IsPaused()

bool FAtomSource::IsPaused ( ) const

inline

Returns true if the sound is paused.

IsPausedByGame()

bool FAtomSource::IsPausedByGame ( ) const

inline

Returns true if the sound is paused by game pause.

IsPausedManually()

bool FAtomSource::IsPausedManually ( ) const

inline

Returns true if the sound is paused manually.

IsPlaying()

bool FAtomSource::IsPlaying ( ) const

inline

Returns whether or not the sound source is playing.

IsPreparedToInit()

virtual bool FAtomSource::IsPreparedToInit ( )

inlinevirtual

Returns if the source is prepared to initialize.

被 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 重载.

IsStopping()

virtual bool FAtomSource::IsStopping ( )

inlinevirtual

Whether or not the source is stopping. Only implemented in audio mixer.

被 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 重载.

IsVoiceSource()

virtual bool FAtomSource::IsVoiceSource ( ) const

inlinevirtual

被 Atom::FAtomExPlayback, Atom::FAtomExternalExPlayback , 以及 Atom::FAtomPlayer 重载.

NotifyPlaybackData()

void FAtomSource::NotifyPlaybackData

(

)

Pause()

virtual void FAtomSource::Pause ( )

protectedpure virtual

Pauses the sound source.

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

Play()

virtual void FAtomSource::Play ( )

pure virtual

Plays the sound source.

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

PrepareForInitialization()

virtual bool FAtomSource::PrepareForInitialization ( FAtomPlaybackInstance * InPlaybackInstance )

inlinevirtual

Prepares the source for initialization.

被 Atom::FAtomExPlayback, Atom::FAtomExternalExPlayback , 以及 Atom::FAtomPlayer 重载.

SetFilterFrequency()

void FAtomSource::SetFilterFrequency

(

)

Returns true if reverb should be applied. Set the bReverbApplied variable. Updates and sets the LFEBleed variable. Updates the FilterFrequency value.

SetPauseByGame()

void FAtomSource::SetPauseByGame

(

bool

bInIsPauseByGame

)

Pause the source from game pause

SetPauseManually()

void FAtomSource::SetPauseManually

(

bool

bInIsPauseManually

)

Pause the source manually

SetVirtual()

void FAtomSource::SetVirtual ( )

inline

Returns the contained sound buffer object. Initializes any source effects for this sound source. Sets if this voice is virtual.

Stop()

void FAtomSource::Stop ( )

virtual

Stops the sound source.

被 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 重载.

StopNow()

virtual CRIWARECORE_API void FAtomSource::StopNow ( )

inlinevirtual

被 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 重载.

Update()

virtual void FAtomSource::Update ( )

pure virtual

Updates the sound source.

在 Atom::FAtomExPlayback , 以及 Atom::FAtomPlayer 内被实现.

UpdateCommon()

void FAtomSource::UpdateCommon ( )

protected

Updates common data for all sound source types.

UpdatePause()

void FAtomSource::UpdatePause ( )

protected

Updates this source's pause state

UpdateStereoEmitterPositions()

void FAtomSource::UpdateStereoEmitterPositions

(

)

Updates the stereo emitter positions of this voice.

类成员变量说明

AtomRuntime

FAtomRuntime* FAtomSource::AtomRuntime

protected

Owning Atom runtime.

bIsInitialized

uint8 FAtomSource::bIsInitialized

protected

Whether or not the sound source is initialized.

bIsManuallyPaused

uint8 FAtomSource::bIsManuallyPaused

protected

Whether or not we were paused manually.

bIsPaused

uint8 FAtomSource::bIsPaused

protected

Whether or not we are actually paused.

bIsPausedByGame

uint8 FAtomSource::bIsPausedByGame

protected

Cached sound mode value used to detect when to switch outputs. Whether we are paused by game state or not.

bIsPlaying

FThreadSafeBool FAtomSource::bIsPlaying

protected

Effect ID of this sound source in the audio device sound source array. Whether we are playing or not.

bIsPreviewSound

uint8 FAtomSource::bIsPreviewSound

protected

Whether or not the sound is a preview sound.

bIsVirtual

uint32 FAtomSource::bIsVirtual

protected

True if this isn't a real hardware voice.

FAtomActiveSound

friend FAtomSource::FAtomActiveSound

protected

FAtomRuntime

friend FAtomSource::FAtomRuntime

protected

HPFFrequency

float FAtomSource::HPFFrequency

protected

What frequency to set the HPF filter to. Note this could be caused by HPF distance attenuation.

LastHeardUpdate

int32 FAtomSource::LastHeardUpdate

protected

Last tick when this source was active and had a hearable volume

LastHPFFrequency

float FAtomSource::LastHPFFrequency

protected

The last HPF frequency set. Used to avoid making API calls when parameter doesn't changing.

LastLPFFrequency

float FAtomSource::LastLPFFrequency

protected

The last LPF frequency set. Used to avoid making API calls when parameter doesn't changing.

LastUpdate

int32 FAtomSource::LastUpdate

protected

Last tick when this source was active

LeftChannelSourceLocation

FVector FAtomSource::LeftChannelSourceLocation

protected

The location of the left-channel source for stereo spatialization.

LPFFrequency

float FAtomSource::LPFFrequency

protected

Cached sound buffer associated with currently bound wave instance. The amount of a sound to bleed to the LFE speaker What frequency to set the LPF filter to. Note this could be caused by occlusion, manual LPF application, or LPF distance attenuation.

NumFramesPlayed

int32 FAtomSource::NumFramesPlayed

protected

The number of frames (Samples / NumChannels) played by the sound source.

NumTotalFrames

int32 FAtomSource::NumTotalFrames

protected

The total number of frames of audio for the sound wave

Pitch

float FAtomSource::Pitch

protected

The pitch of the sound source.

PlaybackInstance

FAtomPlaybackInstance* FAtomSource::PlaybackInstance

protected

Contained playback instance.

PlaybackTime

float FAtomSource::PlaybackTime

protected

The virtual current playback time. Used to trigger notifications when finished.

RightChannelSourceLocation

FVector FAtomSource::RightChannelSourceLocation

protected

The location of the right-channel source for stereo spatialization.

StartFrame

int32 FAtomSource::StartFrame

protected

The frame we started on.

TickCount

int32 FAtomSource::TickCount

protected

Update tick count. Used to stop oldest stopping sound source.

WaveInfo

FAtomWaveInfo FAtomSource::WaveInfo

protected

---

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

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Atom.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Atom.cpp