Navigation
API > API/Runtime > API/Runtime/MoviePlayer
An interface to the movie player we will use for loading screens and gameplay movies
| Name | IGameMoviePlayer |
| Type | class |
| Header File | /Engine/Source/Runtime/MoviePlayer/Public/MoviePlayer.h |
| Include Path | #include "MoviePlayer.h" |
Syntax
class IGameMoviePlayer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IGameMoviePlayer() |
MoviePlayer.h |
Classes
| Name | Remarks |
|---|---|
| FOnMovieClipFinished | |
| FOnMoviePlaybackFinished | |
| FOnMoviePlaybackStarted | Callback for when the LoadingScreen setup above in WidgetLoadingScreen is displayed |
| FOnMoviePlaybackTick | Callback for when the game thread is blocked but you want to do some ticking. |
| FOnPrepareLoadingScreen | Called before playing a movie if the loading screen has not been prepared. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastMovieClipFinished
(
const FString& MovieClipThatFinished |
MoviePlayer.h | ||
void BroadcastMoviePlaybackFinished() |
MoviePlayer.h | ||
virtual void ForceCompletion() |
MoviePlayer.h | ||
FString GetMovieName() |
Returns the name of the movie currently being played | MoviePlayer.h | |
bool HasEarlyStartupMovie() |
MoviePlayer.h | ||
void Initialize
(
FSlateRenderer& InSlateRenderer, |
Initializes this movie player, creating the startup window and hiding the splash screen. | MoviePlayer.h | |
bool IsInitialized() |
MoviePlayer.h | ||
bool IsLastMovieInPlaylist() |
Returns true if the movie being played in the last one in the play list | MoviePlayer.h | |
bool IsLoadingFinished() |
Called from to check if the game thread is finished loading. | MoviePlayer.h | |
bool IsMovieCurrentlyPlaying() |
True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called). | MoviePlayer.h | |
virtual bool IsStartupMoviePlaying() |
Check if the initial movie(s) is still playing | MoviePlayer.h | |
bool LoadingScreenIsPrepared() |
True if we have either slate widgets or a movie to show. | MoviePlayer.h | |
IGameMoviePlayer::FOnMovieClipFinished TBaseMulticastDelegate_OneParam OnMovieClipFinished() |
MoviePlayer.h | ||
IGameMoviePlayer::FOnMoviePlaybackFinished TBaseMulticastDelegate_NoParams OnMoviePlaybackFinished() |
MoviePlayer.h | ||
IGameMoviePlayer::FOnMoviePlaybackStarted TBaseMulticastDelegate_NoParams OnMoviePlaybackStarted() |
MoviePlayer.h | ||
IGameMoviePlayer::FOnMoviePlaybackTick TBaseMulticastDelegate_OneParam OnMoviePlaybackTick() |
MoviePlayer.h | ||
IGameMoviePlayer::FOnPrepareLoadingScreen TBaseMulticastDelegate_NoParams OnPrepareLoadingScreen() |
MoviePlayer.h | ||
void PassLoadingScreenWindowBackToGame() |
Passes the loading screen window back to the game to use. For use by the launch engine loop only. | MoviePlayer.h | |
bool PlayEarlyStartupMovies() |
Play any early start up movies that have been set up | MoviePlayer.h | |
bool PlayMovie() |
Starts playing the movie given the last FLoadingScreenAttributes passed in | MoviePlayer.h | |
void RegisterMovieStreamer
(
TSharedPtr< IMovieStreamer, ESPMode::ThreadSafe > InMovieStreamer |
Registers a movie streamer with the movie player. Set in the preloading screen stage. | MoviePlayer.h | |
virtual void Resume() |
MoviePlayer.h | ||
virtual void SetIsPlayOnBlockingEnabled
(
bool bIsEnabled |
Call this to have the MoviePlayer play in blocking sections and not loadmap. | MoviePlayer.h | |
void SetSlateOverlayWidget
(
TSharedPtr< SWidget > NewOverlayWidget |
Allows for a slate overlay widget to be set after playback. | MoviePlayer.h | |
void SetupLoadingScreen
(
const FLoadingScreenAttributes& InLoadingScreenAttributes |
Passes in a slate loading screen UI, movie paths, and any additional data. | MoviePlayer.h | |
void SetupLoadingScreenFromIni() |
Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen. | MoviePlayer.h | |
virtual void SetViewportDPIScale
(
float InViewportDPIScale |
Allows for a DPI scale to be set. | MoviePlayer.h | |
void Shutdown() |
Shutsdown the movie player. | MoviePlayer.h | |
void StopMovie() |
Stops the currently playing movie, if any. | MoviePlayer.h | |
virtual void Suspend() |
MoviePlayer.h | ||
void WaitForMovieToFinish
(
bool bAllowEngineTick |
Call only on the game thread. | MoviePlayer.h | |
bool WillAutoCompleteWhenLoadFinishes() |
This function shouild return true if the movie will auto-complete the sequence when background loading has finished | MoviePlayer.h |