IMediaModule

Interface for the Media module.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function Virtual

~IMediaModule()

Virtual destructor.

Functions

Name Description

Public function

uint64

 

CreateMediaPlayerInstanceID()

Get new media player instance ID

Public function Const

const TArray...

 

GetCaptureSupports()

Get all registered capture device support objects.

Public function

IMediaClock ...

 

GetClock()

Get the media clock.

Public function Const

double

 

GetFrameStartTime()

Get frame's processing approximate real time start time in seconds

Public function

FSimpleMulti...

 

GetOnTickPreEngineCompleted()

Get a Delegate that is trigger once all MediaClockSink are TickInput

Public function Const

FGuid

 

GetPlatformGuid

(
    const FName& PlatformName
)

Get a GUID from a nice platform name

Public function Const

FName

 

GetPlatformName

(
    const FGuid& PlatformGuid
)

Get a nice platform name from a GUID

Public function Const

const TArray...

 

GetPlayerFactories()

Get the list of installed media player factories.

Public function Const

IMediaPlayer...

 

GetPlayerFactory

(
    const FName& FactoryName
)

Get a media player factory by name.

Public function Const

IMediaPlayer...

 

GetPlayerFactory

(
    const FGuid& PlayerPluginGuid
)

Get a media player factory by GUID.

Public function

IMediaPlayer...

 

GetPlayerLifecycleManagerDelegate()

Get player lifetime delegate

Public function

IMediaTicker...

 

GetTicker()

Get the high-frequency ticker.

Public function

TSharedPtr< ...

 

GetTimeSource()

Get the time source for the media clock.

Public function

void

 

LockToTimecode

(
    bool Locked
)

Whether media objects should lock to the media clock's time code.

Public function

void

 

RegisterCaptureSupport

(
    IMediaCaptureSupport& Support
)

Register a media capture devices support object.

Public function

void

 

RegisterPlayerFactory

(
    IMediaPlayerFactory& Factory
)

Register a media player factory.

Public function

void

 

SetPlayerLifecycleManagerDelegate

Set player lifetime delegate

Public function

void

 

SetTimeSource

(
    const TSharedPtr< IMediaTimeSource,...
)

Set the time source for the media clock.

Public function

void

 

TickPostEngine()

Called by the main loop after the game engine has been ticked.

Public function

void

 

TickPostRender()

Called by the main loop after the entire frame has been rendered.

Public function

void

 

TickPreEngine()

Called by the main loop before the game engine is ticked.

Public function

void

 

TickPreSlate()

Called by the main loop before Slate is ticked.

Public function

void

 

UnregisterCaptureSupport

(
    IMediaCaptureSupport& Support
)

Unregister a media capture device support object.

Public function

void

 

UnregisterPlayerFactory

(
    IMediaPlayerFactory& Factory
)

Unregister a media player factory.