Audio Modification

Detailed Description

An audio modification contains a set of musical edits that the user has made to transform the content of an audio source when rendered by the ARA plug-in. An audio modification is always owned by one audio source, and in turn owns any amount of associated playback regions. Audio modifications are persistent when storing documents.
Plug-in developers using the C++ ARA Library can use the ARA::PlugIn::AudioModification class.

Classes

struct  ARAAudioModificationProperties
 Audio modification 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...
 

Typedefs

typedef struct ARAAudioModificationRefMarkupType * ARAAudioModificationRef
 Reference to the plug-in side representation of an audio modification (opaque to the host).
 
typedef struct ARAAudioModificationHostRefMarkupType * ARAAudioModificationHostRef
 Reference to the host side representation of an audio modification (opaque to the plug-in).
 

Class Documentation

◆ ARAAudioModificationProperties

struct ARAAudioModificationProperties

Audio modification 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 audio modification 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 audio modification. In that case, the host should not make up some name (e.g. derived from the audio source), 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.
 
ARAPersistentID persistentID
 ID used to re-connect model graph when archiving/unarchiving. This ID must be unique for all audio modifications within the document. The plug-in must copy the persistentID, the pointer may be only valid for the duration of the call.