1. Epic GamesDeveloper
  3. IGameMoviePlayer

IGameMoviePlayer

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

API > API/Runtime > API/Runtime/MoviePlayer

References

   
Module MoviePlayer
Header /Engine/Source/Runtime/MoviePlayer/Public/MoviePlayer.h
Include #include "MoviePlayer.h"

Syntax

class IGameMoviePlayer

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

BroadcastMovieClipFinished ( const FString& MovieClipThatFinished
)

  
Public function void  
Public function Virtual void  
Public function FString Returns the name of the movie currently being played
Public function Const bool  
Public function void

Initialize ( FSlateRenderer& InSlateRenderer,
TSharedPtr< SWindow > RenderTarget
)

 Initializes this movie player, creating the startup window and hiding the splash screen.
Public function Const bool  
Public function bool Returns true if the movie being played in the last one in the play list
Public function Const bool Called from to check if the game thread is finished loading.
Public function Const bool True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called).
Public function Virtual Const bool Check if the initial movie(s) is still playing
Public function Const bool True if we have either slate widgets or a movie to show.
Public function IGameMoviePlayer::FOnMovieClipFinished TBaseMulticastDelegate_OneParam  
Public function IGameMoviePlayer::FOnMoviePlaybackFinished TBaseMulticastDelegate_NoParams  
Public function IGameMoviePlayer::FOnMoviePlaybackStarted TBaseMulticastDelegate_NoParams  
Public function IGameMoviePlayer::FOnMoviePlaybackTick TBaseMulticastDelegate_OneParam  
Public function IGameMoviePlayer::FOnPrepareLoadingScreen TBaseMulticastDelegate_NoParams  
Public function Const void Passes the loading screen window back to the game to use. For use by the launch engine loop only.
Public function bool Play any early start up movies that have been set up
Public function bool Starts playing the movie given the last FLoadingScreenAttributes passed in
Public function void

RegisterMovieStreamer ( TSharedPtr< IMovieStreamer, ESPMode::ThreadSafe > InMovieStreamer
)

 Registers a movie streamer with the movie player. Set in the preloading screen stage.
Public function Virtual void

Resume ()

  
Public function Virtual void

SetIsPlayOnBlockingEnabled ( bool bIsEnabled
)

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

SetSlateOverlayWidget ( TSharedPtr< SWidget > NewOverlayWidget
)

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

SetupLoadingScreen ( const FLoadingScreenAttributes& InLoadingScreenAttributes
)

 Passes in a slate loading screen UI, movie paths, and any additional data.
Public function void Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen.
Public function Virtual void

SetViewportDPIScale ( float InViewportDPIScale
)

 Allows for a DPI scale to be set.
Public function void Shutsdown the movie player.
Public function void Stops the currently playing movie, if any.
Public function Virtual void

Suspend ()

  
Public function void

WaitForMovieToFinish ( bool bAllowEngineTick
)

 Call only on the game thread.
Public function bool This function shouild return true if the movie will auto-complete the sequence when background loading has finished

Classes

  Type Name Description
Public class FOnMovieClipFinished    
Public class FOnMoviePlaybackFinished    
Public class FOnMoviePlaybackStarted Callback for when the LoadingScreen setup above in WidgetLoadingScreen is displayed  
Public class FOnMoviePlaybackTick Callback for when the game thread is blocked but you want to do some ticking.  
Public class FOnPrepareLoadingScreen Called before playing a movie if the loading screen has not been prepared.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page