Dialogic® API Helpweb

Dialogic® Global Call & R4 APIs - Overview & Documentation

The documentation for the Programming Libraries of the following Dialogic® products is found on the respective product release documentation page

Overview of the Dialogic® Global Call and R4 family of APIs


The following table summarizes details regarding the libraries that make up the Dialogic® Global Call / R4 family of APIs.
API Purpose Technologies Use with
(examples)
Dialogic®
Products
Notes and example manuals *
SRL
System Runtime Library
Asynchronous event processing
Provide a common interface for event handling and other functionality common to all devices
Analog, TDM and IP All APIs if they are used asynchronously, except GC-SS7   SRL API Library Reference*
SRL API Programming Guide (Windows)*
SRL API Programming Guide (Linux)*
GC - 1PCC
Global Call -
First Party Call Control
Call control
High level call control - signaling and media transport
Analog, TDM and IP Media processing HMP, DMV, DMIP, MMP, JCT Global Call API Library Reference*
Global Call API Programming Guide (HMP)*
Global Call E1/T1 CAS/R2 Technology Guide*
GC - 3PCC
Global Call -
Third Party Call Control
Call control
High level call control - signaling (SIP) only
IP (SIP) only Media transport and media processing HMP, DMIP, MMP Global Call IP Technology Guide *
SDP
SIP SDP parsing
convenience library
Call Control
These are convenience functions that can be used to parse and build the media description part of SIP messages
IP (SIP) only GC and 3PCC HMP, DMIP, MMP This is an easy alternative to writing your own SDP string handling functions. Source code included.
GC - SS7
Global Call -
SS7 ISUP Layer
Call Control
High level call control - abstracts lower level SS7 ISUP functionality into GC implementation
Signaling products SS7 and related signaling protocols Signaling Global Call SS7 Technology Guide*
GCT, getm, relm
Signaling Call Control
Transaction based services and advanced call control for signaling products SS7 and Sigtran related signaling protocols SS7 and related signaling protocols Signaling Provides a higher degree of functionality for call control compared to GC - SS7. Required for transaction based services.
Software Environment Programmer’s Manual – Issue 5 *
IPML
Internet Protocol Media Library
Media transport
Transport of audio and video over IP using Real Time Protocol (RTP)
IP only Global Call, 3rd party SRTP, SIP or H.323 stacks HMP, DMIP, MMP IP Media Library API Library Reference *
IP Media Library API Programming Guide*
M3G
3G-324M
Media transport
Transport of audio and video over TDM
TDM   HMP, MMP 3G-324M API Library Reference*
DX
Voice Library
Audio media endpoint
Voice record, play.  Tone detect and generate
Analog, TDM and IP Usually used with a call control and media transport API HMP, DMV, DMIP, MMP, JCT Voice API Library Reference (HMP/MMP)*
Voice API Programming Guide (HMP/MMP)*
MM
Multimedia Library
Audio/video media endpoint IP   HMP, MMP Multimedia API Library Reference*
Multimedia API Programming Guide*
FX
Fax Library
Fax media endpoint
Control over send and receive fax functions
T.38 fax for fax over IP. T.30 fax for analog and TDM   HMP, DMV, DMIP, MMP, JCT Fax Software Reference*
DCB
Synchronous Conferencing
Audio conferencing media endpoint
Audio conference mixing functions
Analog, TDM and IP HMP, DMV, DMIP Supported on DMV/DMIP.
Deprecated in HMP release
Audio Conferencing API Library Reference*
Audio Conferencing API Programming Guide*
CNF
Asynchronous Conferencing
Audio conferencing media endpoint
Audio conference mixing functions
TDM and IP   HMP, DMV, DMIP, MMP Video conferencing (future) will use this API
Deprecated on SR6.x PCI/cPCI release
Conferencing API Library Reference*
Conferencing API Programming Guide*
CSP
Continuous Speech Processing
Audio media adjunct
Used to deliver full duplex, echo-cancelled voice. Primarily used with Speech Recognition
Analog, TDM and IP DX - audio media endpoint in a record direction HMP, DMV, DMIP, MMP, JCT CSP API Library Reference*
CSP API Programming Guide*
MTK
Multimedia Toolkit API
Audio and Video Media adjunct
Used with Video conferencing for layout, image and text overlay, and stream manipulation
DM and IP mm, ipm,  M3G HMP, MMP Media Toolkit API Library Reference*
DEV
Device Management
Device connection
Manage connections between devices, allowing communications and sharing of resources
IP MM, IPM, T.38 Fax (FX), CNF, M3G HMP, MMP Shared resources here are low-bitrate IP codecs. Dev_Connects/Disconnects and dev_PortConnect/PortDisconnects are meant as replacements for the CTBus timeslot routine functions xx_GetXmitSlot() and xx_Listen and xx_Unlisten.
Device Management API Library Reference*
NCM
Native Configuration Manager Library
OA&M
Create and manipulate the configuration data necessary to initialize and control Dialogic telecom devices
Analog, TDM and IP OA&M oriented - can be used with call control and media APIs HMP, DMV, DMIP, JCT Windows only.  Provides programmatic control over the functions interactively handled by the Dialogic Configuration manager (DCM)
NCM API Library Reference*
NCM API Programming Guide*
DLG
Event Services Library
OA&M
Delivers asynchronous system administration events to an application
Windows and Linux System Releases OA&M oriented - can be used with call control and media APIs DMV, JCT, DMIP Called the "Event Services API"
* The Notes column does not list all the available manuals for every technology and environment. Please consult the Product Documentation pages listed below for further documentation listings, using the manual names in the table to help you find the manual you need.