1. Epic GamesDeveloper
  3. UMovieSceneMediaSection

UMovieSceneMediaSection

Implements a movie scene section for media playback.

API > API/Plugins > API/Plugins/MediaCompositing

Inheritance Hierarchy

References

   
Module MediaCompositing
Header /Engine/Plugins/Media/MediaCompositing/Source/MediaCompositing/Public/MovieSceneMediaSection.h
Include #include "MovieSceneMediaSection.h"

Syntax

UCLASS&40;&41;  
class UMovieSceneMediaSection : public UMovieSceneSection

Remarks

Implements a movie scene section for media playback.

Variables

  Type Name Description
Public variable UProperty Transient bool bHasMediaPlayerProxy True if the object bound to this track has a media player proxy.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bLooping 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.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bUseExternalMediaPlayer If true, this track will control a previously created media player instead of automatically creating one.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite FMediaSourceCacheSettings CacheSettings Override the default cache settings.
Public variable UProperty FMovieSceneBoolChannel ChannelCanPlayerBeOpen If true then the media player can be open.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite TObjectPtr< UMediaPlayer > ExternalMediaPlayer The external media player this track should control.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UMediaSoundComponent > MediaSoundComponent The media sound component that receives the track's audio output.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UMediaSource > MediaSource The source to play with this video track if MediaSourceProxy is not available.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 MediaSourceProxyIndex The index to pass to MediaSourceProxy to get the media source.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< UMediaTexture > MediaTexture The media texture that receives the track's video output.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FFrameNumber StartFrameOffset Offset into the source media.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 TextureIndex If using an object like a MediaPlate, then this determines which texture to use for crossfading purposes.
Public variable UProperty float ThumbnailReferenceOffset The reference frame offset for single thumbnail rendering

Constructors

  Type Name Description
Public function  

UMovieSceneMediaSection ( const FObjectInitializer& ObjectInitializer
)

 Create and initialize a new instance.

Functions

  Type Name Description
Public function Const UMediaSource * Get this section's video source.
Public function Const UMediaSource * If there is a proxy, get the media source from it. Otherwise return our media source.
Public function Static UMediaSource *

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

 Static version of GetMediaSourceOrProxy.
Public function Const const FMovieSceneObjectBindingID & Get this section's video source proxy.
Public function Const float  
Public function void

SetMediaSource ( UMediaSource* InMediaSource
)

 Set this section's video source.
Public function void

SetMediaSourceProxy ( const FMovieSceneObjectBindingID& InObjectBinding,
int32 InIndex
)

 Set this section's video source proxy.
Public function void

SetThumbnailReferenceOffset ( float InNewOffset
)

 Set the thumbnail reference offset

Overridden from UMovieSceneSection

  Type Name Description
Protected function Virtual Const TOptional< FFrameTime > The optional offset time of this section
Protected function Virtual void

GetReferencedBindings ( TArray< FGuid >& OutBindings
)

 Get the referenced bindings for this section
Protected function Virtual void

MigrateFrameTimes ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

 Migrate the frame times of the movie scene section from the source frame rate to the destination frame rate
Protected function Virtual void When guid bindings are updated to allow this section to fix-up any internal bindings
Protected function Virtual UMovieSceneSection *

SplitSection ( FQualifiedFrameTime SplitTime,
bool bDeleteKeys
)

 Split a section in two at the split time
Protected function Virtual void

TrimSection ( FQualifiedFrameTime TrimTime,
bool bTrimLeft,
bool bDeleteKeys
)

 Trim a section at the trim time

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page