IAmbisonicsMixer

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/IAmbisonicsMixer.h

Include

#include "IAmbisonicsMixer.h"

Syntax

class IAmbisonicsMixer

Destructors

Name Description

Public function Virtual

~IAmbisonicsMixer()

Virtual destructor

Functions

Name Description

Public function Virtual

void

 

DecodeFromAmbisonics

(
    const uint32 StreamId,
    const FAmbisonicsDecoderInputData&...,
    FAmbisonicsDecoderPositionalData& ...,
    FAmbisonicsDecoderOutputData& Outp...
)

Decodes the ambisonics data into interleaved audio.

Public function Virtual

void

 

EncodeToAmbisonics

(
    const uint32 SourceId,
    const FAmbisonicsEncoderInputData&...,
    FAmbisonicsEncoderOutputData& Outp...,
    UAmbisonicsSubmixSettingsBase*...
)

Encode the given source input data to ambisonics.

Public function Virtual

UClass *

 

GetCustomSettingsClass()

Public function Virtual

UAmbisonicsS...

 

GetDefaultSettings()

Public function

int32

 

GetNumChannelsForAmbisonicsFormat

Returns the number of channels for a given format.

Public function

void

 

Initialize

(
    const FAudioPluginInitializationPar...
)

Initializes the ambisonics plugin with the given buffer length.

Public function Virtual

void

 

OnCloseDecodingStream

(
    const uint32 StreamId
)

Closes the decoding stream.

Public function Virtual

void

 

OnCloseEncodingStream

(
    const uint32 SourceId
)

Called when a stream is done playing and is released.

Public function Virtual

void

 

OnDeviceShutdown

(
    FAudioDevice* AudioDevice
)

Public function Virtual

void

 

OnOpenDecodingStream

(
    const uint32 StreamId,
    UAmbisonicsSubmixSettingsBase*...,
    FAmbisonicsDecoderPositionalData& ...
)

Open a decoding stream with the given stream id.

Public function Virtual

void

 

OnOpenEncodingStream

(
    const uint32 SourceId,
    UAmbisonicsSubmixSettingsBase*...
)

Called when a stream is opened.

Public function Virtual

bool

 

ShouldReencodeBetween

Override this function to determine whether an audio buffer incoming from a different submix needs to be reencoded.

Public function Virtual

void

 

Shutdown()

Shuts down the audio plugin.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback