1. Epic GamesDeveloper
  3. ISoundfieldEndpointFactory

ISoundfieldEndpointFactory

This factory is used to expose Soundfield Endpoint types to the editor.

Unreal Engine C++ API Reference > Runtime > AudioExtensions

Inheritance Hierarchy

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
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function TUniquePtr< ISoundfieldEndpoint > REQUIRED OVERRIDES: These overrides are required from ISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStream ISoundfieldFactory::CreateEmptyPacketISoundfieldFactory::CanTranscodeFromSoundfieldFormatISoundfieldFactory::GetCustomEncodingSettingsClass ISoundfieldFactory::GetDefaultEncodingSettingsCalled for every new endpoint submix created with this factory's endpoint type.
Public function Static FName This is the default name used when a user creates a soundfield endpoint submix.
Public function Static ISoundfieldEndpointFactory *

Get ( const FName& InName
)

 Get a registered endpoint factory by name.
Public function Static TArray< FName >  
Public function Virtual Const UClass * Should return the StaticClass of this factory's implementation of USoundfieldEndpointSettingsBase.
Public function USoundfieldEndpointSettingsBase * Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified.
Public function FName Get the name for the endpoint type that this factory produces.
Public function Static FName This is the FName used to register Soundfield Endpoint factories with the modular feature system.
Public function Static void This needs to be called to make a soundfield format usable by the engine.
Public function Static void This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Overridden from ISoundfieldFactory

  Type Name Description
Public function Virtual bool

CanTranscodeToSoundfieldFormat ( FName DestinationFormat,
const ISoundfieldEncodingSettingsProxy& DestinationEncodingSettings
)

  
Public function Virtual TUniquePtr< ISoundfieldDecoderStream > This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers.
Public function Virtual FName Get soundfield format name
Public function Virtual bool This is overridden to return true for soundfield formats that are only used for sending audio externally.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page