Navigation
Unreal Engine C++ API Reference > Runtime > Media
Inheritance Hierarchy
- IModuleInterface
- IMediaModule
References
Module | Media |
Header | /Engine/Source/Runtime/Media/Public/IMediaModule.h |
Include | #include "IMediaModule.h" |
Syntax
class IMediaModule : public IModuleInterface
Remarks
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.
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Virtual destructor. |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
uint64 | Get new media player instance ID | |
![]() ![]() |
const TArray< IMediaCaptureSupport * > & | Get all registered capture device support objects. | |
![]() |
IMediaClock & | GetClock () |
Get the media clock. |
![]() ![]() |
double | Get frame's processing approximate real time start time in seconds | |
![]() |
FSimpleMulticastDelegate & | Get a Delegate that is trigger once all MediaClockSink are TickInput | |
![]() ![]() |
FGuid | GetPlatformGuid
(
const FName& PlatformName |
Get a GUID from a nice platform name |
![]() ![]() |
FName | GetPlatformName
(
const FGuid& PlatformGuid |
Get a nice platform name from a GUID |
![]() ![]() |
const TArray< IMediaPlayerFactory * > & | Get the list of installed media player factories. | |
![]() ![]() |
IMediaPlayerFactory * | GetPlayerFactory
(
const FName& FactoryName |
Get a media player factory by name. |
![]() ![]() |
IMediaPlayerFactory * | GetPlayerFactory
(
const FGuid& PlayerPluginGuid |
Get a media player factory by GUID. |
![]() |
IMediaPlayerLifecycleManagerDelegate * | Get player lifetime delegate | |
![]() |
IMediaTicker & | GetTicker () |
Get the high-frequency ticker. |
![]() |
TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe > | Get the time source for the media clock. | |
![]() |
void | LockToTimecode
(
bool Locked |
Whether media objects should lock to the media clock's time code. |
![]() |
void | RegisterCaptureSupport
(
IMediaCaptureSupport& Support |
Register a media capture devices support object. |
![]() |
void | RegisterPlayerFactory
(
IMediaPlayerFactory& Factory |
Register a media player factory. |
![]() |
void | Set player lifetime delegate | |
![]() |
void | SetTimeSource
(
const TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe >& NewTimeSource |
Set the time source for the media clock. |
![]() |
void | Called by the main loop after the game engine has been ticked. | |
![]() |
void | Called by the main loop after the entire frame has been rendered. | |
![]() |
void | Called by the main loop before the game engine is ticked. | |
![]() |
void | TickPreSlate () |
Called by the main loop before Slate is ticked. |
![]() |
void | UnregisterCaptureSupport
(
IMediaCaptureSupport& Support |
Unregister a media capture device support object. |
![]() |
void | UnregisterPlayerFactory
(
IMediaPlayerFactory& Factory |
Unregister a media player factory. |