Navigation
API > API/Plugins > API/Plugins/AvalancheMediaEditor > API/Plugins/AvalancheMediaEditor/Rundown
Inheritance Hierarchy
- IAssetEditorInstance
- FBaseToolkit
- TSharedFromThis
- FAssetEditorToolkit
- FWorkflowCentricApplication
- FAvaRundownEditor
References
| Module | AvalancheMediaEditor |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMediaEditor/Public/Rundown/AvaRundownEditor.h |
| Include | #include "Rundown/AvaRundownEditor.h" |
Syntax
class FAvaRundownEditor : public FWorkflowCentricApplication
Variables
| Type | Name | Description | |
|---|---|---|---|
| TUniquePtr< FAutoPlayTicker > | AutoPlayTicker | ||
| TWeakObjectPtr< UAvaRundown > | AvaRundown | ||
| FOnPageEvent | OnPageEvent |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddTemplate () |
||
| TArray< int32 > | ArgumentsToPageIds
(
const TArray< FString >& InArgs, |
||
| void | BeginModify () |
Begin transaction buffer, but don't mark as dirty yet. | |
| bool | |||
| void | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | CanPreviewStopSelectedPage
(
bool bInForce |
||
| bool | |||
| bool | CanStopSelectedPage
(
bool bInForce |
||
| bool | |||
| bool | |||
| void | ContinuePageCommand
(
const TArray< FString >& InArgs, |
||
| void | |||
| void | |||
| void | |||
| TSharedPtr< SDockTab > | CreateSubListTab
(
const FAvaRundownPageListReference& InSubListReference |
||
| void | ExtendToolBar
(
TSharedPtr< FExtender > InExtender |
||
| void | FillPageToolBar
(
FToolBarBuilder& OutToolBarBuilder |
||
| TSharedPtr< SAvaRundownInstancedPageList > | Returns the currently active Instanced Page List. | ||
| const FBindableMacroCommands & | |||
| FText | |||
| int32 | |||
| TSharedPtr< SAvaRundownPageList > | Returns the currently focused Page List, including templates, instances or views. | ||
| TSharedPtr< SAvaRundownPageList > | |||
| TSharedPtr< SAvaRundownPageList > | GetListWidget
(
const FAvaRundownPageListReference& InPageListReference |
||
| TSharedPtr< SAvaRundownPageList > | GetListWidget
(
const FName& InTabId |
||
| FOnPageEvent & | |||
| UAvaRundown * | GetRundown () |
||
| TConstArrayView< int32 > | |||
| TConstArrayView< int32 > | |||
| TSharedPtr< SAvaRundownPageList > | |||
| bool | HandleKeyDownEvent
(
const FKeyEvent& InKeyEvent |
||
| void | HandleOnPagePlayerAdded
(
UAvaRundown* InRundown, |
||
| void | InitRundownEditor
(
const EToolkitMode::Type InMode, |
||
| bool | IsKeyRelevant
(
const FKeyEvent& InKeyEvent |
||
| bool | |||
| void | LoadPageCommand
(
const TArray< FString >& InArgs |
||
| TSharedRef< SWidget > | |||
| TSharedRef< SWidget > | |||
| void | Mark the rundown as dirty. | ||
| void | |||
| void | OnCanClosePlaybackContext
(
const UAvaRundown* InRundown, |
||
| void | OnPageListChanged
(
const FAvaRundownPageListChangeParams& InParams |
||
| void | PlayNextPage () |
||
| void | PlayNextPageCommand
(
const TArray< FString >& InArgs, |
||
| void | PlayPageCommand
(
const TArray< FString >& InArgs, |
||
| void | |||
| void | |||
| void | |||
| void | PreviewPlaySelectedPage
(
bool bInToMark |
||
| void | PreviewStopSelectedPage
(
bool bInForce |
||
| void | RefreshSubListTab
(
const FAvaRundownPageListReference& InSubListReference, |
||
| void | |||
| void | |||
| void | |||
| bool | RequestCloseDocumentTab
(
const FName& InDocumentTabId |
||
| void | StartAutoPlayCommand
(
const TArray< FString >& InArgs |
||
| void | StartChannelCommand
(
const TArray< FString >& InArgs |
||
| void | StopAutoPlayCommand
(
const TArray< FString >& InArgs |
||
| void | StopChannelCommand
(
const TArray< FString >& InArgs |
||
| void | StopPageCommand
(
const TArray< FString >& InArgs, |
||
| void | StopSelectedPage
(
bool bInForce |
||
| void | |||
| void | TakeToProgramCommand
(
const TArray< FString >& InArgs |
||
| void | UnloadPageCommand
(
const TArray< FString >& InArgs |
||
| void | UnregisterDocumentTabFactory
(
const FName& InDocumentTabId |
||
| void |
Overridden from FAssetEditorToolkit
| Type | Name | Description | |
|---|---|---|---|
| bool | OnRequestClose
(
EAssetEditorCloseReason InCloseReason |
Called when this toolkit is requested to close. Returns false if closing should be prevented. |
Overridden from IToolkit
| Type | Name | Description | |
|---|---|---|---|
| FText | Returns the localized name of this toolkit type (typically just " |
||
| FName | Returns the invariant name of this toolkit type | ||
| FLinearColor | |||
| FString | Returns the localize prefix string to use for tab labels in world-centric mode. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| 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. | ||
| FSharedConsoleCommands | Console commands are shared between all editors. |
Typedefs
| Name | Description |
|---|---|
| FBindableMacroCommands | |
| FMacroCommandFunction | |
| FOnPageEvent |