SoundObject¶
class SoundObject
Base class for Amplitude sound objects.
Functions¶
| Name | Description |
|---|---|
| ~SoundObject | Default destructor. |
| GetGain | Gets the linear gain of the sound object. |
| GetPitch | Gets the actual pitch of the sound object. |
| GetPriority | Gets the actual priority of the sound object. |
| GetEffect | Gets the Effect object associated with this sound object. |
| GetAttenuation | Gets the Attenuation object associated with this sound object. |
| GetBus | Returns the bus this sound object will play on. |
| GetSpatialization | Returns the spatialization mode of the sound object. |
| GetScope | Returns the scope of the sound object. |
Function Details¶
GetAttenuation¶
* GetAttenuation() const
Gets the Attenuation object associated with this sound object.
- Return
- The Attenuation object.
GetBus¶
[[nodiscard]] virtual Bus GetBus() const = 0
Returns the bus this sound object will play on.
- Return
- The bus this sound object will play on.
GetEffect¶
* GetEffect() const
Gets the Effect object associated with this sound object.
- Return
- The Effect object.
GetGain¶
[[nodiscard]] virtual const RtpcValue& GetGain() const = 0
Gets the linear gain of the sound object.
- Return
- The sound object linear gain.
GetPitch¶
[[nodiscard]] virtual const RtpcValue& GetPitch() const = 0
Gets the actual pitch of the sound object.
- Return
- The sound object pitch.
GetPriority¶
[[nodiscard]] virtual const RtpcValue& GetPriority() const = 0
Gets the actual priority of the sound object.
- Return
- The sound object priority.
GetScope¶
[[nodiscard]] virtual eScope GetScope() const = 0
Returns the scope of the sound object.
- Return
- The scope of the sound object.
GetSpatialization¶
[[nodiscard]] virtual eSpatialization GetSpatialization() const = 0
Returns the spatialization mode of the sound object.
- Return
- The spatialization mode of the sound object.
~SoundObject¶
virtual ~SoundObject() = default
Default destructor.