IAudioPluginListener

[IAudioPluginListener](API\Runtime\Engine\IAudioPluginListener) Implementations of this interface can receive updates about the audio listener's position in the game world, as well as other data.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/IAudioExtensionPlugin.h

Include

#include "IAudioExtensionPlugin.h"

Syntax

class IAudioPluginListener

Remarks

IAudioPluginListener Implementations of this interface can receive updates about the audio listener's position in the game world, as well as other data. to use this, register a ListenerObserver to an audio device using FAudioDevice::RegisterPluginListener().

Destructors

Name Description

Public function Virtual

~IAudioPluginListener()

Functions

Name Description

Public function Virtual

void

 

OnDeviceShutdown

(
    FAudioDevice* AudioDevice
)

Public function Virtual

void

 

OnListenerInitialize

(
    FAudioDevice* AudioDevice,
    UWorld* ListenerWorld
)

This function is called when a game world initializes a listener with an audio device this IAudioPluginListener is registered to.

Public function Virtual

void

 

OnListenerShutdown

(
    FAudioDevice* AudioDevice
)

Called when the listener is shutdown.

Public function Virtual

void

 

OnListenerUpdated

(
    FAudioDevice* AudioDevice,
    const int32 ViewportIndex,
    const FTransform& ListenerTransfor...,
    const float InDeltaSeconds
)

Called when the listener is updated on the given audio device.

Public function Virtual

void

 

OnTick

(
    UWorld* InWorld,
    const int32 ViewportIndex,
    const FTransform& ListenerTransfor...,
    const float InDeltaSeconds
)

This is overridable for any actions a plugin manager may need to do on the game thread.

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