Navigation
API > API/Runtime > API/Runtime/Media
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.
| Name | IMediaClockSink |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaClockSink.h |
| Include Path | #include "IMediaClockSink.h" |
Syntax
class IMediaClockSink
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaClockSink() |
Virtual destructor. | IMediaClockSink.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Called each tick to handle updates after the Engine ticked. | IMediaClockSink.h | ||
| Called each tick to handle input before the Engine is ticked. | IMediaClockSink.h | ||
virtual void TickOutput
(
FTimespan DeltaTime, |
Called each tick to output the rendered frame. | IMediaClockSink.h | |
virtual void TickRender
(
FTimespan DeltaTime, |
Called each tick before the frame finished rendering. | IMediaClockSink.h |