FMediaTicker Class Reference

#include <MediaTicker.h>

Inheritance diagram for FMediaTicker:

Public Member Functions
	FMediaTicker ()
virtual	~FMediaTicker ()
virtual bool	Init () override
virtual uint32	Run () override
virtual void	Stop () override
virtual void	Exit () override
virtual void	AddTickable (const TSharedRef< IMediaTickable, ESPMode::ThreadSafe > &Tickable) override
virtual void	RemoveTickable (const TSharedRef< IMediaTickable, ESPMode::ThreadSafe > &Tickable) override
Public Member Functions inherited from FRunnable
virtual class FSingleThreadRunnable *	GetSingleThreadInterface ()
virtual	~FRunnable ()
Public Member Functions inherited from IMediaTicker
virtual	~IMediaTicker ()

Protected Member Functions
void	TickTickables ()

Detailed Description

High frequency ticker thread.

Constructor & Destructor Documentation

FMediaTicker()

FMediaTicker::FMediaTicker

(

)

Default constructor.

~FMediaTicker()

FMediaTicker::~FMediaTicker ( )

virtual

Virtual destructor.

Member Function Documentation

AddTickable()

void FMediaTicker::AddTickable ( const TSharedRef< IMediaTickable, ESPMode::ThreadSafe > &  Tickable )

overridevirtual

Add a media tickable object.

Parameters

Tickable

The object to register.

See also

UnregisterTickable

Implements IMediaTicker.

Exit()

void FMediaTicker::Exit ( void  )

overridevirtual

Exits the runnable object.

Called in the context of the aggregating thread to perform any cleanup.

See also

Init, Run, Stop

Reimplemented from FRunnable.

Init()

bool FMediaTicker::Init ( void  )

overridevirtual

Initializes the runnable object.

This method is called in the context of the thread object that aggregates this, not the thread that passes this runnable to a new thread.

Returns

True if initialization was successful, false otherwise

See also

Run, Stop, Exit

Reimplemented from FRunnable.

RemoveTickable()

void FMediaTicker::RemoveTickable ( const TSharedRef< IMediaTickable, ESPMode::ThreadSafe > &  Tickable )

overridevirtual

Remove a media tickable object.

Parameters

Tickable

The object to register.

See also

RegisterTickable

Implements IMediaTicker.

Run()

uint32 FMediaTicker::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

Implements FRunnable.

Stop()

void FMediaTicker::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.

TickTickables()

void FMediaTicker::TickTickables ( )

protected

Tick all tickables.

---

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

• Engine/Source/Runtime/Media/Private/MediaTicker.h
• Engine/Source/Runtime/Media/Private/MediaTicker.cpp