Navigation
API > API/Plugins > API/Plugins/SubsonicCore
Execution object that tracks explicit execution context for any caller of events related to a given collection. RAII design that automatically registers and unregisters with the Subsonic Event Registry, and by extension, any implemented and active subscribers. This enables subscribers to track and manage data related to event requests from a given executor instance in a data-oriented fashion.
| Name | FSubsonicExecutor |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Subsonic/Source/SubsonicCore/Public/SubsonicExecutor.h |
| Include Path | #include "SubsonicExecutor.h" |
Syntax
struct FSubsonicExecutor : public TSharedFromThis< FSubsonicExecutor >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FSubsonicExecutor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| SubsonicExecutor.h | |||
FSubsonicExecutor
(
const FSubsonicExecutor& |
SubsonicExecutor.h | ||
| SubsonicExecutor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSubsonicExecutor() |
SubsonicExecutor.h |
Structs
| Name | Remarks |
|---|---|
| ICollectionAccessor |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCollectionAccessorPtr | TUniquePtr< ICollectionAccessor > | SubsonicExecutor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CollectionAccessor | FCollectionAccessorPtr | SubsonicExecutor.h | ||
| DeviceId | Audio::FDeviceId | SubsonicExecutor.h | ||
| ExecutorId | uint32 | SubsonicExecutor.h | ||
| Parameters | FSubsonicParameterStore | Trigger-time parameters stored here before ExecuteEvent is called. | SubsonicExecutor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ExecuteEvent
(
FName EventName |
SubsonicExecutor.h | ||
const FSubsonicEventCollectionDefinition * GetCollection() |
SubsonicExecutor.h | ||
FCollectionHandle GetCollectionHandle() |
SubsonicExecutor.h | ||
Audio::FDeviceId GetDeviceId() |
SubsonicExecutor.h | ||
uint32 GetId() |
SubsonicExecutor.h | ||
const FSubsonicParameterStore & GetParameters() |
Returns the current trigger-time parameter store. | SubsonicExecutor.h | |
bool IsValid() |
SubsonicExecutor.h | ||
void SetParameters
(
FSubsonicParameterStore InParams |
Sets trigger-time parameters on this executor. | SubsonicExecutor.h | |
FString ToString() |
SubsonicExecutor.h | ||
void Unregister() |
SubsonicExecutor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FSubsonicExecutor > Create
(
Audio::FDeviceId InDeviceId, |
SubsonicExecutor.h | ||
static uint32 GetInvalidId() |
SubsonicExecutor.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubsonicExecutor & operator=
(
const FSubsonicExecutor& InOther |
SubsonicExecutor.h | ||
FSubsonicExecutor & operator=
(
FSubsonicExecutor&& InOther |
SubsonicExecutor.h |