1. Epic GamesDeveloper
  3. FMediaMovieStreamer

FMediaMovieStreamer

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

API > API/Plugins > API/Plugins/MediaMovieStreamer

Inheritance Hierarchy

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

  Type Name Description
Public variable FMovieStreamerExternalTick MovieStreamerPostEngineTick  
Public variable FMovieStreamerExternalTick MovieStreamerPostRenderTick  
Public variable FMovieStreamerExternalTick MovieStreamerPreEngineTick  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UMediaSoundComponent * Returns the current MediaSoundComponent
Public function void 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* InMediaSoundComponent
)

 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

  Type 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 Forces the movie streamer to cancel what it's streaming and close.
Public function Virtual Const float Gets the aspect ratio of the movie frames being streamed.
Public function Virtual FString Returns the name of the movie currently being played
Public function Virtual FTexture2DRHIRef  
Public function Virtual TSharedPtr< class ISlateViewport > Gets a viewport interface which will be used to draw the movie.
Public function Virtual bool

Init ( const TArray< FString >& InMoviePaths,
TEnumAsByte< EMoviePlaybackType > InPlaybackType
)

 IMovieStreamer interface
Public function Virtual bool Returns true if the movie being played in the last one in the play list
Public function Virtual FOnCurrentMovieClipFinished &  
Public function Virtual void

PreviousViewportInterface ( const TSharedPtr< ISlateViewport >& PreviousViewportInterface
)

 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 Called after the engine ticks.
Public function Virtual void Called after rendering is finished.
Public function Virtual void MediaFramework support.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page