OpalMessage Struct Reference

`#include <opal.h>`

## Data Fields

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

## Detailed Description

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

## Field Documentation

OpalParamAnswerCall OpalMessage::m_answerCall

Used by OpalCmdAnswerCall/OpalCmdAlerting.

OpalStatusCallCleared OpalMessage::m_callCleared

Used by OpalIndCallCleared.

OpalParamSetUpCall OpalMessage::m_callSetUp

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

const char* OpalMessage::m_callToken

Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.

OpalParamCallCleared OpalMessage::m_clearCall

Used by OpalCmdClearCall.

const char* OpalMessage::m_commandError

Used by OpalIndCommandError.

OpalParamGeneral OpalMessage::m_general

Used by OpalCmdSetGeneralParameters.

OpalStatusIncomingCall OpalMessage::m_incomingCall

Used by OpalIndIncomingCall.

OpalStatusIVR OpalMessage::m_ivrStatus

Used by OpalIndCompletedIVR.

OpalStatusLineAppearance OpalMessage::m_lineAppearance

Used by OpalIndLineAppearance.

OpalStatusMediaStream OpalMessage::m_mediaStream

Used by OpalIndMediaStream/OpalCmdMediaStream.

OpalStatusMessageWaiting OpalMessage::m_messageWaiting

Used by OpalIndMessageWaiting.

union { ... } OpalMessage::m_param

OpalParamProtocol OpalMessage::m_protocol

Used by OpalCmdSetProtocolParameters.

OpalParamRecording OpalMessage::m_recording

Used by OpalCmdStartRecording.

OpalParamRegistration OpalMessage::m_registrationInfo

Used by OpalCmdRegistration.

OpalStatusRegistration OpalMessage::m_registrationStatus

Used by OpalIndRegistration.

OpalParamSetUserData OpalMessage::m_setUserData

Used by OpalCmdSetUserData.

OpalStatusTransferCall OpalMessage::m_transferStatus

Used by OpalIndTransferCall.

OpalMessageType OpalMessage::m_type

Type of message.

OpalStatusUserInput OpalMessage::m_userInput

Used by OpalIndUserInput/OpalCmdUserInput.

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

- opal.h