# OpalMessage Struct Reference

`#include <opal.h>`

List of all members.

## Public Attributes

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 OpalIndRegistrationStatus.
OpalParamSetUpCall m_callSetUp
| Used by OpalCmdSetUpCall/OpalIndAlerting/OpalIndEstablished.
const char * m_callToken
| Used by OpalCmdAnswerCall/OpalCmdHoldcall/OpalCmdRetreiveCall.
OpalStatusIncomingCall m_incomingCall
| Used by OpalIndIncomingCall.
OpalStatusUserInput m_userInput
| Used by OpalIndUserInput.
OpalStatusMessageWaiting m_messageWaiting
| Used by OpalIndMessageWaiting.
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.
} | m_param

## Detailed Description

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

## Member Data Documentation

OpalMessageType OpalMessage::m_type

Type of message.

const char* OpalMessage::m_commandError

Used by OpalIndCommandError.

OpalParamGeneral OpalMessage::m_general

Used by OpalCmdSetGeneralParameters.

OpalParamProtocol OpalMessage::m_protocol

Used by OpalCmdSetProtocolParameters.

OpalParamRegistration OpalMessage::m_registrationInfo

Used by OpalCmdRegistration.

OpalStatusRegistration OpalMessage::m_registrationStatus

Used by OpalIndRegistrationStatus.

OpalParamSetUpCall OpalMessage::m_callSetUp

Used by OpalCmdSetUpCall/OpalIndAlerting/OpalIndEstablished.

const char* OpalMessage::m_callToken

Used by OpalCmdAnswerCall/OpalCmdHoldcall/OpalCmdRetreiveCall.

OpalStatusIncomingCall OpalMessage::m_incomingCall

Used by OpalIndIncomingCall.

OpalStatusUserInput OpalMessage::m_userInput

Used by OpalIndUserInput.

OpalStatusMessageWaiting OpalMessage::m_messageWaiting

Used by OpalIndMessageWaiting.

OpalStatusCallCleared OpalMessage::m_callCleared

Used by OpalIndCallCleared.

OpalParamCallCleared OpalMessage::m_clearCall

Used by OpalCmdClearCall.

OpalStatusMediaStream OpalMessage::m_mediaStream

Used by OpalIndMediaStream/OpalCmdMediaStream.

OpalParamSetUserData OpalMessage::m_setUserData

Used by OpalCmdSetUserData.

union { ... } OpalMessage::m_param

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

- opal.h