Sound¶
Amplitude sound asset.
Inherits the following classes: SparkyStudios::Audio::Amplitude::SoundObject, SparkyStudios::Audio::Amplitude::Resource, SparkyStudios::Audio::Amplitude::Asset
Detailed Description¶
A Sound is the most basic sound object in Amplitude. It can be used to directly play an audio file, or can be contained in a SwitchContainer or a Collection for a fine-grained control.
Effects can be attached to a Sound, which will be applied to all instances of that sound in the Amplimix pipeline.
See also: SwitchContainer, Collection, SoundObject
Public Functions¶
| Type | Name |
|---|---|
| virtual const RtpcValue & | GetNearFieldGain () const = 0 Gets the near field effect gain of the sound object. |
| virtual bool | IsLoop () const = 0 Checks if looping is enabled for this Sound . |
| virtual bool | IsStream () const = 0 Checks if streaming is enabled for this Sound . |
Public Functions inherited from SparkyStudios::Audio::Amplitude::SoundObject¶
See SparkyStudios::Audio::Amplitude::SoundObject
| Type | Name |
|---|---|
| virtual const Attenuation * | GetAttenuation () const = 0 Gets the Attenuation object associated with this sound object. |
| virtual Bus | GetBus () const = 0 Returns the Bus this sound object will play on. |
| virtual const Effect * | GetEffect () const = 0 Gets the Effect object associated with this sound object. |
| virtual const RtpcValue & | GetGain () const = 0 Gets the linear gain of the sound object. |
| virtual const RtpcValue & | GetPitch () const = 0 Gets the current pitch of the sound object. |
| virtual const RtpcValue & | GetPriority () const = 0 Gets the current priority of the sound object. |
| virtual eScope | GetScope () const = 0 Returns the scope of the sound object. |
| virtual eSpatialization | GetSpatialization () const = 0 Returns the spatialization mode of the sound object. |
| virtual | ~SoundObject () = default Default destructor. |
Public Functions inherited from SparkyStudios::Audio::Amplitude::Resource¶
See SparkyStudios::Audio::Amplitude::Resource
| Type | Name |
|---|---|
| virtual const AmOsString & | GetPath () const = 0 Gets the path to the resource. |
| virtual void | Load (std::shared_ptr< const FileSystem > loader) = 0 Loads the resource from the given FileSystem . |
| virtual | ~Resource () = default Default destructor. |
Public Functions inherited from SparkyStudios::Audio::Amplitude::Asset¶
See SparkyStudios::Audio::Amplitude::Asset
| Type | Name |
|---|---|
| virtual Id | GetId () const = 0 Returns the unique ID of this asset. |
| virtual const AmString & | GetName () const = 0 Gets the name of this asset. |
| virtual | ~Asset () = default Destroys the asset and all related resources. |
Public Functions Documentation¶
GetNearFieldGain
Gets the near field effect gain of the sound object.
Returns:
The sound object near field effect gain.
IsLoop
Checks if looping is enabled for this Sound .
Returns:
true if looping is enabled, false otherwise.
IsStream
Checks if streaming is enabled for this Sound .
Returns:
true if streaming is enabled, false otherwise.
The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/Sound/Sound.h