IMovieStreamer

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMovieStreamer

FMediaMovieStreamer

References

Module

MoviePlayer

Header

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

Include

#include "MoviePlayer.h"

Syntax

class IMovieStreamer

Remarks

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

Destructors

Name Description

Public function Virtual

~IMovieStreamer()

Functions

Name Description

Public function

void

 

BroadcastCurrentMovieClipFinished

(
    const FString& MovieClipThatFinish...
)

Public function

void

 

Cleanup()

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

Public function

void

 

ForceCompletion()

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

Public function Const

float

 

GetAspectRatio()

Gets the aspect ratio of the movie frames being streamed.

Public function

FString

 

GetMovieName()

Returns the name of the movie currently being played

Public function Virtual

FTexture2DRH...

 

GetTexture()

Public function

TSharedPtr< ...

 

GetViewportInterface()

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

Public function

bool

 

Init

(
    const TArray< FString >& MoviePath...,
    TEnumAsByte< EMoviePlaybackType > i...
)

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.

Public function

bool

 

IsLastMovieInPlaylist()

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

Public function

IMovieStream...

 

OnCurrentMovieClipFinished()

Public function Virtual

void

 

PreviousViewportInterface

(
    const TSharedPtr< ISlateViewport > ...
)

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

Public function Virtual

void

 

Resume()

Public function Virtual

void

 

Suspend()

Called by the engine on suspend/resume

Public function

bool

 

Tick

(
    float DeltaTime
)

Code run every tick for any additional per tick handling of playing the movie.

Public function Virtual

void

 

TickPostEngine()

Called after the engine ticks.

Public function Virtual

void

 

TickPostRender()

Called after rendering is finished.

Public function Virtual

void

 

TickPreEngine()

MediaFramework support.

Classes

Name

Description

Public class

FOnCurrentMovieClipFinished