Pre-defined types to ensure binary compatibility between plug-in and host. These types must be used when crossing the API boundary, but intermediate types can be used internally. For example, you can use your own struct representing color, but when defining color for ARA operations your internal color struct must be converted to ARAColor.
Subpages | |
| Fixed-size Integers | |
| ARA defines platform-independent signed integers with fixed size of 32 or 64 bits and for a pointer-sized signed integer. | |
| Boolean Values | |
| Since Microsoft still doesn't fully support C99 and fails to provide <stdbool.h>, we need to roll our own. On the other hand this ensures a fixed size of 32 bits, too. 32 bits were chosen so that ARABool is consistent with the other enum-like data types such as ARAContentType. Since ARABool is only used in temporary structs that are valid only for the duration of a call and likely passed in a register in most cases, there's no point in trying to optimize for size by using 8 bit boolean types. Note that in order to avoid conversion warnings in Visual Studio, you should not directly cast bool to ARABool or vice versa, but instead use a ternary operator or a comparison like this: | |
| Enums | |
| ARA enums can either be used to represent distinct enumerations, or to declare C-compatible constant integer flags that can be or'd together as bit masks. To ensure binary compatibility between plug-in and host, the underlying type of ARA enums is always ARAInt32. | |
| Strings | |
| User-readable texts are stored as UTF-8 encoded unicode strings. It's not defined if and how the string is normalized - if either side has requirements regarding normalization, it needs to apply these after reading the string from the other side. Unicode rules apply regarding normalization, comparison etc. Both hosts and plug-ins are required to support at least all ISO/IEC 8859-1 based characters (from U+0020 up to U+007E and from U+00A0 up to U+00FF) in their text display rendering. | |
| Common Time-Related Data Types | |
| Some basic data types used in several contexts. | |
| Sampled Audio Data | |
| The audio samples are encoded using these format descriptions. The data alignment and byte order always matches the machine's native layout. | |
| Color | |
| ARA color representation. | |
| Object References | |
| ARA uses pointer-sized unique identifiers to reference objects at runtime - typical C++-based implementations will use the this-pointer as ID. C-style code could do the same, or instead choose to use array indices as ID. Those objects that are archived by the host can be persistently identified by an ARAPersistentID that the host assigns as a property of the object. | |