C++ classes representing the ARA Model Graph objects.
Classes | |
| class | ARA::PlugIn::Document |
| Extensible model object class representing an ARA Document. More... | |
| class | ARA::PlugIn::MusicalContext |
| Extensible model object class representing an ARA Musical Context. More... | |
| class | ARA::PlugIn::RegionSequence |
| Extensible model object class representing an ARA Region Sequences (Added In ARA 2.0). More... | |
| class | ARA::PlugIn::AudioSource |
| Extensible model object class representing an ARA Audio Source. More... | |
| class | ARA::PlugIn::AudioModification |
| Extensible model object class representing an ARA Audio Modification. More... | |
| class | ARA::PlugIn::PlaybackRegion |
| Extensible model object class representing an ARA Playback Region. More... | |
| class ARA::PlugIn::Document |
Extensible model object class representing an ARA Document.
Document Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename AudioSource_t = AudioSource> | |
| std::vector< AudioSource_t * > const & | getAudioSources () const noexcept |
| Retrieve the current list of associated AudioSource instances. | |
| template<typename MusicalContext_t = MusicalContext> | |
| std::vector< MusicalContext_t * > const & | getMusicalContexts () const noexcept |
| Retrieve the current list of associated MusicalContext instances, sorted by ARAMusicalContextProperties::orderIndex. | |
| template<typename RegionSequence_t = RegionSequence> | |
| std::vector< RegionSequence_t * > const & | getRegionSequences () const noexcept |
| Retrieve the current list of associated RegionSequence instances, sorted by ARARegionSequenceProperties::orderIndex. | |
Construction | |
| Document (DocumentController *documentController) noexcept | |
| Called implicitly through DocumentController::doCreateDocument () - provide a matching c'tor if subclassing Document. | |
Document Properties | |
Copy of the current ARADocumentProperties set by the host. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARADocumentProperties::name. | |
| class ARA::PlugIn::MusicalContext |
Extensible model object class representing an ARA Musical Context.
Musical Context Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| ARAMusicalContextHostRef | getHostRef () const noexcept |
| Retrieve the opaque host token for this object. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename Document_t = Document> | |
| Document_t * | getDocument () const noexcept |
| Retrieve the Document instance containing this object. | |
| template<typename RegionSequence_t = RegionSequence> | |
| std::vector< RegionSequence_t * > const & | getRegionSequences () const noexcept |
| Retrieve the current list of associated RegionSequence instances, sorted by ARARegionSequenceProperties::orderIndex. | |
Construction | |
| MusicalContext (Document *document, ARAMusicalContextHostRef hostRef) noexcept | |
| Called implicitly through DocumentController::doCreateMusicalContext () - provide a matching c'tor if subclassing MusicalContext. | |
Musical Context Properties | |
Copy of the current ARAMusicalContextProperties set by the host. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARAMusicalContextProperties::name. | |
| ARAInt32 | getOrderIndex () const noexcept |
| See ARAMusicalContextProperties::orderIndex. | |
| const OptionalProperty< ARAColor * > & | getColor () const noexcept |
| See ARAMusicalContextProperties::color. | |
| const OptionalProperty< ARAUtf8String > & | getEffectiveName () const noexcept |
| Convenience function: if host did not provide name, this returns the document name - note that the fallback may still return nullptr! | |
| class ARA::PlugIn::RegionSequence |
Extensible model object class representing an ARA Region Sequences (Added In ARA 2.0).
Region Sequence Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| ARARegionSequenceHostRef | getHostRef () const noexcept |
| Retrieve the opaque host token for this object. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename Document_t = Document> | |
| Document_t * | getDocument () const noexcept |
| Retrieve the Document instance containing this object. | |
| template<typename MusicalContext_t = MusicalContext> | |
| MusicalContext_t * | getMusicalContext () const noexcept |
| Retrieve the current underlying MusicalContext instance. | |
| template<typename PlaybackRegion_t = PlaybackRegion> | |
| std::vector< PlaybackRegion_t * > const & | getPlaybackRegions () const noexcept |
| Retrieve the current list of associated PlaybackRegion instances. | |
Construction | |
| RegionSequence (Document *document, ARARegionSequenceHostRef hostRef) noexcept | |
| Called implicitly through DocumentController::doCreateRegionSequence () - provide a matching c'tor if subclassing RegionSequence. | |
Region Sequence Properties | |
Copy of the current ARARegionSequenceProperties set by the host. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARARegionSequenceProperties::name. | |
| ARAInt32 | getOrderIndex () const noexcept |
| See ARARegionSequenceProperties::orderIndex. | |
| const OptionalProperty< ARAColor * > & | getColor () const noexcept |
| See ARARegionSequenceProperties::color. | |
| class ARA::PlugIn::AudioSource |
Extensible model object class representing an ARA Audio Source.
Audio Source Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| ARAAudioSourceHostRef | getHostRef () const noexcept |
| Retrieve the opaque host token for this object. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename Document_t = Document> | |
| Document_t * | getDocument () const noexcept |
| Retrieve the Document instance containing this object. | |
| template<typename AudioModification_t = AudioModification> | |
| std::vector< AudioModification_t * > const & | getAudioModifications () const noexcept |
| Retrieve the current list of associated AudioModification instances. | |
Construction | |
| AudioSource (Document *document, ARAAudioSourceHostRef hostRef) noexcept | |
| Called implicitly through DocumentController::doCreateAudioSource () - provide a matching c'tor if subclassing AudioSource. | |
Audio Source Properties | |
Copy of the current ARAAudioSourceProperties set by the host. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARAAudioSourceProperties::name. | |
| const std::string & | getPersistentID () const noexcept |
| See ARAAudioSourceProperties::persistentID. | |
| ARASampleRate | getSampleRate () const noexcept |
| See ARAAudioSourceProperties::sampleRate. | |
| ARASampleCount | getSampleCount () const noexcept |
| See ARAAudioSourceProperties::sampleCount. | |
| ARATimeDuration | getDuration () const noexcept |
| The duration of the audio source in seconds; sampleRate / sampleCount. | |
| ARAChannelCount | getChannelCount () const noexcept |
| See ARAAudioSourceProperties::channelCount. | |
| bool | merits64BitSamples () const noexcept |
| See ARAAudioSourceProperties::merits64BitSamples. | |
Host-controlled Audio Source State | |
| bool | isSampleAccessEnabled () const noexcept |
| See DocumentController::enableAudioSourceSamplesAccess. | |
| bool | isDeactivatedForUndoHistory () const noexcept |
| See DocumentController::deactivateAudioSourceForUndoHistory. | |
| virtual void | doUpdateChannelArrangement (const ChannelArrangement &channelArrangement) noexcept |
| Since the channel arrangement is expressed in terms of the Companion API and not in some native ARA format, translating it into the plug-in's internal representation is delegated by the library via this call for clients to override as necessary. | |
| class ARA::PlugIn::AudioModification |
Extensible model object class representing an ARA Audio Modification.
Audio Modification Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| ARAAudioModificationHostRef | getHostRef () const noexcept |
| Retrieve the opaque host token for this object. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename AudioSource_t = AudioSource> | |
| AudioSource_t * | getAudioSource () const noexcept |
| Retrieve the AudioSource instance containing this object. | |
| template<typename PlaybackRegion_t = PlaybackRegion> | |
| std::vector< PlaybackRegion_t * > const & | getPlaybackRegions () const noexcept |
| Retrieve the current list of associated PlaybackRegion instances. | |
Construction | |
| AudioModification (AudioSource *audioSource, ARAAudioModificationHostRef hostRef, const AudioModification *optionalModificationToClone) noexcept | |
Called implicitly through DocumentController::doCreateAudioModification () - provide a matching c'tor if subclassing AudioModification. optionalModificationToClone will be nullptr when creating new modifications with default state from scratch, or will point to a modification (referencing the same audioSource) from which the internal state should be cloned into the new modification. | |
Audio Modification Properties | |
Copy of the current ARAAudioModificationProperties set by the host. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARAAudioModificationProperties::name. | |
| const std::string & | getPersistentID () const noexcept |
| See ARAAudioModificationProperties::persistentID. | |
| const OptionalProperty< ARAUtf8String > & | getEffectiveName () const noexcept |
| Convenience function: if host did not provide name, this returns the audio source name - note that the fallback may still return nullptr! | |
Host-controlled Audio Modification State | |
| bool | isDeactivatedForUndoHistory () const noexcept |
| See DocumentController::deactivateAudioModificationForUndoHistory. | |
| class ARA::PlugIn::PlaybackRegion |
Extensible model object class representing an ARA Playback Region.
Playback Region Relationships | |
Where applicable, use the optional template parameter to cast the returned instances to your custom subclass. | |
| ARAPlaybackRegionHostRef | getHostRef () const noexcept |
| Retrieve the opaque host token for this object. | |
| template<typename DocumentController_t = DocumentController> | |
| DocumentController_t * | getDocumentController () const noexcept |
| Retrieve the DocumentController instance controlling this object. | |
| template<typename AudioModification_t = AudioModification> | |
| AudioModification_t * | getAudioModification () const noexcept |
| Retrieve the AudioModification instance containing this object. | |
| template<typename RegionSequence_t = RegionSequence> | |
| RegionSequence_t * | getRegionSequence () const noexcept |
| Retrieve the current underlying RegionSequence instance. | |
Construction | |
| PlaybackRegion (AudioModification *audioModification, ARAPlaybackRegionHostRef hostRef) noexcept | |
| Called implicitly through DocumentController::doCreatePlaybackRegion () - provide a matching c'tor if subclassing PlaybackRegion. | |
Playback Region Properties | |
Copy of the current ARAPlaybackRegionProperties set by the host. | |
| ARATimePosition | getStartInAudioModificationTime () const noexcept |
| See ARAPlaybackRegionProperties::startInModificationTime. | |
| ARATimeDuration | getDurationInAudioModificationTime () const noexcept |
| See ARAPlaybackRegionProperties::durationInModificationTime. | |
| ARATimePosition | getEndInAudioModificationTime () const noexcept |
The end of the region in modification time; startInModificationTime + durationInModificationTime. | |
| bool | intersectsWithAudioModificationTimeRange (ARAContentTimeRange range) const noexcept |
Returns true if range intersects the region in modification time. | |
| ARASamplePosition | getStartInAudioModificationSamples () const noexcept |
| Modification start time in samples, derived using underlying AudioSource sample rate. | |
| ARASamplePosition | getEndInAudioModificationSamples () const noexcept |
| Modification end time in samples, derived using underlying AudioSource sample rate. | |
| ARASampleCount | getDurationInAudioModificationSamples () const noexcept |
| Modification duration in samples, derived using underlying AudioSource sample rate. | |
| ARATimePosition | getStartInPlaybackTime () const noexcept |
| See ARAPlaybackRegionProperties::startInPlaybackTime. | |
| ARATimeDuration | getDurationInPlaybackTime () const noexcept |
| See ARAPlaybackRegionProperties::durationInPlaybackTime. | |
| ARATimePosition | getEndInPlaybackTime () const noexcept |
The end of the region in playback time; startInPlaybackTime + durationInPlaybackTime. | |
| bool | intersectsWithPlaybackTimeRange (ARAContentTimeRange range) const noexcept |
Returns true if range intersects the region in playback time. | |
| ARASamplePosition | getStartInPlaybackSamples (ARASampleRate playbackSampleRate) const noexcept |
| Playback start time in samples, derived using underlying AudioSource sample rate. | |
| ARASampleCount | getDurationInPlaybackSamples (ARASampleRate playbackSampleRate) const noexcept |
| Playback duration in samples, derived using underlying AudioSource sample rate. | |
| ARASamplePosition | getEndInPlaybackSamples (ARASampleRate playbackSampleRate) const noexcept |
| Playback end time in samples, derived using underlying AudioSource sample rate. | |
| bool | isTimestretchEnabled () const noexcept |
ARAPlaybackRegionProperties::transformationFlags & kARAPlaybackTransformationTimestretch. | |
| bool | isTimeStretchReflectingTempo () const noexcept |
ARAPlaybackRegionProperties::transformationFlags & kARAPlaybackTransformationTimestretchReflectingTempo. | |
| bool | hasContentBasedFadeAtHead () const noexcept |
ARAPlaybackRegionProperties::transformationFlags & kARAPlaybackTransformationContentBasedFadeAtHead. | |
| bool | hasContentBasedFadeAtTail () const noexcept |
ARAPlaybackRegionProperties::transformationFlags & kARAPlaybackTransformationContentBasedFadeAtTail. | |
| const OptionalProperty< ARAUtf8String > & | getName () const noexcept |
| See ARAPlaybackRegionProperties::name. | |
| const OptionalProperty< ARAColor * > & | getColor () const noexcept |
| See ARAPlaybackRegionProperties::color. | |
| const OptionalProperty< ARAUtf8String > & | getEffectiveName () const noexcept |
| Convenience function: if host did not provide name, this traverses the graph to find a fallback to show to the user using either the audio modification or the audio source name - note that the fallback may still return nullptr! | |
| const OptionalProperty< ARAColor * > & | getEffectiveColor () const noexcept |
| Convenience function: if host did not provide name, this traverses the graph to find a fallback to show to the user using either the audio modification or the audio source color - note that the fallback may still return nullptr! | |