ISoundModulatable Class Reference

#include <IAudioModulation.h>

Inheritance diagram for ISoundModulatable:

Public Member Functions
virtual	~ISoundModulatable ()=default
virtual uint32	GetObjectId () const =0
virtual int32	GetPlayCount () const =0
virtual bool	IsPreviewSound () const =0
virtual void	Stop ()=0

Detailed Description

Interface to sound that is modulatable, allowing for certain specific behaviors to be controlled on the sound level by the modulation system.

Constructor & Destructor Documentation

~ISoundModulatable()

virtual ISoundModulatable::~ISoundModulatable ( )

virtualdefault

Member Function Documentation

GetObjectId()

virtual uint32 ISoundModulatable::GetObjectId ( ) const

pure virtual

Gets the object definition id of the given playing sound's instance

Implemented in FActiveSound.

GetPlayCount()

virtual int32 ISoundModulatable::GetPlayCount ( ) const

pure virtual

Returns number of actively instances of sound playing (including virtualized instances)

Implemented in FActiveSound.

IsPreviewSound()

virtual bool ISoundModulatable::IsPreviewSound ( ) const

pure virtual

Returns whether or not sound is an editor preview sound

Implemented in FActiveSound.

Stop()

virtual void ISoundModulatable::Stop ( )

pure virtual

Stops sound.

Implemented in FActiveSound.

---

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

• Engine/Source/Runtime/AudioExtensions/Public/IAudioModulation.h