Object References

Detailed Description

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.

Persistent IDs

typedef const char * ARAPersistentID
 Persistent object reference representation. Persistent IDs are used to encode object references between plug-in and host when dealing with persistency. Contrary to the user-readable ARAUtf8String, ARAPersistentIDs are seven-bit US-ASCII-encoded strings, such as "com.manufacturerDomain.someIdentifier", and can thus be directly compared using strcmp() and its siblings. They can be copied using strcpy() and must always be compared by value, not by address.
 

Markup Types

Type-safe representations of the opaque refs/host refs. The markup types allow for overloaded custom conversion functions if using C++, or for re-defining the markup types to actual implementations in C like this:

#define ARAAudioSourceRefMarkupType MyAudioFileClass
#define ARAMusicalContextRefMarkupType MyGlobalTracksClass

... etc ...

#define ARA_REF(RefType)   struct RefType##MarkupType * RefType
 Plug-in reference markup type identifier.

Examples:
ARAMusicalContextRef
ARARegionSequenceRef
ARAAudioSourceRef
ARAAudioModificationRef
ARAPlaybackRegionRef
ARAContentReaderRef
ARADocumentControllerRef
ARAPlaybackRendererRef
ARAEditorRendererRef
ARAEditorViewRef
.
 
#define ARA_HOST_REF(HostRefType)   struct HostRefType##MarkupType * HostRefType
 Host reference markup type identifier.

Examples:
ARAMusicalContextHostRef
ARARegionSequenceHostRef
ARAAudioSourceHostRef
ARAAudioModificationHostRef
ARAPlaybackRegionHostRef
ARAContentReaderHostRef
ARAAudioAccessControllerHostRef
ARAAudioReaderHostRef
ARAArchivingControllerHostRef
ARAArchiveReaderHostRef
ARAArchiveWriterHostRef
ARAContentAccessControllerHostRef
ARAModelUpdateControllerHostRef
ARAPlaybackControllerHostRef
.