OPAL  Version 3.10.4
OpalMessage Struct Reference

#include <opal.h>

Data Fields

OpalMessageType m_type
 Type of message.
union {
   const char *   m_commandError
 Used by OpalIndCommandError.
   OpalParamGeneral   m_general
 Used by OpalCmdSetGeneralParameters.
   OpalParamProtocol   m_protocol
 Used by OpalCmdSetProtocolParameters.
   OpalParamRegistration   m_registrationInfo
 Used by OpalCmdRegistration.
   OpalStatusRegistration   m_registrationStatus
 Used by OpalIndRegistration.
   OpalParamSetUpCall   m_callSetUp
 Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.
   const char *   m_callToken
 Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.
   OpalStatusIncomingCall   m_incomingCall
 Used by OpalIndIncomingCall.
   OpalParamAnswerCall   m_answerCall
 Used by OpalCmdAnswerCall/OpalCmdAlerting.
   OpalStatusUserInput   m_userInput
 Used by OpalIndUserInput/OpalCmdUserInput.
   OpalStatusMessageWaiting   m_messageWaiting
 Used by OpalIndMessageWaiting.
   OpalStatusLineAppearance   m_lineAppearance
 Used by OpalIndLineAppearance.
   OpalStatusCallCleared   m_callCleared
 Used by OpalIndCallCleared.
   OpalParamCallCleared   m_clearCall
 Used by OpalCmdClearCall.
   OpalStatusMediaStream   m_mediaStream
 Used by OpalIndMediaStream/OpalCmdMediaStream.
   OpalParamSetUserData   m_setUserData
 Used by OpalCmdSetUserData.
   OpalParamRecording   m_recording
 Used by OpalCmdStartRecording.
   OpalStatusTransferCall   m_transferStatus
 Used by OpalIndTransferCall.
   OpalStatusIVR   m_ivrStatus
 Used by OpalIndCompletedIVR.
m_param

Detailed Description

Message to/from OPAL system. This is passed via the OpalGetMessage() or OpalSendMessage() functions.


Field Documentation

Used by OpalCmdAnswerCall/OpalCmdAlerting.

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.

Used by OpalIndCommandError.

Used by OpalCmdSetGeneralParameters.

Used by OpalIndCompletedIVR.

Used by OpalIndMediaStream/OpalCmdMediaStream.

union { ... } OpalMessage::m_param

Used by OpalCmdSetProtocolParameters.

Used by OpalCmdStartRecording.

Used by OpalCmdSetUserData.

OpalStatusUserInput OpalMessage::m_userInput

Used by OpalIndUserInput/OpalCmdUserInput.


The documentation for this struct was generated from the following file: