Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
| Name | FAvaRundownPage |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Rundown/AvaRundownPage.h |
| Include Path | #include "Rundown/AvaRundownPage.h" |
Syntax
USTRUCT (BlueprintType , DisplayName="Motion Design Rundown Page")
struct FAvaRundownPage
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAvaRundownPage
(
int32 InPageId, |
Rundown/AvaRundownPage.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvalidPageId | const int32 | Rundown/AvaRundownPage.h | |
| NullPage | FAvaRundownPage | Rundown/AvaRundownPage.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| UAvaRundown | friend | Rundown/AvaRundownPage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AppendPagePreviewStatuses
(
const UAvaRundown* InParentRundown, |
Appends the page's preview status(es) for the given preview channel. | Rundown/AvaRundownPage.h | |
int32 AppendPageProgramStatuses
(
const UAvaRundown* InParentRundown, |
Appends the page's program status(es). | Rundown/AvaRundownPage.h | |
void ForEachInstancedCommands
(
TFunctionRef< void(const FAvaRundownPageCommand&, const FAvaRundownPage&)> InFunction, |
Calls the given function for each commands in the page. | Rundown/AvaRundownPage.h | |
FSoftObjectPath GetAssetPath
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
FSoftObjectPath GetAssetPathDirect() |
Rundown/AvaRundownPage.h | ||
TArray< FSoftObjectPath > GetAssetPaths
(
const UAvaRundown* InRundown |
Rundown/AvaRundownPage.h | ||
int32 GetChannelIndex() |
Rundown/AvaRundownPage.h | ||
FName GetChannelName() |
Rundown/AvaRundownPage.h | ||
const TArray< int32 > & GetCombinedTemplateIds() |
Rundown/AvaRundownPage.h | ||
bool GetDefaultControllerValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
bool GetDefaultEntityValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
bool GetDefaultRemoteControlValues
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
const TArray< FInstancedStruct > & GetInstancedCommands() |
Get the instanced page commands. | Rundown/AvaRundownPage.h | |
const TSet< int32 > & GetInstancedIds() |
Rundown/AvaRundownPage.h | ||
int32 GetNumTemplates
(
const UAvaRundown* InRundown |
Returns the number of templates this page/combo template has. | Rundown/AvaRundownPage.h | |
TArray< FAvaRundownChannelPageStatus > GetPageContextualStatuses
(
const UAvaRundown* InParentRundown |
Returns either the program statuses or preview statuses only depending if the page is instanced (has a program channel), or a template respectively. | Rundown/AvaRundownPage.h | |
FText GetPageDescription() |
Rundown/AvaRundownPage.h | ||
FText GetPageFriendlyName() |
Rundown/AvaRundownPage.h | ||
int32 GetPageId() |
Rundown/AvaRundownPage.h | ||
const FString & GetPageName() |
Rundown/AvaRundownPage.h | ||
TArray< FAvaRundownChannelPageStatus > GetPagePreviewStatuses
(
const UAvaRundown* InParentRundown, |
Returns the page's preview statuses for the given preview channel. | Rundown/AvaRundownPage.h | |
TArray< FAvaRundownChannelPageStatus > GetPageProgramStatuses
(
const UAvaRundown* InParentRundown |
Returns the page's program statuses. Returns nothing for template pages. | Rundown/AvaRundownPage.h | |
TArray< FAvaRundownChannelPageStatus > GetPageStatuses
(
const UAvaRundown* InParentRundown |
Returns all the page's "standard" (program and preview) playback statuses. | Rundown/AvaRundownPage.h | |
FText GetPageSummary() |
Rundown/AvaRundownPage.h | ||
const FAvaPlayableRemoteControlValue * GetRemoteControlControllerValue
(
const FGuid& InId |
Rundown/AvaRundownPage.h | ||
const FAvaPlayableRemoteControlValue * GetRemoteControlEntityValue
(
const FGuid& InId |
Rundown/AvaRundownPage.h | ||
const FAvaPlayableRemoteControlValues & GetRemoteControlValues() |
Rundown/AvaRundownPage.h | ||
const FAvaRundownPage & GetTemplate
(
const UAvaRundown* InRundown, |
Returns the template at given index. | Rundown/AvaRundownPage.h | |
int32 GetTemplateId() |
Rundown/AvaRundownPage.h | ||
FAvaTagHandle GetTransitionLayer
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
TArray< FAvaTagHandle > GetTransitionLayers
(
const UAvaRundown* InRundown |
Rundown/AvaRundownPage.h | ||
EAvaTransitionInstancingMode GetTransitionMode
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
TArray< EAvaTransitionInstancingMode > GetTransitionModes
(
const UAvaRundown* InRundown |
Rundown/AvaRundownPage.h | ||
bool HasAssets
(
const UAvaRundown& InRundown |
Returns true if the page has some valid assets. | Rundown/AvaRundownPage.h | |
bool HasCommands
(
const UAvaRundown* InRundown |
Returns true if the page (or it's template(s)) has commands. | Rundown/AvaRundownPage.h | |
bool HasPageFriendlyName() |
Rundown/AvaRundownPage.h | ||
bool HasPageSummary() |
Rundown/AvaRundownPage.h | ||
bool HasRemoteControlControllerValue
(
const FGuid& InId |
Rundown/AvaRundownPage.h | ||
bool HasRemoteControlEntityValue
(
const FGuid& InId |
Rundown/AvaRundownPage.h | ||
bool HasTransitionLogic
(
const UAvaRundown* InRundown |
Rundown/AvaRundownPage.h | ||
bool IsComboTemplate() |
Rundown/AvaRundownPage.h | ||
bool IsDefaultControllerValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
bool IsDefaultEntityValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
bool IsEnabled() |
Rundown/AvaRundownPage.h | ||
bool IsTemplate() |
Rundown/AvaRundownPage.h | ||
bool IsTemplateMatchingByValue
(
const FAvaRundownPage& InTemplatePage |
Compare the values from another template and determines if there is a match. | Rundown/AvaRundownPage.h | |
bool IsValidPage() |
Rundown/AvaRundownPage.h | ||
void LoadInstancedCommands
(
const TArray< FAvaRundownPageCommandData >& InCommands |
Load the instanced commands from the given command data (from web api). | Rundown/AvaRundownPage.h | |
void PostLoad() |
Rundown/AvaRundownPage.h | ||
EAvaPlayableRemoteControlChanges PruneRemoteControlValues
(
const FAvaPlayableRemoteControlValues& InRemoteControlValues |
Rundown/AvaRundownPage.h | ||
void Rename
(
const FString& InNewName |
Rundown/AvaRundownPage.h | ||
void RenameFriendlyName
(
const FString& InNewName |
Rundown/AvaRundownPage.h | ||
void ResetInstancedIds() |
Rundown/AvaRundownPage.h | ||
EAvaPlayableRemoteControlChanges ResetRemoteControlControllerValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
EAvaPlayableRemoteControlChanges ResetRemoteControlEntityValue
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
EAvaPlayableRemoteControlChanges ResetRemoteControlValues
(
const UAvaRundown* InRundown, |
Rundown/AvaRundownPage.h | ||
const FAvaRundownPage & ResolveTemplate
(
const UAvaRundown* InRundown |
Resolves a page's templates. | Rundown/AvaRundownPage.h | |
TArray< FAvaRundownPageCommandData > SaveInstancedCommands() |
Save the instanced commands to command data (suitable for web api). | Rundown/AvaRundownPage.h | |
void SetChannelName
(
FName InChannelName |
Rundown/AvaRundownPage.h | ||
void SetEnabled
(
bool bInEnabled |
Rundown/AvaRundownPage.h | ||
void SetInstancedCommands
(
const TArray< FInstancedStruct >& InInstancedCommands |
Set the instanced commands. | Rundown/AvaRundownPage.h | |
void SetPageFriendlyName
(
const FText& InPageFriendlyName |
Rundown/AvaRundownPage.h | ||
void SetPageId
(
int32 InPageId |
Rundown/AvaRundownPage.h | ||
void SetPageName
(
const FString& InPageName |
Rundown/AvaRundownPage.h | ||
void SetRemoteControlControllerValue
(
const FGuid& InId, |
Rundown/AvaRundownPage.h | ||
void SetRemoteControlEntityValue
(
const FGuid& InId, |
Rundown/AvaRundownPage.h | ||
void SetTemplateId
(
int32 InTemplateId |
Rundown/AvaRundownPage.h | ||
bool UpdateAsset
(
const FSoftObjectPath& InAssetPath, |
Rundown/AvaRundownPage.h | ||
bool UpdatePageSummary
(
const UAvaRundown* InRundown |
Update the page summary (only if summary is empty) | Rundown/AvaRundownPage.h | |
bool UpdatePageSummary
(
const TArray< const URemoteControlPreset* >& InPresets, |
Rundown/AvaRundownPage.h | ||
bool UpdatePageSummary
(
const UAvaRundown* InRundown, |
Update the page summary from controller values or commands. | Rundown/AvaRundownPage.h | |
EAvaPlayableRemoteControlChanges UpdateRemoteControlValues
(
const FAvaPlayableRemoteControlValues& InRemoteControlValues, |
Rundown/AvaRundownPage.h | ||
bool UpdateTransitionLogic() |
Rundown/AvaRundownPage.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool StatusesContainsStatus
(
const TArray< FAvaRundownChannelPageStatus >& InStatuses, |
Rundown/AvaRundownPage.h |