AG Access Function Reference Manual

P/N PN/ 6197-12


(Page 1 of 1 in this chapter)

Table of Contents

1 Introduction

1.1 About AG Access
1.2 Basic Terminology
1.3 About this Manual
1.3.1 Organization
1.4 Related Documents
1.5 Developer Support

2 Function Summary

2.1 Introduction
2.2 Managing Ports, Contexts and Protocols
2.3 Processing Events
2.4 Call Control
2.5 Voice Record and Play
2.5.1 Play and Record Functions
2.5.2 Terminating Play or Record Operations
2.5.3 Buffer Management Functions
2.5.4 Status and Modification Functions
2.6 Collecting Digits (DTMFs)
2.7 Generating Tones and DTMFs
2.8 Detecting DTMFs and MFs
2.9 Echo Cancellation
2.10 Detecting Energy and Specific Tones
2.11 Managing Call Progress Analysis
2.12 Sending and Receiving Frequency Shift Key (FSK) Data
2.13 Low-level Call Control Functions
2.14 Using an On-Board Timer
2.15 Managing Parameters
2.16 Handling Errors
2.17 Utility Functions

3 Alphabetical Function Reference

3.1 Introduction

adiAnswerCall 26

adiAssertSignal 28

adiBlockCalls 30

adiCloseDriver 32

adiClosePort 33

adiCollectDigits 35

adiConfigParm 39

adiFetchAndProcess 41

adiFlushDigitQueue 45

adiGetBoardInfo 47

adiGetBoardSlots 50

adiGetCallStatus 53

adiGetContextInfo 57

adiGetDigit 60

adiGetEEPromData 62

adiGetEncodingInfo 64

adiGetErrorText 66

adiGetEventText 68

adiGetParmByName 69

adiGetParmInfo 71

adiGetParms 76

adiGetPlayStatus 78

adiGetRecordStatus 81

adiGetTimeStamp 84

adiGetVersion 86

adiLoopbackEvent 88

adiModifyPlayGain 89

adiModifyPlaySpeed 92

adiOpenDriver 93

adiOpenPort 95

adiPeekDigit 98

adiPlaceCall 99

adiPlaceSecondCall 106

adiPlayAsync 109

adiPlayFromMemory 113

adiQuerySignalState 116

adiRecordAsync 118

adiRecordToMemory 123

adiRejectCall 128

adiReleaseCall 130

adiReleaseSecondCall 132

adiSetErrorHandler 133

adiStartCallProgress 135

adiStartDial 140

adiStartDTMF 144

adiStartDTMFDetector 146

adiStartEnergyDetector 148

adiStartMFDetector 150

adiStartPlaying 153

adiStartProtocol 159

adiStartPulse 165

adiStartReceivingFSK 167

adiStartRecording 170

adiStartSendingFSK 176

adiStartSignalDetector 179

adiStartTimer 183

adiStartToneDetector 185

adiStartTones 189

adiStopCallProgress 193

adiStopCollection 195

adiStopDial 196

adiStopDTMFDetector 198

adiStopEnergyDetector 200

adiStopMFDetector 202

adiStopPlaying 204

adiStopProtocol 205

adiStopReceivingFSK 207

adiStopRecording 208

adiStopSendingFSK 209

adiStopSignalDetector 210

adiStopTimer 212

adiStopToneDetector 214

adiStopTones 216

adiSubmitPlayBuffer 218

adiSubmitRecordBuffer 221

adiTransferCall 224

adiUnBlockCalls 227

Appendix A Error Summary

Introduction
About Error Codes
About DONE Events
Errors Ordered Alphabetically
Error Codes Ordered By Value

Appendix B Event Summary

Introduction
About the Event Data Structure
About DONE Events
Events Ordered Alphabetically
Events Ordered by Numerical Value
Events Ordered by Category
Administrative Events
Call Control Events
Play and Record Events
DTMF Events
MF Events
Call Progress Events
Tone Detector Events
Call Control Primitives
Miscellaneous Events

Appendix C Telephony Protocols

Introduction
About Executing Telephony Protocols
NOCC
Parameter Structure
Direct Inward Dial (DID)
Parameter Structure
Parsing DID digits for ANI
Feature Group D (FDI)
Parameter Structure
Ground-Start (GST)
Parameter Structure
Using Release Guard
Using Precise Dial Tone Detection
Loop-Start (LPS)
Parameter Structure
Using Caller ID with the Loop-Start Protocol
Using Release Guard
Using Precise Dial Tone Detection
Outgoing Trunk (OGT)
Parameter Structure
Wink-Start (WNK)
Parameter Structure
Parsing DID digits for ANI

Appendix D Parameters

Introduction
Function Parameters
Trunk Control Program Parameters

Appendix E DSP Files

Introduction
Summary of DSP Files

Appendix F Low-Level AG Functions

Introduction

adiGetAGMessage 311

adiRetractAGBuffer 313

adiSendAGMessage 314



(Page 1 of 1 in this chapter)


Tech_Support@nmss.com
Copyright © 1996, Natural MicroSystems, Inc. All rights reserved.