Unit Codec

From Ultibo.org
Jump to: navigation, search

Return to Unit Reference


Description


Ultibo Codec Interface unit

Constants



[Expand]
Codec specific constants CODEC_*


[Expand]
Codec device type CODEC_TYPE_*


[Expand]
Codec device state CODEC_STATE_*


[Expand]
Codec device flag CODEC_FLAG_*


[Expand]
Codec logging CODEC_LOG_*


Type definitions



Codec properties

[Expand]

PCodecProperties = ^TCodecProperties;

TCodecProperties = record

Codec enumeration callback

TCodecEnumerate = function(Codec:PCodecDevice; Data:Pointer):LongWord;

Codec notification callback

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

Codec device get properties

TCodecDeviceGetProperties = function(Codec:PCodecDevice; Properties:PCodecProperties):LongWord;

Codec device

[Expand]

PCodecDevice = ^TCodecDevice;

TCodecDevice = record


Public variables



Codec logging

CODEC_DEFAULT_LOG_LEVEL:LongWord = CODEC_LOG_LEVEL_DEBUG; Minimum level for Codec messages. Only messages with level greater than or equal to this will be printed.
CODEC_LOG_ENABLED:Boolean;


Function declarations



Initialization functions

[Expand]
procedure CodecInit;
Description: Initialize the Codec unit and Codec device table


Codec device functions

[Expand]
function CodecDeviceGetProperties(Codec:PCodecDevice; Properties:PCodecProperties):LongWord;
Description: Get the properties for the specified Codec device


[Expand]
function CodecDeviceCreate:PCodecDevice;
Description: Create a new Codec device entry


[Expand]
function CodecDeviceCreateEx(Size:LongWord):PCodecDevice;
Description: Create a new Codec device entry


[Expand]
function CodecDeviceDestroy(Codec:PCodecDevice):LongWord;
Description: Destroy an existing Codec device entry


[Expand]
function CodecDeviceRegister(Codec:PCodecDevice):LongWord;
Description: Register a new Codec device in the Codec device table


[Expand]
function CodecDeviceDeregister(Codec:PCodecDevice):LongWord;
Description: Deregister an Codec device from the Codec device table


[Expand]
function CodecDeviceFind(CodecId:LongWord):PCodecDevice;
Description: To be documented


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


[Expand]
function CodecDeviceFindByDescription(const Description:String):PCodecDevice; inline;
Description: To be documented


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


[Expand]
function CodecDeviceNotification(Codec:PCodecDevice; Callback:TCodecNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Codec helper functions

[Expand]
function CodecGetCount:LongWord;
Description: Get the current Codec device count


[Expand]
function CodecDeviceGetDefault:PCodecDevice;
Description: Get the current default Codec device


[Expand]
function CodecDeviceSetDefault(Codec:PCodecDevice):LongWord; 
Description: Set the current default Codec device


[Expand]
function CodecDeviceCheck(Codec:PCodecDevice):PCodecDevice;
Description: Check if the supplied Codec device is in the Codec device table


[Expand]
procedure CodecLog(Level:LongWord; Codec:PCodecDevice; const AText:String);
Description: To be documented


[Expand]
procedure CodecLogInfo(Codec:PCodecDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure CodecLogWarn(Codec:PCodecDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure CodecLogError(Codec:PCodecDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure CodecLogDebug(Codec:PCodecDevice; const AText:String); inline;
Description: To be documented


Return to Unit Reference