Skip to content

Engine

Engine-specific functionalities

Types

Name Description
AttenuationZone The propagation shape for positional sounds.
Bus An object representing one node in the tree of buses. Buses are used to adjust a set of channel gains in tandem.
Channel An object that represents a single channel of audio.
ChannelEvent Enumerates the events triggered by a Channel during playback.
ChannelEventCallback A callback function for handling channel events.
ChannelEventInfo The event info passed to the channel event listener.
ChannelEventListener Channel Event listener.
Codec Audio file reader and writer.
DeviceDescription The device description.
DeviceNotification The possible device notification types.
DeviceState The device state.
Driver Base class for audio device driver implementations.
EffectInstance An instance of an Effect asset.
Engine The Amplitude Engine.
Entity An Entity represents a spatially positioned object in the game.
Environment An Environment is a zone where every spatialized audio playing inside him got * applied a specific effect.
EventCanceler An helper class used to cancel a running Event.
EventInstance A triggered event.
Fader Helper class to process faders.
FaderInstance A Fader instance. An object of this class will be created each time a Fader is requested.
Listener A object which can render sound sources.
PlaybackOutputChannels The playback output channel layout of the device.
PlaybackOutputFormat The playback output format of the device.
Room Represents a physical space where sound waves can propagate.
RoomMaterial Represents the material of a Room wall.
RoomMaterialType Defines the material type of a Room wall.
RoomWall Enumerates the walls of a Room.
RtpcValue A RTPC compatible value is used as a wrapper to hold property values * that can be linked to RTPCs.
SoundObject Base class for Amplitude sound objects.
SwitchContainerItem Describes a single item within a SwitchContainer.
SwitchState A switch state.
eChannelPlaybackState Enumerates the playback states for a Channel.
eFaderState Enumerates the list of states in a fader.

Macros

Name Description
AM_AUDIO_SAMPLE_MAX The maximum value for an audio sample.
AM_AUDIO_SAMPLE_MIN The minimum value for an audio sample.
AM_INVALID_HANDLE Define an invalid object handle.
AM_IS_VALID_HANDLE Checks if a handle is valid
amEngine Macro to get the current Amplitude engine instance.

Functions

Name Description
AM_CALLBACK The device notification callback.
CallDeviceNotificationCallback Calls the registered device notification callback.
RegisterDeviceNotificationCallback Registers a callback to listen to device state changes.
UnregisterDeviceNotificationCallback Unregisters the registered device notification callback.

Macro Details

AM_AUDIO_SAMPLE_MAX

#define AM_AUDIO_SAMPLE_MAX

The maximum value for an audio sample.

AM_AUDIO_SAMPLE_MIN

#define AM_AUDIO_SAMPLE_MIN

The minimum value for an audio sample.

AM_INVALID_HANDLE

#define AM_INVALID_HANDLE

Define an invalid object handle.

AM_IS_VALID_HANDLE

#define AM_IS_VALID_HANDLE(handle)

Checks if a handle is valid

Parameter handle
The handle to check
Return
true if the handle is valid, false otherwise.

amEngine

#define amEngine

Macro to get the current Amplitude engine instance.

Function Details

AM_CALLBACK

AM_CALLBACK(void, DeviceNotificationCallback)(DeviceNotification notification, const DeviceDescription& device, Driver* driver)

The device notification callback.

Parameter notification
The notification type.
Parameter device
The device description.
Parameter driver
The driver which triggered the device notification.

CallDeviceNotificationCallback

void CallDeviceNotificationCallback(DeviceNotification notification, const DeviceDescription& device, Driver* driver)

Calls the registered device notification callback.

Parameter notification
The notification type.
Parameter device
The device description.
Parameter driver
The driver which triggered the device notification.

RegisterDeviceNotificationCallback

void RegisterDeviceNotificationCallback(DeviceNotificationCallback callback)

Registers a callback to listen to device state changes.

Parameter callback
The callback to register.

UnregisterDeviceNotificationCallback

void UnregisterDeviceNotificationCallback()

Unregisters the registered device notification callback.