Navigation
API > API/Plugins > API/Plugins/MediaMovieStreamer
Movie streamer that allows you to use MediaFramework during level loading, etc.
| Name | FMediaMovieStreamer |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaMovieStreamer/Source/MediaMovieStreamer/Public/MediaMovieStreamer.h |
| Include Path | #include "MediaMovieStreamer.h" |
Syntax
class FMediaMovieStreamer : public IMovieStreamer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaMovieStreamer() |
MediaMovieStreamer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMediaMovieStreamer() |
MediaMovieStreamer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MovieStreamerPostEngineTick | FMovieStreamerExternalTick | MediaMovieStreamer.h | ||
| MovieStreamerPostRenderTick | FMovieStreamerExternalTick | MediaMovieStreamer.h | ||
| MovieStreamerPreEngineTick | FMovieStreamerExternalTick | MediaMovieStreamer.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsMediaControlledExternally | bool | True if somethiing else is controlling the media. | MediaMovieStreamer.h | |
| bIsPlaying | bool | True if the media is still playing. | MediaMovieStreamer.h | |
| MediaPlayer | TWeakObjectPtr< UMediaPlayer > | Holds the player we are using. | MediaMovieStreamer.h | |
| MediaSoundComponent | TWeakObjectPtr< UMediaSoundComponent > | Holds the media sound component we are using. | MediaMovieStreamer.h | |
| MediaSource | TWeakObjectPtr< UMediaSource > | Holds the media source we are using. | MediaMovieStreamer.h | |
| MediaTexture | TWeakObjectPtr< UMediaTexture > | Holds the media texture we are using. | MediaMovieStreamer.h | |
| MovieViewport | TSharedPtr< FMovieViewport > | Viewport data for displaying to Slate. | MediaMovieStreamer.h | |
| OnCurrentMovieClipFinishedDelegate | FOnCurrentMovieClipFinished | Delegate for when the movie is finished. | MediaMovieStreamer.h | |
| PreviousTimeSource | TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe > | Stores the previous time source so we can restore it when we are done. | MediaMovieStreamer.h | |
| Texture | TSharedPtr< FSlateTexture2DRHIRef, ESPMode::ThreadSafe > | Texture displaying to Slate. | MediaMovieStreamer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Cleanup() |
MediaMovieStreamer.h | ||
virtual void ForceCompletion() |
MediaMovieStreamer.h | ||
virtual float GetAspectRatio() |
MediaMovieStreamer.h | ||
UMediaSoundComponent * GetMediaSoundComponent() |
Returns the current MediaSoundComponent | MediaMovieStreamer.h | |
virtual FString GetMovieName() |
MediaMovieStreamer.h | ||
virtual FTextureRHIRef GetTexture() |
MediaMovieStreamer.h | ||
virtual TSharedPtr< class ISlateViewport > GetViewportInterface() |
MediaMovieStreamer.h | ||
virtual bool Init
(
const TArray< FString >& InMoviePaths, |
IMovieStreamer interface | MediaMovieStreamer.h | |
virtual bool IsLastMovieInPlaylist() |
MediaMovieStreamer.h | ||
virtual FOnCurrentMovieClipFinished & OnCurrentMovieClipFinished() |
MediaMovieStreamer.h | ||
void OnMediaEnd() |
Called from UMediaMovieAssets when the media ends. | MediaMovieStreamer.h | |
virtual void PreviousViewportInterface
(
const TSharedPtr< ISlateViewport >& PreviousViewportInterface |
MediaMovieStreamer.h | ||
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. | MediaMovieStreamer.h | |
void SetMediaPlayer
(
UMediaPlayer* InMediaPlayer |
Sets which media player should be playing. | MediaMovieStreamer.h | |
void SetMediaSoundComponent
(
UMediaSoundComponent* InMediaSoundComponent |
Sets what media sound component we are using. | MediaMovieStreamer.h | |
void SetMediaSource
(
UMediaSource* InMediaSource |
Sets what to play. | MediaMovieStreamer.h | |
void SetMediaTexture
(
UMediaTexture* InMediaTexture |
Sets what media texture we are using. | MediaMovieStreamer.h | |
virtual bool Tick
(
FRHICommandListBase& RHICmdList, |
MediaMovieStreamer.h | ||
virtual void TickPostEngine() |
MediaMovieStreamer.h | ||
virtual void TickPostRender() |
MediaMovieStreamer.h | ||
virtual void TickPreEngine() |
MediaMovieStreamer.h |