Namespace SparkyStudios::Audio::Amplitude¶

Namespaces¶

Type	Name
namespace	Thread

Classes¶

Type	Name
class	AmAlignedReal32Buffer Class that handles aligned allocations to support vectorized operations.
class	AmFakeSharedPtr <typename T> Fake shared pointer.
class	AmSharedPtr <class T, Pool> Shared pointer type.
struct	AmVersion A structure containing the version number of the library.
class	Amplimix Amplitude Audio Mixer.
class	AmplimixLayer A single layer in the mixer.
class	Asset <typename Id> Amplitude asset.
class	AssetManagerFile A `File` implementation that reads and writes files from an Android AssetManager.
class	AssetManagerFileSystem A `FileSystem` implementation that reads and writes files from an Android AssetManager.
class	Attenuation Amplitude attenuation asset.
class	AttenuationZone The propagation shape for positional sounds.
class	AudioBuffer Represents an audio buffer containing multiple channels.
class	AudioBufferChannel Represents a view to a single channel in an `AudioBuffer` .
class	AudioBufferCrossFader Helper class used to cross fade between audio buffers.
class	AudioConverter Allow converting audio buffers between different sample rates and channel counts.
struct	BarycentricCoordinates Represents barycentric coordinates between a point and 3 vertices of a triangle.
struct	BezierCurveControlPoints A structure containing control points for a Bézier curve.
class	BoxShape A box shape, defined by a width, a height, and a depth.
class	BoxZone A `Zone` built with an inner`BoxShape` and an outer`BoxShape` .
class	Bus An object representing one node in the tree of buses. Buses are used to adjust a set of channel gains in tandem.
class	CapsuleShape A capsule shape, defined by a radius and a height.
class	CapsuleZone A `Zone` built with an inner`CapsuleShape` and an outer`CapsuleShape` .
class	CartesianCoordinateSystem A class representing a cartesian coordinate system.
class	Channel An object that represents a single channel of audio.
struct	ChannelEventInfo The event info passed to the channel event listener.
class	ChannelEventListener Channel event listener.
class	ChannelInstance Represents a single position instance within a multi-position channel.
class	Codec Audio file reader and writer.
class	Collection Amplitude collection asset.
class	ConeShape A cone shape, defined by a radius and a height.
class	ConeZone A `Zone` built with an inner`ConeShape` and an outer`ConeShape` .
class	ConsoleLogger A Logger implementation that outputs messages to the console.
class	ConsumerNodeInstance Interface for Amplimix pipeline nodes that can consume audio data from an input buffer.
class	Convolver Implementation of a partitioned FFT convolution algorithm with a uniform block size.
class	Curve A `Curve` that describes the variation of a value (on the Y-axis) according to another (on the X-axis).
class	CurvePart A segment of a `Curve` .
struct	CurvePoint A single point in a Curve .
class	DefaultMemoryAllocator Default memory allocator.
struct	DeviceDescription The device description.
class	DiskFile A File implementation that reads and writes files on disk.
class	DiskFileSystem A `FileSystem` implementation that manages files and directories on disk.
class	Driver Base class used to create device drivers.
struct	Edge Represents an edge.
class	Effect Amplitude effect asset.
class	EffectInstance An instance of an `Effect` asset.
class	Engine The Amplitude engine.
class	Entity An Entity represents a spatially positioned object in the game.
class	Environment An Environment is a zone where every spatialized audio playing inside him got applied a specific effect.
class	Event Amplitude event asset.
class	EventCanceler Helper class used to cancel a running `Event` .
class	EventInstance A triggered event.
class	FFT The Fast Fourier Transform ( FFT ) class.
struct	Face Represents a triangulated face.
class	Fader Base class used to create faders.
class	FaderInstance A Fader instance.
class	File Base class used to manage files in a `FileSystem` .
class	FileLogger A Logger implementation that writes log messages to a file.
class	FileSystem Base class for files and resources loaders.
class	Filter Base class used to create DSP filters.
class	FilterInstance A Filter instance.
class	HRIRSphere Represents a Head-Related Impulse Response (HRIR) sphere.
struct	HRIRSphereFileHeaderDescription Provides metadata about an HRIR sphere file.
struct	HRIRSphereVertex A vertex in a HRIR sphere.
class	InputNodeInstance Class used to mark the input of the pipeline.
class	Listener An object used to render sound sources.
class	LogcatLogger A logger that writes to Android's logcat.
class	Logger The logger class.
class	MPSCQueue <typename T, Capacity> Lock-free bounded multi-producer single-consumer queue.
class	MappedFile A File implementation that uses memory-mapped I/O for efficient read-only file access.
class	MemoryAllocator Memory Allocator Interface.
class	MemoryFile A `File` implementation that reads from and writes to a memory buffer.
class	MemoryManager Manages memory allocations inside the engine.
struct	MemoryPoolStats Collects the statistics about the memory allocations for a specific pool.
class	MixerNodeInstance Base class for Amplimix pipeline nodes that can mix audio data from multiple input buffers.
class	NSFile A `File` implementation that reads and writes files using Apple's NSFileHandle.
class	NSFileSystem An implementation of the `FileSystem` interface for iOS using NSFileManager.
class	NSLogger A logger that writes to iOS's unified logging system.
class	Node Base class for Amplimix pipeline nodes.
class	NodeInstance An instance of an Amplimix pipeline node.
class	NullLogger A Logger implementation that discards all log messages.
struct	Orientation Represents an orientation in 3D space.
class	OutputNodeInstance Class used to mark the output of the pipeline.
struct	PackageFileCompressedChunk Describes a compressed chunk in the package file.
struct	PackageFileHeaderDescription Provides metadata about the package file.
struct	PackageFileItemDescription Describes an item in the package file.
class	PackageFileSystem A `FileSystem` implementation that provides access to an Amplitude package file.
class	PackageItemFile A `File` implementation that provides access to an item in an Amplitude package file.
class	Pipeline Assembles a set of nodes to process audio data.
class	PipelineInstance Represents an instance of a pipeline for a specific layer.
class	ProcessorNodeInstance Base class for Amplimix pipeline nodes that can process audio data in-place.
class	ProviderNodeInstance Interface for Amplimix pipeline nodes that can provide audio data to an output buffer.
class	RefCounter Holds the number of references to an object.
class	Resampler Base class used to create resamplers.
class	ResamplerInstance A Resampler instance.
class	Resource An Amplitude resource in a `FileSystem` .
class	Room Represents a physical space where sound waves can propagate.
struct	RoomWallMaterial Represents the material of a `Room` wall.
class	Rtpc Amplitude Real-Time Parameter Control asset.
struct	RtpcValue A RTPC-compatible value is used as a wrapper to hold property values that can be linked to RTPCs.
class	SPSCQueue <typename T, Capacity> Lock-free single-producer single-consumer queue.
class	ScopedMemoryAllocation Allocates a block of memory with the given size in the given pool.
class	Shape A geometrical closed 3D shape.
class	Sound Amplitude sound asset.
class	SoundBank Amplitude sound bank asset.
struct	SoundFormat Describes the format of an audio sample.
class	SoundObject Base class for Amplitude sound objects.
class	SphereShape A sphere shape, defined by a radius.
class	SphereZone A `Zone` built with an inner`SphereShape` and an outer`SphereShape` .
struct	SphericalPosition Spherical coordinates representation.
class	SplitComplex Buffer for split-complex representation of FFT results.
class	Switch Amplitude switch asset.
class	SwitchContainer Amplitude switch container asset.
struct	SwitchContainerItem Describes a single item within a switch container.
struct	SwitchState A switch state.
class	Zone A tuple of shapes that represents a zone in the world.
struct	am_delete <class T, Pool> Deleter for unique/shared pointers.

Public Types¶

Type	Name
typedef AmObjectID	AmAttenuationID
typedef AmReal32	AmAudioSample
typedef AmReal32 *	AmAudioSampleBuffer
typedef AmObjectID	AmBankID
typedef AmObjectID	AmBusID
typedef AmObjectID	AmChannelID
typedef AmObjectID	AmChannelInstanceID
typedef AmObjectID	AmCollectionID
typedef const AmReal32 *	AmConstAudioSampleBuffer
typedef const int16_t *	AmConstInt16Buffer
typedef const int32_t *	AmConstInt32Buffer
typedef const int64_t *	AmConstInt64Buffer
typedef const int8_t *	AmConstInt8Buffer
typedef const float *	AmConstReal32Buffer
typedef const double *	AmConstReal64Buffer
typedef const uint16_t *	AmConstUInt16Buffer
typedef const uint32_t *	AmConstUInt32Buffer
typedef const uint64_t *	AmConstUInt64Buffer
typedef const uint8_t *	AmConstUInt8Buffer
typedef const void *	AmConstVoidPtr
typedef AmObjectID	AmEffectID
typedef AmObjectID	AmEntityID
typedef AmObjectID	AmEnvironmentID
typedef AmObjectID	AmEventID
typedef FILE *	AmFileHandle
typedef AmUInt64	AmHandle
typedef int16_t	AmInt16
typedef int16_t *	AmInt16Buffer
typedef int32_t	AmInt32
typedef int32_t *	AmInt32Buffer
typedef int64_t	AmInt64
typedef int64_t *	AmInt64Buffer
typedef int8_t	AmInt8
typedef int8_t *	AmInt8Buffer
typedef intptr_t	AmIntPtr
typedef AmObjectID	AmListenerID
typedef union SparkyStudios::Audio::Amplitude::AmMatrix3	AmMatrix3 A 3x3 matrix represented as an array of 9 float values in column-major order.
typedef union SparkyStudios::Audio::Amplitude::AmMatrix4	AmMatrix4 A 4x4 matrix represented as an array of 16 float values in column-major order.
typedef AmUInt64	AmObjectID
typedef char	AmOsChar
typedef std::string	AmOsString
typedef AmObjectID	AmPipelineID
typedef union SparkyStudios::Audio::Amplitude::AmQuaternion	AmQuaternion A quaternion rotation.
typedef float	AmReal32
typedef float *	AmReal32Buffer
typedef double	AmReal64
typedef double *	AmReal64Buffer
typedef AmUInt8	AmResult
typedef AmObjectID	AmRoomID
typedef AmObjectID	AmRtpcID
typedef size_t	AmSize
typedef AmObjectID	AmSoundID
typedef std::string	AmString
typedef AmObjectID	AmSwitchContainerID
typedef AmObjectID	AmSwitchID
typedef AmVoidPtr	AmThreadHandle
typedef AmUInt64	AmThreadID
typedef AmReal64	AmTime
typedef uint16_t	AmUInt16
typedef uint16_t *	AmUInt16Buffer
typedef uint32_t	AmUInt32
typedef uint32_t *	AmUInt32Buffer
typedef uint64_t	AmUInt64
typedef uint64_t *	AmUInt64Buffer
typedef uint8_t	AmUInt8
typedef uint8_t *	AmUInt8Buffer
typedef uintptr_t	AmUIntPtr
typedef union SparkyStudios::Audio::Amplitude::AmVector2	AmVector2 A column-vector of two float values.
typedef union SparkyStudios::Audio::Amplitude::AmVector3	AmVector3 A column-vector of three float values.
typedef union SparkyStudios::Audio::Amplitude::AmVector4	AmVector4 A column-vector of four float values.
typedef void *	AmVoidPtr
typedef Attenuation *	AttenuationHandle
typedef Collection *	CollectionHandle
typedef Effect *	EffectHandle
typedef Event *	EventHandle
typedef Pipeline *	PipelineHandle
typedef Rtpc *	RtpcHandle
typedef Sound *	SoundHandle
typedef SoundObject *	SoundObjectHandle
union	AmMatrix3 A 3x3 matrix represented as an array of 9 float values in column-major order.
union	AmMatrix4 A 4x4 matrix represented as an array of 16 float values in column-major order.
union	AmQuaternion A quaternion rotation.
union	AmVector2 A column-vector of two float values.
union	AmVector3 A column-vector of three float values.
union	AmVector4 A column-vector of four float values.
union	Triangle Represent a triangle geometry.
typedef SwitchContainer *	SwitchContainerHandle
typedef Switch *	SwitchHandle
enum	eParameterType Lists the available parameter types for a filter.

Public Attributes¶

Type	Name
const AudioBuffer *	buffer
const DeviceDescription &	device
const DeviceDescription Driver *	driver
const AudioBuffer AmUInt32	frames
struct SparkyStudios::Audio::Amplitude::@303226263004265114154117100331001171351017233331	gLCG = `{ 4321 }`
AmInt32	state

Public Types Documentation¶

AmAttenuationID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmAttenuationID;

AmAudioSample

typedef AmReal32 SparkyStudios::Audio::Amplitude::AmAudioSample;

AmAudioSampleBuffer

typedef AmReal32* SparkyStudios::Audio::Amplitude::AmAudioSampleBuffer;

AmBankID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmBankID;

AmBusID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmBusID;

AmChannelID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmChannelID;

AmChannelInstanceID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmChannelInstanceID;

AmCollectionID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmCollectionID;

AmConstAudioSampleBuffer

typedef const AmReal32* SparkyStudios::Audio::Amplitude::AmConstAudioSampleBuffer;

AmConstInt16Buffer

typedef const int16_t * SparkyStudios::Audio::Amplitude::AmConstInt16Buffer;

AmConstInt32Buffer

typedef const int32_t * SparkyStudios::Audio::Amplitude::AmConstInt32Buffer;

AmConstInt64Buffer

typedef const int64_t * SparkyStudios::Audio::Amplitude::AmConstInt64Buffer;

AmConstInt8Buffer

typedef const int8_t * SparkyStudios::Audio::Amplitude::AmConstInt8Buffer;

AmConstReal32Buffer

typedef const float * SparkyStudios::Audio::Amplitude::AmConstReal32Buffer;

AmConstReal64Buffer

typedef const double * SparkyStudios::Audio::Amplitude::AmConstReal64Buffer;

AmConstUInt16Buffer

typedef const uint16_t * SparkyStudios::Audio::Amplitude::AmConstUInt16Buffer;

AmConstUInt32Buffer

typedef const uint32_t * SparkyStudios::Audio::Amplitude::AmConstUInt32Buffer;

AmConstUInt64Buffer

typedef const uint64_t * SparkyStudios::Audio::Amplitude::AmConstUInt64Buffer;

AmConstUInt8Buffer

typedef const uint8_t * SparkyStudios::Audio::Amplitude::AmConstUInt8Buffer;

AmConstVoidPtr

typedef const void * SparkyStudios::Audio::Amplitude::AmConstVoidPtr;

AmEffectID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmEffectID;

AmEntityID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmEntityID;

AmEnvironmentID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmEnvironmentID;

AmEventID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmEventID;

AmFileHandle

typedef FILE * SparkyStudios::Audio::Amplitude::AmFileHandle;

AmHandle

typedef AmUInt64 SparkyStudios::Audio::Amplitude::AmHandle;

AmInt16

typedef int16_t SparkyStudios::Audio::Amplitude::AmInt16;

AmInt16Buffer

typedef int16_t * SparkyStudios::Audio::Amplitude::AmInt16Buffer;

AmInt32

typedef int32_t SparkyStudios::Audio::Amplitude::AmInt32;

AmInt32Buffer

typedef int32_t * SparkyStudios::Audio::Amplitude::AmInt32Buffer;

AmInt64

typedef int64_t SparkyStudios::Audio::Amplitude::AmInt64;

AmInt64Buffer

typedef int64_t * SparkyStudios::Audio::Amplitude::AmInt64Buffer;

AmInt8

typedef int8_t SparkyStudios::Audio::Amplitude::AmInt8;

AmInt8Buffer

typedef int8_t * SparkyStudios::Audio::Amplitude::AmInt8Buffer;

AmIntPtr

typedef intptr_t SparkyStudios::Audio::Amplitude::AmIntPtr;

AmListenerID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmListenerID;

AmMatrix3

A 3x3 matrix represented as an array of 9 float values in column-major order.

typedef union SparkyStudios::Audio::Amplitude::AmMatrix3 SparkyStudios::Audio::Amplitude::AmMatrix3;

The matrix layout in memory is: [m00 m01 m02] [m10 m11 m12] [m20 m21 m22]

AmMatrix4

A 4x4 matrix represented as an array of 16 float values in column-major order.

typedef union SparkyStudios::Audio::Amplitude::AmMatrix4 SparkyStudios::Audio::Amplitude::AmMatrix4;

The matrix layout in memory is: [m00 m01 m02 m03] [m10 m11 m12 m13] [m20 m21 m22 m23] [m30 m31 m32 m33]

AmObjectID

typedef AmUInt64 SparkyStudios::Audio::Amplitude::AmObjectID;

AmOsChar

typedef wchar_t SparkyStudios::Audio::Amplitude::AmOsChar;

AmOsString

typedef std::wstring SparkyStudios::Audio::Amplitude::AmOsString;

AmPipelineID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmPipelineID;

AmQuaternion

A quaternion rotation.

typedef union SparkyStudios::Audio::Amplitude::AmQuaternion SparkyStudios::Audio::Amplitude::AmQuaternion;

Index 0 is the value of the W component.
Index 1 is the value of the X component.
Index 2 is the value of the Y component.
Index 3 is the value of the Z component.

AmReal32

typedef float SparkyStudios::Audio::Amplitude::AmReal32;

AmReal32Buffer

typedef float * SparkyStudios::Audio::Amplitude::AmReal32Buffer;

AmReal64

typedef double SparkyStudios::Audio::Amplitude::AmReal64;

AmReal64Buffer

typedef double * SparkyStudios::Audio::Amplitude::AmReal64Buffer;

AmResult

typedef AmUInt8 SparkyStudios::Audio::Amplitude::AmResult;

AmRoomID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmRoomID;

AmRtpcID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmRtpcID;

AmSize

typedef size_t SparkyStudios::Audio::Amplitude::AmSize;

AmSoundID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmSoundID;

AmString

typedef std::string SparkyStudios::Audio::Amplitude::AmString;

AmSwitchContainerID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmSwitchContainerID;

AmSwitchID

typedef AmObjectID SparkyStudios::Audio::Amplitude::AmSwitchID;

AmThreadHandle

typedef AmVoidPtr SparkyStudios::Audio::Amplitude::AmThreadHandle;

AmThreadID

typedef AmUInt64 SparkyStudios::Audio::Amplitude::AmThreadID;

AmTime

typedef AmReal64 SparkyStudios::Audio::Amplitude::AmTime;

AmUInt16

typedef uint16_t SparkyStudios::Audio::Amplitude::AmUInt16;

AmUInt16Buffer

typedef uint16_t * SparkyStudios::Audio::Amplitude::AmUInt16Buffer;

AmUInt32

typedef uint32_t SparkyStudios::Audio::Amplitude::AmUInt32;

AmUInt32Buffer

typedef uint32_t * SparkyStudios::Audio::Amplitude::AmUInt32Buffer;

AmUInt64

typedef uint64_t SparkyStudios::Audio::Amplitude::AmUInt64;

AmUInt64Buffer

typedef uint64_t * SparkyStudios::Audio::Amplitude::AmUInt64Buffer;

AmUInt8

typedef uint8_t SparkyStudios::Audio::Amplitude::AmUInt8;

AmUInt8Buffer

typedef uint8_t * SparkyStudios::Audio::Amplitude::AmUInt8Buffer;

AmUIntPtr

typedef uintptr_t SparkyStudios::Audio::Amplitude::AmUIntPtr;

AmVector2

A column-vector of two float values.

typedef union SparkyStudios::Audio::Amplitude::AmVector2 SparkyStudios::Audio::Amplitude::AmVector2;

Index 0 is the value of the X component.
Index 1 is the value of the Y component.

AmVector3

A column-vector of three float values.

typedef union SparkyStudios::Audio::Amplitude::AmVector3 SparkyStudios::Audio::Amplitude::AmVector3;

Index 0 is the value of the X component.
Index 1 is the value of the Y component.
Index 2 is the value of the Z component.

AmVector4

A column-vector of four float values.

typedef union SparkyStudios::Audio::Amplitude::AmVector4 SparkyStudios::Audio::Amplitude::AmVector4;

Index 0 is the value of the X component.
Index 1 is the value of the Y component.
Index 2 is the value of the Z component.
Index 3 is the value of the W component.

AmVoidPtr

typedef void * SparkyStudios::Audio::Amplitude::AmVoidPtr;

AttenuationHandle

typedef Attenuation* SparkyStudios::Audio::Amplitude::AttenuationHandle;

CollectionHandle

typedef Collection* SparkyStudios::Audio::Amplitude::CollectionHandle;

EffectHandle

typedef Effect* SparkyStudios::Audio::Amplitude::EffectHandle;

EventHandle

typedef Event* SparkyStudios::Audio::Amplitude::EventHandle;

PipelineHandle

typedef Pipeline* SparkyStudios::Audio::Amplitude::PipelineHandle;

RtpcHandle

typedef Rtpc* SparkyStudios::Audio::Amplitude::RtpcHandle;

SoundHandle

typedef Sound* SparkyStudios::Audio::Amplitude::SoundHandle;

SoundObjectHandle

typedef SoundObject* SparkyStudios::Audio::Amplitude::SoundObjectHandle;

AmMatrix3

A 3x3 matrix represented as an array of 9 float values in column-major order.

The matrix layout in memory is: [m00 m01 m02] [m10 m11 m12] [m20 m21 m22]

AmMatrix4

A 4x4 matrix represented as an array of 16 float values in column-major order.

The matrix layout in memory is: [m00 m01 m02 m03] [m10 m11 m12 m13] [m20 m21 m22 m23] [m30 m31 m32 m33]

AmQuaternion

A quaternion rotation.

Index 0 is the value of the W component.
Index 1 is the value of the X component.
Index 2 is the value of the Y component.
Index 3 is the value of the Z component.

AmVector2

A column-vector of two float values.

Index 0 is the value of the X component.
Index 1 is the value of the Y component.

AmVector3

A column-vector of three float values.

Index 0 is the value of the X component.
Index 1 is the value of the Y component.
Index 2 is the value of the Z component.

AmVector4

A column-vector of four float values.

Index 0 is the value of the X component.
Index 1 is the value of the Y component.
Index 2 is the value of the Z component.
Index 3 is the value of the W component.

Triangle

Represent a triangle geometry.

A triangle is a collection of three vertices oriented in a Clock-Wise (CW) manner.

SwitchContainerHandle

typedef SwitchContainer* SparkyStudios::Audio::Amplitude::SwitchContainerHandle;

SwitchHandle

typedef Switch* SparkyStudios::Audio::Amplitude::SwitchHandle;

eParameterType

Lists the available parameter types for a filter.

enum SparkyStudios::Audio::Amplitude::eParameterType {
    eParameterType_Float = 0,
    eParameterType_Int,
    eParameterType_Bool
};

Public Attributes Documentation¶

buffer

const AudioBuffer* SparkyStudios::Audio::Amplitude::buffer;

device

const DeviceDescription& SparkyStudios::Audio::Amplitude::device;

driver

const DeviceDescription Driver* SparkyStudios::Audio::Amplitude::driver;

frames

const AudioBuffer AmUInt32 SparkyStudios::Audio::Amplitude::frames;

gLCG

struct SparkyStudios::Audio::Amplitude::@303226263004265114154117100331001171351017233331 SparkyStudios::Audio::Amplitude::gLCG;

state

AmInt32 SparkyStudios::Audio::Amplitude::state;

The documentation for this namespace was generated from the following file: include/SparkyStudios/Audio/Amplitude/Core/Asset.h