#include <AtomMixerSource.h>

类 Atom::FAtomPlayer 继承关系图:

Public 成员函数
	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 成员函数继承自 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 成员函数
void	FreeResources ()
bool	IsPlaybackFinished ()
void	UpdateVolume ()
Protected 成员函数继承自 FAtomSource
CRIWARECORE_API float	GetDebugVolume (const float InVolume)
CRIWARECORE_API void	InitCommon ()
CRIWARECORE_API void	UpdateCommon ()
void	UpdatePause ()

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

详细描述

FAtomPlayer class

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

构造及析构函数说明

◆ FAtomPlayer()

Atom::FAtomPlayer::FAtomPlayer ( FAtomRuntime * InAtomRuntime )

◆ ~FAtomPlayer()

Atom::FAtomPlayer::~FAtomPlayer ( )

成员函数说明

◆ 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).

重载 FAtomSource .

◆ FreeResources()

void Atom::FAtomPlayer::FreeResources ( )

protected

◆ GetNativeHandle()

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

inlineoverridevirtual

实现了 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.

实现了 FAtomSource.

◆ IsFinished()

bool Atom::FAtomPlayer::IsFinished ( )

overridevirtual

Returns true if the sound source has finished playing.

实现了 FAtomSource.

◆ IsPlaybackFinished()

bool Atom::FAtomPlayer::IsPlaybackFinished ( )

protected

◆ IsPreparedToInit()

bool Atom::FAtomPlayer::IsPreparedToInit ( )

overridevirtual

Returns if the source is prepared to initialize.

重载 FAtomSource .

◆ IsStopping()

bool Atom::FAtomPlayer::IsStopping ( )

overridevirtual

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

重载 FAtomSource .

◆ IsVoiceSource()

bool Atom::FAtomPlayer::IsVoiceSource ( ) const

inlineoverridevirtual

重载 FAtomSource .

◆ Pause()

void Atom::FAtomPlayer::Pause ( )

overridevirtual

Pauses the sound source.

实现了 FAtomSource.

◆ Play()

void Atom::FAtomPlayer::Play ( )

overridevirtual

Plays the sound source.

实现了 FAtomSource.

◆ PrepareForInitialization()

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

overridevirtual

Prepares the source for initialization.

重载 FAtomSource .

◆ Stop()

void Atom::FAtomPlayer::Stop ( )

overridevirtual

Stops the sound source.

重载 FAtomSource .

◆ StopNow()

void Atom::FAtomPlayer::StopNow ( )

overridevirtual

重载 FAtomSource .

◆ Update()

void Atom::FAtomPlayer::Update ( )

overridevirtual

Updates the sound source.

实现了 FAtomSource.

◆ UpdateVolume()

void Atom::FAtomPlayer::UpdateVolume ( )

protected

Updates the volume parameter set from the game thread.

类成员变量说明

◆ 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

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

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

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ FAtomPlayer()

◆ ~FAtomPlayer()

成员函数说明

◆ Describe()

◆ FreeResources()

◆ GetNativeHandle()

◆ HandleNativePlayerOnPcmDecode()

◆ Init()

◆ IsFinished()

◆ IsPlaybackFinished()

◆ IsPreparedToInit()

◆ IsStopping()

◆ IsVoiceSource()

◆ Pause()

◆ Play()

◆ PrepareForInitialization()

◆ Stop()

◆ StopNow()

◆ Update()

◆ UpdateVolume()

类成员变量说明

◆ bIsLoadingResource

◆ bIsPrepareFailed

◆ bIsPreparingForInit

◆ bIsPreparingPlayer

◆ bIsStopping

◆ CreatePlayerTask

◆ Player

◆ Status