Navigation
API > API/Runtime > API/Runtime/AudioExtensions
Inheritance Hierarchy
- IModularFeature
- ISoundfieldFactory
- ISoundfieldEndpointFactory
References
| Module | AudioExtensions |
| Header | /Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldEndpoint.h |
| Include | #include "ISoundfieldEndpoint.h" |
Syntax
class ISoundfieldEndpointFactory : public ISoundfieldFactory
Remarks
This factory is used to expose Soundfield Endpoint types to the editor. Once a factory is constructed and RegisterEndpointType is called, it will be exposed as a type of endpoint That a submix in the submix graph could be constructed with. Also note that an implementation of ISoundfieldDecoder is not necessary for soundfield formats that are only used for soundfield endpoints.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TUniquePtr< ISoundfieldEndpoint > | CreateNewEndpointInstance
(
const FAudioPluginInitializationParams& InitInfo, |
REQUIRED OVERRIDES: These overrides are required from ISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStream ISoundfieldFactory::CreateEmptyPacketISoundfieldFactory::CanTranscodeFromSoundfieldFormatISoundfieldFactory::GetCustomEncodingSettingsClassISoundfieldFactory::GetDefaultEncodingSettings Called for every new endpoint submix created with this factory's endpoint type. |
  |
FName | This is the default name used when a user creates a soundfield endpoint submix. | |
  |
ISoundfieldEndpointFactory * | Get a registered endpoint factory by name. | |
  |
TArray< FName > | ||
   |
UClass * | Should return the StaticClass of this factory's implementation of USoundfieldEndpointSettingsBase. | |
 |
USoundfieldEndpointSettingsBase * | Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified. | |
 |
FName | Get the name for the endpoint type that this factory produces. | |
  |
FName | This is the FName used to register Soundfield Endpoint factories with the modular feature system. | |
  |
void | RegisterEndpointType
(
ISoundfieldEndpointFactory* InFactory |
This needs to be called to make a soundfield format usable by the engine. |
  |
void | UnregisterEndpointType
(
ISoundfieldEndpointFactory* InFactory |
This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed. |
Overridden from ISoundfieldFactory
| Type | Name | Description | |
|---|---|---|---|
  |
bool | CanTranscodeToSoundfieldFormat
(
FName DestinationFormat, |
|
  |
TUniquePtr< ISoundfieldDecoderStream > | CreateDecoderStream
(
const FAudioPluginInitializationParams& InitInfo, |
This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers. |
  |
FName | Get soundfield format name | |
  |
bool | This is overridden to return true for soundfield formats that are only used for sending audio externally. |