AWE Core OS 8.B.19 Documentation
Data Structures | Macros | Typedefs | Enumerations
AWECoreOS Types

Data Structures

struct  AWEOSAudioRecordNotification
 Audio recording notification callback argument structure. More...
 
struct  AWEOSThreadPIDs
 Internal threading PID structure, meant to be used with aweOS_getThreadPIDs. More...
 
struct  AWEOSVersionInfo
 Versioning structure returned by aweOS_getVersion. More...
 
struct  AWEOSConfigParameters
 AWEOSConfigParameters. More...
 

Macros

#define TUNING_LOG_ERROR   1
 AWE Core OS internal tuning interface logging verbosity level: low – log only errors.
 
#define TUNING_LOG_INFO   2
 AWE Core OS internal tuning interface logging verbosity level: medium – log errors and header info from all packets sent and received.
 
#define TUNING_LOG_DATA   3
 AWE Core OS internal tuning interface logging verbosity level: high –log errors, header info and raw packet content for all packets.
 
#define AUDIO_RECORDING_NOTIFICATION_ERRORS   (1 << 0)
 Audio recording: Notify only on errors.
 
#define AUDIO_RECORDING_NOTIFICATION_XRUNS   (1 << 1)
 Audio recording: Notify only on overruns.
 
#define AUDIO_RECORDING_NOTIFICATION_ALL   (AUDIO_RECORDING_NOTIFICATION_ERRORS | AUDIO_RECORDING_NOTIFICATION_XRUNS)
 Audio recording: Notify on errors and overruns.
 

Typedefs

typedef struct AWEOSAudioRecordNotification AWEOSAudioRecordNotification_t
 Audio recording notification callback argument structure.
 
typedef void(* recordNotificationCallbackFunction) (AWEOSAudioRecordNotification_t *)
 Audio recording notification callback type.
 
typedef struct AWEOSThreadPIDs AWEOSThreadPIDs_t
 Internal threading PID structure, meant to be used with aweOS_getThreadPIDs.
 
typedef struct AWEOSVersionInfo AWEOSVersionInfo_t
 Versioning structure returned by aweOS_getVersion.
 
typedef void AWEOSInstance
 The AWE Core OS Instance instance type. More...
 
typedef struct AWEOSConfigParameters AWEOSConfigParameters
 AWEOSConfigParameters. More...
 

Enumerations

enum  STATUS { ERROR , INPUT_OVERRUN , OUTPUT_OVERRUN }
 Audio recording notification status type.
 

Detailed Description

Typedef Documentation

◆ AWEOSInstance

typedef void AWEOSInstance

The AWE Core OS Instance instance type.

The instance itself is opaque, and it is configured with aweOS_getParamDefaults and aweOS_init. This handle will be passed to most API functions. Multi Instance integrations can utilize an array of AWEOSInstances (see the MultiInstance example app)

◆ AWEOSConfigParameters

AWEOSConfigParameters.

The AWE Core OS Configuration Parameter Structure

This structure will hold the config parameters for the AWE Core OS instance. A user must create one of these per AWEOSInstance, and either populate it in manually, or call the aweOS_getParamDefaults to populate it with defaults. Once the structure has been configured, it is passed in to the aweOS_init function with an AWEOSInstance, and the instance is initialized with the given configuration parameters. The heap pointers, pPacketBuffer and pReplyBuffer will be assigned to NULL when calling aweOS_getParamDefaults. If they are not overwritten by user, then memory is allocated in aweOS_init. Internally allocated heap sizes can be controlled via the heapSize configuration parameters.