Navigation
Unreal Engine C++ API Reference > 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 | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | BroadcastMovieClipFinished
(
const FString& MovieClipThatFinished |
|
![]() |
void | ||
![]() ![]() |
void | ||
![]() |
FString | GetMovieName () |
Returns the name of the movie currently being played |
![]() ![]() |
bool | ||
![]() |
void | Initialize
(
FSlateRenderer& InSlateRenderer, |
Initializes this movie player, creating the startup window and hiding the splash screen. |
![]() ![]() |
bool | ||
![]() |
bool | Returns true if the movie being played in the last one in the play list | |
![]() ![]() |
bool | Called from to check if the game thread is finished loading. | |
![]() ![]() |
bool | True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called). | |
![]() ![]() ![]() |
bool | Check if the initial movie(s) is still playing | |
![]() ![]() |
bool | True if we have either slate widgets or a movie to show. | |
![]() |
IGameMoviePlayer::FOnMovieClipFinished TBaseMulticastDelegate_OneParam | ||
![]() |
IGameMoviePlayer::FOnMoviePlaybackFinished TBaseMulticastDelegate_NoParams | ||
![]() |
IGameMoviePlayer::FOnMoviePlaybackStarted TBaseMulticastDelegate_NoParams | ||
![]() |
IGameMoviePlayer::FOnMoviePlaybackTick TBaseMulticastDelegate_OneParam | ||
![]() |
IGameMoviePlayer::FOnPrepareLoadingScreen TBaseMulticastDelegate_NoParams | ||
![]() ![]() |
void | Passes the loading screen window back to the game to use. For use by the launch engine loop only. | |
![]() |
bool | Play any early start up movies that have been set up | |
![]() |
bool | PlayMovie () |
Starts playing the movie given the last FLoadingScreenAttributes passed in |
![]() |
void | RegisterMovieStreamer
(
TSharedPtr< IMovieStreamer, ESPMode::ThreadSafe > InMovieStreamer |
Registers a movie streamer with the movie player. Set in the preloading screen stage. |
![]() ![]() |
void | Resume () |
|
![]() ![]() |
void | SetIsPlayOnBlockingEnabled
(
bool bIsEnabled |
Call this to have the MoviePlayer play in blocking sections and not loadmap. |
![]() |
void | SetSlateOverlayWidget
(
TSharedPtr< SWidget > NewOverlayWidget |
Allows for a slate overlay widget to be set after playback. |
![]() |
void | SetupLoadingScreen
(
const FLoadingScreenAttributes& InLoadingScreenAttributes |
Passes in a slate loading screen UI, movie paths, and any additional data. |
![]() |
void | Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen. | |
![]() ![]() |
void | SetViewportDPIScale
(
float InViewportDPIScale |
Allows for a DPI scale to be set. |
![]() |
void | Shutdown () |
Shutsdown the movie player. |
![]() |
void | StopMovie () |
Stops the currently playing movie, if any. |
![]() ![]() |
void | Suspend () |
|
![]() |
void | WaitForMovieToFinish
(
bool bAllowEngineTick |
Call only on the game thread. |
![]() |
bool | This function shouild return true if the movie will auto-complete the sequence when background loading has finished |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
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. |