|
Module |
|
|
Header |
/Engine/Source/Runtime/MoviePlayer/Public/MoviePlayer.h |
|
Include |
#include "MoviePlayer.h" |
class IGameMoviePlayer
An interface to the movie player we will use for loading screens and gameplay movies
| Name | Description | |
|---|---|---|
|
|
~IGameMoviePlayer() |
| Name | Description | ||
|---|---|---|---|
|
|
BroadcastMovieClipFinished ( |
||
|
|
BroadcastMoviePlaybackFinished() |
||
|
|
ForceCompletion() |
||
|
|
GetMovieName() |
Returns the name of the movie currently being played |
|
|
|
HasEarlyStartupMovie() |
||
|
|
Initialize ( |
Initializes this movie player, creating the startup window and hiding the splash screen. |
|
|
|
IsLastMovieInPlaylist() |
Returns true if the movie being played in the last one in the play list |
|
|
|
IsLoadingFinished() |
Called from to check if the game thread is finished loading. |
|
|
|
IsMovieCurrentlyPlaying() |
True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called). |
|
|
|
IsStartupMoviePlaying() |
Check if the initial movie(s) is still playing |
|
|
|
LoadingScreenIsPrepared() |
True if we have either slate widgets or a movie to show. |
|
|
|
IGameMoviePl... |
OnMovieClipFinished() |
|
|
|
IGameMoviePl... |
OnMoviePlaybackFinished() |
|
|
|
IGameMoviePl... |
OnMoviePlaybackStarted() |
|
|
|
IGameMoviePl... |
OnPrepareLoadingScreen() |
|
|
|
PassLoadingScreenWindowBackToGame() |
Passes the loading screen window back to the game to use. For use by the launch engine loop only. |
|
|
|
PlayEarlyStartupMovies() |
Play any early start up movies that have been set up |
|
|
|
PlayMovie() |
Starts playing the movie given the last FLoadingScreenAttributes passed in |
|
|
|
RegisterMovieStreamer ( |
Registers a movie streamer with the movie player. Set in the preloading screen stage. |
|
|
|
Resume() |
||
|
|
SetSlateOverlayWidget ( |
Allows for a slate overlay widget to be set after playback. |
|
|
|
SetupLoadingScreen ( |
Passes in a slate loading screen UI, movie paths, and any additional data. |
|
|
|
SetupLoadingScreenFromIni() |
Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen. |
|
|
|
Shutdown() |
Shutsdown the movie player. |
|
|
|
StopMovie() |
Stops the currently playing movie, if any. |
|
|
|
Suspend() |
||
|
|
WaitForMovieToFinish ( |
Call only on the game thread. |
|
|
|
WillAutoCompleteWhenLoadFinishes() |
This function shouild return true if the movie will auto-complete the sequence when background loading has finished |
|
Name |
Description |
|
|---|---|---|
|
|
FOnMovieClipFinished |
|
|
|
FOnMoviePlaybackFinished |
|
|
|
FOnMoviePlaybackStarted |
Callback for when the LoadingScreen setup above in WidgetLoadingScreen is displayed |
|
|
FOnPrepareLoadingScreen |
Called before playing a movie if the loading screen has not been prepared. |
