ISoundHandleSystem Class Reference

#include <ISoundHandleSystem.h>

Inheritance diagram for ISoundHandleSystem:

Public Member Functions
virtual	~ISoundHandleSystem ()=default
virtual Audio::FSoundHandleID	CreateSoundHandle (USoundBase *Sound, ISoundHandleOwner *Owner)
	This should create a sound and we should map it to an identifier. Then return the identifier to the owner to keep track of.
virtual void	SetTransform (Audio::FSoundHandleID ID, const FTransform &Transform)
	Set the transform on the sound that is represented by the sound handle with the following ID.
virtual Audio::EResult	Play (Audio::FSoundHandleID ID)
	Play the sound that is represented by the sound handle with the following ID.
virtual void	Stop (Audio::FSoundHandleID ID)
	Stop the sound that is represented by the sound handle with the following ID.

Static Public Member Functions
static FName	GetModularFeatureName ()
static TArray< ISoundHandleSystem * >	GetRegisteredInterfaces ()

Detailed Description

This interface should be used with systems aiming to create Sound Handles: gameplay thread representations of sounds

Constructor & Destructor Documentation

~ISoundHandleSystem()

virtual ISoundHandleSystem::~ISoundHandleSystem ( )

virtualdefault

Member Function Documentation

CreateSoundHandle()

virtual Audio::FSoundHandleID ISoundHandleSystem::CreateSoundHandle ( USoundBase *  Sound, ISoundHandleOwner *  Owner  )

inlinevirtual

This should create a sound and we should map it to an identifier. Then return the identifier to the owner to keep track of.

Parameters

Sound
Owner

Returns

GetModularFeatureName()

static FName ISoundHandleSystem::GetModularFeatureName ( )

inlinestatic

Get the name of all Sound Handle implementations in the Modular Features registry.

Returns

"SoundHandles"

GetRegisteredInterfaces()

static TArray< ISoundHandleSystem * > ISoundHandleSystem::GetRegisteredInterfaces ( )

inlinestatic

Play()

virtual Audio::EResult ISoundHandleSystem::Play ( Audio::FSoundHandleID  ID )

inlinevirtual

Play the sound that is represented by the sound handle with the following ID.

Parameters

ID

SetTransform()

virtual void ISoundHandleSystem::SetTransform ( Audio::FSoundHandleID  ID, const FTransform &  Transform  )

inlinevirtual

Set the transform on the sound that is represented by the sound handle with the following ID.

Parameters

ID
Transform

Stop()

virtual void ISoundHandleSystem::Stop ( Audio::FSoundHandleID  ID )

inlinevirtual

Stop the sound that is represented by the sound handle with the following ID.

Parameters

ID

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Engine/Public/Audio/ISoundHandleSystem.h