Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
Inheritance Hierarchy
- IModuleInterface
- IAvaMediaModule
References
| Module | AvalancheMedia |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/IAvaMediaModule.h |
| Include | #include "IAvaMediaModule.h" |
Syntax
class IAvaMediaModule : public IModuleInterface
Functions
| Type | Name | Description | |
|---|---|---|---|
| IAvaMediaModule & | Get () |
||
| const FAvaInstanceSettings & | Access the global Motion Design instance settings. | ||
| IAvaMediaSyncProvider * | Access the currently used Ava Media Sync Provider. | ||
| FOnAvaPlaybackClientStopped & | |||
| FOnAvaPlaybackServerStopped & | |||
| const IAvaBroadcastSettings & | Access the global broadcast settings. | ||
| const IMediaIOCoreDeviceProvider * | GetDeviceProvider
(
FName InProviderName, |
||
| IAvaBroadcastDeviceProviderProxyManager & | Access the device provider proxy manager. | ||
| TArray< const IMediaIOCoreDeviceProvider * > | GetDeviceProvidersForServer
(
const FString& InServerName |
||
| FGetEditorViewportClient & | |||
| FAvaPlaybackManager & | This is the backend for playing Motion Design assets locally. | ||
| FAvaRundownManagedInstanceCache & | Access the "managed" Motion Design Asset Instance cache. | ||
| FOnAvaMediaSyncPackageModified & | |||
| FOnAvaMediaSyncProviderChanged & | |||
| FOnAvaPlaybackClientStarted & | |||
| FOnAvaPlaybackServerStarted & | |||
| FOnMapChangedEvent & | |||
| IAvaPlaybackClient & | |||
| IAvaPlaybackServer * | |||
| TSharedPtr< FAvaPlaybackServer > | |||
| FString | GetServerNameForDevice
(
const FName& InDeviceProviderName, |
||
| bool | Returns true if the AvaMediaSyncProvider modular feature is available. | ||
| bool | Returns true if the game mode local playback server process is launched. | ||
| bool | IsLocalDevice
(
const FName& InDeviceProviderName, |
||
| bool | |||
| bool | Returns true if the playback client is started. | ||
| bool | Returns true if the playback server is started. | ||
| void | Launches a separate process in game mode to run a local playback server. | ||
| void | NotifyMapChangedEvent
(
UWorld* InWorld, |
Propagate a map changed event (from the level editor). | |
| void | Starts the playback client (if not already started). | ||
| void | StartPlaybackServer
(
const FString& InPlaybackServerName |
Starts the playback server (if not already started). | |
| void | Stops currently running game mode local playback server. | ||
| void | Stops the playback client. | ||
| void | Stops the playback server. |
Typedefs
| Name | Description |
|---|---|
| FGetEditorViewportClient | Use to query the current editor viewport from the corresponding editor module. |
| FOnAvaMediaSyncPackageModified | Delegate called when a package has been touched by a sync operation from the given sync provider. |
| FOnAvaMediaSyncProviderChanged | Delegate called when a new IAvaMediaSyncProvider modular feature is used. |
| FOnAvaPlaybackClientStarted | |
| FOnAvaPlaybackClientStopped | |
| FOnAvaPlaybackServerStarted | |
| FOnAvaPlaybackServerStopped | |
| FOnMapChangedEvent |