IMediaClock Class Reference

#include <IMediaClock.h>

Inheritance diagram for IMediaClock:

Public Member Functions
virtual FTimespan	GetTimecode () const =0
virtual bool	IsTimecodeLocked () const =0
virtual void	AddSink (const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &Sink)=0
virtual void	RemoveSink (const TSharedRef< IMediaClockSink, ESPMode::ThreadSafe > &Sink)=0
virtual	~IMediaClock ()

Detailed Description

Interface for media framework clocks.

Constructor & Destructor Documentation

~IMediaClock()

virtual IMediaClock::~IMediaClock ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

AddSink()

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

pure virtual

Add a media clock sink.

Parameters

Sink	The sink object to add.

See also

RemoveSink

Implemented in FMediaClock.

GetTimecode()

virtual FTimespan IMediaClock::GetTimecode ( ) const

pure virtual

Get the clock's current time code.

Returns

Time code.

See also

IsTimecodeLocked

Implemented in FMediaClock.

IsTimecodeLocked()

virtual bool IMediaClock::IsTimecodeLocked ( ) const

pure virtual

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

Returns

true if locked, false otherwise.

See also

GetTimecode

Implemented in FMediaClock.

RemoveSink()

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

pure virtual

Remove a media clock sink.

Parameters

Sink	The sink object to remove.

See also

AddSink

Implemented in FMediaClock.

---

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

• Engine/Source/Runtime/Media/Public/IMediaClock.h