Audio::FMixerNullCallback Class Reference

#include <AudioMixerNullDevice.h>

Inheritance diagram for Audio::FMixerNullCallback:

Public Member Functions
AUDIOMIXERCORE_API	FMixerNullCallback (float BufferDuration, TFunction< void()> InCallback, EThreadPriority ThreadPriority=TPri_TimeCritical, bool bStartedPaused=false)
virtual	~FMixerNullCallback ()=default
virtual AUDIOMIXERCORE_API uint32	Run () override
virtual AUDIOMIXERCORE_API void	Stop () override
AUDIOMIXERCORE_API void	Resume (const TFunction< void()> &InCallback, float InBufferDuration)
AUDIOMIXERCORE_API void	Pause ()

Additional Inherited Members
Protected Member Functions inherited from FRunnable
virtual bool	Init ()
virtual void	Exit ()
virtual class FSingleThreadRunnable *	GetSingleThreadInterface ()
virtual	~FRunnable ()

Detailed Description

FMixerNullCallback This class, when started, spawns a new high priority thread that exists to query an FAudioMixerPlatformInterface and immediately throw out whatever buffers it receives.

Constructor & Destructor Documentation

FMixerNullCallback()

Audio::FMixerNullCallback::FMixerNullCallback	(	float	BufferDuration,
		TFunction< void()>	InCallback,
		EThreadPriority	ThreadPriority = TPri_TimeCritical,
		bool	bStartedPaused = false
	)

Constructing the FMixerNullCallback immediately begins calling InCallback every BufferDuration seconds.

~FMixerNullCallback()

virtual Audio::FMixerNullCallback::~FMixerNullCallback ( )

virtualdefault

The destructor waits on Callback to be completed before stopping the thread.

Member Function Documentation

Pause()

void Audio::FMixerNullCallback::Pause

(

)

Resume()

void Audio::FMixerNullCallback::Resume	(	const TFunction< void()> &	InCallback,
		float	InBufferDuration
	)

Run()

uint32 Audio::FMixerNullCallback::Run ( )

overridevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns

The exit code of the runnable object

See also

Init, Stop, Exit

NO_LOGGING

Implements FRunnable.

Stop()

void Audio::FMixerNullCallback::Stop ( void  )

overridevirtual

Stops the runnable object.

This is called if a thread is requested to terminate early.

See also

Init, Run, Exit

Reimplemented from FRunnable.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/AudioMixerCore/Public/AudioMixerNullDevice.h
• Engine/Source/Runtime/AudioMixerCore/Private/AudioMixerNullDevice.cpp