UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMoviePlayerProxy Class Reference

#include <MoviePlayerProxy.h>

Static Public Member Functions

static MOVIEPLAYERPROXY_API void BlockingStarted ()
 
static MOVIEPLAYERPROXY_API void BlockingTick ()
 
static MOVIEPLAYERPROXY_API void BlockingFinished ()
 
static MOVIEPLAYERPROXY_API void BlockingForceFinished ()
 
static MOVIEPLAYERPROXY_API void SetIsSlateThreadAllowed (bool bInIsSlateThreadAllowed)
 
static MOVIEPLAYERPROXY_API void RegisterServer (IMoviePlayerProxyServer *InServer)
 
static MOVIEPLAYERPROXY_API void UnregisterServer ()
 

Detailed Description

This provides a mechanism to connect the engine (the client) to a movie player (the server).

Engine code can call BlockingStarted/Tick/Finished around blocking areas.

The movie player can call RegisterServer/UnregisterServer so it can receive the calls from the engine.

Member Function Documentation

◆ BlockingFinished()

void FMoviePlayerProxy::BlockingFinished ( )
static

Call this once the blocking operation is done to shut down the movie player.

◆ BlockingForceFinished()

void FMoviePlayerProxy::BlockingForceFinished ( )
static

Call this to make sure the movie player is no longer running.

◆ BlockingStarted()

void FMoviePlayerProxy::BlockingStarted ( )
static

Call this before doing a blocking operation on the game thread so that the movie player can activate.

◆ BlockingTick()

void FMoviePlayerProxy::BlockingTick ( )
static

Call this periodically during a blocking operation on the game thread.

◆ RegisterServer()

void FMoviePlayerProxy::RegisterServer ( IMoviePlayerProxyServer InServer)
static

Call this to hook up a server.

◆ SetIsSlateThreadAllowed()

void FMoviePlayerProxy::SetIsSlateThreadAllowed ( bool  bInIsSlateThreadAllowed)
static

Call this to prevent the movie player from using the Slate thread.

◆ UnregisterServer()

void FMoviePlayerProxy::UnregisterServer ( )
static

Call this to unregister the current server.


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