Navigation
API > API/Plugins > API/Plugins/MediaCompositing
Persistent data that's stored for each currently evaluating section.
| Name | FMovieSceneMediaData |
| Type | struct |
| Header File | /Engine/Plugins/Media/MediaCompositing/Source/MediaCompositing/Public/MovieSceneMediaData.h |
| Include Path | #include "MovieSceneMediaData.h" |
Syntax
struct FMovieSceneMediaData : public PropertyTemplate::FSectionData
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneMediaData() |
Default constructor. | MovieSceneMediaData.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMovieSceneMediaData() |
Virtual destructor. | MovieSceneMediaData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasBeenExecuted | bool | Indicate if the section template has been executed already or not. | MovieSceneMediaData.h | |
| bIsAspectRatioSet | bool | Stores if the aspect ratio has been set yet. | MovieSceneMediaData.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverrideMediaPlayer | bool | MovieSceneMediaData.h | ||
| MediaPlayer | UMediaPlayer * | The media player used by this object. | MovieSceneMediaData.h | |
| MediaPlayerStoreWeak | TWeakPtr< FMovieSceneMediaPlayerStore > | Pointer to the media player store this section data was setup with. | MovieSceneMediaData.h | |
| MediaSection | FObjectKey | Owning Media Section. Used as persistent identifier for media player data. | MovieSceneMediaData.h | |
| PlaybackParams | FMovieSceneMediaPlaybackParams | Additional player parameters to set before the first seek. | MovieSceneMediaData.h | |
| PlayerProxy | TWeakObjectPtr< UObject > | Optional proxy for the media player. | MovieSceneMediaData.h | |
| ProxyLayerIndex | int32 | Layer that this section should reside in. | MovieSceneMediaData.h | |
| ProxyMediaTexture | TWeakObjectPtr< UMediaTexture > | Media texture allocated from the proxy. | MovieSceneMediaData.h | |
| ProxyTextureIndex | int32 | Index of texture allocated from the proxy. | MovieSceneMediaData.h | |
| SampleQueue | TSharedPtr< FMediaTextureSampleQueue > | Sample queue to be used as video sink for the media player. | MovieSceneMediaData.h | |
| SeekOnOpenTime | FTimespan | The time to seek to after the media source is opened. | MovieSceneMediaData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMediaPlayer * GetMediaPlayer() |
Get the media player used by this persistent data. | MovieSceneMediaData.h | |
UObject * GetPlayerProxy() |
Get the optional proxy object used by this persistent data. | MovieSceneMediaData.h | |
int32 GetProxyLayerIndex() |
Get the layer index we are using (when using a proxy). | MovieSceneMediaData.h | |
UMediaTexture * GetProxyMediaTexture() |
Get the proxy media texture. | MovieSceneMediaData.h | |
int32 GetProxyTextureIndex() |
Get the texture index we are using (when using a proxy). | MovieSceneMediaData.h | |
void Initialize
(
bool bIsEvaluating |
Called from FMovieSceneMediaSectionTemplate::Initialize. | MovieSceneMediaData.h | |
bool IsPlayerProxyStale() |
Returns true if the player proxy object has become stale. | MovieSceneMediaData.h | |
void SeekOnOpen
(
FTimespan Time |
Set the time to seek to after opening a media source has finished. | MovieSceneMediaData.h | |
void Setup
(
const TSharedPtr< FMovieSceneMediaPlayerStore >& InMediaPlayerStore, |
MovieSceneMediaData.h | ||
void Setup
(
const TSharedPtr< FMovieSceneMediaPlayerStore >& InMediaPlayerStore, |
Set up this persistent data object. | MovieSceneMediaData.h | |
void TearDown() |
Called from FMovieSceneMediaSectionTemplate::TearDown. | MovieSceneMediaData.h | |
TSharedPtr< FMediaTextureSampleQueue > TransferSampleQueue() |
Retrieve the sample queue and release the ownership. | MovieSceneMediaData.h | |
void UpdatePlayerProxy
(
UObject* InPlayerProxy |
Update the player proxy interface object. | MovieSceneMediaData.h |