Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
| Name | IAvaMediaModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/IAvaMediaModule.h |
| Include Path | #include "IAvaMediaModule.h" |
Syntax
class IAvaMediaModule : public IModuleInterface
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetEditorViewportClient | TBaseDelegate_OneParam< void, FCommonViewportClient ** > | Use to query the current editor viewport from the corresponding editor module. | IAvaMediaModule.h |
| FOnAvaMediaSyncPackageModified | TMulticastDelegate_TwoParams< void, IAvaMediaSyncProvider *, const FName & > | Delegate called when a package has been touched by a sync operation from the given sync provider. | IAvaMediaModule.h |
| FOnAvaMediaSyncProviderChanged | TMulticastDelegate_OneParam< void, IAvaMediaSyncProvider * > | Delegate called when a new IAvaMediaSyncProvider modular feature is used. | IAvaMediaModule.h |
| FOnAvaPlaybackClientStarted | TMulticastDelegate_NoParams< void > | IAvaMediaModule.h | |
| FOnAvaPlaybackClientStopped | TMulticastDelegate_NoParams< void > | IAvaMediaModule.h | |
| FOnAvaPlaybackServerStarted | TMulticastDelegate_NoParams< void > | IAvaMediaModule.h | |
| FOnAvaPlaybackServerStopped | TMulticastDelegate_NoParams< void > | IAvaMediaModule.h | |
| FOnMapChangedEvent | TMulticastDelegate_TwoParams< void, UWorld *, EAvaMediaMapChangeType > | IAvaMediaModule.h | |
| FOnRundownServerEvent | TMulticastDelegate_OneParam< void, TSharedPtr< IAvaRundownServer > > | IAvaMediaModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FAvaInstanceSettings & GetAvaInstanceSettings () |
Access the global Motion Design instance settings. | IAvaMediaModule.h | |
IAvaMediaSyncProvider * GetAvaMediaSyncProvider() |
Access the currently used Ava Media Sync Provider. | IAvaMediaModule.h | |
FOnAvaPlaybackClientStopped & GetAvaPlaybackClientStopped() |
IAvaMediaModule.h | ||
FOnAvaPlaybackServerStopped & GetAvaPlaybackServerStopped() |
IAvaMediaModule.h | ||
const IAvaBroadcastSettings & GetBroadcastSettings() |
Access the global broadcast settings. | IAvaMediaModule.h | |
const IMediaIOCoreDeviceProvider * GetDeviceProvider
(
FName InProviderName, |
IAvaMediaModule.h | ||
IAvaBroadcastDeviceProviderProxyManager & GetDeviceProviderProxyManager() |
Access the device provider proxy manager. | IAvaMediaModule.h | |
TArray< const IMediaIOCoreDeviceProvider * > GetDeviceProvidersForServer
(
const FString& InServerName |
IAvaMediaModule.h | ||
FGetEditorViewportClient & GetEditorViewportClientDelegate() |
IAvaMediaModule.h | ||
FAvaPlaybackManager & GetLocalPlaybackManager() |
This is the backend for playing Motion Design assets locally. | IAvaMediaModule.h | |
FAvaRundownManagedInstanceCache & GetManagedInstanceCache() |
Access the "managed" Motion Design Asset Instance cache. | IAvaMediaModule.h | |
FOnAvaMediaSyncPackageModified & GetOnAvaMediaSyncPackageModified() |
IAvaMediaModule.h | ||
FOnAvaMediaSyncProviderChanged & GetOnAvaMediaSyncProviderChanged() |
IAvaMediaModule.h | ||
FOnAvaPlaybackClientStarted & GetOnAvaPlaybackClientStarted() |
IAvaMediaModule.h | ||
FOnAvaPlaybackServerStarted & GetOnAvaPlaybackServerStarted() |
IAvaMediaModule.h | ||
FOnMapChangedEvent & GetOnMapChangedEvent() |
IAvaMediaModule.h | ||
FOnRundownServerEvent & GetOnRundownServerStarted() |
IAvaMediaModule.h | ||
FOnRundownServerEvent & GetOnRundownServerStopping() |
IAvaMediaModule.h | ||
IAvaPlayableRemoteControlPresetInfoCache & GetPlayableRemoteControlPresetInfoCache() |
Access the global remote control preset info cache. | IAvaMediaModule.h | |
const FAvaPlayableSettings & GetPlayableSettings () |
Access global Playable Settings. | IAvaMediaModule.h | |
IAvaPlaybackClient & GetPlaybackClient() |
IAvaMediaModule.h | ||
IAvaPlaybackServer * GetPlaybackServer() |
IAvaMediaModule.h | ||
TSharedPtr< IAvaRundownServer > GetRundownServer() |
Returns currently running rundown server. | IAvaMediaModule.h | |
| IAvaMediaModule.h | |||
bool IsAvaMediaSyncProviderFeatureAvailable() |
Returns true if the AvaMediaSyncProvider modular feature is available. | IAvaMediaModule.h | |
bool IsGameModeLocalPlaybackServerLaunched() |
Returns true if the game mode local playback server process is launched. | IAvaMediaModule.h | |
| IAvaMediaModule.h | |||
bool IsLocalPlaybackManagerAvailable() |
Returns true if the local playback manager is (still) available. | IAvaMediaModule.h | |
bool IsManagedInstanceCacheAvailable() |
Returns true if the managed instance cache is (still) available. | IAvaMediaModule.h | |
bool IsPlaybackClientStarted() |
Returns true if the playback client is started. | IAvaMediaModule.h | |
bool IsPlaybackServerStarted() |
Returns true if the playback server is started. | IAvaMediaModule.h | |
bool IsRundownServerStarted() |
Returns true if the rundown server is started. | IAvaMediaModule.h | |
void LaunchGameModeLocalPlaybackServer() |
Launches a separate process in game mode to run a local playback server. | IAvaMediaModule.h | |
TSharedPtr< IAvaRundownServer > MakeDetachedRundownServer
(
const FString& InServerName |
Creates a rundown server that is not managed by the module. | IAvaMediaModule.h | |
void NotifyMapChangedEvent
(
UWorld* InWorld, |
Propagate a map changed event (from the level editor). | IAvaMediaModule.h | |
void StartPlaybackClient() |
Starts the playback client (if not already started). | IAvaMediaModule.h | |
void StartPlaybackServer
(
const FString& InPlaybackServerName |
Starts the playback server (if not already started). | IAvaMediaModule.h | |
void StartRundownServer
(
const FString& InServerName |
Starts the rundown server (if not already started). | IAvaMediaModule.h | |
void StopGameModeLocalPlaybackServer() |
Stops currently running game mode local playback server. | IAvaMediaModule.h | |
void StopPlaybackClient() |
Stops the playback client. | IAvaMediaModule.h | |
void StopPlaybackServer() |
Stops the playback server. | IAvaMediaModule.h | |
void StopRundownServer() |
Stops the rundown server. | IAvaMediaModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IAvaMediaModule & Get() |
IAvaMediaModule.h | ||
static bool IsModuleLoaded() |
IAvaMediaModule.h |