FOculusAmbisonicsFactory

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

ISoundfieldFactory

FOculusAmbisonicsFactory

References

Module

OculusAudio

Header

/Engine/Plugins/Runtime/Oculus/OculusAudio/Source/OculusAudio/Public/OculusAmbisonicSpatializer.h

Include

#include "OculusAmbisonicSpatializer.h"

Syntax

class FOculusAmbisonicsFactory : public ISoundfieldFactory

Constructors

Name Description

Public function

FOculusAmbisonicsFactory()

Destructors

Name Description

Public function Virtual

~FOculusAmbisonicsFactory()

Overridden from ISoundfieldFactory

Name Description

Public function Virtual

bool

 

CanTranscodeFromSoundfieldFormat

(
    FName SourceFormat,
    const ISoundfieldEncodingSettingsPr...
)

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

Public function Virtual

bool

 

CanTranscodeToSoundfieldFormat

(
    FName DestinationFormat,
    const ISoundfieldEncodingSettingsPr...
)

Public function Virtual

TUniquePtr< ...

 

CreateDecoderStream

(
    const FAudioPluginInitializationPar...,
    const ISoundfieldEncodingSettingsPr...
)

Public function Virtual

TUniquePtr< ...

 

CreateEmptyPacket()

Public function Virtual

TUniquePtr< ...

 

CreateEncoderStream

(
    const FAudioPluginInitializationPar...,
    const ISoundfieldEncodingSettingsPr...
)

Called when a stream is opened.

Public function Virtual

TUniquePtr< ...

 

CreateMixerStream

(
    const ISoundfieldEncodingSettingsPr...
)

Public function Virtual

TUniquePtr< ...

 

CreateTranscoderStream

(
    const FName SourceFormat,
    const ISoundfieldEncodingSettingsPr...,
    const FName DestinationFormat,
    const ISoundfieldEncodingSettingsPr...,
    const FAudioPluginInitializationPar...
)

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

Public function Virtual Const

UClass *

 

GetCustomEncodingSettingsClass()

Should return the StaticClass of your implementation of USoundfieldEncodingSettingsBase.

Public function Virtual

const USound...

 

GetDefaultEncodingSettings()

Begin ISoundfieldFactory.

Public function Virtual

FName

 

GetSoundfieldFormatName()

Get soundfield format name

Public function Virtual

bool

 

IsTranscodeRequiredBetweenSettings

(
    const ISoundfieldEncodingSettingsPr...,
    const ISoundfieldEncodingSettingsPr...
)

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.

Constants

Name

Description

ContextMap

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss