This is an old revision of the document!
ezOrange API
Following is the Application Programming Interface (API) for the ezOrange application.
API 3.5
Added these functions to the existing 3.4 API:
Public Function SetParams(Arr: OleVariant); Public Function GetParams(): OleVariant; Public Function SetAudiogram(Audiogram: PSafeArray); Public Function GetAudiogram(): PSafearray; Public Function SetSerialNum(SerialNum: string); Public Function GetSerialNum(): string;
Return or Set values for GetInterface() and SetInterface() routines:
| Code | Value | Description |
|---|---|---|
| 0 | Simulation | There is no programmer interface. |
| 1 | HiPro | HiPro is programmer interface. |
| 2 | EMiniTec | EMiniTec is programmer interface. |
Audiogram array to pass to Optimizer (SetAudiogram() and GetAudiogram()):
| Index | Frequency |
|---|---|
| 0 | 250 |
| 1 | 500 |
| 2 | 750 |
| 3 | 1000 |
| 4 | 1500 |
| 5 | 2000 |
| 6 | 3000 |
| 7 | 4000 |
| 8 | 6000 |
| 9 | 8000 |
For SetParams(), GetParams(), and GetEthosParams(), array format for Ethos-based circuit:
paramsArray[0] := BEQ1_gain; paramsArray[1] := BEQ2_gain; paramsArray[2] := BEQ3_gain; paramsArray[3] := BEQ4_gain; paramsArray[4] := BEQ5_gain; paramsArray[5] := BEQ6_gain; paramsArray[6] := BEQ7_gain; paramsArray[7] := BEQ8_gain; paramsArray[8] := BEQ9_gain; paramsArray[9] := BEQ10_gain; paramsArray[10] := BEQ11_gain; paramsArray[11] := BEQ12_gain; paramsArray[12] := C1_MPO; paramsArray[13] := C2_MPO; paramsArray[14] := C3_MPO; paramsArray[15] := C4_MPO; paramsArray[16] := C5_MPO; paramsArray[17] := C6_MPO; paramsArray[18] := C7_MPO; paramsArray[19] := C8_MPO; paramsArray[20] := C1_Ratio; paramsArray[21] := C2_Ratio; paramsArray[22] := C3_Ratio; paramsArray[23] := C4_Ratio; paramsArray[24] := C5_Ratio; paramsArray[25] := C6_Ratio; paramsArray[26] := C7_Ratio; paramsArray[27] := C8_Ratio; paramsArray[28] := C1_TK; paramsArray[29] := C2_TK; paramsArray[30] := C3_TK; paramsArray[31] := C4_TK; paramsArray[32] := C5_TK; paramsArray[33] := C6_TK; paramsArray[34] := C7_TK; paramsArray[35] := C8_TK; paramsArray[36] := FBC_Enable; paramsArray[37] := input_mux; paramsArray[38] := matrix_gain; paramsArray[39] := Noise_Reduction; paramsArray[40] := preamp_gain0; paramsArray[41] := preamp_gain1; paramsArray[42] := TimeConstants;
API 3.4
Public Function SetShowForm(ByVal Visible As Boolean) As Integer Public Function GetShowForm() As Boolean Public Function SetEar(ByVal index As Integer) As Integer Public Function GetEar() As Integer Public Function SetMemory(ByVal index As Integer) As Integer Public Function GetMemory() As Integer Public Function SetInterface(ByVal index As Integer) As Integer Public Function GetInterface() As Integer Public Function SetHAIntialize() As Integer Public Function SetHARead() As Integer Public Function SetHAWrite() As Integer Public Function SetHABurn() As Integer Public Function SetHAClose() As Integer Public Function GetHAIntialized() As Boolean Public Function SetBumpQ(ByVal index As Integer) As Integer Public Function GetBumpQ(ByRef Value as Single) As Integer Public Function SetBumpGain(ByVal index As Integer) As Integer Public Function GetBumpGain(ByRef Value as Single) As Integer Public Function SetBumpCF(ByVal index As Integer) As Integer Public Function GetBumpCF(ByRef Value as Single) As Integer Public Function SetTiltCF(ByVal index As Integer) As Integer Public Function GetTiltCF(ByRef Value as Single) As Integer Public Function SetTiltSlope(ByVal index As Integer) As Integer Public Function GetTiltSlope(ByRef Value as Single) As Integer Public Function SetGain(ByVal index As Integer) As Integer Public Function GetGain(ByRef Value as Single) As Integer Public Function SetBias(Bias As Integer) As Integer Public Function GetBias(Bias As Integer) As Integer Public Function SetSilentErrors(ByVal Silent As Boolean) As Integer Public Function GetSilentErrors() As Boolean Public Sub GetEthosArray(arr() As Long) Public Function SetCompression( ByVal BumpGain60 As Integer, ByVal BumpQ60 As Integer, ByVal BumpCF60 As Integer, ByVal TiltSlope60 As Integer, ByVal OverallGain60 As Integer, ByVal Bias60 as integer ByVal BumpGain80 As Integer, ByVal BumpQ80 As Integer, ByVal BumpCF80 As Integer, ByVal TiltSlope80 As Integer, ByVal OverallGain80 As Integer ByVal GainBias80 as Integer ) As Integer
Ethos Error Values
| Error Code | Error Description |
|---|---|
| 0 | Ethos OK |
| 1 | Ethos NoProgrammer |
| 2 | Ethos NoInstrument |
| 3 | Ethos BadArgument |
| 4 | Ethos NotInitialized |
| 5 | Ethos NotRead |
| 6 | Ethos ChecksumError |
| 7 | Ethos InvalidVersion |
| 8 | Ethos ProgrammerError |
| 9 | Ethos CMFError |
| 10 | Ethos WrongInstrument |
| 11 | Ethos BootError |
| 12 | Ethos NoNLDriver |
| 13 | Ethos NLInUse |
API 1.1
Public Function SetShowForm(ByVal Visible As Boolean) As Integer Public Function GetShowForm() As Boolean Public Function SetEar(ByVal index As Integer) As Integer Public Function GetEar() As Integer Public Function SetMemory(ByVal index As Integer) As Integer Public Function GetMemory() As Integer Public Function SetInterface(ByVal index As Integer) As Integer Public Function GetInterface() As Integer Public Function SetHAIntialize() As Integer Public Function SetHARead() As Integer Public Function SetHAWrite() As Integer Public Function SetHABurn() As Integer Public Function SetHAClose() As Integer Public Function GetHAIntialized() As Boolean Public Function SetBumpQ(ByVal index As Integer) As Integer Public Function GetBumpQ(ByRef Value as Single) As Integer Public Function SetBumpGain(ByVal index As Integer) As Integer Public Function GetBumpGain(ByRef Value as Single) As Integer Public Function SetBumpCF(ByVal index As Integer) As Integer Public Function GetBumpCF(ByRef Value as Single) As Integer Public Function SetTiltCF(ByVal index As Integer) As Integer Public Function GetTiltCF(ByRef Value as Single) As Integer Public Function SetTiltSlope(ByVal index As Integer) As Integer Public Function GetTiltSlope(ByRef Value as Single) As Integer Public Function SetGain(ByVal index As Integer) As Integer Public Function GetGain(ByRef Value as Single) As Integer Public Function SetSilentErrors(ByVal Silent As Boolean) As Integer Public Function GetSilentErrors() As Boolean
Ethos Error Values
| Error Code | Error Description |
|---|---|
| 0 | Ethos OK |
| 1 | Ethos NoProgrammer |
| 2 | Ethos NoInstrument |
| 3 | Ethos BadArgument |
| 4 | Ethos NotInitialized |
| 5 | Ethos NotRead |
| 6 | Ethos ChecksumError |
| 7 | Ethos InvalidVersion |
| 8 | Ethos ProgrammerError |
| 9 | Ethos CMFError |
| 10 | Ethos WrongInstrument |
| 11 | Ethos BootError |
| 12 | Ethos NoNLDriver |
| 13 | Ethos NLInUse |
API 1.0
Following is the Application Programming Interface for the ezOrange application.
Public Function SetShowForm(ByVal Visible As Boolean) As Integer Public Function GetShowForm() As Boolean Public Function SetEar(ByVal index As Integer) As Integer Public Function GetEar() As Integer Public Function SetMemory(ByVal index As Integer) As Integer Public Function GetMemory() As Integer Public Function SetHAInitialize() As Integer Public Function SetHARead() As Integer Public Function SetHAWrite() As Integer Public Function SetHABurn() As Integer Public Function SetHAClose() As Integer Public Function SetBumpQ(ByVal index As Integer) As Integer Public Function GetBumpQ() As Integer Public Function SetBumpGain(ByVal index As Integer) As Integer Public Function GetBumpGain() As Integer Public Function SetBumpCF(ByVal index As Integer) As Integer Public Function GetBumpCF() As Integer Public Function SetTiltCF(ByVal index As Integer) As Integer Public Function GetTiltCF(ByVal index As Integer) As Integer Public Function SetTiltSlope(ByVal index As Integer) As Integer Public Function GetTiltSlope() As Integer Public Function SetGain(ByVal index As Integer) As Integer Public Function GetGain() As Integer