Navigation
API > API/Plugins > API/Plugins/SoundFields
Inheritance Hierarchy
- IModularFeature
- ISoundfieldFactory
- FAmbisonicsSoundfieldFormat
References
| Module | SoundFields |
| Header | /Engine/Plugins/Runtime/SoundFields/Source/SoundFields/Public/SoundFields.h |
| Include | #include "SoundFields.h" |
Syntax
class FAmbisonicsSoundfieldFormat : public ISoundfieldFactory
Remarks
This is the default format for Ambisonics in the Unreal Audio Engine.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Dtor |
Overridden from ISoundfieldFactory
| Type | Name | Description | |
|---|---|---|---|
  |
bool | CanTranscodeFromSoundfieldFormat
(
FName SourceFormat, |
Override this function to decide whether this soundfield format can read and convert from a source format. |
  |
bool | CanTranscodeToSoundfieldFormat
(
FName DestinationFormat, |
|
  |
TUniquePtr< ISoundfieldDecoderStream > | CreateDecoderStream
(
const FAudioPluginInitializationParams& InitInfo, |
|
  |
TUniquePtr< ISoundfieldAudioPacket > | ||
  |
TUniquePtr< ISoundfieldEncoderStream > | CreateEncoderStream
(
const FAudioPluginInitializationParams& InitInfo, |
Called when a stream is opened. |
  |
TUniquePtr< ISoundfieldMixerStream > | CreateMixerStream
(
const ISoundfieldEncodingSettingsProxy& InitialSettings |
|
  |
TUniquePtr< ISoundfieldTranscodeStream > | CreateTranscoderStream
(
const FName SourceFormat, |
Transcoder streams are fed a soundfield audio packet with either a different format entirely, or the same format and different settings. |
   |
UClass * | Should return the StaticClass of your implementation of USoundfieldEncodingSettingsBase. | |
  |
USoundfieldEncodingSettingsBase * | ||
  |
FName | Begin ISoundfieldFactory. | |
  |
bool | IsTranscodeRequiredBetweenSettings
(
const ISoundfieldEncodingSettingsProxy& SourceSettings, |
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. |