71 #define OPAL_EXPORT __stdcall 83 #define OPAL_C_API_VERSION 27 143 #define OPAL_INITIALISE_FUNCTION "OpalInitialise" 166 #define OPAL_SHUTDOWN_FUNCTION "OpalShutDown" 217 #define OPAL_GET_MESSAGE_FUNCTION "OpalGetMessage" 277 #define OPAL_SEND_MESSAGE_FUNCTION "OpalSendMessage" 290 #define OPAL_FREE_MESSAGE_FUNCTION "OpalFreeMessage" 300 #define OPAL_PREFIX_H323 "h323" 301 #define OPAL_PREFIX_SIP "sip" 302 #define OPAL_PREFIX_IAX2 "iax2" 303 #define OPAL_PREFIX_PCSS "pc" 304 #define OPAL_PREFIX_LOCAL "local" 305 #define OPAL_PREFIX_POTS "pots" 306 #define OPAL_PREFIX_PSTN "pstn" 307 #define OPAL_PREFIX_IVR "ivr" 309 #define OPAL_PREFIX_ALL OPAL_PREFIX_H323 " " \ 310 OPAL_PREFIX_SIP " " \ 311 OPAL_PREFIX_IAX2 " " \ 312 OPAL_PREFIX_PCSS " " \ 313 OPAL_PREFIX_LOCAL " " \ 314 OPAL_PREFIX_POTS " " \ 315 OPAL_PREFIX_PSTN " " \ 758 #define OPAL_MWI_EVENT_PACKAGE "message-summary" 761 #define OPAL_LINE_APPEARANCE_EVENT_PACKAGE "dialog;sla;ma" 1094 typedef struct OpalStatusUserInput {
1335 #if defined(__cplusplus) || defined(DOC_PLUS_PLUS) 1347 const char * GetCallToken()
const;
1348 void SetCallToken(
const char * token);
1350 const char * GetCommandError()
const;
1359 OpalStatusUserInput * GetUserInput()
const;
1406 unsigned Initialise(
1407 const char * options,
1420 unsigned timeout = 0
1433 const char * partyB,
1434 const char * partyA = NULL,
1435 const char * alertingType = NULL
1440 const char * callToken
1445 const char * callToken,
1451 const char * callToken,
1452 const char * userInput,
1453 unsigned duration = 0
1462 #endif // OPAL_OPAL_H
const char * m_callToken
Call token for call being cleared.
Definition: opal.h:1232
Transport error cleared call.
Definition: opal.h:1267
const char * m_mediaMask
Definition: opal.h:576
OpalVideoRecordMixMode m_videoMixing
Definition: opal.h:1195
const char * m_audioFormat
Definition: opal.h:1184
const char * m_type
Type for MWI, "Voice", "Fax", "Pager", "Multimedia", "Text", "None".
Definition: opal.h:1110
const char * m_autoTxMedia
Definition: opal.h:583
OpalMediaStates
Definition: opal.h:1038
Use RFC 2833 for DTMF only.
Definition: opal.h:710
Call cleared because the line is out of service,.
Definition: opal.h:1288
unsigned m_rtpPortMax
Definition: opal.h:601
unsigned m_audioBuffers
Definition: opal.h:629
const char * m_audioPlayerDevice
Definition: opal.h:569
const char * m_callToken
Call token for call being recorded.
Definition: opal.h:1178
unsigned m_videoRate
Definition: opal.h:1194
OpalMediaDataType m_mediaDataHeader
Definition: opal.h:636
const char * m_eventPackage
Definition: opal.h:847
unsigned m_t35CountryCode
Definition: opal.h:683
unsigned m_channels
Definition: opal.h:1181
const char * m_partyB
Definition: opal.h:1148
const char * m_remoteAddress
URL of calling party. e.g. "sip:them@there.com".
Definition: opal.h:994
const char * m_serverName
Definition: opal.h:881
Use arbitrary strings (H.245 string, or INFO dtmf)
Definition: opal.h:708
OpalHandle m_handle
Definition: opal.h:1457
unsigned m_maxAudioJitter
Definition: opal.h:611
void OPAL_EXPORT OpalFreeMessage(OpalMessage *message)
int(* OpalMediaDataFunction)(const char *token, const char *stream, const char *format, void *userData, void *data, int size)
Definition: opal.h:455
OpalMessageType
Definition: opal.h:321
const char * m_callToken
Call token for call being cleared.
Definition: opal.h:1245
OpalMessage * m_message
Definition: opal.h:1370
const char * m_natRouter
Definition: opal.h:587
unsigned m_videoWidth
Definition: opal.h:1192
const char * m_videoFormat
Definition: opal.h:1188
OpalHandle(OPAL_EXPORT * OpalInitialiseFunction)(unsigned *version, const char *options)
Definition: opal.h:148
const char * m_partyA
Definition: opal.h:930
OpalMessage *OPAL_EXPORT OpalGetMessage(OpalHandle opal, unsigned timeout)
unsigned m_videoHeight
Definition: opal.h:1193
OpalParamRegistration m_registrationInfo
Used by OpalCmdRegistration.
Definition: opal.h:1311
OpalMediaTiming m_mediaTiming
Definition: opal.h:661
unsigned m_rtpMaxPayloadSize
Definition: opal.h:605
Call was forwarded using FACILITY message.
Definition: opal.h:1273
const char * m_protocol
Definition: opal.h:879
Call cleared due to invalid conference ID.
Definition: opal.h:1285
OpalUserInputModes
Definition: opal.h:705
const char * m_variables
Definition: opal.h:1233
OpalVideoRecordMixMode
Definition: opal.h:1155
const char * m_adminEntity
Definition: opal.h:839
const char * m_authUserName
Definition: opal.h:837
const char * m_prefix
Definition: opal.h:732
Call failed as could not find user (in GK)
Definition: opal.h:1270
const char * m_redirectingNumber
This is the E.164 number of the party doing transfer, if available.
Definition: opal.h:1015
OpalParamGeneral m_general
Used by OpalCmdSetGeneralParameters.
Definition: opal.h:1309
OpalEchoCancelMode
Definition: opal.h:434
const char * m_videoOutputDevice
Definition: opal.h:571
unsigned m_tcpPortBase
Definition: opal.h:591
const char * m_mediaOptions
Definition: opal.h:643
const char * m_version
Definition: opal.h:680
OpalStatusCallCleared m_callCleared
Used by OpalIndCallCleared.
Definition: opal.h:1320
const char * m_protocolCallId
Definition: opal.h:1012
const char * m_calledAddress
URL of called party the remote is trying to contact.
Definition: opal.h:997
const char * m_mediaOrder
Definition: opal.h:573
const char * m_protocolCallId
Definition: opal.h:1204
OpalParamRecording m_recording
Used by OpalCmdStartRecording.
Definition: opal.h:1324
Use in-band generated audio tones for DTMF.
Definition: opal.h:711
const char * m_callToken
Call token for the call the media stream is.
Definition: opal.h:1084
void OPAL_EXPORT OpalShutDown(OpalHandle opal)
OpalStatusLineAppearance m_lineAppearance
Used by OpalIndLineAppearance.
Definition: opal.h:1319
unsigned m_minAudioJitter
Definition: opal.h:607
OpalParamCallCleared m_clearCall
Used by OpalCmdClearCall.
Definition: opal.h:1321
Call cleared due to an enforced duration limit.
Definition: opal.h:1284
unsigned m_audioBufferTime
Definition: opal.h:652
const char * m_stunServer
Definition: opal.h:589
const char * m_extraInfo
Definition: opal.h:1111
Remote endpoint congested.
Definition: opal.h:1278
const char * m_videoPreviewDevice
Definition: opal.h:572
unsigned m_udpPortBase
Definition: opal.h:595
const char * m_localAddress
URL of local interface. e.g. "sip:me@here.com".
Definition: opal.h:993
unsigned m_manufacturerCode
Definition: opal.h:693
OpalMediaTiming
Definition: opal.h:523
const char * m_protocolCallId
Definition: opal.h:980
The remote party host off line.
Definition: opal.h:1281
unsigned m_silenceDeadband
Definition: opal.h:622
const char * m_vendor
Definition: opal.h:674
const char * m_reason
Definition: opal.h:1246
#define OPAL_C_API_VERSION
Current API version.
Definition: opal.h:83
const char * m_error
Definition: opal.h:884
The remote party is not running an endpoint.
Definition: opal.h:1280
Call failed as could not get enough bandwidth.
Definition: opal.h:1271
Call cleared due to missing dial tone.
Definition: opal.h:1286
unsigned m_udpPortMax
Definition: opal.h:597
const char * m_password
Password for authentication with server.
Definition: opal.h:838
const char * m_info
Definition: opal.h:1221
OpalMediaDataFunction m_mediaWriteData
Definition: opal.h:634
OpalSilenceDetectMode
Definition: opal.h:423
const char * m_name
Definition: opal.h:677
const char * m_interfaceAddresses
Definition: opal.h:741
OpalMessage *(OPAL_EXPORT * OpalSendMessageFunction)(OpalHandle opal, const OpalMessage *message)
Definition: opal.h:272
Local endpoint busy.
Definition: opal.h:1275
const char * m_calledPartyNumber
This is the E.164 number of the called party, if available.
Definition: opal.h:998
Remote endpoint application cleared call.
Definition: opal.h:1263
const char * m_remoteDisplayName
Display name calling party. e.g. "Fred Nurk".
Definition: opal.h:996
OpalLineAppearanceStates
Definition: opal.h:1121
OpalCallEndReason
Definition: opal.h:1258
OpalParamProtocol m_overrides
Definition: opal.h:982
struct OpalHandleStruct * OpalHandle
Handle to initialised OPAL instance.
Definition: opal.h:77
OpalParamSetUserData m_setUserData
Used by OpalCmdSetUserData.
Definition: opal.h:1323
const char * m_callToken
Call token for call being cleared.
Definition: opal.h:1296
The remote ended the call with unmapped Q.931 cause code.
Definition: opal.h:1283
unsigned m_tcpPortMax
Definition: opal.h:593
const char * m_callToken
Call token for call being transferred.
Definition: opal.h:1203
const char * m_partyA
Definition: opal.h:1147
const char * m_callId
Definition: opal.h:1143
Remote endpoint did not answer in required time.
Definition: opal.h:1265
const char * m_party
Party for which the MWI is directed.
Definition: opal.h:1109
const char * m_defaultOptions
Definition: opal.h:752
OpalMessage *OPAL_EXPORT OpalSendMessage(OpalHandle opal, const OpalMessage *message)
OpalStatusMediaStream m_mediaStream
Used by OpalIndMediaStream/OpalCmdMediaStream.
Definition: opal.h:1322
unsigned m_manualAlerting
Definition: opal.h:655
OpalParamProtocol m_protocol
Used by OpalCmdSetProtocolParameters.
Definition: opal.h:1310
int(* OpalMessageAvailableFunction)(const OpalMessage *message)
Definition: opal.h:485
const char * m_autoRxMedia
Definition: opal.h:579
unsigned m_t35Extension
Definition: opal.h:688
OpalProductDescription m_product
Definition: opal.h:999
OpalEchoCancelMode m_echoCancellation
Definition: opal.h:627
OpalCallEndReason m_reason
Definition: opal.h:1297
#define OPAL_EXPORT
Definition: opal.h:73
OpalStatusMessageWaiting m_messageWaiting
Used by OpalIndMessageWaiting.
Definition: opal.h:1318
Call failed a security check and was ended.
Definition: opal.h:1274
void(OPAL_EXPORT * OpalFreeMessageFunction)(OpalMessage *message)
Definition: opal.h:295
unsigned m_signalDeadband
Definition: opal.h:620
void(OPAL_EXPORT * OpalShutDownFunction)(OpalHandle opal)
Definition: opal.h:171
Remote endpoint refused call.
Definition: opal.h:1264
unsigned m_timeToLive
Definition: opal.h:842
Could not find common capabilities.
Definition: opal.h:1272
const char * m_commandError
Used by OpalIndCommandError.
Definition: opal.h:1308
void * m_userData
user data value to associate with this call
Definition: opal.h:1085
const char * m_alertingType
Definition: opal.h:961
Use DTMF specific names (H.245 signal, or INFO dtmf-relay)
Definition: opal.h:709
Gatekeeper has cleared call.
Definition: opal.h:1269
OpalStatusRegistration m_registrationStatus
Used by OpalIndRegistration.
Definition: opal.h:1312
OpalMessageType m_type
Type of message.
Definition: opal.h:1306
OpalStatusIncomingCall m_incomingCall
Used by OpalIndIncomingCall.
Definition: opal.h:1315
The remote failed temporarily app may retry.
Definition: opal.h:1282
OpalParamSetUpCall m_callSetUp
Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.
Definition: opal.h:1313
const char * m_videoInputDevice
Definition: opal.h:570
unsigned m_silenceAdaptPeriod
Definition: opal.h:624
const char * m_result
Definition: opal.h:1206
bool IsInitialised() const
Indicate if the OPAL context has been initialised.
Definition: opal.h:1412
OpalMediaDataType
Definition: opal.h:497
OpalProductDescription m_product
Definition: opal.h:740
OpalMediaTiming m_videoSourceTiming
Definition: opal.h:665
const char * m_callToken
Definition: opal.h:956
Remote endpoint busy.
Definition: opal.h:1277
int m_appearance
Definition: opal.h:1140
Default mode for protocol.
Definition: opal.h:706
const char * m_callToken
Call token for call to be answered.
Definition: opal.h:1028
Call cleared due to missing ringback tone.
Definition: opal.h:1287
OpalMessage *(OPAL_EXPORT * OpalGetMessageFunction)(OpalHandle opal, unsigned timeout)
Definition: opal.h:222
Local endpoint application cleared call.
Definition: opal.h:1260
OpalStatusIVR m_ivrStatus
Used by OpalIndCompletedIVR.
Definition: opal.h:1326
const char * m_remotePartyNumber
This is the E.164 number of the caller, if available.
Definition: opal.h:995
OpalStatusUserInput m_userInput
Used by OpalIndUserInput/OpalCmdUserInput.
Definition: opal.h:1317
const char * m_identifier
Definition: opal.h:827
const char * m_callToken
Call token for new call.
Definition: opal.h:992
const char * m_file
Definition: opal.h:1179
const char * m_audioRecordDevice
Definition: opal.h:568
Local endpoint declined to answer call.
Definition: opal.h:1262
OpalParamProtocol m_overrides
Definition: opal.h:1029
const char * m_line
URI for the line whose state is changing.
Definition: opal.h:1138
Wrapper around the OpalMessage structure.
Definition: opal.h:1338
Call cleared because another call is answered.
Definition: opal.h:1289
Use Q.931 Information Elements (H.323 only)
Definition: opal.h:707
OpalLineAppearanceStates m_state
State the line has just moved to.
Definition: opal.h:1139
const char * m_partyB
Definition: opal.h:944
const char * m_protocol
Definition: opal.h:825
const char * m_callToken
Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.
Definition: opal.h:1314
Local endpoint congested.
Definition: opal.h:1276
Transport connection failed to establish call.
Definition: opal.h:1268
unsigned m_rtpTypeOfService
Definition: opal.h:603
OpalProductDescription m_product
Definition: opal.h:889
const char * m_referredByAddress
This is the full address of the party doing transfer, if available.
Definition: opal.h:1014
OpalParamAnswerCall m_answerCall
Used by OpalCmdAnswerCall/OpalCmdAlerting.
Definition: opal.h:1316
OpalRegistrationStates
Definition: opal.h:861
OpalUserInputModes m_userInputMode
Definition: opal.h:749
Local endpoint did not accept call OnIncomingCall()=PFalse.
Definition: opal.h:1261
const char * m_displayName
Definition: opal.h:738
OpalMessageAvailableFunction m_messageAvailable
Definition: opal.h:639
OpalRegistrationStates m_status
Definition: opal.h:888
unsigned m_rtpPortBase
Definition: opal.h:599
unsigned m_silenceThreshold
Definition: opal.h:618
const char * m_alertingType
Definition: opal.h:1000
const char * m_userName
Definition: opal.h:735
const char * m_hostName
Definition: opal.h:833
Remote endpoint stopped calling.
Definition: opal.h:1266
OpalStatusTransferCall m_transferStatus
Used by OpalIndTransferCall.
Definition: opal.h:1325
Could not reach the remote party.
Definition: opal.h:1279
unsigned m_restoreTime
Definition: opal.h:844
OpalSilenceDetectMode m_silenceDetectMode
Definition: opal.h:615
OpalMediaDataFunction m_mediaReadData
Definition: opal.h:632
OpalHandle OPAL_EXPORT OpalInitialise(unsigned *version, const char *options)