1. Epic GamesDeveloper
  3. FAvaRundownEditor

FAvaRundownEditor

API > API/Plugins > API/Plugins/AvalancheMediaEditor

   
Name FAvaRundownEditor
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMediaEditor/Public/Rundown/AvaRundownEditor.h
Include Path #include "Rundown/AvaRundownEditor.h"

Syntax

class FAvaRundownEditor : public FWorkflowCentricApplication

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FAvaRundownEditor()

   Rundown/AvaRundownEditor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAvaRundownEditor()

   Rundown/AvaRundownEditor.h  

Classes

Name Remarks
FSharedConsoleCommands Console commands are shared between all editors.

Structs

Name Remarks
FAutoPlayTicker Tickable object that keeps track of the play time of a page and will automatically play the next page once the specified play time has elapsed.

Typedefs

Name Type Remarks Include Path
FBindableMacroCommands TMap< FName, FMacroCommandFunction >   Rundown/AvaRundownEditor.h
FMacroCommandFunction TFunction< void(const TArray< FString > &InArgs)>   Rundown/AvaRundownEditor.h
FOnPageEvent TMulticastDelegate_TwoParams< void, const TArray< int32 > &, UE::AvaRundown::EPageEvent >   Rundown/AvaRundownEditor.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BindableMacroCommands FBindableMacroCommands   Rundown/AvaRundownEditor.h  
bStopPagesOnCloseOverride TOptional< bool > Optional user specified action for stopping pages. Rundown/AvaRundownEditor.h  
InputProcessor TSharedPtr< FAvaRundownEditorInputProcessor >   Rundown/AvaRundownEditor.h  
ReadPageWidget TSharedPtr< SAvaRundownReadPage >   Rundown/AvaRundownEditor.h  
SharedConsoleCommands TSharedPtr< FSharedConsoleCommands >   Rundown/AvaRundownEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTemplate()

   Rundown/AvaRundownEditor.h  

void BeginModify()

 Begin transaction buffer, but don't mark as dirty yet. Rundown/AvaRundownEditor.h  

bool CanAddTemplate()

   Rundown/AvaRundownEditor.h  

bool CanContinueSelectedPage()

   Rundown/AvaRundownEditor.h  

bool CanCreateInstancesFromSelectedTemplates()

   Rundown/AvaRundownEditor.h  

bool CanPlayNextPage()

   Rundown/AvaRundownEditor.h  

bool CanPlaySelectedPage()

   Rundown/AvaRundownEditor.h  

bool CanPreviewContinueSelectedPage()

   Rundown/AvaRundownEditor.h  

bool CanPreviewPlayNextPage()

   Rundown/AvaRundownEditor.h  

bool CanPreviewPlaySelectedPage()

   Rundown/AvaRundownEditor.h  

bool CanPreviewStopSelectedPage ( bool bInForce
) const

   Rundown/AvaRundownEditor.h  

bool CanRemoveSelectedPages()

   Rundown/AvaRundownEditor.h  

bool CanStopSelectedPage ( bool bInForce
) const

   Rundown/AvaRundownEditor.h  

bool CanTakeToProgram()

   Rundown/AvaRundownEditor.h  

bool CanUpdateValuesOnSelectedPage()

   Rundown/AvaRundownEditor.h  

void ContinueSelectedPage()

   Rundown/AvaRundownEditor.h  

void CreateInstancesFromSelectedTemplates()

   Rundown/AvaRundownEditor.h  

void ExtendToolBar ( TSharedPtr< FExtender > InExtender
)

   Rundown/AvaRundownEditor.h  

void FillPageToolBar ( FToolBarBuilder& OutToolBarBuilder
)

   Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownInstancedPageList > GetActiveListWidget()

 Returns the currently active Instanced Page List. Rundown/AvaRundownEditor.h  

int32 GetFirstSelectedPageOnActiveSubListWidget()

   Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownPageList > GetFocusedListWidget()

 Returns the currently focused Page List, including templates, instances or views. Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownPageList > GetInstanceListWidget()

   Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownPageList > GetListWidget ( const FAvaRundownPageListReference& InPageListReference
) const

   Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownPageList > GetListWidget ( const FName& InTabId
) const

   Rundown/AvaRundownEditor.h  

FOnPageEvent & GetOnPageEvent()

   Rundown/AvaRundownEditor.h  

UAvaRundown * GetRundown()

   Rundown/AvaRundownEditor.h  

TConstArrayView< int32 > GetSelectedPagesOnActiveSubListWidget()

   Rundown/AvaRundownEditor.h  

TConstArrayView< int32 > GetSelectedPagesOnFocusedWidget()

   Rundown/AvaRundownEditor.h  

TSharedPtr< SAvaRundownPageList > GetTemplateListWidget()

   Rundown/AvaRundownEditor.h  

bool HandleKeyDownEvent ( const FKeyEvent& InKeyEvent
)

   Rundown/AvaRundownEditor.h  

void InitRundownEditor ( const EToolkitMode::Type InMode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UAvaRundown* InRundown
)

   Rundown/AvaRundownEditor.h  

bool IsKeyRelevant ( const FKeyEvent& InKeyEvent
) const

   Rundown/AvaRundownEditor.h  

bool IsRundownValid()

   Rundown/AvaRundownEditor.h  

TSharedRef< SWidget > MakeReadPageWidget()

   Rundown/AvaRundownEditor.h  

void MarkAsModified()

 Mark the rundown as dirty. Rundown/AvaRundownEditor.h  

void PlayNextPage()

   Rundown/AvaRundownEditor.h  

void PlaySelectedPage()

   Rundown/AvaRundownEditor.h  

void PreviewContinueSelectedPage()

   Rundown/AvaRundownEditor.h  

void PreviewPlayNextPage()

   Rundown/AvaRundownEditor.h  

void PreviewPlaySelectedPage ( bool bInToMark
)

   Rundown/AvaRundownEditor.h  

void PreviewStopSelectedPage ( bool bInForce
)

   Rundown/AvaRundownEditor.h  

void RefreshSubListTabs()

   Rundown/AvaRundownEditor.h  

void RemoveSelectedPages()

   Rundown/AvaRundownEditor.h  

bool RequestCloseDocumentTab ( const FName& InDocumentTabId
)

   Rundown/AvaRundownEditor.h  

void StopSelectedPage ( bool bInForce
)

   Rundown/AvaRundownEditor.h  

void TakeToProgram()

   Rundown/AvaRundownEditor.h  

void UnregisterDocumentTabFactory ( const FName& InDocumentTabId
)

   Rundown/AvaRundownEditor.h  

void UpdateValuesOnSelectedPage()

   Rundown/AvaRundownEditor.h  

Overridden from FAssetEditorToolkit

Name Remarks Include Path Unreal Specifiers

virtual bool OnRequestClose ( EAssetEditorCloseReason InCloseReason
)

   Rundown/AvaRundownEditor.h  

Overridden from IToolkit

Name Remarks Include Path Unreal Specifiers

virtual FText GetBaseToolkitName()

   Rundown/AvaRundownEditor.h  

virtual FName GetToolkitFName()

   Rundown/AvaRundownEditor.h  

virtual FLinearColor GetWorldCentricTabColorScale()

   Rundown/AvaRundownEditor.h  

virtual FString GetWorldCentricTabPrefix()

   Rundown/AvaRundownEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

TArray< int32 > ArgumentsToPageIds ( const TArray< FString >& InArgs,
bool bInPreview,
FString& OutErrors
) const

   Rundown/AvaRundownEditor.h  

void CancelAutoPlay()

   Rundown/AvaRundownEditor.h  

void ContinuePageCommand ( const TArray< FString >& InArgs,
bool bInPreview
)

   Rundown/AvaRundownEditor.h  

void CreateRundownCommands()

   Rundown/AvaRundownEditor.h  

TSharedPtr< SDockTab > CreateSubListTab ( const FAvaRundownPageListReference& InSubListReference
)

   Rundown/AvaRundownEditor.h  

const FBindableMacroCommands & GetBindableMacroCommands()

   Rundown/AvaRundownEditor.h  

FText GetCurrentProfileName()

   Rundown/AvaRundownEditor.h  

void HandleOnPagePlayerAdded ( UAvaRundown* InRundown,
UAvaRundownPagePlayer* InPagePlayer
)

   Rundown/AvaRundownEditor.h  

void LoadPageCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

TSharedRef< SWidget > MakeProfileComboButton()

   Rundown/AvaRundownEditor.h  

void OnActiveListChanged()

   Rundown/AvaRundownEditor.h  

void OnCanClosePlaybackContext ( const UAvaRundown* InRundown,
bool& bOutResult
) const

   Rundown/AvaRundownEditor.h  

void OnPageListChanged ( const FAvaRundownPageListChangeParams& InParams
)

   Rundown/AvaRundownEditor.h  

void PlayNextPageCommand ( const TArray< FString >& InArgs,
bool bInPreview
)

   Rundown/AvaRundownEditor.h  

void PlayPageCommand ( const TArray< FString >& InArgs,
bool bInPreview
)

   Rundown/AvaRundownEditor.h  

void RefreshSubListTab ( const FAvaRundownPageListReference& InSubListReference,
bool bInSetActive
)

   Rundown/AvaRundownEditor.h  

void RegisterApplicationModes()

   Rundown/AvaRundownEditor.h  

void StartAutoPlayCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void StartChannelCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void StopAutoPlayCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void StopChannelCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void StopLayersCommand ( const TArray< FString >& InArgs,
bool bInPreview,
bool bInForce
)

   Rundown/AvaRundownEditor.h  

void StopPageCommand ( const TArray< FString >& InArgs,
bool bInPreview,
bool bInForce
)

   Rundown/AvaRundownEditor.h  

void StopPageTransitionCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void TakeToProgramCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

void UnloadPageCommand ( const TArray< FString >& InArgs
)

   Rundown/AvaRundownEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page