Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
ezfit:clarujust:ezorange_api [2009/11/17 12:23] smayr |
ezfit:clarujust:ezorange_api [2009/11/20 16:52] (current) smayr |
||
---|---|---|---|
Line 2: | Line 2: | ||
Following is the Application Programming Interface (API) for the ezOrange application. | Following is the Application Programming Interface (API) for the ezOrange application. | ||
- | == Interfaces | + | === API 3.6 === |
+ | <code vb> | ||
+ | '// NOTE: All returns are Error Codes | ||
+ | function SetInterface(ProgIntfIdx: | ||
+ | function GetInterface(var ProgIntfIdx: | ||
- | == Function Prototypes == | + | '//--- Not used by Clarujust --- |
+ | function SetEar(EarSideIdx: | ||
+ | function GetEar(): Integer; safecall; | ||
+ | function SetMemory(MemIdx: | ||
+ | function GetMemory(): | ||
+ | function SetHAInitialize(): | ||
+ | function SetHARead(): | ||
+ | function SetHAWrite(): | ||
+ | function SetHABurn(): | ||
+ | function SetHAClose(): | ||
+ | procedure SetParams(Params: | ||
+ | function GetParams: OleVariant; safecall; // Not needed by Clarujust | ||
+ | procedure LaunchClarujustApp(); | ||
+ | |||
+ | '//--- Debugging --- | ||
+ | function SetSilentErrors(Silent: | ||
+ | function GetSilentErrors(): | ||
+ | |||
+ | '//--- Bump, Tilt, and Gain --- | ||
+ | function SetBumpQ(BumpQIdx: | ||
+ | function GetBumpQ(var BumpQIdx: Integer, var BumpQVal: Single): Integer; safecall; | ||
+ | function SetBumpGain(BumpGainIdx: | ||
+ | function GetBumpGain(var BumpQIdx: Integer, var BumpGainVal: | ||
+ | function SetBumpCF(BumpCFIdx: | ||
+ | function GetBumpCF(var BumpCFIdx: Integer, var BumpCFVal: Single): Integer; safecall; | ||
+ | function SetTiltCF(TiltCFIdx: | ||
+ | function GetTiltCF(var TiltCFIdx: Integer, var TiltCFVal: Single): Integer; safecall; | ||
+ | function SetTiltSlope(TiltSlopeIdx: | ||
+ | function GetTiltSlope(var TiltSlopeIdx: | ||
+ | function SetGain(GainIdx: | ||
+ | function GetGain(var GainIdx: Integer, var GainVal: Single): Integer; safecall; | ||
+ | function SetBias(Bias: | ||
+ | function GetBias(var Bias: Integer): Integer; safecall; | ||
+ | function GetEthosArray(out Arr: PSafeArray): | ||
+ | |||
+ | function SetCompression(BumpGain60: | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | '//--- Revised functionality --- | ||
+ | function SetAudiogram(AnAudiogram: | ||
+ | function GetAudiogram(var AnAudiogram: | ||
+ | |||
+ | function SetSerialNumber(SerialNum: | ||
+ | function GetSerialNumber(var SerialNumber: | ||
+ | |||
+ | '//--- New functionality --- | ||
+ | function Setup60(): Integer; safecall; | ||
+ | function Setup80(): Integer; safecall; | ||
+ | function ApplySettings: | ||
+ | function GetHAInitialized(var IsInitialized: | ||
+ | function GetEarCount(var EarCount: Integer) : Integer; safecall; | ||
+ | |||
+ | </ | ||
=== API 3.5 === | === API 3.5 === | ||
Line 159: | Line 217: | ||
== Data Types == | == Data Types == | ||
+ | ==== Programming Interface ==== | ||
Return or Set values for '' | Return or Set values for '' | ||
^ Code ^ Value ^ Description ^ | ^ Code ^ Value ^ Description ^ | ||
Line 165: | Line 224: | ||
| 2 | EMiniTec | | 2 | EMiniTec | ||
+ | ==== Audiogram ==== | ||
Audiogram array to pass to Optimizer ('' | Audiogram array to pass to Optimizer ('' | ||
^ Index ^ Frequency ^ | ^ Index ^ Frequency ^ | ||
Line 178: | Line 238: | ||
| 9 | | 9 | ||
+ | ==== Circuit Parameters ==== | ||
For '' | For '' | ||
<code delphi> | <code delphi> | ||
Line 229: | Line 290: | ||
</ | </ | ||
- | ==== Ethos Error Values | + | ==== Circuit I/O Operation |
- | ^ Error Code ^ Error Description ^ | + | ^ Error Value ^ Error Code ^ Error Description ^ |
- | | 0 | Ethos OK | | + | | 0 |
- | | 1 | Ethos NoProgrammer | | + | | 1 |
- | | 2 | Ethos NoInstrument | | + | | 2 |
- | | 3 | Ethos BadArgument | | + | | 3 |
- | | 4 | Ethos NotInitialized | | + | - Invalid programming interface |
- | | 5 | Ethos NotRead | | + | - Invalid platformID specified |
- | | 6 | Ethos ChecksumError | | + | - Invalid program specified |
- | | 7 | Ethos InvalidVersion | | + | - Invalid channel specified |
- | | 8 | Ethos ProgrammerError | | + | - Invalid data in params or config structure |
- | | 9 | Ethos CMFError | | + | - Page argument invalid</ |
- | | 10 | Ethos WrongInstrument | | + | | 4 |
- | | 11 | Ethos BootError | | + | | 5 |
- | | 12 | Ethos NoNLDriver | | + | | 6 |
- | | 13 | Ethos NLInUse | | + | | 7 |
+ | | 8 | ||
+ | | 9 | ||
+ | | 10 | WrongInstrument | ||
+ | | 11 | BootError | ||
+ | | 12 | NoNLDriver | ||
+ | | 13 | NLInUse | ||