Navigation
| Name | AvalancheMedia |
| Type | Plugin |
| Part of Plugins | Motion Design |
| Location | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/ |
| Module Build Rules | AvalancheMedia.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAvaPlayableTransitionBuilder | |
| FAvaPlaybackGraphBuilder | Somewhat reusable helper class to build a playback graph. |
| FAvaPlaybackInstance | Handle to a playback instance for recycling. |
| FAvaPlaybackManager | |
| FAvaPlaybackSourceAssetEntry | For each playback instance, a source asset entry is kept track of to allow the entry to be invalidated and prevent the instance to be recycled. |
| UAvaBroadcast | Single Instance Class that manages all the Output Channels |
| UAvaBroadcastLibrary | |
| UAvaBroadcastOutputChannelViewInterface | |
| UAvaMediaSettings | |
| UAvaPlayableGroup | This class defines the interface and base of a playable group. |
| UAvaPlayableLibrary | |
| UAvaPlayableTransition | |
| UAvaPlayableVisibilityConstraint | Interface for the Playable visibility constraint. |
| UAvaPlaybackNode | Base Class for all the Nodes found in the Motion Design Playback Graph |
| UAvaPlaybackNodeAction | Node part of the Event Nodes that handles Logic Execution |
| UAvaPlaybackNodeEvent | Base Class for all Event Nodes |
| UAvaPlaybackNodeFlow | Node part of the Event Nodes that Controls the Flow of Events |
| UAvaPlaybackNodePlayer | |
| UAvaPlaybackNodeRoot | |
| UAvaPlaybackNodeTrigger | Node part of the Event Nodes that Listens to an Event and Triggers the Event Flow |
| UAvaRundown | This class is a container for what could be described as a "show" for broadcast purposes. |
| UAvaRundownPagePlayer | |
| UAvaRundownPlaybackInstancePlayer | To support combo templates, a page is now potentially composed of a number of playback instances that each have their own player. |
Structs
| Name | Remarks |
|---|---|
| FAvaBroadcastCapture | Creates a bridge between the UMediaCapture's event and our events. |
| FAvaBroadcastMediaOutputInfo | Extra information about the Media Output object. |
| FAvaBroadcastOutputChannel | |
| FAvaBroadcastProfile | |
| FAvaMediaLocalPlaybackServerSettings | |
| FAvaMediaSyncCompareResponse | Payload for a comparison request |
| FAvaMediaSyncConnectionInfo | Holds data about local project (such as Message Address Ids, Project Name, Hostname, InstanceId, etc.) |
| FAvaMediaSynchronizedEvent | Base class for synchronized events. |
| FAvaMediaSyncResponse | Base sync response with Status and Error information |
| FAvaPlayableRemoteControlControlledEntityInfo | Container for the controlled entities extra information. |
| FAvaPlayableRemoteControlPresetInfo | Container for the remote control preset extra information used for playable. |
| FAvaPlayableRemoteControlValue | |
| FAvaPlayableRemoteControlValues | Container for the remote control values of a playable. |
| FAvaPlayableSettings | Settings applied when instancing a Motion Design Playable. |
| FAvaPlaybackAnimations | |
| FAvaPlaybackAnimPlaySettings | |
| FAvaPlaybackChannelParameters | Parameters used to tell a Channel its Playback Settings |
| FAvaPlaybackEventParameters | Parameters for Event/Action |
| FAvaPlaybackPlayableGroup | Owns a group of playables. |
| FAvaPlaybackPlayerParameters | Parameters of a player entry for active player nodes in playback graph. |
| FAvaPlaybackServerLoggingEntry | |
| FAvaRundownChannelPageStatus | |
| FAvaRundownMacroCommand | |
| FAvaRundownMacroKeyBinding | Defines a macro (list of commands) that is assigned to a shortcut key. |
| FAvaRundownPage | |
| FAvaRundownPageCollection | |
| FAvaRundownPageCommand | Base class for page commands. this API is experimental. |
| FAvaRundownPageCommandContext | Base context carrying parameters for page commands execution. |
| FAvaRundownPageCommandData | Page command data is stored in json serialized string in the page to be compatible with external apps. |
| FAvaRundownPageIdGeneratorParams | Defines the parameters for the page id generator algorithm. |
| FAvaRundownPageInsertPosition | Defines the insertion position in a page list. |
| FAvaRundownPageListChangeParams | |
| FAvaRundownPageListPlaybackContext | Carries the context for the playback of a page list. |
| FAvaRundownPageListPlaybackContextCollection | This class is a container for all the page list contexts are rundown can have. |
| FAvaRundownPageListReference | |
| FAvaRundownSubList | |
| FAvaSynchronizedEventsFeatureSelection | |
| FConnectionEventArgs | |
| FPlaybackAssetStatusChangedArgs | |
| FPlaybackSequenceEventArgs | |
| FPlaybackStatusChangedArgs | |
| FPlaybackTransitionEventArgs |
Interfaces
| Name | Remarks |
|---|---|
| IAvaBroadcastDeviceProviderProxyManager | |
| IAvaBroadcastOutputChannelViewInterface | |
| IAvaBroadcastSettings | Interface for the broadcast settings. |
| IAvaMediaModule | |
| IAvaMediaSynchronizedEventDispatcher | Queue and Dispatcher for Synchronized events. |
| IAvaMediaSynchronizedEventsFeature | Interface for synchronized events implementation in a distributed environment such as the Display Cluster or forked channels. |
| IAvaMediaSyncProvider | Base Sync feature interface |
| IAvaPlayableRemoteControlPresetInfoCache | Global Cache for remote control preset info |
| IAvaPlayableVisibilityConstraint | |
| IAvaPlaybackClient | |
| IAvaPlaybackGraphEditor | |
| IAvaPlaybackServer | |
| IAvaRundownPageLoadingManager | Manages page pre-loading. |
| IAvaRundownServer |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAvaBroadcastChanged | TMulticastDelegate_OneParam< void, EAvaBroadcastChange > | Broadcast/AvaBroadcast.h | |
| FOnAvaBroadcastChannelsListChanged | TMulticastDelegate_OneParam< void, const FAvaBroadcastProfile & > | Broadcast/AvaBroadcast.h | |
| FOnAvaMediaSyncCompareResponse | TBaseDelegate_OneParam< void, const TSharedPtr< FAvaMediaSyncCompareResponse > & > | Delegate with a comparison response. | ModularFeature/IAvaMediaSyncProvider.h |
| FOnAvaMediaSyncPackageModified | TMulticastDelegate_OneParam< void, const FName & > | Delegate called when a package is modified by a sync operation, either added or modified. | ModularFeature/IAvaMediaSyncProvider.h |
| FOnAvaMediaSyncResponse | TBaseDelegate_OneParam< void, const TSharedPtr< FAvaMediaSyncResponse > & > | Generic delegate response handler | ModularFeature/IAvaMediaSyncProvider.h |
| FOnAvaRundownPageListChanged | TMulticastDelegate_OneParam< void, const FAvaRundownPageListChangeParams & > | Rundown/AvaRundown.h | |
| FOnAvaRundownPagesChanged | TMulticastDelegate_ThreeParams< void, const UAvaRundown *, const FAvaRundownPage &, EAvaRundownPageChanges > | Rundown/AvaRundown.h | |
| FOnConnectionEvent | TMulticastDelegate_TwoParams< void, IAvaPlaybackClient &, const FConnectionEventArgs & > | Delegate called when a server connection event occurs. | Playback/AvaPlaybackClientDelegates.h |
| FOnPlaybackAssetStatusChanged | TMulticastDelegate_TwoParams< void, IAvaPlaybackClient &, const FPlaybackAssetStatusChangedArgs & > | Delegate called when a playback asset status changed message is received. | Playback/AvaPlaybackClientDelegates.h |
| FOnPlaybackSequenceEvent | TMulticastDelegate_TwoParams< void, IAvaPlaybackClient &, const FPlaybackSequenceEventArgs & > | Delegate called when a playback status changed message is received. | Playback/AvaPlaybackClientDelegates.h |
| FOnPlaybackStatusChanged | TMulticastDelegate_TwoParams< void, IAvaPlaybackClient &, const FPlaybackStatusChangedArgs & > | Delegate called when a playback status changed message is received. | Playback/AvaPlaybackClientDelegates.h |
| FOnPlaybackTransitionEvent | TMulticastDelegate_TwoParams< void, IAvaPlaybackClient &, const FPlaybackTransitionEventArgs & > | Delegate called when a playback status changed message is received. | Playback/AvaPlaybackClientDelegates.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAvaBroadcastAction | |
| EAvaBroadcastChange | An enum indicating what changed in Broadcast. |
| EAvaBroadcastChannelChange | An enum indicating what changed in Channel. |
| EAvaBroadcastChannelState | Channel state is a union summary of the output's states. |
| EAvaBroadcastChannelType | The channel type defines what it is used for in the broadcast framework. |
| EAvaBroadcastIssueSeverity | In case the broadcast device is Live (see EAvaBroadcastOutputState), this extra status indicates if the device is operating normally. |
| EAvaBroadcastOutputOverrunAction | Action to perform when a media capture overrun (main vs render thread) occurs on a broadcast channel. |
| EAvaBroadcastOutputState | Status of the media output. |
| EAvaMediaLogVerbosity | Defines the verbosity level of the logging system. |
| EAvaMediaMapChangeType | Maps one to one with the editor's map changed type (for now). |
| EAvaMediaSyncEngineType | Engine type values for a sync connected device |
| EAvaMediaSynchronizedEventState | |
| EAvaMediaSyncResponseResult | |
| EAvaPlayableCommandResult | |
| EAvaPlayableEndPlayOptions | Option flags for the EndPlay function. |
| EAvaPlayableRCUpdateFlags | Flags for the remote control values update command. |
| EAvaPlayableRemoteControlChanges | Flags indicating which component of the remote control values have been modified by an operation. |
| EAvaPlayableSequenceEventType | |
| EAvaPlayableStatus | The status of a playable object. |
| EAvaPlayableTransitionEntryRole | Defines the playable entry role in the transition. |
| EAvaPlayableTransitionEventFlags | |
| EAvaPlayableTransitionFlags | Transition flags carry additional context to help resolve the behaviors. |
| EAvaPlaybackAction | |
| EAvaPlaybackAnimAction | |
| EAvaPlaybackAssetStatus | The status of the playback asset on disk. |
| EAvaPlaybackPackageEventFlags | Flags indicating what changed in the package event. |
| EAvaPlaybackStatus | The status of the playback object. |
| EAvaPlaybackStopOptions | |
| EAvaPlaybackUnloadOptions | |
| EAvaRundownPageChanges | |
| EAvaRundownPageListChange | |
| EAvaRundownPageListType | Rundown's page list type. |
| EAvaRundownPagePlayType | |
| EAvaRundownPageStatus | |
| EAvaRundownPageStopOptions | |
| UE::AvaMedia::Rundown:: | |
| UE::AvaPlaybackClient::Delegates::EConnectionEvent | Delegates related to IAvaPlaybackClient. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| UE::AvaMedia::Playback::DefaultPreviewChannelName | const FLazyName | Playback manager needs a channel name as a key. | Playback/AvaPlaybackDefines.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| meta | Collection of rundown commands and bindings (either keys or other). | Rundown/AvaRundownMacroCollection.h | ||
| meta | A Playback Graph is used for playing Motion Design assets integrated with the broadcast framework. | Playback/AvaPlaybackGraph.h | ||
| meta | Base class for a Motion Design playable. | Playable/AvaPlayable.h | ||
| meta | Output Media to a display adapter. | Broadcast/OutputDevices/AvaBroadcastDisplayMediaOutput.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!
(
EAvaBroadcastChange E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaBroadcastChannelChange E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaPlayableTransitionFlags E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaPlayableTransitionEventFlags E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaPlayableRCUpdateFlags E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaRundownPageListChange E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaRundownPageChanges E |
AvaMediaDefines.h | ||
bool operator!
(
EAvaPlayableEndPlayOptions E |
Playable/AvaPlayable.h | ||
bool operator!
(
EAvaPlayableRemoteControlChanges E |
Playable/AvaPlayableRemoteControlValues.h | ||
bool operator!
(
EAvaPlaybackStopOptions E |
Playback/AvaPlaybackGraph.h | ||
bool operator!
(
EAvaPlaybackUnloadOptions E |
Playback/AvaPlaybackGraph.h | ||
bool operator!
(
EAvaPlaybackPackageEventFlags E |
Playback/AvaPlaybackManager.h | ||
bool operator!
(
EAvaRundownPageStopOptions E |
Rundown/AvaRundown.h | ||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
EAvaBroadcastChange & operator&=
(
EAvaBroadcastChange& Lhs, |
AvaMediaDefines.h | ||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
EAvaRundownPageChanges & operator&=
(
EAvaRundownPageChanges& Lhs, |
AvaMediaDefines.h | ||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
EAvaBroadcastChange & operator^=
(
EAvaBroadcastChange& Lhs, |
AvaMediaDefines.h | ||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
EAvaRundownPageChanges & operator^=
(
EAvaRundownPageChanges& Lhs, |
AvaMediaDefines.h | ||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
EAvaBroadcastChange & operator|=
(
EAvaBroadcastChange& Lhs, |
AvaMediaDefines.h | ||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
EAvaRundownPageChanges & operator|=
(
EAvaRundownPageChanges& Lhs, |
AvaMediaDefines.h | ||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| AvaMediaDefines.h | |||
| Playable/AvaPlayable.h | |||
| Playable/AvaPlayableRemoteControlValues.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackGraph.h | |||
| Playback/AvaPlaybackManager.h | |||
| Rundown/AvaRundown.h | |||
bool UE::AvaRundown::IsPreviewPlayType
(
EAvaRundownPagePlayType InPlayType |
Rundown/AvaRundown.h |