Unit Audio

Return to Unit Reference

Description

---

Ultibo Audio Interface unit

This unit provides both the Audio device interface and the generic USB audio device driver.

Constants

---

[Expand]

Audio specific constants AUDIO_*

AUDIO_NAME_PREFIX = 'Audio';

Name prefix for Audio Devices

[Expand]

Audio device types AUDIO_TYPE_*

AUDIO_TYPE_NONE = 0;

[Expand]

Audio device states AUDIO_STATE_*

AUDIO_STATE_DISABLED = 0;
AUDIO_STATE_ENABLED = 1;

[Expand]

Audio device flags AUDIO_FLAG_*

AUDIO_FLAG_NONE = $00000000;

[Expand]

Audio logging AUDIO_LOG_*

AUDIO_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;	Audio debugging messages
AUDIO_LOG_LEVEL_INFO = LOG_LEVEL_INFO;	Audio informational messages, such as a device being attached or detached
AUDIO_LOG_LEVEL_WARN = LOG_LEVEL_WARN;	Audio warning messages
AUDIO_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;	Audio error messages
AUDIO_LOG_LEVEL_NONE = LOG_LEVEL_NONE;	No Audio messages

Type definitions

---

Audio properties

[Expand]

PAudioProperties = ^TAudioProperties;

TAudioProperties = record

Flags:LongWord;

Device flags (eg AUDIO_FLAG_????)

Audio enumeration callback

TAudioEnumerate = function(Audio:PAudioDevice; Data:Pointer):LongWord;

Audio notification callback

TAudioNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Audio device get properties

TAudioDeviceGetProperties = function(Audio:PAudioDevice; Properties:PAudioProperties):LongWord;

Audio device

[Expand]

PAudioDevice = ^TAudioDevice;

TAudioDevice = record

Device Properties
Device:TDevice;	The Device entry for this Audio device
Audio Properties
AudioId:LongWord;	Unique Id of this Audio device in the Audio device table
AudioState:LongWord;	Audio device state (eg AUDIO_STATE_ENABLED)
DeviceGetProperties:TAudioDeviceGetProperties;	A Device specific DeviceGetProperties method implementing the standard Audio device interface (Or nil if the default method is suitable)
Driver Properties
Lock:TMutexHandle;	Device lock
Properties:TAudioProperties;	Device properties
Internal Properties
Prev:PAudioDevice;	Previous entry in Audio device table
Next:PAudioDevice;	Next entry in Audio device table

Public variables

---

Audio logging

AUDIO_DEFAULT_LOG_LEVEL:LongWord = AUDIO_LOG_LEVEL_DEBUG;

Minimum level for Audio messages. Only messages with level greater than or equal to this will be printed.

AUDIO_LOG_ENABLED:Boolean;

Function declarations

---

Initialization functions

[Expand]

procedure AudioInit;

Description: Initialize the Audio unit and Audio device table

Note	Called only during system startup

Audio device functions

[Expand]

function AudioDeviceGetProperties(Audio:PAudioDevice; Properties:PAudioProperties):LongWord;

Description: Get the properties for the specified Audio device

Audio	The Audio device to get properties from
Properties	Pointer to a TAudioProperties structure to fill in
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function AudioDeviceCreate:PAudioDevice;

Description: Create a new Audio device entry

Return	Pointer to new Audio device entry or nil if Audio device could not be created

[Expand]

function AudioDeviceCreateEx(Size:LongWord):PAudioDevice;

Description: Create a new Audio device entry

Size	Size in bytes to allocate for new Audio device (Including the Audio device entry)
Return	Pointer to new Audio device entry or nil if Audio device could not be created

[Expand]

function AudioDeviceDestroy(Audio:PAudioDevice):LongWord;

Description: Destroy an existing Audio device entry

Note	None documented

[Expand]

function AudioDeviceRegister(Audio:PAudioDevice):LongWord;

Description: Register a new Audio device in the Audio device table

Note	None documented

[Expand]

function AudioDeviceDeregister(Audio:PAudioDevice):LongWord;

Description: Deregister an Audio device from the Audio device table

Note	None documented

[Expand]

function AudioDeviceFind(AudioId:LongWord):PAudioDevice;

Description: To be documented

Note	None documented

[Expand]

function AudioDeviceFindByName(const Name:String):PAudioDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function AudioDeviceFindByDescription(const Description:String):PAudioDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function AudioDeviceEnumerate(Callback:TAudioEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function AudioDeviceNotification(Audio:PAudioDevice; Callback:TAudioNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	None documented

Audio helper functions

[Expand]

function AudioGetCount:LongWord;

Description: Get the current Audio device count

Note	None documented

[Expand]

function AudioDeviceGetDefault:PAudioDevice;

Description: Get the current default Audio device

Note	None documented

[Expand]

function AudioDeviceSetDefault(Audio:PAudioDevice):LongWord;

Description: Set the current default Audio device

Note	None documented

[Expand]

function AudioDeviceCheck(Audio:PAudioDevice):PAudioDevice;

Description: Check if the supplied Audio device is in the Audio device table

Note	None documented

[Expand]

procedure AudioLog(Level:LongWord; Audio:PAudioDevice; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure AudioLogInfo(Audio:PAudioDevice; const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure AudioLogWarn(Audio:PAudioDevice; const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure AudioLogError(Audio:PAudioDevice; const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure AudioLogDebug(Audio:PAudioDevice; const AText:String); inline;

Description: To be documented

Note	None documented

Return to Unit Reference