FMediaClock Class Reference

#include <MediaClock.h>

Inheritance diagram for FMediaClock:

Public Member Functions
	FMediaClock ()
void	TickInput ()
void	TickOutput ()
void	TickRender ()
void	TickFetch ()
void	UpdateTimecode (const FTimespan NewTimecode, bool NewTimecodeLocked)
virtual void	AddSink (const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &Sink) override
virtual FTimespan	GetTimecode () const override
virtual bool	IsTimecodeLocked () const override
virtual void	RemoveSink (const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &Sink) override
Public Member Functions inherited from IMediaClock
virtual	~IMediaClock ()

Detailed Description

Implements the media clock.

Constructor & Destructor Documentation

FMediaClock()

FMediaClock::FMediaClock

(

)

Default constructor.

Member Function Documentation

AddSink()

void FMediaClock::AddSink ( const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &  Sink )

overridevirtual

Add a media clock sink.

Parameters

Sink	The sink object to add.

See also

RemoveSink

Implements IMediaClock.

GetTimecode()

FTimespan FMediaClock::GetTimecode ( ) const

overridevirtual

Get the clock's current time code.

Returns

Time code.

See also

IsTimecodeLocked

Implements IMediaClock.

IsTimecodeLocked()

bool FMediaClock::IsTimecodeLocked ( ) const

overridevirtual

Whether the clock's time code is locked to an external time source.

Returns

true if locked, false otherwise.

See also

GetTimecode

Implements IMediaClock.

RemoveSink()

void FMediaClock::RemoveSink ( const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &  Sink )

overridevirtual

Remove a media clock sink.

Parameters

Sink	The sink object to remove.

See also

AddSink

Implements IMediaClock.

TickFetch()

void FMediaClock::TickFetch

(

)

Tick all clock sinks in the Update stage.

See also

TickInput, TickOutput, TickRender

TickInput()

void FMediaClock::TickInput

(

)

Tick all clock sinks in the Input stage.

See also

TickOutput, TickRender, TickUpdate

TickOutput()

void FMediaClock::TickOutput

(

)

Tick all clock sinks in the Output stage.

See also

TickInput, TickRender, TickUpdate

TickRender()

void FMediaClock::TickRender

(

)

Tick all clock sinks in the Render stage.

See also

TickInput, TickOutput, TickUpdate

UpdateTimecode()

void FMediaClock::UpdateTimecode	(	const FTimespan	NewTimecode,
		bool	NewTimecodeLocked
	)

Update the current time code.

Parameters

NewTimecode	The new time code.
NewTimecodeLocked	Whether media objects should lock to the time code.

---

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

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