Model Content Access Controller

Detailed Description

This optional interface provides access to host model data such as the musical context. Its functions may only be called from ARADocumentControllerInterface.create...() or update...() for the object currently created/updated, or from ARADocumentControllerInterface::endEditing() for any object.
Host developer using C++ ARA Library can implement the ARA::Host::ContentAccessControllerInterface. For plug-in developers this interface is wrapped by the ARA::PlugIn::HostContentAccessController.

Classes

struct  ARAContentAccessControllerInterface
 Host interface: content access controller. As with all host interfaces, the function pointers in this struct must remain valid until all document controllers on the plug-in side that use it have been destroyed. More...
 

Typedefs

typedef struct ARAContentAccessControllerHostRefMarkupType * ARAContentAccessControllerHostRef
 Reference to the host side representation of a content access controller (opaque to the plug-in).
 

Class Documentation

◆ ARAContentAccessControllerInterface

struct ARAContentAccessControllerInterface

Host interface: content access controller. As with all host interfaces, the function pointers in this struct must remain valid until all document controllers on the plug-in side that use it have been destroyed.

Size-based struct versioning

See Versioned structs.

ARASize structSize
 

Content Reader Management

These functions mirror the content reader section in ARADocumentControllerInterface.

ARABool(* isMusicalContextContentAvailable )(ARAContentAccessControllerHostRef controllerHostRef, ARAMusicalContextHostRef musicalContextHostRef, ARAContentType contentType)
 Query whether the given content type is currently available for the given musical context.
 
ARAContentGrade(* getMusicalContextContentGrade )(ARAContentAccessControllerHostRef controllerHostRef, ARAMusicalContextHostRef musicalContextHostRef, ARAContentType contentType)
 Query the current quality of the information provided for the given musical context and content type.
 
ARAContentReaderHostRef(* createMusicalContextContentReader )(ARAContentAccessControllerHostRef controllerHostRef, ARAMusicalContextHostRef musicalContextHostRef, ARAContentType contentType, const ARAContentTimeRange *range)
 Create a content reader for the given musical context and content type. This should only be called after availability has been confirmed using isMusicalContextContentAvailable(), and is mainly used to communicate the song timeline to the plug-in. The time range may be NULL, which means that the entire musical context shall be read. If a time range is specified, all events that at least partially intersect with the range will be read.
 
ARABool(* isAudioSourceContentAvailable )(ARAContentAccessControllerHostRef controllerHostRef, ARAAudioSourceHostRef audioSourceHostRef, ARAContentType contentType)
 Query whether the given content type is currently available for the given audio source.
 
ARAContentGrade(* getAudioSourceContentGrade )(ARAContentAccessControllerHostRef controllerHostRef, ARAAudioSourceHostRef audioSourceHostRef, ARAContentType contentType)
 Query the current quality of the information provided for the given audio source and content type.
 
ARAContentReaderHostRef(* createAudioSourceContentReader )(ARAContentAccessControllerHostRef controllerHostRef, ARAAudioSourceHostRef audioSourceHostRef, ARAContentType contentType, const ARAContentTimeRange *range)
 Create a content reader for the given audio source and content type. This should only be called after availability has been confirmed using isAudioSourceContentAvailable(). The host may be able to provide meta-information such as a known tempo or a known set of notes used in the material, which may enable the plug-in to speed up or even skip completely certain analysis passes (often depending on the content grade of the information). The time range may be NULL, which means that the entire audio source shall be read. If a time range is specified, all events that at least partially intersect with the range will be read.
 
ARAInt32(* getContentReaderEventCount )(ARAContentAccessControllerHostRef controllerHostRef, ARAContentReaderHostRef contentReaderHostRef)
 Query how many events the given reader exposes.
 
const void *(* getContentReaderDataForEvent )(ARAContentAccessControllerHostRef controllerHostRef, ARAContentReaderHostRef contentReaderHostRef, ARAInt32 eventIndex)
 Query data of the given event of the given reader. The returned pointer is owned by the host and must remain valid until either getContentReaderDataForEvent() is called again or the content reader is destroyed.
 
void(* destroyContentReader )(ARAContentAccessControllerHostRef controllerHostRef, ARAContentReaderHostRef contentReaderHostRef)
 Destroy the given content reader.