1. Epic GamesDeveloper
  3. FAvaPlaybackManager

FAvaPlaybackManager

API > API/Plugins > API/Plugins/AvalancheMedia

   
Name FAvaPlaybackManager
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Playback/AvaPlaybackManager.h
Include Path #include "Playback/AvaPlaybackManager.h"

Syntax

class FAvaPlaybackManager : public TSharedFromThis< FAvaPlaybackManager >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Non-copyable (because copy of CachedAssetStatusExtra is not defined) Playback/AvaPlaybackManager.h  
  Playback/AvaPlaybackManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAvaPlaybackManager()

   Playback/AvaPlaybackManager.h  

Structs

Name Remarks
FPlaybackObjectCommandBuffers  

Typedefs

Name Type Remarks Include Path
FOnBeginTick TMulticastDelegate_OneParam< void, float >   Playback/AvaPlaybackManager.h
FOnLocalPlaybackAssetRemoved TMulticastDelegate_OneParam< void, const FSoftObjectPath & >   Playback/AvaPlaybackManager.h
FOnPlaybackInstanceInvalidated TMulticastDelegate_OneParam< void, const FAvaPlaybackInstance & >   Playback/AvaPlaybackManager.h
FOnPlaybackInstanceStatusChanged TMulticastDelegate_OneParam< void, const FAvaPlaybackInstance & >   Playback/AvaPlaybackManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnBeginTick FOnBeginTick   Playback/AvaPlaybackManager.h  
OnLocalPlaybackAssetRemoved FOnLocalPlaybackAssetRemoved   Playback/AvaPlaybackManager.h  
OnPlaybackInstanceInvalidated FOnPlaybackInstanceInvalidated   Playback/AvaPlaybackManager.h  
OnPlaybackInstanceStatusChanged FOnPlaybackInstanceStatusChanged   Playback/AvaPlaybackManager.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnablePlaybackCommandsBuffering bool Enables the playback command buffering. Playback/AvaPlaybackManager.h  
bIsShuttingDown bool   Playback/AvaPlaybackManager.h  
CachedAssetStatus TMap< FName, EAvaPlaybackAssetStatus > Cached asset status. Playback/AvaPlaybackManager.h  
PendingStartTransitions TArray< TWeakObjectPtr< UAvaPlaybackTransition > >   Playback/AvaPlaybackManager.h  
PlayableGroupManager TStrongObjectPtr< UAvaPlayableGroupManager > This is the shared pool of shared playable groups for all the playback objects. Playback/AvaPlaybackManager.h  
PlaybackAssetEntries TMap< FSoftObjectPath, TSharedPtr< FAvaPlaybackSourceAssetEntry > > TODO: Refactor this to support cache capacity with eviction (LRU) like FAvaRundownManagedInstanceCache. Playback/AvaPlaybackManager.h  
PlaybackObjectCommandBuffers TMap< FString, FPlaybackObjectCommandBuffers > Use FAvaPlaybackManager::MakePlaybackKey for Map key. Playback/AvaPlaybackManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< FAvaPlaybackInstance > AcquireOrLoadPlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InLoadOptions
)

 Attempts to acquire (recycle) an existing playback instance. Playback/AvaPlaybackManager.h  

TSharedPtr< FAvaPlaybackInstance > AcquirePlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName
) const

 Acquire (recycle) a cached playback instance. Will return null if none available in the cache. Playback/AvaPlaybackManager.h  

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. Playback/AvaPlaybackManager.h  

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

 Utility function to create a new playback graph instance for the given world asset with the given channel as context. Playback/AvaPlaybackManager.h  

TSharedPtr< FAvaPlaybackInstance > FindPlaybackInstance ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName
) const

 Finds an existing (either available or used) playback instance. Playback/AvaPlaybackManager.h  

void ForAllPlaybackInstances ( TFunctionRef< void(FAvaPlaybackInstance&)> InFunction
)

   Playback/AvaPlaybackManager.h  

EAvaPlaybackAssetStatus GetLocalAssetStatus ( const FName& InPackageName
)

 Determines the local status of the given asset on this local instance of the playback manager. Playback/AvaPlaybackManager.h  

UAvaPlayableGroupManager * GetPlayableGroupManager()

   Playback/AvaPlaybackManager.h  

EAvaPlaybackStopOptions GetPlaybackStopOptions ( bool bInUnload
) const

   Playback/AvaPlaybackManager.h  

EAvaPlaybackUnloadOptions GetPlaybackUnloadOptions()

   Playback/AvaPlaybackManager.h  

EAvaPlaybackStatus GetUnloadedPlaybackStatus ( const FSoftObjectPath& InAssetPath
)

 Utility function to determine the playback status of an unloaded asset. Playback/AvaPlaybackManager.h  

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. Playback/AvaPlaybackManager.h  

void InvalidateCachedLocalAssetStatus ( const FName& InPackageName
)

 Invalidates the cached local asset status. Playback/AvaPlaybackManager.h  

void InvalidatePlaybackAssetEntry ( const FSoftObjectPath& InAssetPath
)

 Invalidate the asset entry. All cached instances will be invalidated along with it. Playback/AvaPlaybackManager.h  

bool IsLocalAssetAvailable ( const FSoftObjectPath& InAssetPath
)

   Playback/AvaPlaybackManager.h  

bool IsLocalAssetAvailable ( const FName& InPackageName
)

 Utility function to determine if an asset is locally available. Playback/AvaPlaybackManager.h  

bool IsShuttingDown()

   Playback/AvaPlaybackManager.h  

TSharedPtr< FAvaPlaybackInstance > LoadPlaybackInstance ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InLoadOptions
)

 Load a new (recyclable) playback instance for the given asset in the given channel. Playback/AvaPlaybackManager.h  

UAvaPlaybackGraph * LoadPlaybackObject ( const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InLoadOptions
) const

 Loads a new playback graph for the given asset with the given channel as context. Playback/AvaPlaybackManager.h  

void OnPackageModified ( const FName& InPackageName,
EAvaPlaybackPackageEventFlags InFlags
)

 Let the Playback manager know that a package has been modified. Playback/AvaPlaybackManager.h  
TearDown the whole Motion Design Playback system. Playback/AvaPlaybackManager.h  

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

   Playback/AvaPlaybackManager.h  

bool PushPlaybackTransitionStartCommand ( UAvaPlaybackTransition* InTransitionToStart
)

   Playback/AvaPlaybackManager.h  

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

   Playback/AvaPlaybackManager.h  

void SetEnablePlaybackCommandsBuffering ( bool bInEnable
)

   Playback/AvaPlaybackManager.h  

void StartShuttingDown()

 Indicate the manager is in a shutdown sequence and will force game instances to destroy worlds right away. Playback/AvaPlaybackManager.h  

TArray< FSoftObjectPath > StopAllPlaybacks ( bool bInUnload
)

 Stops all currently playing playback objects. Playback/AvaPlaybackManager.h  

void Tick()

   Playback/AvaPlaybackManager.h  

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

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

Protected

Name Remarks Include Path Unreal Specifiers

TSharedPtr< FAvaPlaybackSourceAssetEntry > FindPlaybackAssetEntry ( const FSoftObjectPath& InAssetPath
) const

   Playback/AvaPlaybackManager.h  

TSharedPtr< FAvaPlaybackSourceAssetEntry > GetPlaybackAssetEntry ( const FSoftObjectPath& InAssetPath
)

   Playback/AvaPlaybackManager.h  

void OnAssetRemoved ( const FAssetData& InAssetData
)

   Playback/AvaPlaybackManager.h  

void OnAvaSyncPackageModified ( IAvaMediaSyncProvider* InAvaMediaSyncProvider,
const FName& InPackageName
)

   Playback/AvaPlaybackManager.h  

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

   Playback/AvaPlaybackManager.h  

Static

Name Remarks Include Path Unreal Specifiers

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. Playback/AvaPlaybackManager.h  

Operators

Name Remarks Include Path Unreal Specifiers

FAvaPlaybackManager & operator= ( const FAvaPlaybackManager&
)

   Playback/AvaPlaybackManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page