UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IGameMoviePlayer Class Referenceabstract

#include <MoviePlayer.h>

+ Inheritance diagram for IGameMoviePlayer:

Public Member Functions

virtual void RegisterMovieStreamer (TSharedPtr< IMovieStreamer, ESPMode::ThreadSafe > InMovieStreamer)=0
 
virtual void Initialize (class FSlateRenderer &InSlateRenderer, TSharedPtr< SWindow > RenderTarget=nullptr)=0
 
virtual void Shutdown ()=0
 
virtual void PassLoadingScreenWindowBackToGame () const =0
 
virtual void SetupLoadingScreen (const FLoadingScreenAttributes &InLoadingScreenAttributes)=0
 
virtual FOnPrepareLoadingScreen & OnPrepareLoadingScreen ()=0
 
virtual bool HasEarlyStartupMovie () const =0
 
virtual bool PlayEarlyStartupMovies ()=0
 
virtual bool IsInitialized () const =0
 
virtual bool PlayMovie ()=0
 
virtual void StopMovie ()=0
 
virtual void WaitForMovieToFinish (bool bAllowEngineTick=false)=0
 
virtual bool IsLoadingFinished () const =0
 
virtual bool IsMovieCurrentlyPlaying () const =0
 
virtual bool LoadingScreenIsPrepared () const =0
 
virtual void SetupLoadingScreenFromIni ()=0
 
virtual FString GetMovieName ()=0
 
virtual bool IsLastMovieInPlaylist ()=0
 
virtual FOnMoviePlaybackStarted & OnMoviePlaybackStarted ()=0
 
 DECLARE_EVENT_OneParam (IGameMoviePlayer, FOnMoviePlaybackTick, float DeltaTime) virtual FOnMoviePlaybackTick &OnMoviePlaybackTick()=0
 
virtual FOnMoviePlaybackFinished & OnMoviePlaybackFinished ()=0
 
 DECLARE_EVENT_OneParam (IGameMoviePlayer, FOnMovieClipFinished, const FString &) virtual FOnMovieClipFinished &OnMovieClipFinished()=0
 
virtual void SetSlateOverlayWidget (TSharedPtr< SWidget > NewOverlayWidget)=0
 
virtual void SetViewportDPIScale (float InViewportDPIScale)
 
void BroadcastMoviePlaybackFinished ()
 
void BroadcastMovieClipFinished (const FString &MovieClipThatFinished)
 
virtual bool WillAutoCompleteWhenLoadFinishes ()=0
 
virtual ~IGameMoviePlayer ()
 
virtual bool IsStartupMoviePlaying () const
 
virtual void ForceCompletion ()
 
virtual void Suspend ()
 
virtual void Resume ()
 
virtual void SetIsPlayOnBlockingEnabled (bool bIsEnabled)
 

Detailed Description

An interface to the movie player we will use for loading screens and gameplay movies

Constructor & Destructor Documentation

◆ ~IGameMoviePlayer()

virtual IGameMoviePlayer::~IGameMoviePlayer ( )
inlinevirtual

Member Function Documentation

◆ BroadcastMovieClipFinished()

void IGameMoviePlayer::BroadcastMovieClipFinished ( const FString &  MovieClipThatFinished)
inline

◆ BroadcastMoviePlaybackFinished()

void IGameMoviePlayer::BroadcastMoviePlaybackFinished ( )
inline

◆ DECLARE_EVENT_OneParam() [1/2]

IGameMoviePlayer::DECLARE_EVENT_OneParam ( IGameMoviePlayer  ,
FOnMovieClipFinished  ,
const FString &   
) &
pure virtual

◆ DECLARE_EVENT_OneParam() [2/2]

IGameMoviePlayer::DECLARE_EVENT_OneParam ( IGameMoviePlayer  ,
FOnMoviePlaybackTick  ,
float  DeltaTime 
) &
pure virtual

Callback for when the game thread is blocked but you want to do some ticking.

◆ ForceCompletion()

virtual void IGameMoviePlayer::ForceCompletion ( )
inlinevirtual

Reimplemented in FDefaultGameMoviePlayer.

◆ GetMovieName()

virtual FString IGameMoviePlayer::GetMovieName ( )
pure virtual

returns the name of the movie currently being played

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ HasEarlyStartupMovie()

virtual bool IGameMoviePlayer::HasEarlyStartupMovie ( ) const
pure virtual
Returns
true if the movie player has been set up with an early startup movie

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ Initialize()

virtual void IGameMoviePlayer::Initialize ( class FSlateRenderer &  InSlateRenderer,
TSharedPtr< SWindow >  RenderTarget = nullptr 
)
pure virtual

Initializes this movie player, creating the startup window and hiding the splash screen. To be called in the launch engine loop.

Implemented in FNullGameMoviePlayer, and FDefaultGameMoviePlayer.

◆ IsInitialized()

virtual bool IGameMoviePlayer::IsInitialized ( ) const
pure virtual
Returns
true if Initialize was called

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ IsLastMovieInPlaylist()

virtual bool IGameMoviePlayer::IsLastMovieInPlaylist ( )
pure virtual

returns true if the movie being played in the last one in the play list

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ IsLoadingFinished()

virtual bool IGameMoviePlayer::IsLoadingFinished ( ) const
pure virtual

Called from to check if the game thread is finished loading.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ IsMovieCurrentlyPlaying()

virtual bool IGameMoviePlayer::IsMovieCurrentlyPlaying ( ) const
pure virtual

True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called).

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ IsStartupMoviePlaying()

virtual bool IGameMoviePlayer::IsStartupMoviePlaying ( ) const
inlinevirtual

Check if the initial movie(s) is still playing

Reimplemented in FDefaultGameMoviePlayer.

◆ LoadingScreenIsPrepared()

virtual bool IGameMoviePlayer::LoadingScreenIsPrepared ( ) const
pure virtual

True if we have either slate widgets or a movie to show.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ OnMoviePlaybackFinished()

virtual FOnMoviePlaybackFinished & IGameMoviePlayer::OnMoviePlaybackFinished ( )
pure virtual

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ OnMoviePlaybackStarted()

virtual FOnMoviePlaybackStarted & IGameMoviePlayer::OnMoviePlaybackStarted ( )
pure virtual

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ OnPrepareLoadingScreen()

virtual FOnPrepareLoadingScreen & IGameMoviePlayer::OnPrepareLoadingScreen ( )
pure virtual

Called before playing a movie if the loading screen has not been prepared.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ PassLoadingScreenWindowBackToGame()

virtual void IGameMoviePlayer::PassLoadingScreenWindowBackToGame ( ) const
pure virtual

Passes the loading screen window back to the game to use. For use by the launch engine loop only.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ PlayEarlyStartupMovies()

virtual bool IGameMoviePlayer::PlayEarlyStartupMovies ( )
pure virtual

Play any early start up movies that have been set up

Returns
true if a movie started playing

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ PlayMovie()

virtual bool IGameMoviePlayer::PlayMovie ( )
pure virtual

Starts playing the movie given the last FLoadingScreenAttributes passed in

Returns
true of a movie started playing.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ RegisterMovieStreamer()

virtual void IGameMoviePlayer::RegisterMovieStreamer ( TSharedPtr< IMovieStreamer, ESPMode::ThreadSafe >  InMovieStreamer)
pure virtual

Registers a movie streamer with the movie player. Set in the preloading screen stage.

Implemented in FNullGameMoviePlayer, and FDefaultGameMoviePlayer.

◆ Resume()

virtual void IGameMoviePlayer::Resume ( )
inlinevirtual

Reimplemented in FDefaultGameMoviePlayer.

◆ SetIsPlayOnBlockingEnabled()

virtual void IGameMoviePlayer::SetIsPlayOnBlockingEnabled ( bool  bIsEnabled)
inlinevirtual

Call this to have the MoviePlayer play in blocking sections and not loadmap.

Reimplemented in FDefaultGameMoviePlayer.

◆ SetSlateOverlayWidget()

virtual void IGameMoviePlayer::SetSlateOverlayWidget ( TSharedPtr< SWidget >  NewOverlayWidget)
pure virtual

Allows for a slate overlay widget to be set after playback.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ SetupLoadingScreen()

virtual void IGameMoviePlayer::SetupLoadingScreen ( const FLoadingScreenAttributes &  InLoadingScreenAttributes)
pure virtual

Passes in a slate loading screen UI, movie paths, and any additional data.

Implemented in FNullGameMoviePlayer, and FDefaultGameMoviePlayer.

◆ SetupLoadingScreenFromIni()

virtual void IGameMoviePlayer::SetupLoadingScreenFromIni ( )
pure virtual

Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ SetViewportDPIScale()

virtual void IGameMoviePlayer::SetViewportDPIScale ( float  InViewportDPIScale)
inlinevirtual

Allows for a DPI scale to be set.

Reimplemented in FDefaultGameMoviePlayer.

◆ Shutdown()

virtual void IGameMoviePlayer::Shutdown ( )
pure virtual

Shutsdown the movie player.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ StopMovie()

virtual void IGameMoviePlayer::StopMovie ( )
pure virtual

Stops the currently playing movie, if any.

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ Suspend()

virtual void IGameMoviePlayer::Suspend ( )
inlinevirtual

Reimplemented in FDefaultGameMoviePlayer.

◆ WaitForMovieToFinish()

virtual void IGameMoviePlayer::WaitForMovieToFinish ( bool  bAllowEngineTick = false)
pure virtual

Call only on the game thread. Spins this thread until the movie stops. If bAllowEngineTick is true, the engine tick may run inside here

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

◆ WillAutoCompleteWhenLoadFinishes()

virtual bool IGameMoviePlayer::WillAutoCompleteWhenLoadFinishes ( )
pure virtual

This function shouild return true if the movie will auto-complete the sequence when background loading has finished

Implemented in FDefaultGameMoviePlayer, and FNullGameMoviePlayer.

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