1. Epic GamesDeveloper
  3. FAvaPlaybackManager

FAvaPlaybackManager

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Playback

Inheritance Hierarchy

References

   
Module AvalancheMedia
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/Playback/AvaPlaybackManager.h
Include #include "Playback/AvaPlaybackManager.h"

Syntax

class FAvaPlaybackManager : public TSharedFromThis< FAvaPlaybackManager >

Variables

  Type Name Description
Public variable FOnBeginTick OnBeginTick  
Public variable FOnLocalPlaybackAssetRemoved OnLocalPlaybackAssetRemoved  
Public variable FOnPlaybackInstanceInvalidated OnPlaybackInstanceInvalidated  
Public variable FOnPlaybackInstanceStatusChanged OnPlaybackInstanceStatusChanged  

Constructors

  Type Name Description
Public function    
Protected function   Non-copyable (because copy of CachedAssetStatusExtra is not defined)

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedPtr< FAvaPlaybackInstance >

AcquireOrLoadPlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

 Attempts to acquire existing instance. If none available, will load a new one.
Public function Const TSharedPtr< FAvaPlaybackInstance >

AcquirePlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

 Acquire a cached playback instance. Will return null if none available in the cache.
Public function void

ApplyPendingCommands ( UAvaPlaybackGraph* InPlaybackObject,
const FGuid& InInstanceId,
const FSoftObjectPath& InSourcePath,
const FString& InChannelName
)

 This is used on the playback server to apply any pending commands to a playback instance.
Public function Const UAvaPlaybackGraph *

BuildPlaybackFromWorld ( const TSoftObjectPtr< UWorld >& InWorld,
const FString& InChannelName
)

  
Protected function Const TSharedPtr< FAvaPlaybackSourceAssetEntry >

FindPlaybackAssetEntry ( const FSoftObjectPath& InAssetPath
)

  
Public function Const TSharedPtr< FAvaPlaybackInstance >

FindPlaybackInstance ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

 Finds an existing (either available or used) playback instance.
Public function void  
Public function EAvaPlaybackAssetStatus

GetLocalAssetStatus ( const FName& InPackageName
)

 Determines the local status of the given asset on this local instance of the playback manager.
Public function Const UAvaPlayableGroupManager *  
Protected function TSharedPtr< FAvaPlaybackSourceAssetEntry >

GetPlaybackAssetEntry ( const FSoftObjectPath& InAssetPath
)

  
Public function Const EAvaPlaybackStopOptions

GetPlaybackStopOptions ( bool bInUnload
)

  
Public function Const EAvaPlaybackUnloadOptions  
Public function EAvaPlaybackStatus Utility function to determine the playback status of an unloaded asset.
Public function bool

HandleStatCommand ( const TArray< FString >& InArgs
)

 Implements a similar command to Engine::HandleStatCommand, except it will fetch Motion Design's game viewport client if everything else fails.
Public function void

InvalidateCachedLocalAssetStatus ( const FName& InPackageName
)

 Invalidates the cached local asset status.
Public function void Invalidate the asset entry. All cached instances will be invalidated along with it.
Public function bool

IsLocalAssetAvailable ( const FSoftObjectPath& InAssetPath
)

  
Public function bool

IsLocalAssetAvailable ( const FName& InPackageName
)

 Utility function to determine if an asset is locally available.
Public function Static bool

IsPlaybackAsset ( const FAssetData& InAssetData
)

 Returns true if the given asset is a playback asset, i.e. either a "playable" asset or a playback graph.
Public function TSharedPtr< FAvaPlaybackInstance >

LoadPlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

 Load a new playback instance.
Public function Const UAvaPlaybackGraph *

LoadPlaybackObject ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

  
Protected function void

OnAssetRemoved ( const FAssetData& InAssetData
)

  
Protected function void

OnAvaSyncPackageModified ( IAvaMediaSyncProvider* InAvaMediaSyncProvider,
const FName& InPackageName
)

  
Public function void

OnPackageModified ( const FName& InPackageName,
EAvaPlaybackPackageEventFlags InFlags
)

 Let the Playback manager know that a package has been modified.
Protected function void

OnPackageSaved ( const FString& InPackageFileName,
UPackage* InPackage,
FObjectPostSaveContext InObjectSaveContext
)

  
Public function void TearDown the whole Motion Design Playback system.
Public function bool

PushAnimationCommand ( const FGuid& InInstanceId,
const FSoftObjectPath& InSourcePath,
const FString& InChannelName,
EAvaPlaybackAnimAction InAction,
const FAvaPlaybackAnimPlaySettings& InAnimSettings
)

  
Public function bool

PushPlaybackTransitionStartCommand ( UAvaPlaybackTransition* InTransitionToStart
)

  
Public function bool

PushRemoteControlCommand ( const FGuid& InInstanceId,
const FSoftObjectPath& InSourcePath,
const FString& InChannelName,
const TSharedRef< FAvaPlayableRemoteControlValues >& InRemoteControlValues
)

  
Public function void  
Public function void Indicate the manager is in a shutdown sequence and will force game instances to destroy worlds right away.
Public function TArray< FSoftObjectPath >

StopAllPlaybacks ( bool bInUnload
)

 Stops all currently playing playback objects.
Public function void

Tick ()

  
Public function bool

UnloadPlaybackInstances ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
)

 Unload and discard any available (i.e. not used) instances for this asset/channel entry.

Operators

  Type Name Description
Protected function FAvaPlaybackManager &  

Typedefs

Name Description
FOnBeginTick  
FOnLocalPlaybackAssetRemoved  
FOnPlaybackInstanceInvalidated  
FOnPlaybackInstanceStatusChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page