#include <ase/member.hh>
#include <ase/value.hh>

Go to the source code of this file.

Classes
class	Ase::SharedBase
	Common base type for polymorphic classes managed by `std::shared_ptr<>`. More...

struct	Ase::Choice
	Representation of one possible choice for selection properties. More...

struct	Ase::TelemetryField
	Telemetry segment location. More...

class	Ase::Emittable
	Base type for classes with Event subscription. More...

struct	Ase::Emittable::Connection

class	Ase::Property
	A Property allows querying, setting and monitoring of an object property. More...

class	Ase::Object
	Base type for classes with Property interfaces. More...

class	Ase::Gadget
	Base type for classes that have a Property. More...

struct	Ase::DeviceInfo
	Info for device types. More...

class	Ase::Device
	Interface to access Device instances. More...

class	Ase::NativeDevice
	Interface to access NativeDevice instances. More...

struct	Ase::ClipNote
	Part specific note event representation. More...

class	Ase::Clip
	Container for MIDI note and control events. More...

class	Ase::Track
	Container for Clip objects and sequencing information. More...

struct	Ase::ProbeFeatures
	Bits representing a selection of probe sample data features. More...

class	Ase::Monitor
	Interface for monitoring output signals. More...

class	Ase::Project
	Projects support loading, saving, playback and act as containers for all other sound objects. More...

struct	Ase::Resource
	Description of a resource, possibly nested. More...

class	Ase::ResourceCrawler
	Helper to crawl hierarchical resources. More...

struct	Ase::UserNote
	Contents of user interface notifications. More...

struct	Ase::TelemetrySegment
	Telemetry segment location. More...

class	Ase::Server
	Central singleton, serves as API entry point. More...

Namespaces
namespace	Ase
	The Anklang C++ API namespace.

Macros
#define	ASE_SERVER

Enumerations
enum class	Ase::Error : int32_t { NONE , PERMS , IO , NO_MEMORY , NO_SPACE , NO_FILES , MANY_FILES , RETRY , NOT_DIRECTORY , FILE_NOT_FOUND , FILE_IS_DIR , FILE_EXISTS , FILE_BUSY , INTERNAL , UNIMPLEMENTED , FILE_EOF , FILE_OPEN_FAILED , FILE_SEEK_FAILED , FILE_READ_FAILED , FILE_WRITE_FAILED , PARSE_ERROR , 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 , DEVICE_ASYNC , DEVICE_BUSY , DEVICE_FORMAT , DEVICE_BUFFER , DEVICE_LATENCY , DEVICE_CHANNELS , DEVICE_FREQUENCY , DEVICES_MISMATCH , WAVE_NOT_FOUND , INVALID_PROPERTY , INVALID_MIDI_CONTROL , OPERATION_BUSY }
	Enum representing Error states. More...

enum class	Ase::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. More...

enum class	ResourceType { FOLDER , FILE }

Functions
constexpr bool	Ase::operator== (Error v, int64_t n)

constexpr bool	Ase::operator== (int64_t n, Error v)

constexpr bool	Ase::operator!= (Error v, int64_t n)

constexpr bool	Ase::operator!= (int64_t n, Error v)

constexpr bool	Ase::operator! (Error error)

const char *	Ase::ase_error_blurb (Error error)
	Describe Error condition.

Error	Ase::ase_error_from_errno (int sys_errno, Error fallback=Error::IO)

constexpr bool	Ase::operator== (MusicalTuning v, int64_t n)

constexpr bool	Ase::operator== (int64_t n, MusicalTuning v)

constexpr bool	Ase::operator!= (MusicalTuning v, int64_t n)

constexpr bool	Ase::operator!= (int64_t n, MusicalTuning v)

ChoiceS &	Ase::operator+= (ChoiceS &choices, Choice &&newchoice)
	Convenience ChoiceS construction helper.

Variables
constexpr const char	Ase::GUIONLY []
	GUI READABLE WRITABLE.

constexpr const char	Ase::STORAGE []
	STORAGE READABLE WRITABLE.

constexpr const char	Ase::STANDARD []
	STORAGE GUI READABLE WRITABLE.

Class Documentation

◆ Ase::TelemetryField

struct Ase::TelemetryField

Telemetry segment location.

Definition at line 113 of file api.hh.

Class Members
int32	length	Length in bytes.
String	name	Names like "bpm", etc.
int32	offset	Position in bytes.
String	type	Types like "i32", "f32", "f64".

◆ Ase::DeviceInfo

struct Ase::DeviceInfo

Info for device types.

Definition at line 203 of file api.hh.

Class Members
String	category	Category to allow grouping for processors of similar function.
String	creator_name	Name of the creator.
String	creator_url	Internet contact of the creator.
String	description	Elaborate description for help dialogs.
String	name	Preferred user interface name.
String	uri	Unique identifier for de-/serialization.
String	website_url	Website of/about this Processor.

◆ Ase::ProbeFeatures

struct Ase::ProbeFeatures

Bits representing a selection of probe sample data features.

Definition at line 297 of file api.hh.

Class Members
bool	probe_energy	Provide sample energy measurement.
bool	probe_fft	Provide FFT analysis probe.
bool	probe_range	Provide sample range probes.
bool	probe_samples	Provide probe with bare sample values.

◆ Ase::Resource

struct Ase::Resource

Description of a resource, possibly nested.

Definition at line 359 of file api.hh.

Class Members
String	label	UI display name.
int64	mtime	Modification time in milliseconds.
int64	size	Resource size.
ResourceType	type	Resource classification.
String	uri	Unique resource identifier.

◆ Ase::TelemetrySegment

struct Ase::TelemetrySegment

Telemetry segment location.

Definition at line 394 of file api.hh.

Class Members
int32	length	Length in bytes.
int32	offset	Position in bytes.

Macro Definition Documentation

◆ ASE_SERVER

#define ASE_SERVER

Definition at line 433 of file api.hh.

Classes

Namespaces

Macros

Enumerations

Functions

Variables