1. Epic GamesDeveloper
  3. ISoundfieldFactory

ISoundfieldFactory

Unreal Engine C++ API Reference > Runtime > AudioExtensions

Inheritance Hierarchy

References

   
Module AudioExtensions
Header /Engine/Source/Runtime/AudioExtensions/Public/ISoundfieldFormat.h
Include #include "ISoundfieldFormat.h"

Syntax

class ISoundfieldFactory : public IModularFeature

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function bool

CanTranscodeFromSoundfieldFormat ( FName SourceFormat,
const ISoundfieldEncodingSettingsProxy& SourceEncodingSettings
)

 Override this function to decide whether this soundfield format can read and convert from a source format.
Public function bool

CanTranscodeToSoundfieldFormat ( FName DestinationFormat,
const ISoundfieldEncodingSettingsProxy& DestinationEncodingSettings
)

  
Public function TUniquePtr< ISoundfieldDecoderStream >  
Public function TUniquePtr< ISoundfieldAudioPacket >  
Public function TUniquePtr< ISoundfieldEncoderStream > Called when a stream is opened.
Public function TUniquePtr< ISoundfieldMixerStream >  
Public function TUniquePtr< ISoundfieldTranscodeStream >

CreateTranscoderStream ( const FName SourceFormat,
const ISoundfieldEncodingSettingsProxy& InitialSourceSettings,
const FName DestinationFormat,
const ISoundfieldEncodingSettingsProxy& InitialDestinationSettings,
const FAudioPluginInitializationParams& InitInfo
)

 Transcoder streams are fed a soundfield audio packet with either a different format entirely, or the same format and different settings.
Public function Static ISoundfieldFactory *

Get ( const FName& InName
)

 Get a registered soundfield format factory by name.
Public function Static TArray< FName >  
Public function Virtual Const UClass * Should return the StaticClass of your implementation of USoundfieldEncodingSettingsBase.
Public function const USoundfieldEncodingSettingsBase *  
Public function Static FName When a submix has this format name, it derives its format from the submix it sends audio to.
Public function Static FName When a submix has this format name, it is using interleaved, floating point audio with no metadata.
Public function Static FName This is the FName used to register Soundfield Format factories with the modular feature system.
Public function 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.
Public function Virtual bool Override this function to determine whether an incoming ISoundfieldPacket would need to be explicitly operated on between two submixes with the same format, but potentially different encoding settings.
Public function Static void This needs to be called to make a soundfield format usable by the engine.
Public function Virtual bool If this is overridden to true, we will set up a separate encoding stream for every submix plugged into this soundfield submix.
Public function Static void This needs to be called it an implementation of ISoundfieldFactory is about to be destroyed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page