FMediaMovieStreamer

Movie streamer that allows you to use MediaFramework during level loading, etc.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMovieStreamer

FMediaMovieStreamer

References

Module

MediaMovieStreamer

Header

/Engine/Plugins/Media/MediaMovieStreamer/Source/MediaMovieStreamer/Public/MediaMovieStreamer.h

Include

#include "MediaMovieStreamer.h"

Syntax

class FMediaMovieStreamer : public IMovieStreamer

Remarks

Movie streamer that allows you to use MediaFramework during level loading, etc.

Variables

Constructors

Name Description

Public function

FMediaMovieStreamer()

Destructors

Name Description

Public function

~FMediaMovieStreamer()

Functions

Name Description

Public function

UMediaSoundC...

 

GetMediaSoundComponent()

Returns the current MediaSoundComponent

Public function

void

 

OnMediaEnd()

Called from UMediaMovieAssets when the media ends.

Public function

void

 

SetIsMediaControlledExternally

(
    bool bInIsMediaControlledExternally
)

If you do not want FMediaMovieStreamer to play automatically, but want to control the media yourself, then call this with true.

Public function

void

 

SetMediaPlayer

(
    UMediaPlayer* InMediaPlayer
)

Sets which media player should be playing.

Public function

void

 

SetMediaSoundComponent

(
    UMediaSoundComponent* InMediaS...
)

Sets what media sound component we are using.

Public function

void

 

SetMediaSource

(
    UMediaSource* InMediaSource
)

Sets what to play.

Public function

void

 

SetMediaTexture

(
    UMediaTexture* InMediaTexture
)

Sets what media texture we are using.

Overridden from IMovieStreamer

Name Description

Public function Virtual

void

 

Cleanup()

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

Public function Virtual

void

 

ForceCompletion()

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

Public function Virtual Const

float

 

GetAspectRatio()

Gets the aspect ratio of the movie frames being streamed.

Public function Virtual

FString

 

GetMovieName()

Returns the name of the movie currently being played

Public function Virtual

FTexture2DRH...

 

GetTexture()

Public function Virtual

TSharedPtr< ...

 

GetViewportInterface()

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

Public function Virtual

bool

 

Init

(
    const TArray< FString >& InMoviePa...,
    TEnumAsByte< EMoviePlaybackType > I...
)

IMovieStreamer interface

Public function Virtual

bool

 

IsLastMovieInPlaylist()

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

Public function Virtual

FOnCurrentMo...

 

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

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.