1. Epic GamesDeveloper
  3. UAvaRundown

UAvaRundown

This class is a container for what could be described as a "show" for broadcast purposes.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (NotBlueprintable, BlueprintType, ClassGroup="Motion Design Rundown",  
       Meta=(DisplayName="Motion Design Rundown"))  
class UAvaRundown : public UObject

Remarks

This class is a container for what could be described as a "show" for broadcast purposes.

It goes beyond a simple list of items. It contains the following:

  • a list of Motion Design Template Pages (or just Templates).
  • a list of Motion Design Instanced Pages (or just Pages).
  • a list of page views (or just Views).

Workflow:

1- Templates

The first step in the work flow consist in importing templates. The source asset is not actually imported in the "show" container, it is just soft referenced. However, the import process will load and cache some information about the template (exposed properties, default values, animations, transition logic layer, etc). Given that this information is cached, it may become stale if the source asset is updated. Therefore, reimporting the templates may be necessary within the normal work flow. Todo: keep a hash of the source asset to determine if it has changed.

2- Pages

The pages are instances of the templates, allowing to change the exposed properties and controllers, also selecting an output program channel for the given page. Only one program channel is allowed per page.

3- Page Views

Separate page views can be made in order to create "rundowns" for separate segments/parts of a show.

"Page Groups" Discussion: "Page Groups" are not implemented. It would be different than page views, i.e. pages could be grouped in either of the page list or page views. Other applications support page grouping to emulate MOS's hierarchy. In the MOS/NCS hierarchies: Rundown -> Stories/Segments -> Parts -> Pieces/Items Although full emulation of MOS schema may not be necessary within the Motion Design playback framework.

Variables

  Type Name Description
Protected variable UProperty Transient duplicatetransient, textexporttransient FAvaRundownPageListReference ActivePageList ==InstancePageList Indicates that the entire list is being played, rather than a specific view.
Protected variable UProperty FAvaRundownPageCollection InstancedPages  
Protected variable FOnActiveListChanged OnActiveListChanged  
Protected variable FOnCanClosePlaybackContext OnCanClosePlaybackContext  
Protected variable FOnAvaRundownPageListChanged OnPageListChanged  
Public variable FOnPagePlayerEvent OnPagePlayerAdded Rundown Player Event - Called when a new page player is added to the playback context.
Public variable FOnPagePlayerEvent OnPagePlayerRemoving Rundown Player Event - Called when a stopped page player is about to be removed from the playback context.
Protected variable FOnAvaRundownPagesChanged OnPagesChanged  
Public variable FOnPageTransitionEvent OnPageTransitionAdded Rundown Transition Event - Called when a new page transition is added to the playback context.
Public variable FOnPageTransitionEvent OnPageTransitionRemoving Rundown Transition Event - Called when a completed page transition is about to be removed from the playback context.
Protected variable TUniquePtr< FAvaRundownPageListPlaybackContextCollection > PageListPlaybackContextCollection  
Protected variable TUniquePtr< IAvaRundownPageLoadingManager > PageLoadingManager  
Protected variable UProperty Transient duplicatetransient, textexporttransient TArray< TObjectPtr< UAvaRundownPagePlayer > > PagePlayers Keeping track of playing pages.
Protected variable UProperty Transient duplicatetransient, textexporttransient TArray< TObjectPtr< UAvaRundownPageTransition > > PageTransitions  
Protected variable TPimplPtr< FAvaRundownPlaybackClientWatcher > PlaybackClientWatcher  
Protected variable TPimplPtr< FPreUndoBackup > PreUndoBackup  
Protected variable TMap< FGuid, int32 > SubListIndices  
Protected variable UProperty TArray< FAvaRundownSubList > SubLists  
Protected variable UProperty FAvaRundownPageCollection TemplatePages  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function int32

AddComboTemplate ( const TArray< int32 >& InTemplateIds,
const FAvaRundownPageIdGeneratorParams& InIdGeneratorParams
)

  
Public function int32

AddPageFromTemplate ( int32 InTemplateId,
const FAvaRundownPageIdGeneratorParams& InIdGeneratorParams,
const FAvaRundownPageInsertPosition& InInsertAt
)

 Creates a new page in the page list using the given template.
Protected function int32

AddPageFromTemplateInternal ( int32 InTemplateId,
const FAvaRundownPageIdGeneratorParams& InIdGeneratorParams,
const FAvaRundownPageInsertPosition& InInsertAt
)

  
Protected function void  
Public function TArray< int32 >

AddPagesFromTemplates ( const TArray< int32 >& InTemplateIds
)

 Create new pages in the page list for teh given template Ids.
Public function bool

AddPagesToSubList ( const FAvaRundownPageListReference& InPageListReference,
const TArray< int32 >& InPages
)

  
Public function bool

AddPageToSubList ( const FAvaRundownPageListReference& InPageListReference,
int32 InPageId,
const FAvaRundownPageInsertPosition& InInsertPosition
)

  
Public function void

AddPageTransition ( UAvaRundownPageTransition* InPageTransition
)

  
Public function FAvaRundownPageListReference  
Public function int32

AddTemplate ( const FAvaRundownPageIdGeneratorParams& InIdGeneratorParams
)

 Add empty template.
Public function int32

AddTemplateInternal ( const FAvaRundownPageIdGeneratorParams& InIdGeneratorParams,
const TFunctionRef< bool(FAvaRundownPage&)> InSetupTemplateFunction
)

  
Public function TArray< int32 >

AddTemplates ( const TArray< FAvaRundownPage >& InSourceTemplates
)

 Add templates from existing source.
Public function Const bool  
Public function Const bool  
Public function Const bool Determines if the playback context can be closed.
Public function Const bool

CanContinuePage ( int32 InPageId,
bool bInPreview
)

  
Public function Const bool

CanContinuePage ( int32 InPageId,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function Const bool

CanPlayPage ( int32 InPageId,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function Const bool

CanPlayPage ( int32 InPageId,
bool bInPreview
)

  
Public function Const bool

CanRemovePage ( int32 InPageId
)

  
Public function Const bool

CanRemovePages ( const TArray< int32 >& InPageIds
)

  
Public function Const bool

CanRenumberPageId ( int32 InPageId,
int32 InNewPageId
)

  
Public function Const bool

CanRenumberPageId ( int32 InPageId
)

  
Public function Const bool

CanStartTransitionForPage ( const FAvaRundownPage& InPage,
bool bInIsPreview,
const FName& InPreviewChannelName
)

  
Public function Const bool

CanStopChannel ( const FString& InChannelName
)

  
Public function Const bool

CanStopPage ( int32 InPageId,
EAvaRundownPageStopOptions InOptions,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function Const bool

CanStopPage ( int32 InPageId,
EAvaRundownPageStopOptions InOptions,
bool bInPreview
)

  
Public function bool

ChangePageOrder ( const FAvaRundownPageListReference& InPageListReference,
const TArray< int32 >& InPageIndices
)

 Reorders the pages, swapping the old indices for the new ones.
Public function void

ClosePlaybackContext ( bool bInStopAllPages
)

 Similarly, when the editor is done, it can close the playback context.
Public function bool

ContinuePage ( int32 InPageId,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function bool

ContinuePage ( int32 InPageId,
bool bInPreview
)

  
Public function Static FAvaRundownPageListReference  
Public function Static FAvaRundownPageListReference

CreateSubListReference ( const FGuid& InSubListId
)

  
Public function bool

Empty ()

 Clear the rundown of all it's content. Will be prevented if the rundown is playing.
Public function Const UAvaRundownPagePlayer *

FindPagePlayer ( int32 InPageId,
FName InChannelName
)

 Finds the page player for the given pageId and channel name.
Public function Const UAvaRundownPagePlayer *

FindPlayerForPage ( int32 InPageId,
bool bInIsPreview,
const FName& InPreviewChannelName
)

  
Public function Const UAvaRundownPagePlayer *

FindPlayerForPreviewPage ( int32 InPageId,
const FName& InPreviewChannelFName
)

  
Public function Const UAvaRundownPagePlayer *  
Protected function Const int32

GenerateUniquePageId ( int32 InReferencePageId,
int32 InIncrement
)

  
Protected function Const int32  
Public function Const const FAvaRundownPageListReference &  
Public function FAvaRundownSubList &  
Public function Const const FAvaRundownSubList &  
Public function Static FName Returns the currently selected preview channel (from the settings).
Public function Const const FAvaRundownPageCollection &  
Public function FAvaRundownPage &

GetNextPage ( int32 InPageId,
const FAvaRundownPageListReference& InPageListReference
)

 Gets the page following the page with the given page id in the given page list.
Public function Const const FAvaRundownPage &

GetNextPage ( int32 InPageId,
const FAvaRundownPageListReference& InPageListReference
)

 Gets the page following the page with the given page id in the given page list.
Public function FAvaRundownPage &

GetNextPage ( int32 InPageId
)

 Gets the page following the page with the given page id. Using current active page list.
Public function Const const FAvaRundownPage &

GetNextPage ( int32 InPageId
)

 Gets the page following the page with the given page id. Using current active page list.
Public function FOnActiveListChanged &  
Public function Const FOnCanClosePlaybackContext::RegistrationType &  
Public function FOnAvaRundownPageListChanged &  
Public function FOnPagePlayerEvent &  
Public function FOnPagePlayerEvent &  
Public function FOnAvaRundownPagesChanged &  
Public function FOnPageTransitionEvent &  
Public function FOnPageTransitionEvent &  
Public function FAvaRundownPageListPlaybackContextCollection &  
Public function Const const FAvaRundownPage &

GetPage ( int32 InPageId
)

  
Public function FAvaRundownPage &

GetPage ( int32 InPageId
)

  
Public function Const FAvaRundownPageListPlaybackContextCollection *  
Public function IAvaRundownPageLoadingManager & Access the page loading manager for this rundown.
Public function Const const TArray< TObjectPtr< UAvaRundownPagePlayer > > &  
Public function Static const FAvaRundownPage &

GetPageSafe ( const UAvaRundown* InRundown,
int32 InPageId
)

  
Public function Const UAvaRundownPageTransition *

GetPageTransition ( const FGuid& InTransitionId
)

  
Public function Const FAvaPlaybackManager &  
Public function Const TArray< int32 >

GetPlayingPageIds ( const FName InProgramChannelName
)

 Return the current playing Page Ids on the specified program channel.
Public function Const TArray< int32 >

GetPreviewingPageIds ( const FName InPreviewChannelName
)

 Return the current previewing Page Ids on the specified preview channel.
Public function Const UTextureRenderTarget2D *

GetPreviewRenderTarget ( const FName& InPreviewChannel
)

  
Public function Const UTextureRenderTarget2D *  
Public function Const const FAvaRundownSubList &

GetSubList ( const FAvaRundownPageListReference& InPageListReference
)

  
Public function FAvaRundownSubList &

GetSubList ( const FGuid& InSubListId
)

  
Public function Const const FAvaRundownSubList &

GetSubList ( const FGuid& InSubListId
)

  
Public function FAvaRundownSubList &

GetSubList ( int32 InSubListIndex
)

  
Public function Const const FAvaRundownSubList &

GetSubList ( int32 InSubListIndex
)

  
Public function FAvaRundownSubList &

GetSubList ( const FAvaRundownPageListReference& InPageListReference
)

  
Public function Const int32

GetSubListIndex ( const FAvaRundownSubList& InSubList
)

  
Public function Const const TArray< FAvaRundownSubList > &  
Public function Const const FAvaRundownPageCollection &  
Public function Const bool Returns true only if a sub list, not the main list, is active.
Protected function Const void

InitializePage ( FAvaRundownPage& InOutPage,
int32 InPageId,
int32 InTemplateId
)

  
Public function void Since the playback context is part of the asset for now, there is an explicit call to initialize it.
Public function Const void  
Protected function Const bool

IsChannelTypeCompatibleForRequest ( const FAvaRundownPage& InSelectedPage,
bool bInIsPreview,
const FName& InPreviewChannelName,
bool bInLogFailureReason
)

 Returns true if the selected page can play on the given channel.
Public function Const bool

IsEmpty ()

 Returns true if the rundown is empty, i.e. no pages and no templates.
Protected function Const bool

IsPageIdUnique ( int32 InPageId
)

  
Public function Const bool

IsPagePlaying ( int32 InPageId
)

 Returns true if the page is playing in it's assigned program channel.
Public function Const bool

IsPagePlaying ( const FAvaRundownPage& InPage
)

  
Public function Const bool  
Public function Const bool

IsPagePreviewing ( int32 InPageId
)

 Returns true if the page with the given page Id is being previewed (in any preview channel).
Public function Const bool Returns true if the any page is either playing or previewing.
Public function Const bool

IsValidSubList ( const FAvaRundownPageListReference& InPageListReference
)

  
Public function TArray< FLoadedInstanceInfo >

LoadPage ( int32 InPageId,
bool bInPreview,
const FName& InPreviewChannelName
)

 Preload the given page so it has an asset ready for playback.
Public function void  
Public function void  
Public function Const void

NotifyPageStopped ( int32 InPageId
)

  
Public function void

NotifyPIEEnded ( const bool
)

  
Public function void Clean up playing status on a system tear down.
Public function bool

PlayPage ( int32 InPageId,
EAvaRundownPagePlayType InPlayType
)

  
Public function bool

PlayPage ( int32 InPageId,
EAvaRundownPagePlayType InPlayType,
const FName& InPreviewChannelName
)

  
Public function TArray< int32 >

PlayPages ( const TArray< int32 >& InPageIds,
EAvaRundownPagePlayType InPlayType,
const FName& InPreviewChannelName
)

 Start the playback of the asset defined in the given pages.
Public function TArray< int32 >

PlayPages ( const TArray< int32 >& InPageIds,
EAvaRundownPagePlayType InPlayType
)

 Start the playback of the asset defined in the given pages.
Public function Const bool

PushRuntimeRemoteControlValues ( int32 InPageId,
bool bInIsPreview,
const FName& InPreviewChannelName
)

 Push the page's RC values to the runtime playback instances.
Protected function void Caches the Page's Id to its Index in the Pages Array
Protected function void  
Public function bool

RemovePage ( int32 InPageId
)

  
Public function int32

RemovePages ( const TArray< int32 >& InPageIds
)

 Remove all the Pages in the Array. Returns the number of Pages removed.
Public function int32

RemovePagesFromSubList ( const FAvaRundownPageListReference& InPageListReference,
const TArray< int32 >& InPages
)

  
Public function void

RemovePageTransition ( UAvaRundownPageTransition* InPageTransition
)

  
Public function void  
Public function bool

RemoveSubList ( const FAvaRundownPageListReference& InPageListReference
)

  
Public function bool

RenameSubList ( const FAvaRundownPageListReference& InPageListReference,
const FText& InNewName
)

  
Public function bool

RenumberPageId ( int32 InPageId,
int32 InNewPageId
)

  
Public function bool

RenumberPageIds ( const TArray< int32 >& InPageIds,
const FAvaRundownPageIdGeneratorParams& InIdParams
)

  
Public function EAvaPlayableRemoteControlChanges

ResetRemoteControlControllerValue ( int32 InPageId,
const FGuid& InControllerId,
bool bInUseTemplateValues,
bool bInIsDefault
)

  
Public function EAvaPlayableRemoteControlChanges

ResetRemoteControlEntityValue ( int32 InPageId,
const FGuid& InEntityId,
bool bInUseTemplateValues,
bool bInIsDefault
)

  
Public function EAvaPlayableRemoteControlChanges

ResetRemoteControlValues ( int32 InPageId,
bool bInUseTemplateValues,
bool bInIsDefault
)

  
Public function bool

RestorePlaySubPage ( int32 InPageId,
int32 InSubPageIndex,
const FGuid& InExistingInstanceId,
bool bInIsPreview,
const FName& InPreviewChannelName
)

 Used to reconcile playing state with a remote playback if connection was lost.
Public function bool

SetActivePageList ( const FAvaRundownPageListReference& InPageListReference
)

  
Public function bool  
Public function bool

SetRemoteControlEntityValue ( int32 InPageId,
const FGuid& InId,
const FAvaPlayableRemoteControlValue& InValue
)

  
Public function bool

StopChannel ( const FString& InChannelName
)

  
Public function bool

StopPage ( int32 InPageId,
EAvaRundownPageStopOptions InOptions,
bool bInPreview
)

  
Public function bool

StopPage ( int32 InPageId,
EAvaRundownPageStopOptions InOptions,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function TArray< int32 >

StopPages ( const TArray< int32 >& InPageIds,
EAvaRundownPageStopOptions InOptions,
bool bInPreview,
const FName& InPreviewChannelName
)

  
Public function TArray< int32 >

StopPages ( const TArray< int32 >& InPageIds,
EAvaRundownPageStopOptions InOptions,
bool bInPreview
)

  
Public function void

StopPageTransitionsForPage ( const FAvaRundownPage& InPage,
bool bInIsPreview,
const FName& InPreviewChannelName
)

  
Public function bool

UnloadPage ( int32 InPageId,
const FString& InChannelName
)

  
Public function void

UpdateAssetForPages ( const TArray< int32 >& InPageIds,
bool bInReimportPage
)

  
Public function EAvaPlayableRemoteControlChanges

UpdateRemoteControlValues ( int32 InPageId,
const FAvaPlayableRemoteControlValues& InRemoteControlValues,
bool bInUpdateDefaults
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called before applying a transaction to the object.

Classes

  Type Name Description
Public struct FLoadedInstanceInfo    
Public class FPreUndoBackup    

Typedefs

Name Description
FOnActiveListChanged  
FOnCanClosePlaybackContext Delegate called to determine if the playback context can be closed.
FOnPagePlayerEvent  
FOnPageTransitionEvent  

Constants

Name Description
InstancePageList  
InvalidSubList  
InvalidSubListMutable  
TemplatePageList  

Deprecated Variables

  Type Name Description
Protected variable UProperty TArray< FAvaRundownPage > Pages_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page