Navigation
API > API/Runtime > API/Runtime/Media
Interface for the Media module.
Media Framework is ticked in several stages. The Input tick happens after the Engine (including Sequencer, game world, and Blueprints) were ticked. This allows any game logic to modify the state of tickable media objects before they fetch input.
The Update tick happens right after the Input tick when all tickable media objects have fetched the latest input based on their current state.
Finally, the Output tick happens after all game and core ticking completed, and after all render commands have been enqueued. It is the very last thing to happen before the frame is complete.
| Name | IMediaModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaModule.h |
| Include Path | #include "IMediaModule.h" |
Syntax
class IMediaModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaModule() |
Virtual destructor. | IMediaModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 CreateMediaPlayerInstanceID() |
Get new media player instance ID | IMediaModule.h | |
const TArray< IMediaCaptureSupport * > & GetCaptureSupports () |
Get all registered capture device support objects. | IMediaModule.h | |
IMediaClock & GetClock () |
Get the media clock. | IMediaModule.h | |
double GetFrameStartTime() |
Get frame's processing approximate real time start time in seconds | IMediaModule.h | |
FSimpleMulticastDelegate & GetOnTickPreEngineCompleted() |
Get a Delegate that is trigger once all MediaClockSink are TickInput | IMediaModule.h | |
| Get a GUID from a nice platform name | IMediaModule.h | ||
| Get a nice platform name from a GUID | IMediaModule.h | ||
const TArray< IMediaPlayerFactory * > & GetPlayerFactories () |
Get the list of installed media player factories. | IMediaModule.h | |
IMediaPlayerFactory * GetPlayerFactory
(
const FName& FactoryName |
Get a media player factory by name. | IMediaModule.h | |
IMediaPlayerFactory * GetPlayerFactory
(
const FGuid& PlayerPluginGuid |
Get a media player factory by GUID. | IMediaModule.h | |
IMediaPlayerLifecycleManagerDelegate * GetPlayerLifecycleManagerDelegate() |
Get player lifetime delegate | IMediaModule.h | |
IMediaTicker & GetTicker () |
Get the high-frequency ticker. | IMediaModule.h | |
TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe > GetTimeSource() |
Get the time source for the media clock. | IMediaModule.h | |
void LockToTimecode
(
bool Locked |
Whether media objects should lock to the media clock's time code. | IMediaModule.h | |
void RegisterCaptureSupport
(
IMediaCaptureSupport& Support |
Register a media capture devices support object. | IMediaModule.h | |
void RegisterPlayerFactory
(
IMediaPlayerFactory& Factory |
Register a media player factory. | IMediaModule.h | |
void SetPlayerLifecycleManagerDelegate
(
IMediaPlayerLifecycleManagerDelegate* Delegate |
Set player lifetime delegate | IMediaModule.h | |
void SetTimeSource
(
const TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe >& NewTimeSource |
Set the time source for the media clock. | IMediaModule.h | |
void TickPostEngine () |
Called by the main loop after the game engine has been ticked. | IMediaModule.h | |
void TickPostRender () |
Called by the main loop after the entire frame has been rendered. | IMediaModule.h | |
void TickPreEngine () |
Called by the main loop before the game engine is ticked. | IMediaModule.h | |
void TickPreSlate () |
Called by the main loop before Slate is ticked. | IMediaModule.h | |
void UnregisterCaptureSupport
(
IMediaCaptureSupport& Support |
Unregister a media capture device support object. | IMediaModule.h | |
void UnregisterPlayerFactory
(
IMediaPlayerFactory& Factory |
Unregister a media player factory. | IMediaModule.h |