IMediaClockSink Class Reference

#include <IMediaClockSink.h>

Inheritance diagram for IMediaClockSink:

Public Member Functions
virtual void	TickFetch (FTimespan DeltaTime, FTimespan Timecode)
virtual void	TickInput (FTimespan DeltaTime, FTimespan Timecode)
virtual void	TickOutput (FTimespan DeltaTime, FTimespan Timecode)
virtual void	TickRender (FTimespan DeltaTime, FTimespan Timecode)
virtual	~IMediaClockSink ()

Detailed Description

Interface for media clock sinks.

This interface can be implemented by classes that wish to be ticked by the Media Framework clock. The following tick stages are available (in the order in which they are called on clock sinks):

TickInput Called each tick from the main thread before the Engine is being ticked. It is used by media player plug-ins to update their state and initiate the reading of new input samples.

TickFetch Called each tick from the main thread after the Engine has been ticked, but before TickRender. It can be used by media players to fetch the results of the TickInput stage prior to rendering.

TickRender Called each tick from the main thread after TickFetch is complete, but before the frame has finished rendering. It is mainly used by media sinks to render the fetched input samples, such as drawing video frames to a texture or playing audio samples on a sound component.

TickOutput Called each tick from the main thread after the Engine has been ticked and the frame finished rendering. It can be used by output plug-ins to write the completed frame to disk or stream it over the network.

Constructor & Destructor Documentation

~IMediaClockSink()

virtual IMediaClockSink::~IMediaClockSink ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

TickFetch()

virtual void IMediaClockSink::TickFetch ( FTimespan  DeltaTime, FTimespan  Timecode  )

inlinevirtual

Called each tick to handle updates after the Engine ticked.

Parameters

DeltaTime	Time since this function was last called.
Timecode	The current media time code.

See also

TickInput, TickOutput, TickRender

Reimplemented in FMediaPlayerFacade.

TickInput()

virtual void IMediaClockSink::TickInput ( FTimespan  DeltaTime, FTimespan  Timecode  )

inlinevirtual

Called each tick to handle input before the Engine is ticked.

Parameters

DeltaTime	Time since this function was last called.
Timecode	The current media time code.

See also

TickFetch, TickOutput, TickRender

Reimplemented in FMediaSoundComponentClockSink, and FMediaPlayerFacade.

TickOutput()

virtual void IMediaClockSink::TickOutput ( FTimespan  DeltaTime, FTimespan  Timecode  )

inlinevirtual

Called each tick to output the rendered frame.

Parameters

DeltaTime	Time since this function was last called.
Timecode	The current media time code.

See also

TickFetch, TickInput, TickRender

Reimplemented in FMediaRecorderClockSink, and FMediaPlayerFacade.

TickRender()

virtual void IMediaClockSink::TickRender ( FTimespan  DeltaTime, FTimespan  Timecode  )

inlinevirtual

Called each tick before the frame finished rendering.

Parameters

DeltaTime	Time since this function was last called.
Timecode	The current media time code.

See also

TickFetch, TickInput, TickOutput

Reimplemented in FMediaTextureClockSink.

---

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

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