ase/api.hh file


Namespaces

namespace Ase
The Anklang C++ API namespace.

Classes

class Ase::SharedBase
Common base type for polymorphic classes managed by std::shared_ptr<>.
struct Ase::Choice
Representation of one possible choice for selection properties.
struct Ase::TelemetryField
Telemetry segment location.
class Ase::Emittable
Base type for classes with Event subscription.
class Ase::Property
A Property allows querying, setting and monitoring of an object property.
class Ase::Object
Base type for classes with Property interfaces.
class Ase::Gadget
Base type for classes that have a Property.
struct Ase::DeviceInfo
Info for device types.
class Ase::Device
Interface to access Device instances.
class Ase::NativeDevice
Interface to access NativeDevice instances.
struct Ase::ClipNote
Part specific note event representation.
class Ase::Clip
Container for MIDI note and control events.
class Ase::Track
Container for Clip objects and sequencing information.
struct Ase::ProbeFeatures
Bits representing a selection of probe sample data features.
class Ase::Monitor
Interface for monitoring output signals.
class Ase::Project
Projects support loading, saving, playback and act as containers for all other sound objects.
struct Ase::Resource
Description of a resource, possibly nested.
class Ase::ResourceCrawler
Helper to crawl hierarchical resources.
struct Ase::UserNote
Contents of user interface notifications.
struct Ase::TelemetrySegment
Telemetry segment location.
class Ase::Server
Central singleton, serves as API entry point.

Enums

enum class Error: int32_t { NONE = 0, PERMS = EPERM, IO = EIO, NO_MEMORY = ENOMEM, NO_SPACE = ENOSPC, NO_FILES = ENFILE, MANY_FILES = EMFILE, RETRY = EINTR, NOT_DIRECTORY = ENOTDIR, FILE_NOT_FOUND = ENOENT, FILE_IS_DIR = EISDIR, FILE_EXISTS = EEXIST, FILE_BUSY = EBUSY, INTERNAL = 0x30000000, UNIMPLEMENTED, FILE_EOF = 0x30001000, FILE_OPEN_FAILED, FILE_SEEK_FAILED, FILE_READ_FAILED, FILE_WRITE_FAILED, PARSE_ERROR = 0x30002000, NO_HEADER, NO_SEEK_INFO, NO_DATA_AVAILABLE, DATA_CORRUPT, WRONG_N_CHANNELS, FORMAT_INVALID, FORMAT_UNKNOWN, DATA_UNMATCHED, CODEC_FAILURE, BROKEN_ARCHIVE, BAD_PROJECT, NO_PROJECT_DIR, DEVICE_NOT_AVAILABLE = 0x30003000, DEVICE_ASYNC, DEVICE_BUSY, DEVICE_FORMAT, DEVICE_BUFFER, DEVICE_LATENCY, DEVICE_CHANNELS, DEVICE_FREQUENCY, DEVICES_MISMATCH, WAVE_NOT_FOUND = 0x30004000, INVALID_PROPERTY, INVALID_MIDI_CONTROL, OPERATION_BUSY }
Enum representing Error states.
enum class MusicalTuning: uint8 { OD_12_TET, OD_7_TET, OD_5_TET, DIATONIC_SCALE, INDIAN_SCALE, PYTHAGOREAN_TUNING, PENTATONIC_5_LIMIT, PENTATONIC_BLUES, PENTATONIC_GOGO, QUARTER_COMMA_MEANTONE, SILBERMANN_SORGE, WERCKMEISTER_3, WERCKMEISTER_4, WERCKMEISTER_5, WERCKMEISTER_6, KIRNBERGER_3, YOUNG }
Musical tunings, see: http://en.wikipedia.org/wiki/Musical_tuning.

Functions

auto ase_error_blurb(Error error) →  const char*
Describe Error condition.
auto operator+=(ChoiceS& choices, Choice&& newchoice) →  ChoiceS&
Convenience ChoiceS construciton helper.

Variables

const char GUIONLY constexpr
GUI READABLE WRITABLE.
const char STANDARD constexpr
STORAGE GUI READABLE WRITABLE.
const char STORAGE constexpr
STORAGE READABLE WRITABLE.