Editor Renderer Interface (Added In ARA 2.0)

Detailed Description

See kARAEditorRendererRole.
Plug-in developers using C++ ARA Library can implement the ARA::PlugIn::EditorRendererInterface, or extend the already implemented ARA::PlugIn::EditorRenderer class as needed. For host developers this interface is wrapped by the ARA::Host::EditorRenderer.

Classes

struct  ARAEditorRendererInterface
 Plug-in interface: editor 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 ARAEditorRendererRefMarkupType * ARAEditorRendererRef
 Reference to the plug-in side representation of a editor renderer (opaque to the host).
 

Class Documentation

◆ ARAEditorRendererInterface

struct ARAEditorRendererInterface

Plug-in interface: editor 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 preview while editing

Specify the set of playback region(s) for which the this plug-in instance provides previewing. Hosts can choose to either maintain individual regions, or conveniently maintain regions by specifying region sequences as a shortcut for all regions on those sequences. Behavior is identical in both cases, but hosts should not mix both types of call on a single plug-in instance. Preview should be unambiguous, i.e. there should be only one editor renderer plug-in instance associated with each playback region. During transitions however (such as moving a region from one track to another), this rule may be disregarded temporarily. The host can make these calls while the plug-in is in render-state ("active" in VST3 speak, "initialized" in Audio Unit speak). Plug-ins must implement a proper bridging to the concurrent render threads. Further, 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() ARADocumentControllerInterface::endEditing() when feasible may yield better performance since all updates can be calculated together. The calls shall be made on the same thread that also hosts the document controller. The host is not required to remove any or all playback regions or region sequences before destroying the plug-in. If a plug-in does not implement any audio preview features, it can safely ignore these calls and provide empty implementations.

void(* addPlaybackRegion )(ARAEditorRendererRef editorRendererRef, ARAPlaybackRegionRef playbackRegionRef)
 
void(* removePlaybackRegion )(ARAEditorRendererRef editorRendererRef, ARAPlaybackRegionRef playbackRegionRef)
 
void(* addRegionSequence )(ARAEditorRendererRef editorRendererRef, ARARegionSequenceRef regionSequenceRef)
 
void(* removeRegionSequence )(ARAEditorRendererRef editorRendererRef, ARARegionSequenceRef regionSequenceRef)