1. Epic GamesDeveloper
  3. FAvaRundownPage

FAvaRundownPage

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Rundown

References

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

Syntax

USTRUCT (BlueprintType , DisplayName="Motion Design Rundown Page")  
struct FAvaRundownPage

Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere FSoftObjectPath AssetPath Template property: path for this template.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere bool bEnabled  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere bool bHasTransitionLogic Indicate if the template asset has transition logic.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TArray< int32 > CombinedTemplateIds Template property: For combination template, lists the templates that are combined.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FText FriendlyName  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TSet< int32 > Instances Template property: List the Ids of all instances.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 OutputChannel  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 PageId  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FString PageName  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FText PageSummary  
Protected variable UProperty Category, EditAnywhere FAvaPlayableRemoteControlValues RemoteControlValues  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 TemplateId Page Instance Property: Template Id for this page.
Protected variable UProperty Category visibleanywhere FAvaTagHandle TransitionLayerTag Transition Layer Tag cached from the transition tree.
Public variable friend UAvaRundown  

Constructors

  Type Name Description
Public function  

FAvaRundownPage ( int32 InPageId,
int32 InTemplateId
)

  

Functions

  Type Name Description
Public function Const int32

AppendPagePreviewStatuses ( const UAvaRundown* InParentRundown,
const FName& InPreviewChannelName,
TArray< FAvaRundownChannelPageStatus >& OutPageStatuses
)

 Appends the page's preview status(es) for the given preview channel.
Public function Const int32

AppendPageProgramStatuses ( const UAvaRundown* InParentRundown,
TArray< FAvaRundownChannelPageStatus >& OutPageStatuses
)

 Appends the page's program status(es).
Public function Const FSoftObjectPath

GetAssetPath ( const UAvaRundown* InRundown,
int32 InTemplateIndex
)

  
Public function Const FSoftObjectPath  
Public function Const TArray< FSoftObjectPath >

GetAssetPaths ( const UAvaRundown* InRundown
)

  
Public function Const int32  
Public function Const FName  
Public function Const const TArray< int32 > &  
Public function Const const TSet< int32 > &  
Public function Const int32

GetNumTemplates ( const UAvaRundown* InRundown
)

 Returns the number of templates this page/combo template has.
Public function Const 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.
Public function Const FText  
Public function Const FText  
Public function Const int32  
Public function Const const FString &  
Public function Const TArray< FAvaRundownChannelPageStatus >

GetPagePreviewStatuses ( const UAvaRundown* InParentRundown,
const FName& InPreviewChannelName
)

 Returns the page's preview statuses for the given preview channel.
Public function Const TArray< FAvaRundownChannelPageStatus >

GetPageProgramStatuses ( const UAvaRundown* InParentRundown
)

 Returns the page's program statuses. Returns nothing for template pages.
Public function Const TArray< FAvaRundownChannelPageStatus >

GetPageStatuses ( const UAvaRundown* InParentRundown
)

 Returns all the page's "standard" (program and preview) playback statuses.
Public function Const FText  
Public function Const const FAvaPlayableRemoteControlValue *  
Public function Const const FAvaPlayableRemoteControlValue *  
Public function Const const FAvaPlayableRemoteControlValues &  
Public function Const const FAvaRundownPage &

GetTemplate ( const UAvaRundown* InRundown,
int32 InIndex
)

 Returns the template at given index.
Public function Const int32  
Public function Const FAvaTagHandle

GetTransitionLayer ( const UAvaRundown* InRundown,
int32 InTemplateIndex
)

  
Public function Const TArray< FAvaTagHandle >

GetTransitionLayers ( const UAvaRundown* InRundown
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

HasTransitionLogic ( const UAvaRundown* InRundown
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsTemplateMatchingByValue ( const FAvaRundownPage& InTemplatePage
)

 Compare the values from another template and determines if there is a match.
Public function Const bool  
Public function void  
Public function EAvaPlayableRemoteControlChanges  
Public function void

Rename ( const FString& InNewName
)

  
Public function void

RenameFriendlyName ( const FString& InNewName
)

  
Public function Const const FAvaRundownPage &

ResolveTemplate ( const UAvaRundown* InRundown
)

 Resolves a page's templates.
Public function void

SetChannelName ( FName InChannelName
)

  
Public function void

SetEnabled ( bool bInEnabled
)

  
Public function void

SetPageFriendlyName ( const FText& InPageFriendlyName
)

  
Public function void

SetPageId ( int32 InPageId
)

  
Public function void

SetPageName ( const FString& InPageName
)

  
Public function void  
Public function void  
Public function void

SetTemplateId ( int32 InTemplateId
)

  
Public function Static bool

StatusesContainsStatus ( const TArray< FAvaRundownChannelPageStatus >& InStatuses,
const TArray< EAvaRundownPageStatus >& InStatusEnums
)

  
Public function bool

UpdateAsset ( const FSoftObjectPath& InAssetPath,
bool bInReimportPage
)

  
Public function bool

UpdatePageSummary ( const UAvaRundown* InRundown
)

  
Public function bool

UpdatePageSummary ( const TArray< const URemoteControlPreset* >& InPresets,
bool bInIsPresetChanged
)

  
Public function EAvaPlayableRemoteControlChanges

UpdateRemoteControlValues ( const FAvaPlayableRemoteControlValues& InRemoteControlValues,
bool bInUpdateDefaults
)

  
Public function bool  

Operators

  Type Name Description
Public function Const bool

operator< ( const FAvaRundownPage& InOther
)

  

Constants

Name Description
InvalidPageId  
NullPage  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page