Maxim Integrated 73M1866B/73M1966B FXOAPI - Manual (Page 18)

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046
18 Rev. 2.1
2.5 Hook Switch and Pulse Dial Related APIs
2.5.1 M1x66_HookSwitch
Description
Perform on/off-hook on the FXO channel.
Prototype
M1x66_RET M1x66_HookSwitch (
M1x66_HANDLE channel,
M1x66_HOOK_SWITCH hookSwitch );
Parameters
Data Type Name Description
M1x66_HANDLE channel Channel handle from FXO open channel.
M1x66_HOOK_SWITCH hookSwitch Type of hook switch requested.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successfully performed hook switch.
M1x66_FAILED – Failure.
2.5.2 M1x66_PulseDial
Description
Perform pulse dialing on the FXO channel. This API will bring the FXO channel off-hook then perform
pulse dialing with the digit string provided. Once the dialing is completed the FXO channel will remain
off-hook indefinitely, or until it is manually brought back on-hook.
Up to 30 numeric digits is supported. Valid numeric digit is from ASCII 0 to 9 (i.e., 0x30 to 0x39).
Prototype
M1x66_RET M1x66_PulseDial (
M1x66_HANDLE channel,
char *dialSting );
Parameters
Data Type Name Description
M1x66_HANDLE channel Channel handle from FXO open channel.
char *dialString Numeric dial string of up to 30 characters max.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successfully dialed.
M1x66_FAILED – Failure.