Sampled Audio Data

Detailed Description

The audio samples are encoded using these format descriptions. The data alignment and byte order always matches the machine's native layout.

Typedefs

typedef double ARASampleRate
 Specified in Hz.
 
typedef ARAInt32 ARAChannelCount
 Count of discrete channels of an audio signal. The spacial positioning of the channels may be provided via ARAChannelArrangementDataType.
 

Enumeration Type Documentation

◆ ARAChannelArrangementDataType

To avoid defining yet another abstraction of spacial layout information for the individual channels of an audio signal, ARA directly uses the respective Companion API's model of spacial arrangement. Since different Companion APIs are available, this enum specifies which abstraction is used.

Enumerator
kARAChannelArrangementUndefined 

Used to indicate the feature is not supported/used (e.g. mono or stereo).

kARAChannelArrangementVST3SpeakerArrangement 

For VST3, the channel arrangement is specified as Steinberg::Vst::SpeakerArrangement.

kARAChannelArrangementCoreAudioChannelLayout 

For Audio Units, the channel arrangement is specified as the CoreAudio struct AudioChannelLayout. Note that according to Apple's documentation, "the kAudioChannelLayoutTag_UseChannelBitmap field is NOT used within the context of the AudioUnit." If possible, kAudioChannelLayoutTag_UseChannelDescriptions should also be avoided to ease parsing the struct.

kARAChannelArrangementAAXStemFormat 

For AAX, the channel arrangement is specified as AAX_EStemFormat.