Atom::FAtomExPlayer クラス

#include <AtomMixerPlayer.h>

クラス
struct	FPlaybackEventInfo
struct	IPlaybackListener

公開メンバ関数
	FAtomExPlayer ()
	FAtomExPlayer (const FAtomExPlayerArgs &InArgs, FCriAtomExPlayerPtr &&ExternalPlayer=FCriAtomExPlayerPtr())
	~FAtomExPlayer ()
void	EnablePcmFilter (bool bEnable)
FAtomRuntime *	GetAtomRuntime () const
void *	GetNativeHandle () const
void	HandleNativeOnCueBlockIndexChanged (CriAtomExPlaybackId PlaybackID, CriAtomExBlockIndex BlockIndex)
void	HandleNativeOnPlaybackEvent (CriAtomExPlaybackEvent PlaybackEvent, const CriAtomExPlaybackInfoDetail *Info)
void	HandleNativePlayerOnFilter (CriAtomExPlaybackId PlaybackID, CriAtomPcmFormat Format, CriSint32 NumChannels, CriSint32 NumFrames, void *Data[])
bool	IsExternal () const
bool	IsInitialized () const
void	Pause (FAtomPlaybackId PlaybackID)
FAtomPlaybackId	Prepare ()
void	RegisterPlaybackListener (TSharedRef< IPlaybackListener > PlaybackListener, FAtomPlaybackId PlaybackID)
void	ResetSpatialization (const FAtomPlaybackInstance &PlaybackInstance)
void	Resume (FAtomPlaybackId PlaybackID)
void	Stop (FAtomPlaybackId PlaybackID)
void	StopWithoutReleaseTime (FAtomPlaybackId PlaybackID)
void	UnregisterPlaybackListener (FAtomPlaybackId PlaybackID)
bool	Update ()
void	UpdateParameters (FAtomPlaybackId PlaybackID)
bool	UpdateSpatialization (const FAtomPlaybackInstance &PlaybackInstance)

静的公開メンバ関数
static TSharedPtr< FAtomExPlayer, ESPMode::ThreadSafe >	Create (const FAtomExPlayerArgs &Args)
static TSharedPtr< FAtomExPlayer, ESPMode::ThreadSafe >	CreateWithExternalPlayer (const FAtomExPlayerArgs &Args, FCriAtomExPlayerPtr &&ExternalPlayer)
static void	GetPlaybackInfo (FAtomPlaybackInstance *PlaybackInstance, FAtomPlaybackId PlaybackID)

非公開メンバ関数
void	AddSpatialization (const FAtomPlaybackInstance &PlaybackInstance)
void	ProcessEvent (FPlaybackEventInfo EventInfo)
void	RemoveSpatialization ()
void	Update3DSource (FCriAtomExSourcePtr &InExSource, const FTransform &InTransform, const FAtomAttenuationSettings *InAttenuationSettings=nullptr, bool bSpatialize=false, bool bForceAttenuate=false)

非公開変数類
FAtomActiveSound *	ActiveSound
FAtomRuntime *	AtomRuntime
uint8	bIs3D: 1
FThreadSafeBool	bIsExternal
uint8	bIsInitialized: 1
uint8	bUsePcmFilter: 1
FCriAtomExPlayerPtr	ExPlayer
FCriAtomExSourcePtr	ExSource
FCriAtomExSourceListPtr	ExSourceList
TArray< FCriAtomExSourcePtr >	ExSources
friend	FAtomExPlayback
TMap< FAtomPlaybackId, TSharedRef< IPlaybackListener > >	PlaybackListeners
FCriticalSection	PlaybackListenersLock
TSharedPtr< FAtomExPlayerGroup >	PlayerGroup
FCriticalSection	PlayerLock
TQueue< FPlaybackEventInfo, EQueueMode::Mpsc >	QueuedEvents
CriAtomExPlayerStatus	Status

詳解

FAtomExPlayer class

Class which implements a mixer sound source controller object using for Playback Instancing.

構築子と解体子

FAtomExPlayer() [1/2]

Atom::FAtomExPlayer::FAtomExPlayer

(

)

Constructors.

FAtomExPlayer() [2/2]

Atom::FAtomExPlayer::FAtomExPlayer	(	const FAtomExPlayerArgs &	InArgs,
		FCriAtomExPlayerPtr &&	ExternalPlayer = FCriAtomExPlayerPtr() )

~FAtomExPlayer()

Atom::FAtomExPlayer::~FAtomExPlayer

(

)

Destructor.

関数詳解

AddSpatialization()

void Atom::FAtomExPlayer::AddSpatialization ( const FAtomPlaybackInstance & PlaybackInstance )

private

Create()

TSharedPtr< FAtomExPlayer, ESPMode::ThreadSafe > Atom::FAtomExPlayer::Create ( const FAtomExPlayerArgs & Args )

static

CreateWithExternalPlayer()

TSharedPtr< FAtomExPlayer, ESPMode::ThreadSafe > Atom::FAtomExPlayer::CreateWithExternalPlayer ( const FAtomExPlayerArgs & Args, FCriAtomExPlayerPtr && ExternalPlayer )

static

EnablePcmFilter()

void Atom::FAtomExPlayer::EnablePcmFilter

(

bool

bEnable

)

GetAtomRuntime()

FAtomRuntime * Atom::FAtomExPlayer::GetAtomRuntime ( ) const

inline

GetNativeHandle()

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

inline

GetPlaybackInfo()

void Atom::FAtomExPlayer::GetPlaybackInfo ( FAtomPlaybackInstance * PlaybackInstance, FAtomPlaybackId PlaybackID )

static

HandleNativeOnCueBlockIndexChanged()

void Atom::FAtomExPlayer::HandleNativeOnCueBlockIndexChanged	(	CriAtomExPlaybackId	PlaybackID,
		CriAtomExBlockIndex	BlockIndex )

HandleNativeOnPlaybackEvent()

void Atom::FAtomExPlayer::HandleNativeOnPlaybackEvent	(	CriAtomExPlaybackEvent	PlaybackEvent,
		const CriAtomExPlaybackInfoDetail *	Info )

HandleNativePlayerOnFilter()

void Atom::FAtomExPlayer::HandleNativePlayerOnFilter	(	CriAtomExPlaybackId	PlaybackID,
		CriAtomPcmFormat	Format,
		CriSint32	NumChannels,
		CriSint32	NumFrames,
		void *	Data[] )

IsExternal()

bool Atom::FAtomExPlayer::IsExternal ( ) const

inline

IsInitialized()

bool Atom::FAtomExPlayer::IsInitialized ( ) const

inline

Pause()

void Atom::FAtomExPlayer::Pause

(

FAtomPlaybackId

PlaybackID

)

Prepare()

FAtomPlaybackId Atom::FAtomExPlayer::Prepare

(

)

ADX Api wrap

ProcessEvent()

void Atom::FAtomExPlayer::ProcessEvent ( FPlaybackEventInfo EventInfo )

private

RegisterPlaybackListener()

void Atom::FAtomExPlayer::RegisterPlaybackListener	(	TSharedRef< IPlaybackListener >	PlaybackListener,
		FAtomPlaybackId	PlaybackID )

RemoveSpatialization()

void Atom::FAtomExPlayer::RemoveSpatialization ( )

private

ResetSpatialization()

void Atom::FAtomExPlayer::ResetSpatialization

(

const FAtomPlaybackInstance &

PlaybackInstance

)

Resume()

void Atom::FAtomExPlayer::Resume

(

FAtomPlaybackId

PlaybackID

)

Stop()

void Atom::FAtomExPlayer::Stop

(

FAtomPlaybackId

PlaybackID

)

StopWithoutReleaseTime()

void Atom::FAtomExPlayer::StopWithoutReleaseTime

(

FAtomPlaybackId

PlaybackID

)

UnregisterPlaybackListener()

void Atom::FAtomExPlayer::UnregisterPlaybackListener

(

FAtomPlaybackId

PlaybackID

)

Update()

bool Atom::FAtomExPlayer::Update

(

)

Executes event listener and return true if player is still playing some playback.

Update3DSource()

void Atom::FAtomExPlayer::Update3DSource ( FCriAtomExSourcePtr & InExSource, const FTransform & InTransform, const FAtomAttenuationSettings * InAttenuationSettings = nullptr, bool bSpatialize = false, bool bForceAttenuate = false )

private

UpdateParameters()

void Atom::FAtomExPlayer::UpdateParameters

(

FAtomPlaybackId

PlaybackID

)

UpdateSpatialization()

bool Atom::FAtomExPlayer::UpdateSpatialization

(

const FAtomPlaybackInstance &

PlaybackInstance

)

メンバ詳解

ActiveSound

FAtomActiveSound* Atom::FAtomExPlayer::ActiveSound

private

the linked active sound.

AtomRuntime

FAtomRuntime* Atom::FAtomExPlayer::AtomRuntime

private

the atom runtime.

bIs3D

uint8 Atom::FAtomExPlayer::bIs3D

private

bIsExternal

FThreadSafeBool Atom::FAtomExPlayer::bIsExternal

private

bIsInitialized

uint8 Atom::FAtomExPlayer::bIsInitialized

private

bUsePcmFilter

uint8 Atom::FAtomExPlayer::bUsePcmFilter

private

ExPlayer

FCriAtomExPlayerPtr Atom::FAtomExPlayer::ExPlayer

private

The native AtomEx player handle.

ExSource

FCriAtomExSourcePtr Atom::FAtomExPlayer::ExSource

private

The native AtomEx source handle if 3d sound.

ExSourceList

FCriAtomExSourceListPtr Atom::FAtomExPlayer::ExSourceList

private

The native AtomEx source list handle if using multiple 3d sound positions.

ExSources

TArray<FCriAtomExSourcePtr> Atom::FAtomExPlayer::ExSources

private

The native AtomEx source handles if using multiple 3d sound positions.

FAtomExPlayback

friend Atom::FAtomExPlayer::FAtomExPlayback

private

PlaybackListeners

TMap<FAtomPlaybackId, TSharedRef<IPlaybackListener> > Atom::FAtomExPlayer::PlaybackListeners

private

PlaybackListenersLock

FCriticalSection Atom::FAtomExPlayer::PlaybackListenersLock

private

PlayerGroup

TSharedPtr<FAtomExPlayerGroup> Atom::FAtomExPlayer::PlayerGroup

private

The player group this player is attached.

PlayerLock

FCriticalSection Atom::FAtomExPlayer::PlayerLock

private

the lock for player handle.

QueuedEvents

TQueue<FPlaybackEventInfo, EQueueMode::Mpsc> Atom::FAtomExPlayer::QueuedEvents

private

The playback event queue

Status

CriAtomExPlayerStatus Atom::FAtomExPlayer::Status

private

The native Status of the player.

---

このクラス詳解は次のファイルから抽出されました:

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