Region sequences allow hosts to group playback regions, typically by "tracks" or "lanes" in their arrangement. Each sequence is associated with a musical context, and all regions in a sequence will be adapted to that same context. Further, all regions within a sequence are expected to play back through the same routing (incl. same latency), typically the same "mixer track" or "audio channel". Regions in a sequence can overlap, and such overlapping regions will sound concurrently. A region sequence is always owned by one document, and refers to a musical context. Region sequences are not persistent when storing documents, instead the host re-creates them as needed.
Plug-in developers using the C++ ARA Library can use the ARA::PlugIn::RegionSequence class.
|
| struct | ARARegionSequenceProperties |
| | Region sequence 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. More...
|
| |
|
|
typedef struct ARARegionSequenceRefMarkupType * | ARARegionSequenceRef |
| | Reference to the plug-in side representation of a region sequence (opaque to the host).
|
| |
|
typedef struct ARARegionSequenceHostRefMarkupType * | ARARegionSequenceHostRef |
| | Reference to the host side representation of a region sequence (opaque to the plug-in).
|
| |
◆ ARARegionSequenceProperties
| struct ARARegionSequenceProperties |
Region sequence 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 region sequence 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 region sequence. 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 region sequence in the host. The index must allow for the plug-in to order the region sequences 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.
|
| |
|
ARAMusicalContextRef | musicalContextRef |
| | Musical context in which the playback regions of the sequence will be edited and rendered. Note that when rendering the playback regions via any plug-in instance, the time information provided for this plug-in through the companion API must match this musical context.
|
| |
|
const ARAColor * | color |
| | Color associated with the region sequence 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 region sequence.
|
| |