Unit I2S

From Ultibo.org
Jump to: navigation, search

Return to Unit Reference


Description


Ultibo I2S/PCM Interface unit

Constants



[Expand]
I2S specific constants I2S_*


[Expand]
I2S device types I2S_TYPE_*


[Expand]
I2S device states I2S_STATE_*


[Expand]
I2S device flags I2S_FLAG_*


[Expand]
I2S logging I2S_LOG_*


Type definitions



I2S properties

[Expand]

PI2SProperties = ^TI2SProperties;

TI2SProperties = record

I2S enumeration callback

TI2SEnumerate = function(I2S:PI2SDevice; Data:Pointer):LongWord;

I2S notification callback

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

I2S device get properties

TI2SDeviceGetProperties = function(I2S:PI2SDevice; Properties:PI2SProperties):LongWord;

I2S device

[Expand]

PI2SDevice = ^TI2SDevice;

TI2SDevice = record


Public variables



I2S logging

I2S_DEFAULT_LOG_LEVEL:LongWord = I2S_LOG_LEVEL_DEBUG; Minimum level for I2S messages. Only messages with level greater than or equal to this will be printed.
I2S_LOG_ENABLED:Boolean;


Function declarations



Initialization functions

[Expand]
procedure I2SInit;
Description: To be documented


I2S functions

[Expand]
function I2SDeviceGetProperties(I2S:PI2SDevice; Properties:PI2SProperties):LongWord;
Description: To be documented


[Expand]
function I2SDeviceCreate:PI2SDevice;
Description: Create a new I2S entry


[Expand]
function I2SDeviceCreateEx(Size:LongWord):PI2SDevice;
Description: Create a new I2S entry


[Expand]
function I2SDeviceDestroy(I2S:PI2SDevice):LongWord;
Description: Destroy an existing I2S entry


[Expand]
function I2SDeviceRegister(I2S:PI2SDevice):LongWord;
Description: Register a new I2S in the I2S table


[Expand]
function I2SDeviceDeregister(I2S:PI2SDevice):LongWord;
Description: Deregister a I2S from the I2S table


[Expand]
function I2SDeviceFind(I2SId:LongWord):PI2SDevice;
Description: To be documented


[Expand]
function I2SDeviceFindByName(const Name:String):PI2SDevice; inline;
Description: To be documented


[Expand]
function I2SDeviceFindByDescription(const Description:String):PI2SDevice; inline;
Description: To be documented


[Expand]
function I2SDeviceEnumerate(Callback:TI2SEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand]
function I2SDeviceNotification(I2S:PI2SDevice; Callback:TI2SNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


I2S helper functions

[Expand]
function I2SGetCount:LongWord;
Description: Get the current I2S count


[Expand]
function I2SDeviceGetDefault:PI2SDevice;
Description: Get the current default I2S device


[Expand]
function I2SDeviceSetDefault(I2S:PI2SDevice):LongWord;
Description: Set the current default I2S device


[Expand]
function I2SDeviceCheck(I2S:PI2SDevice):PI2SDevice;
Description: Check if the supplied I2S is in the I2S table


[Expand]
procedure I2SLog(Level:LongWord; I2S:PI2SDevice; const AText:String);
Description: To be documented


[Expand]
procedure I2SLogInfo(I2S:PI2SDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure I2SLogWarn(I2S:PI2SDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure I2SLogError(I2S:PI2SDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure I2SLogDebug(I2S:PI2SDevice; const AText:String); inline;
Description: To be documented


Return to Unit Reference