Atom::FAtomPlayer Class Reference

#include <AtomMixerSource.h>

Inheritance diagram for Atom::FAtomPlayer:

Public Member Functions
	FAtomPlayer (FAtomRuntime *InAtomRuntime)
	~FAtomPlayer ()
FString	Describe (bool bUseLongName) override
void *	GetNativeHandle () const override
void	HandleNativePlayerOnPcmDecode (CriAtomPcmFormat Format, CriSint32 NumChannels, CriSint32 NumSamples, void *Data[])
bool	Init (FAtomPlaybackInstance *InPlaybackInstance) override
bool	IsFinished () override
bool	IsPreparedToInit () override
bool	IsStopping () override
bool	IsVoiceSource () const override
void	Pause () override
void	Play () override
bool	PrepareForInitialization (FAtomPlaybackInstance *InPlaybackInstance) override
void	Stop () override
void	StopNow () override
void	Update () override
Public Member Functions inherited from FAtomSource
CRIWARECORE_API	FAtomSource (FAtomRuntime *InAtomRuntime)
virtual CRIWARECORE_API	~FAtomSource ()=0
CRIWARECORE_API void	GetChannelLocations (FVector &Left, FVector &Right) const
virtual CRIWARECORE_API float	GetEnvelopeValue () const
const FAtomPlaybackInstance *	GetPlaybackInstance () const
virtual CRIWARECORE_API float	GetPlaybackPercent () 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 ()

Protected Member Functions
void	FreeResources ()
bool	IsPlaybackFinished ()
void	UpdateVolume ()
Protected Member Functions inherited from FAtomSource
CRIWARECORE_API float	GetDebugVolume (const float InVolume)
CRIWARECORE_API void	InitCommon ()
CRIWARECORE_API void	UpdateCommon ()
void	UpdatePause ()

Protected Attributes
FThreadSafeBool	bIsLoadingResource
FThreadSafeBool	bIsPrepareFailed
FThreadSafeBool	bIsPreparingForInit
FThreadSafeBool	bIsPreparingPlayer
FThreadSafeBool	bIsStopping
FGraphEventRef	CreatePlayerTask
FCriAtomPlayerPtr	Player
CriAtomPlayerStatus	Status
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

FAtomPlayer class

Class which implements a simplest sound source object using an Atom Player (CriAtomPlayer is a voice by itself).

Constructor & Destructor Documentation

FAtomPlayer()

Atom::FAtomPlayer::FAtomPlayer

(

FAtomRuntime *

InAtomRuntime

)

~FAtomPlayer()

Atom::FAtomPlayer::~FAtomPlayer

(

)

Member Function Documentation

Describe()

FString Atom::FAtomPlayer::Describe ( bool bUseLongName )

inlineoverridevirtual

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

Reimplemented from FAtomSource.

FreeResources()

void Atom::FAtomPlayer::FreeResources ( )

protected

GetNativeHandle()

void * Atom::FAtomPlayer::GetNativeHandle ( ) const

inlineoverridevirtual

Implements FAtomSource.

HandleNativePlayerOnPcmDecode()

void Atom::FAtomPlayer::HandleNativePlayerOnPcmDecode	(	CriAtomPcmFormat	Format,
		CriSint32	NumChannels,
		CriSint32	NumSamples,
		void *	Data[] )

Init()

bool Atom::FAtomPlayer::Init ( FAtomPlaybackInstance * InPlaybackInstance )

overridevirtual

Initializes the Atom source.

Implements FAtomSource.

IsFinished()

bool Atom::FAtomPlayer::IsFinished ( )

overridevirtual

Returns true if the sound source has finished playing.

Implements FAtomSource.

IsPlaybackFinished()

bool Atom::FAtomPlayer::IsPlaybackFinished ( )

protected

IsPreparedToInit()

bool Atom::FAtomPlayer::IsPreparedToInit ( )

overridevirtual

Returns if the source is prepared to initialize.

Reimplemented from FAtomSource.

IsStopping()

bool Atom::FAtomPlayer::IsStopping ( )

overridevirtual

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

Reimplemented from FAtomSource.

IsVoiceSource()

bool Atom::FAtomPlayer::IsVoiceSource ( ) const

inlineoverridevirtual

Reimplemented from FAtomSource.

Pause()

void Atom::FAtomPlayer::Pause ( )

overridevirtual

Pauses the sound source.

Implements FAtomSource.

Play()

void Atom::FAtomPlayer::Play ( )

overridevirtual

Plays the sound source.

Implements FAtomSource.

PrepareForInitialization()

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

overridevirtual

Prepares the source for initialization.

Reimplemented from FAtomSource.

Stop()

void Atom::FAtomPlayer::Stop ( )

overridevirtual

Stops the sound source.

Reimplemented from FAtomSource.

StopNow()

void Atom::FAtomPlayer::StopNow ( )

overridevirtual

Reimplemented from FAtomSource.

Update()

void Atom::FAtomPlayer::Update ( )

overridevirtual

Updates the sound source.

Implements FAtomSource.

UpdateVolume()

void Atom::FAtomPlayer::UpdateVolume ( )

protected

Updates the volume parameter set from the game thread.

Member Data Documentation

bIsLoadingResource

FThreadSafeBool Atom::FAtomPlayer::bIsLoadingResource

protected

bIsPrepareFailed

FThreadSafeBool Atom::FAtomPlayer::bIsPrepareFailed

protected

bIsPreparingForInit

FThreadSafeBool Atom::FAtomPlayer::bIsPreparingForInit

protected

bIsPreparingPlayer

FThreadSafeBool Atom::FAtomPlayer::bIsPreparingPlayer

protected

bIsStopping

FThreadSafeBool Atom::FAtomPlayer::bIsStopping

protected

CreatePlayerTask

FGraphEventRef Atom::FAtomPlayer::CreatePlayerTask

protected

Task used to create player.

Player

FCriAtomPlayerPtr Atom::FAtomPlayer::Player

protected

Status

CriAtomPlayerStatus Atom::FAtomPlayer::Status

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