Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
Handle to a playback instance for recycling.
| Name | FAvaPlaybackInstance |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Playback/AvaPlaybackManager.h |
| Include Path | #include "Playback/AvaPlaybackManager.h" |
Syntax
class FAvaPlaybackInstance : public FGCObject
Inheritance Hierarchy
- FGCObject → FAvaPlaybackInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Playback/AvaPlaybackManager.h | |||
FAvaPlaybackInstance
(
const FGuid& InInstanceId, |
Playback/AvaPlaybackManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAvaPlaybackInstance() |
Playback/AvaPlaybackManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetEntryWeak | TWeakPtr< FAvaPlaybackSourceAssetEntry > | If the cache slot becomes invalid, it means this instance will be discarded instead of being recycled. | Playback/AvaPlaybackManager.h | |
| ChannelFName | FName | Playback/AvaPlaybackManager.h | ||
| ChannelName | FString | Playback/AvaPlaybackManager.h | ||
| InstanceId | FGuid | Playback/AvaPlaybackManager.h | ||
| InstanceUserData | FString | Playback/AvaPlaybackManager.h | ||
| Playback | TObjectPtr< UAvaPlaybackGraph > | Playback/AvaPlaybackManager.h | ||
| SourcePath | FSoftObjectPath | Playback/AvaPlaybackManager.h | ||
| Status | EAvaPlaybackStatus | Playback/AvaPlaybackManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FName & GetChannelFName() |
Playback/AvaPlaybackManager.h | ||
const FString & GetChannelName() |
Playback/AvaPlaybackManager.h | ||
const FGuid & GetInstanceId() |
Playback/AvaPlaybackManager.h | ||
const FString & GetInstanceUserData() |
Playback/AvaPlaybackManager.h | ||
TSharedPtr< FAvaPlaybackManager > GetManager() |
Playback/AvaPlaybackManager.h | ||
UAvaPlaybackGraph * GetPlayback() |
Playback/AvaPlaybackManager.h | ||
const FSoftObjectPath & GetSourcePath() |
Playback/AvaPlaybackManager.h | ||
EAvaPlaybackStatus GetStatus() |
Playback/AvaPlaybackManager.h | ||
bool IsPlaying() |
Playback/AvaPlaybackManager.h | ||
void Recycle() |
Playback/AvaPlaybackManager.h | ||
void SetInstanceId
(
const FGuid& InInstanceId |
This is used by the server to track the client's id. | Playback/AvaPlaybackManager.h | |
void SetInstanceUserData
(
const FString& InUserData |
Set the instance's user data. | Playback/AvaPlaybackManager.h | |
void SetStatus
(
EAvaPlaybackStatus InStatus |
Playback/AvaPlaybackManager.h | ||
void Unload() |
Playback/AvaPlaybackManager.h | ||
bool UpdateStatus() |
Playback/AvaPlaybackManager.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Playback/AvaPlaybackManager.h | ||
virtual FString GetReferencerName() |
Playback/AvaPlaybackManager.h |