1. Epic GamesDeveloper
  3. AMediaBundleActorBase

AMediaBundleActorBase

A base actor that

API > API/Plugins > API/Plugins/MediaFrameworkUtilities

Inheritance Hierarchy

References

   
Module MediaFrameworkUtilities
Header /Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/MediaBundleActorBase.h
Include #include "MediaBundleActorBase.h"

Syntax

UCLASS&40;Abstract, Blueprintable&41;  
class AMediaBundleActorBase : public AActor

Remarks

A base actor that

Variables

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly bool bAutoPlay Wheter to auto start the MediaPlayer
Protected variable bool bPlayingMedia Whether we're actually playing the media
Protected variable UProperty Category, EditDefaultsOnly, Meta bool bPlayWhileEditing Wheter to keep MediaPlayer playing when editing
Public variable UProperty Category, EditAnywhere TObjectPtr< UTextureRenderTarget2D > GarbageMatteMask Texture containging 2D garbage matte mask
Protected variable UProperty Category, EditDefaultsOnly TObjectPtr< UMaterialInstanceDynamic > Material Dynamic instance of the associated MediaBundle base Material
Protected variable UProperty Category, EditAnywhere noclear TObjectPtr< UMediaBundle > MediaBundle Associated MediaBundle
Protected variable UProperty Category, EditDefaultsOnly noclear TObjectPtr< UMediaSoundComponent > MediaSoundCmp MediaSoundComponent associated to play sound of our MediaSource
Protected variable UProperty Category, EditDefaultsOnly TObjectPtr< UPrimitiveComponent > PrimitiveCmp PrimitiveComponent on which to attach our Material
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay int32 PrimitiveMaterialIndex Index of the Material on the primitive

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category UMediaBundle * Get the Media Bundle.
Public function Const bool Whether this actor requested the media to play.
Public function UFunction BlueprintCallable, Category void Close the Media Source.
Public function UFunction BlueprintCallable, Category bool Play the Media Source.
Protected function UFunction BlueprintCallable, Category void

SetComponent ( UPrimitiveComponent* InPrimitive,
UMediaSoundComponent* InMediaSound
)

 Assign the primitive to render on. Will change the material for the Media material.

Overridden from AActor

  Type Name Description
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual void Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog.
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual void Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void

PostLoadSubobjects ( FObjectInstancingGraph* OuterInstanceGraph
)

 Instances components for objects being loaded from disk, if necessary.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page