IMovieStreamer Class Reference

#include <MoviePlayer.h>

Public Member Functions
virtual bool	Init (const TArray< FString > &MoviePaths, TEnumAsByte< EMoviePlaybackType > inPlaybackType)=0
virtual void	PreviousViewportInterface (const TSharedPtr< ISlateViewport > &PreviousViewportInterface)
virtual void	ForceCompletion ()=0
virtual bool	Tick (FRHICommandListBase &RHICmdList, float DeltaTime)=0
virtual TSharedPtr< class ISlateViewport >	GetViewportInterface ()=0
virtual float	GetAspectRatio () const =0
virtual FString	GetMovieName ()=0
virtual bool	IsLastMovieInPlaylist ()=0
virtual void	Cleanup ()=0
virtual FTextureRHIRef	GetTexture ()
virtual	~IMovieStreamer ()
	DECLARE_EVENT_OneParam (IMovieStreamer, FOnCurrentMovieClipFinished, const FString &) virtual FOnCurrentMovieClipFinished &OnCurrentMovieClipFinished()=0
void	BroadcastCurrentMovieClipFinished (const FString &MovieClipThatFinished)
virtual void	Suspend ()
virtual void	Resume ()
virtual void	TickPreEngine ()
virtual void	TickPostEngine ()
virtual void	TickPostRender ()

Detailed Description

Interface for creating a movie streaming player. Should be one instance per platform.

Constructor & Destructor Documentation

~IMovieStreamer()

virtual IMovieStreamer::~IMovieStreamer ( )

inlinevirtual

Member Function Documentation

BroadcastCurrentMovieClipFinished()

void IMovieStreamer::BroadcastCurrentMovieClipFinished ( const FString &  MovieClipThatFinished )

inline

Cleanup()

virtual void IMovieStreamer::Cleanup ( )

pure virtual

Called to allow the movie streamer to cleanup any resources once there are no movies left to play.

DECLARE_EVENT_OneParam()

IMovieStreamer::DECLARE_EVENT_OneParam ( IMovieStreamer  , FOnCurrentMovieClipFinished  , const FString &    ) &

pure virtual

ForceCompletion()

virtual void IMovieStreamer::ForceCompletion ( )

pure virtual

Forces the movie streamer to cancel what it's streaming and close.

GetAspectRatio()

virtual float IMovieStreamer::GetAspectRatio ( ) const

pure virtual

Gets the aspect ratio of the movie frames being streamed.

GetMovieName()

virtual FString IMovieStreamer::GetMovieName ( )

pure virtual

returns the name of the movie currently being played

GetTexture()

virtual FTextureRHIRef IMovieStreamer::GetTexture ( )

inlinevirtual

GetViewportInterface()

virtual TSharedPtr< class ISlateViewport > IMovieStreamer::GetViewportInterface ( )

pure virtual

Gets a viewport interface which will be used to draw the movie.

Init()

virtual bool IMovieStreamer::Init ( const TArray< FString > &  MoviePaths, TEnumAsByte< EMoviePlaybackType >  inPlaybackType  )

pure virtual

Initializes this movie streamer with all the movie paths (ordered) we want to play Movie paths are local to the current game's Content/Movies/ directory.

IsLastMovieInPlaylist()

virtual bool IMovieStreamer::IsLastMovieInPlaylist ( )

pure virtual

returns true if the movie being played in the last one in the play list

PreviousViewportInterface()

virtual void IMovieStreamer::PreviousViewportInterface ( const TSharedPtr< ISlateViewport > &  PreviousViewportInterface )

inlinevirtual

Tells the movie streamer about the viewport interface that was active before us.

Resume()

virtual void IMovieStreamer::Resume ( )

inlinevirtual

Suspend()

virtual void IMovieStreamer::Suspend ( )

inlinevirtual

Called by the engine on suspend/resume

Tick()

virtual bool IMovieStreamer::Tick ( FRHICommandListBase &  RHICmdList, float  DeltaTime  )

pure virtual

Code run every tick for any additional per tick handling of playing the movie. Returns true if done.

TickPostEngine()

virtual void IMovieStreamer::TickPostEngine ( )

inlinevirtual

Called after the engine ticks.

TickPostRender()

virtual void IMovieStreamer::TickPostRender ( )

inlinevirtual

Called after rendering is finished.

TickPreEngine()

virtual void IMovieStreamer::TickPreEngine ( )

inlinevirtual

Called before the engine tick.

---

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

• Engine/Source/Runtime/MoviePlayer/Public/MoviePlayer.h