Musical context properties. Note that like all properties, a pointer to this struct is only valid for the duration of the call receiving the pointer - the data must be evaluated/copied inside the call, and the pointer must not be stored anywhere.
Public Attributes |
|
ARASize | structSize |
| | Size-based struct versioning - see Versioned structs.
|
| |
|
ARAUtf8String | name |
| | User-readable name of the musical context as displayed in the host. The plug-in must copy the name, the pointer may be only valid for the duration of the call. It may be NULL if the host cannot provide a name for the musical context (which is typically true for all hosts that only use a single context per document.) In that case, the host should not make up some dummy name just to satisfy the API, but rather let the plug-in do this if desired - this way it can distinguish between a proper name visible somewhere in the host and a dummy name implicitly derived from other state.
|
| |
|
ARAInt32 | orderIndex |
| | Sort order of the musical context in the host. The index must allow for the plug-in to order the musical contexts as shown in the host, but the actual index values are not shown to the user. They can be arbitrary, but must increase strictly monotonically.
|
| |
|
const ARAColor * | color |
| | Color associated with the musical context in the host. The plug-in must copy the color, the pointer may be only valid for the duration of the call. It may be NULL if the host cannot provide a color for the musical context.
|
| |