1. Epic GamesDeveloper
  3. UMovieSceneMediaSection

UMovieSceneMediaSection

Implements a movie scene section for media playback.

API > API/Plugins > API/Plugins/MediaCompositing

Implements a movie scene section for media playback.

   
Name UMovieSceneMediaSection
Type class
Header File /Engine/Plugins/Media/MediaCompositing/Source/MediaCompositing/Public/MovieSceneMediaSection.h
Include Path #include "MovieSceneMediaSection.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieSceneMediaSection : public UMovieSceneSection

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneMediaSection ( const FObjectInitializer& ObjectInitializer
)

 Create and initialize a new instance. MovieSceneMediaSection.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bHasMediaPlayerProxy bool True if the object bound to this track has a media player proxy. MovieSceneMediaSection.h
  • Transient
bLooping bool Should the media player be set to loop? This can be helpful for media formats that can use this information (such as exr sequences) to pre-cache the starting data when nearing the end of playback. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
bUseExternalMediaPlayer bool If true, this track will control a previously created media player instead of automatically creating one. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
  • AdvancedDisplay
CacheSettings FMediaSourceCacheSettings Override the default cache settings. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
  • Meta=(EditCondition="!bHasMediaPlayerProxy", HideEditConditionToggle=true, EditConditionHides)
  • AdvancedDisplay
ChannelCanPlayerBeOpen FMovieSceneBoolChannel If true then the media player can be open. MovieSceneMediaSection.h  
ExternalMediaPlayer TObjectPtr< UMediaPlayer > The external media player this track should control. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
  • Meta=(EditCondition="bUseExternalMediaPlayer")
  • AdvancedDisplay
MediaSoundComponent TObjectPtr< UMediaSoundComponent > The media sound component that receives the track's audio output. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
MediaSource TObjectPtr< UMediaSource > The source to play with this video track if MediaSourceProxy is not available. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
MediaSourceProxyIndex int32 The index to pass to MediaSourceProxy to get the media source. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
MediaTexture TObjectPtr< UMediaTexture > The media texture that receives the track's video output. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
  • Meta=(EditCondition="!bUseExternalMediaPlayer")
StartFrameOffset FFrameNumber Offset into the source media. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
TextureIndex int32 If using an object like a MediaPlate, then this determines which texture to use for crossfading purposes. MovieSceneMediaSection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Media"
  • Meta=(EditCondition="bHasMediaPlayerProxy", HideEditConditionToggle=true, EditConditionHides)
  • AdvancedDisplay
ThumbnailReferenceOffset float The reference frame offset for single thumbnail rendering MovieSceneMediaSection.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
MediaSourceProxyBindingID FMovieSceneObjectBindingID The object to get the source to play from if you don't want to directly specify a media source. MovieSceneMediaSection.h
  • EditAnywhere
  • Category="Section"

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMediaSource * GetMediaSource ()

 Get this section's video source. MovieSceneMediaSection.h  

UMediaSource * GetMediaSourceOrProxy ( IMovieScenePlayer& Player,
FMovieSceneSequenceID SequenceID
) const

 If there is a proxy, get the media source from it. Otherwise return our media source. MovieSceneMediaSection.h  

const FMovieSceneObjectBindingID & GetMediaSourceProxy()

 Get this section's video source proxy. MovieSceneMediaSection.h  

float GetThumbnailReferenceOffset()

   MovieSceneMediaSection.h  

void SetMediaSource ( UMediaSource* InMediaSource
)

 Set this section's video source. MovieSceneMediaSection.h  

void SetMediaSourceProxy ( const FMovieSceneObjectBindingID& InObjectBinding,
int32 InIndex
)

 Set this section's video source proxy. MovieSceneMediaSection.h  

void SetThumbnailReferenceOffset ( float InNewOffset
)

 Set the thumbnail reference offset MovieSceneMediaSection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   MovieSceneMediaSection.h  

Protected

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers

virtual TOptional< FFrameTime > GetOffsetTime()

   MovieSceneMediaSection.h  

virtual void GetReferencedBindings ( TArray< FGuid >& OutBindings
)

   MovieSceneMediaSection.h  

virtual UObject * GetSourceObject()

   MovieSceneMediaSection.h  

virtual void MigrateFrameTimes ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

   MovieSceneMediaSection.h  

virtual void OnBindingIDsUpdated ( const TMap< UE::MovieScene::FFixedObjectBindingID, UE::MovieScene::FFixedObjectBindingID >& OldFixe...,
FMovieSceneSequenceID LocalSequenceID,
TSharedRef< UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

   MovieSceneMediaSection.h  

virtual UMovieSceneSection * SplitSection ( FQualifiedFrameTime SplitTime,
bool bDeleteKeys
)

   MovieSceneMediaSection.h  

virtual void TrimSection ( FQualifiedFrameTime TrimTime,
bool bTrimLeft,
bool bDeleteKeys
)

   MovieSceneMediaSection.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMediaSource * GetMediaSourceOrProxy ( IMovieScenePlayer& InPlayer,
FMovieSceneSequenceID InSequenceID,
UMediaSource* InMediaSource,
const FMovieSceneObjectBindingID& InMediaSourceProxyBindingID,
int32 InMediaSourceProxyIndex
)

 Static version of GetMediaSourceOrProxy. MovieSceneMediaSection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page