See kARAPlaybackRendererRole.
Plug-in developers using C++ ARA Library can implement the ARA::PlugIn::PlaybackRendererInterface, or extend the already implemented ARA::PlugIn::PlaybackRenderer class as needed. For host developers this interface is wrapped by the ARA::Host::PlaybackRenderer.
Classes | |
| struct | ARAPlaybackRendererInterface |
| Plug-in interface: playback renderer. The function pointers in this struct must remain valid until the companion API plug-in instance (and accordingly its plug-in extension) is destroyed by the host. More... | |
Typedefs | |
| typedef struct ARAPlaybackRendererRefMarkupType * | ARAPlaybackRendererRef |
| Reference to the plug-in side representation of a playback renderer (opaque to the host). | |
| struct ARAPlaybackRendererInterface |
Plug-in interface: playback renderer. The function pointers in this struct must remain valid until the companion API plug-in instance (and accordingly its plug-in extension) is destroyed by the host.
Size-based struct versioning | |
See Versioned structs. | |
| ARASize | structSize |
Assigning the playback region(s) for playback rendering | |
Specify the playback region(s) for which the this plug-in instance provides playback rendering. (and, if using ARA1 which does not distinguish roles: also editor rendering and view). These calls can only be made when the plug-in is not in render-state ("not active" in VST3 speak, "not initialized" in AU-speak), however the host may display the UI for the plug-in while making these calls. They can be made both inside or outside any editing or restoration cycles of the associated ARA document controller, but doing them between ARADocumentControllerInterface::beginEditing() and ARADocumentControllerInterface::endEditing() when feasible may yield better performance since all updates can be calculated together. When called outside beginEditing() and endEditing(), the changes may not be audible until the next render call that starts after the plug-in has returned from the respective call. The calls shall be made on the same thread that also hosts the document controller. The host is not required to remove the playback regions before destroying the plug-in. If multiple regions are set, they will all be sounding concurrently in case they overlap. | |
| void(* | addPlaybackRegion )(ARAPlaybackRendererRef playbackRendererRef, ARAPlaybackRegionRef playbackRegionRef) |
| void(* | removePlaybackRegion )(ARAPlaybackRendererRef playbackRendererRef, ARAPlaybackRegionRef playbackRegionRef) |