Crate ara2_bridge_sys

Expand description

Raw FFI bindings for the Celemony ARA2 SDK.

Generated by bindgen from ARAInterface.h v2.3.0.

This crate is not intended to be used directly. See the ara2-bridge crate for safe Rust wrappers around these types.

§Regenerating

The bindings are generated at build time in build.rs. If you update ARAInterface.h, the bindings regenerate automatically. No manual steps required.

§Coverage

210 types exported, including:

11 interface structs (function pointer vtables)
Property structs for audio sources, musical contexts, region sequences
Opaque reference types for plugin and host objects
Constants and enums for API generations, content types, and flags

Structs§

ARAArchiveReaderHostRefMarkupType
ARAArchiveWriterHostRefMarkupType
ARAArchivingControllerHostRefMarkupType
ARAArchivingControllerInterface: ! Host interface: archive 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.
ARAAudioAccessControllerHostRefMarkupType
ARAAudioAccessControllerInterface: ! Host interface: audio 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.
ARAAudioModificationHostRefMarkupType
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.
ARAAudioModificationRefMarkupType
ARAAudioReaderHostRefMarkupType
ARAAudioSourceHostRefMarkupType
ARAAudioSourceProperties: ! Audio source 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.
ARAAudioSourceRefMarkupType
ARAColor: ! R/G/B color, values range from 0.0f to 1.0f. ! Does not include transparency because it must not depend on the background its drawn upon ! in order to be equally represented in both the host and plug-in UI - any transparency on ! either side must be converted depending on internal drawing before/after the ARA calls.
ARAContentAccessControllerHostRefMarkupType
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.
ARAContentBarSignature: ! Content reader event class: bar signatures provided by kARAContentTypeBarSignatures. ! The event position relates to ARAContentTempoEntry, a valid tempo map must be provided ! by any provider of ARAContentBarSignature. ! Each bar signature is valid until the following one, and the first bar signature is assumed to ! also be valid any time before it is actually defined. ! The location of the first bar signature is also considered to be the location of bar 1. ! Event sort order is by position. ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
ARAContentChord: ! Content reader event class: chords provided by kARAContentTypeSheetChords. ! The event position relates to ARAContentTempoEntry, a valid tempo map must be provided ! by any provider of ARAContentBarSignature. ! Each chord is valid until the following one, and the first chord is assumed to also be valid ! any time before it is actually defined (i.e. its position is effectively ignored). ! The “undefined chord” markup (all intervals unused) can be used to express a range where no ! chord is applicable. Such gaps may appear between “regular” chords, or they can be used ! to limit the otherwise infinite duration of the first and last “regular” chord if desired. ! Event sort order is by position. ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
ARAContentKeySignature: ! Content reader event class: key signature provided by kARAContentTypeKeySignatures. ! Defines the usage of each pitch class in the octave-cyclic 12-tone pitch system. ! This content type describes the key signatures as would be annotated in a score, not the local ! scales (which may be using some out-of-key notes via additional per-note accidentals). ! The event position relates to ARAContentTempoEntry, a valid tempo map must be provided ! by any provider of ARAContentBarSignature. ! Each key signature is valid until the following one, the first key signature is assumed to also ! be valid any time before it is actually defined. ! Event sort order is by position. ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
ARAContentNote: ! Content reader event class: notes provided by kARAContentTypeNotes. ! Event sort order is by startPosition. ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
ARAContentReaderHostRefMarkupType
ARAContentReaderRefMarkupType
ARAContentTempoEntry: ! Content reader event class: tempo map provided by kARAContentTypeTempoEntries. ! Event sort order is by timePosition. ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
ARAContentTimeRange: ! Content reader optional creation parameter: a range in time to filter content events. ! As an optimization hint, a content reader can be asked to restrict its data to only those events ! that intersect with the given time range. Reader implementations should strive to respect this ! request, but focus on overall performance - the events actually returned may exceed the specified ! range by any amount, and calling code must evaluate the returned event positions/event durations. ! \br ! Note that when calls accept a pointer to a content time range, that pointer is only valid for ! the duration of the call - the data must be evaluated/copied inside the call, and the pointer ! must not be stored anywhere. ! Further, in most of these calls the pointer to a content range may be NULL, indicating that the ! entire content range of the object should be read.
ARAContentTuning: ! Content reader event class: periodic 12-tone tuning table provided by kARAContentTypeStaticTuning. ! Defines the tuning of each pitch class in the octave-cyclic 12-tone pitch system. ! Allows to import (12-tone) Scala files. ! Stretched tunings are not supported by ARA at this point, but may be added in a future release ! as an additional tuning stretch curve applied on top of this average tuning. ! ARA defines a single overall tuning (i.e. there’s always only one event for this reader). ! As with all content readers, a pointer to this struct retrieved via getContentReaderDataForEvent() ! is still owned by the callee and must remain valid until either getContentReaderDataForEvent() ! is called again or the reader is destroyed via destroyContentReader().
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.
ARADocumentControllerInstance: ! The document controller instance struct and all interfaces and refs therein must remain valid ! until the document controller is destroyed by the host.
ARADocumentControllerInterface: ! Plug-in interface: document controller. ! The function pointers in this struct must remain valid until the document controller is ! destroyed by the host.
ARADocumentControllerRefMarkupType
ARADocumentProperties: ! Document 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.
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.
ARAEditorRendererRefMarkupType
ARAEditorViewInterface: ! Plug-in interface: view controller. ! The function pointers in this struct must remain valid until the document controller is ! destroyed by the host.
ARAEditorViewRefMarkupType
ARAFactory: ! @defgroup Plug_In_Interfaces Plug-In Interfaces ! @{ ***************************************************************************************************/
ARAInterfaceConfiguration: ! API configuration. ! This configuration struct allows for setting the desired API version, the debug callback etc. ! Note that a pointer to this struct is only valid for the duration of the call to ! initializeARAWithConfiguration() - the data must be fully evaluated/copied inside the call.
ARAModelUpdateControllerHostRefMarkupType
ARAModelUpdateControllerInterface: ! Host interface: model update 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.
ARAMusicalContextHostRefMarkupType
ARAMusicalContextProperties: ! Musical context 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.
ARAMusicalContextRefMarkupType
ARAPlaybackControllerHostRefMarkupType
ARAPlaybackControllerInterface: ! Host interface: playback 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.
ARAPlaybackRegionHostRefMarkupType
ARAPlaybackRegionProperties: ! Playback region 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.
ARAPlaybackRegionRefMarkupType
ARAPlaybackRendererInterface: ! Plug-in interface: playback 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.
ARAPlaybackRendererRefMarkupType
ARAPlugInExtensionInstance: ! The plug-in extension instance struct and all interfaces and refs therein must remain valid ! until the companion plug-in is destroyed by the host. ! Note that the companion plug-in destruction may happen before or after destroying the document ! controller it has been bound to, plug-ins must handle both possible destruction orders. ! Plug-ins must provide all interfaces that have been requested by the host through the role ! assignment, and suppress interfaces explicitly excluded by the roles - e.g. if the host did ! not assign kARAEditorRendererRole even it was known, editorRendererInterface will be NULL.
ARAPlugInExtensionInterface
ARAPlugInExtensionRefMarkupType
ARAProcessingAlgorithmProperties: ! Processing algorithm description returned by ARADocumentControllerInterface::getProcessingAlgorithmProperties() ! Provides a unique identifier and a user-readable name of the algorithm, as displayed in the plug-in. ! The pointers contained in this struct must remain valid until the document controller that has ! provided the struct is destroyed.
ARARegionSequenceHostRefMarkupType
ARARegionSequenceProperties: ! Region sequence 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.
ARARegionSequenceRefMarkupType
ARARestoreObjectsFilter: ! Optional filter when restoring objects. ! \br ! Allows the host to specify a subset of the persistent objects in the archive to restore in ! ARADocumentControllerInterface::restoreObjectsFromArchive(). ! \br ! The given IDs refer to objects in the archive, but can optionally be mapped to those used in the ! current document. This may be necessary to resolve potential conflicts between persistent IDs ! from different documents when importing parts of one document into another (since persistent IDs ! are only required to be unique within a document, not across documents). ! \br ! The C++ ARA Library offers plug-in developers the ARA::PlugIn::RestoreObjectsFilter ! utility class to ease the implementation of partial persistency.
ARAStoreObjectsFilter: ! Optional filter when storing objects. ! \br ! Allows the host to specify a subset of the objects in the model graph to be stored in ! ARADocumentControllerInterface::storeObjectsToArchive(). ! \br ! The C++ ARA Library offers plug-in developers the ARA::PlugIn::StoreObjectsFilter ! utility class to ease the implementation of partial persistency.
ARAViewSelection: ! Host generated ARA view selection.

Enums§

_bindgen_ty_1: ! To avoid defining yet another abstraction of spacial layout information for the individual ! channels of an audio signal, ARA directly uses the respective companion API’s model of ! spacial arrangement. Since different companion APIs are available, this enum specifies which ! abstraction is used.
_bindgen_ty_2: / //! @defgroup API_generations API Generations //! While purely additive features can be handled through ARA’s versioned structs, //! ARA API generations allow for non-backwards-compatible, fundamental API changes. //! For hosts that rely on a certain minimum ARA feature set provided by the plug-ins, it also //! offers a convenient way to filter incompatible plug-ins. //! Plug-ins on the other hand can use the API generation chosen by the host to optimize their //! feature set for the given environment, such as disabling potentially costly fallback code //! required for older hosts when running in a modern host. //! @{
_bindgen_ty_3: ! Hint about the nature of the programming error.
_bindgen_ty_4
_bindgen_ty_5
_bindgen_ty_6
_bindgen_ty_7
_bindgen_ty_8
_bindgen_ty_9: ! Playback region transformations. ! Plug-ins may or may not support all transformations that can be configured in a playback region. ! They express these capabilities at factory level, and the host must respect this. ! Also used in ARAFactory::supportedPlaybackTransformationFlags.
_bindgen_ty_10
_bindgen_ty_11: ! Flags indicating the scope of a content update. ! If notifying the API partner about a content update, the caller can make guarantees about which ! abstractions of the signal are unaffected by the given change. ! The enum flags describing these abstractions are or’d together into a single ARAInt32 value. ! \br ! The C++ ARA Library encapsulates content updates in the ARA::ContentUpdateScopes class.
_bindgen_ty_12: ! Types of data that can be shared between host and plug-in.
_bindgen_ty_13: ! Content grade: degree of reliability of the provided content information. ! The most prominent use of the content grade is to solve conflicts between data provided by the ! host and data found via analysis on the plug-in side. Another example is that when being notified ! about content changes in the plug-in, a host may choose to trigger certain automatic updates only ! if the grade of the content is above a certain reliability threshold.
_bindgen_ty_14
_bindgen_ty_15
_bindgen_ty_16
_bindgen_ty_17: ! Audio source analysis progress indication.
_bindgen_ty_18
_bindgen_ty_19
_bindgen_ty_20
_bindgen_ty_21
_bindgen_ty_22
_bindgen_ty_23
_bindgen_ty_24
_bindgen_ty_25
_bindgen_ty_26
_bindgen_ty_27
_bindgen_ty_28: ! Plug-in instance role flags.
_bindgen_ty_29
_bindgen_ty_30
_bindgen_ty_31
_bindgen_ty_32
_bindgen_ty_33
_bindgen_ty_34

Constants§

kARAAPIGeneration_1_0_Draft
kARAAPIGeneration_1_0_Final
kARAAPIGeneration_2_0_Draft
kARAAPIGeneration_2_0_Final
kARAAPIGeneration_2_3_Final
kARAAPIGeneration_2_X_Draft
kARAAnalysisProgressCompleted
kARAAnalysisProgressStarted
kARAAnalysisProgressUpdated
kARAArchivingControllerInterfaceMinSize
kARAAssertInvalidArgument
kARAAssertInvalidState
kARAAssertInvalidThread
kARAAssertUnspecified
kARAAudioAccessControllerInterfaceMinSize
kARAAudioModificationPropertiesMinSize
kARAAudioSourcePropertiesMinSize
kARAChannelArrangementAAXStemFormat
kARAChannelArrangementCLAPAmbisonicInfo
kARAChannelArrangementCLAPChannelMap
kARAChannelArrangementCoreAudioChannelLayout
kARAChannelArrangementUndefined
kARAChannelArrangementVST3SpeakerArrangement
kARAContentAccessControllerInterfaceMinSize
kARAContentGradeAdjusted
kARAContentGradeApproved
kARAContentGradeDetected
kARAContentGradeInitial
kARAContentTypeBarSignatures
kARAContentTypeKeySignatures
kARAContentTypeNotes
kARAContentTypeSheetChords
kARAContentTypeStaticTuning
kARAContentTypeTempoEntries
kARAContentUpdateEverythingChanged
kARAContentUpdateHarmonicScopeRemainsUnchanged
kARAContentUpdateNoteScopeRemainsUnchanged
kARAContentUpdateSignalScopeRemainsUnchanged
kARAContentUpdateTimingScopeRemainsUnchanged
kARAContentUpdateTuningScopeRemainsUnchanged
kARADefaultConcertPitchFrequency
kARADocumentControllerHostInstanceMinSize
kARADocumentControllerInstanceMinSize
kARADocumentControllerInterfaceMinSize
kARADocumentPropertiesMinSize
kARAEditorRendererInterfaceMinSize
kARAEditorRendererRole
kARAEditorViewInterfaceMinSize
kARAEditorViewRole
kARAFactoryMinSize
kARAInterfaceConfigurationMinSize
kARAInvalidFrequency
kARAInvalidPitchNumber
kARAModelUpdateControllerInterfaceMinSize
kARAMusicalContextPropertiesMinSize
kARAPlaybackControllerInterfaceMinSize
kARAPlaybackRegionPropertiesMinSize
kARAPlaybackRendererInterfaceMinSize
kARAPlaybackRendererRole
kARAPlaybackTransformationContentBasedFadeAtHead
kARAPlaybackTransformationContentBasedFadeAtTail
kARAPlaybackTransformationContentBasedFades
kARAPlaybackTransformationNoChanges
kARAPlaybackTransformationTimestretch
kARAPlaybackTransformationTimestretchReflectingTempo
kARAPlugInExtensionInstanceMinSize
kARAPlugInExtensionInterfaceMinSize
kARAProcessingAlgorithmPropertiesMinSize
kARARegionSequencePropertiesMinSize
kARARestoreObjectsFilterMinSize
kARAStoreObjectsFilterMinSize
kARAViewSelectionMinSize

Functions§

build_araarchivingcontroller_vtable
build_araaudioaccesscontroller_vtable
build_aracontentaccesscontroller_vtable
build_aramodelupdatecontroller_vtable
build_araplaybackcontroller_vtable

Type Aliases§

ARAAPIGeneration: / //! @defgroup API_generations API Generations //! While purely additive features can be handled through ARA’s versioned structs, //! ARA API generations allow for non-backwards-compatible, fundamental API changes. //! For hosts that rely on a certain minimum ARA feature set provided by the plug-ins, it also //! offers a convenient way to filter incompatible plug-ins. //! Plug-ins on the other hand can use the API generation chosen by the host to optimize their //! feature set for the given environment, such as disabling potentially costly fallback code //! required for older hosts when running in a modern host. //! @{
ARAAnalysisProgressState: ! Audio source analysis progress indication.
ARAArchiveReaderHostRef: ! Reference to the host side representation of an archive reader (opaque to the plug-in).
ARAArchiveWriterHostRef: ! Reference to the host side representation of an archive writer (opaque to the plug-in).
ARAArchivingControllerHostRef: ! Reference to the host side representation of an archiving controller (opaque to the plug-in).
ARAAssertCategory: ! Hint about the nature of the programming error.
ARAAssertFunction: ! Global assert function pointer. ! The assert categories passed to the global assert function are useful both for guiding developers ! when debugging and for automatic assert evaluation when building unit tests. \br ! The diagnosis text is intended solely to aid the developer debugging an issue “from the ! other side”; they must not be presented to the user (or even parsed for flow control). ! If applicable (i.e. if the category is kARAAssertInvalidArgument), the diagnosis should contain ! a hint about what problematicArgument actually points to - for example if a struct is too small, ! you’d pass the pointer to the struct along with a diagnosis message a la: ! “someExampleInterfacePointer->structSize < kExampleStructMinSize”. ! Creating such appropriate texts automatically can be easily accomplished by custom assert macros. \br ! Finally, problematicArgument should point to the argument that contains the invalid data, so that ! the developer on that end can quickly identify the problem. If you can’t provide a meaningful ! address for it, e.g. because the category is kARAAssertInvalidThread, pass NULL here.
ARAAudioAccessControllerHostRef: ! Reference to the host side representation of an audio access controller (opaque to the plug-in).
ARAAudioModificationHostRef: ! Reference to the host side representation of an audio modification (opaque to the plug-in).
ARAAudioModificationRef: ! Reference to the plug-in side representation of an audio modification (opaque to the host).
ARAAudioReaderHostRef: ! Reference to the host side representation of an audio reader (opaque to the plug-in).
ARAAudioSourceHostRef: ! Reference to the host side representation of an audio source (opaque to the plug-in).
ARAAudioSourceRef: ! Reference to the plug-in side representation of an audio source (opaque to the host).
ARABool: ! Platform independent 32-bit boolean value.
ARAByte: ! Byte: 8 bits wide unsigned integer.
ARAChannelArrangementDataType: ! To avoid defining yet another abstraction of spacial layout information for the individual ! channels of an audio signal, ARA directly uses the respective companion API’s model of ! spacial arrangement. Since different companion APIs are available, this enum specifies which ! abstraction is used.
ARAChannelCount: ! Count of discrete channels of an audio signal. ! The spacial positioning of the channels may be provided via ARAChannelArrangementDataType.
ARAChordIntervalUsage: ! The ARAChordIntervalUsage defines whether a particular interval is used ! (kARAChordIntervalUsed) or not (kARAChordIntervalUnused), or if used may instead further ! specify the function of the interval in the chord by specifying its diatonic degree: ! 1 = unison, 3 = third, up to 13 = thirteenth ! Note that the bass note of a chord is treated separately, see below.
ARACircleOfFifthsIndex: ! The root of a key signature or chord as an index (or angle) in the circle of fifths from ‘C’. ! Enharmonic equivalents such as Db and C# are distinguished: ! \verbatim ! … ! -5: Db ! … ! -1: F ! 0: C ! 1: G ! 2: D ! … ! 7: C# ! … ! 11: E# ! … ! \endverbatim
ARAContentAccessControllerHostRef: ! Reference to the host side representation of a content access controller (opaque to the plug-in).
ARAContentGrade: ! Content grade: degree of reliability of the provided content information. ! The most prominent use of the content grade is to solve conflicts between data provided by the ! host and data found via analysis on the plug-in side. Another example is that when being notified ! about content changes in the plug-in, a host may choose to trigger certain automatic updates only ! if the grade of the content is above a certain reliability threshold.
ARAContentReaderHostRef: ! Reference to the host side representation of a content reader (opaque to the plug-in).
ARAContentReaderRef: ! Reference to the plug-in side representation of a content reader (opaque to the host).
ARAContentType: ! Types of data that can be shared between host and plug-in.
ARAContentUpdateFlags: ! Flags indicating the scope of a content update. ! If notifying the API partner about a content update, the caller can make guarantees about which ! abstractions of the signal are unaffected by the given change. ! The enum flags describing these abstractions are or’d together into a single ARAInt32 value. ! \br ! The C++ ARA Library encapsulates content updates in the ARA::ContentUpdateScopes class.
ARADocumentControllerRef: ! Reference to the plug-in side representation of a document controller (opaque to the host).
ARAEditorRendererRef: ! Reference to the plug-in side representation of a editor renderer (opaque to the host).
ARAEditorViewRef: ! Reference to the plug-in side representation of a editor view (opaque to the host).
ARAInt32: ! 32 bits wide signed integer.
ARAInt64: ! 64 bits wide signed integer.
ARAKeySignatureIntervalUsage: ! The ARAKeySignatureIntervalUsage defines whether a particular interval is used ! (kARAKeySignatureIntervalUsed) or not (kARAKeySignatureIntervalUnused). ! Future extensions of the API could further specify the usage of a given interval, similar to the ! chord intervals below. However since there are currently no clear-cut use cases for such a ! distinction, this is not yet specified.
ARAModelUpdateControllerHostRef: ! Reference to the host side representation of a model update controller (opaque to the plug-in).
ARAMusicalContextHostRef: ! Reference to the host side representation of a musical context (opaque to the plug-in).
ARAMusicalContextRef: ! Reference to the plug-in side representation of a musical context (opaque to the host).
ARAPersistentID: ! Persistent object reference representation. ! Persistent IDs are used to encode object references between plug-in and host when dealing ! with persistency. Contrary to the user-readable ARAUtf8String, ARAPersistentIDs are seven-bit ! US-ASCII-encoded strings, such as “com.manufacturerDomain.someIdentifier”, and can thus be ! directly compared using strcmp() and its siblings. They can be copied using strcpy() and must ! always be compared by value, not by address.
ARAPitchNumber: ! Quantized pitch, corresponds to the MIDI note number in the range 0…127, but may exceed this range.
ARAPlaybackControllerHostRef: ! Reference to the host side representation of a playback controller (opaque to the plug-in).
ARAPlaybackRegionHostRef: ! Reference to the host side representation of a playback region (opaque to the plug-in).
ARAPlaybackRegionRef: ! Reference to the plug-in side representation of a playback region (opaque to the host).
ARAPlaybackRendererRef: ! Reference to the plug-in side representation of a playback renderer (opaque to the host).
ARAPlaybackTransformationFlags: ! Playback region transformations. ! Plug-ins may or may not support all transformations that can be configured in a playback region. ! They express these capabilities at factory level, and the host must respect this. ! Also used in ARAFactory::supportedPlaybackTransformationFlags.
ARAPlugInExtensionRef: ! @defgroup Plug-In_Extension_Interface Deprecated: Plug-In Extension Interface. ! This interface was used before ARA 2.0 defined dedicated plug-in roles. ! It is only to be implemented when ARA 1 backwards compatibility is desired. ! An ARA 1 call to set/removePlaybackRegion() in this interface is equivalent ! to calling both set/removePlaybackRegion() in ARAPlaybackRendererInterface ! and add/removePlaybackRegion() in ARAEditorRendererInterface. ! To some extend ARA 1 also uses this to for tasks now associated with ! ARAEditorViewInterface: opening the UI of an ARA 1 plug-in instance is ! interpreted as selection of the playback region set via this interface. ! @{
ARAPlugInInstanceRoleFlags: ! Plug-in instance role flags.
ARAQuarterDuration: ! A duration in musical time measured in quarter notes - the start of the duration is part of the interval, the end is not.
ARAQuarterPosition: ! A position in musical time measured in quarter notes.
ARARegionSequenceHostRef: ! Reference to the host side representation of a region sequence (opaque to the plug-in).
ARARegionSequenceRef: ! Reference to the plug-in side representation of a region sequence (opaque to the host).
ARASampleCount: ! Integer sample count, always related to a particular sample rate defined by the context this is used in.
ARASamplePosition: ! Integer sample index, always related to a particular sample rate defined by the context it is used in.
ARASampleRate: ! Specified in Hz.
ARASize: ! Pointer-wide size value for ARA structs.
ARATimeDuration: ! A duration of time in seconds - the start of the duration is part of the interval, the end is not.
ARATimePosition: ! A point in time in seconds.
ARAUtf8Char: ! A single character.
ARAUtf8String: ! A string, 0-terminated.

Crate ara2_bridge_sys

Crate ara2_bridge_sys Copy item path

§Regenerating

§Coverage

Structs§

Enums§

Constants§

Functions§

Type Aliases§

Crate ara2_bridge_sys