Document Controller Instance

Detailed Description

The callbacks into the host are published by the host when creating a document controller on the plug-in side to maintain an ARA model graph. The instance struct and all interfaces and host refs therein must remain valid until the document controller is destroyed. The host can choose to create its controller objects per document controller instance, or it can share a single instance between all document controllers, whatever fits its needs. It may even mix-and-match both approaches per individual interface.

Classes

struct  ARADocumentControllerHostInstance
 The document controller host instance struct and all interfaces and refs therein must remain valid until all plug-in document controllers created with this struct have been destroyed by the host. More...
 

Class Documentation

◆ ARADocumentControllerHostInstance

struct ARADocumentControllerHostInstance

The document controller host instance struct and all interfaces and refs therein must remain valid until all plug-in document controllers created with this struct have been destroyed by the host.

Size-based struct versioning

See Versioned structs.

ARASize structSize
 

AudioAccessControllerInterface

Must always be supported.

ARAAudioAccessControllerHostRef audioAccessControllerHostRef
 
const ARAAudioAccessControllerInterface * audioAccessControllerInterface
 

ArchiveControllerInterface

Must always be supported.

ARAArchivingControllerHostRef archivingControllerHostRef
 
const ARAArchivingControllerInterface * archivingControllerInterface
 

ContentAccessControllerInterface

OPTIONAL INTERFACE: plug-in must check contentAccessControllerInterface is not NULL before calling!

ARAContentAccessControllerHostRef contentAccessControllerHostRef
 
const ARAContentAccessControllerInterface * contentAccessControllerInterface
 

ModelUpdateControllerInterface

OPTIONAL INTERFACE: plug-in must check modelUpdateControllerInterface is not NULL before calling!

ARAModelUpdateControllerHostRef modelUpdateControllerHostRef
 
const ARAModelUpdateControllerInterface * modelUpdateControllerInterface
 

PlaybackControllerInterface

OPTIONAL INTERFACE: plug-in must check playbackControllerInterface is not NULL before calling!

ARAPlaybackControllerHostRef playbackControllerHostRef
 
const ARAPlaybackControllerInterface * playbackControllerInterface