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 OpalCmdAnswerCall/OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording/OpalCmdAlerting.
OpalStatusIncomingCall   m_incomingCall
	Used by OpalIndIncomingCall.
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.
}	m_param

---

Detailed Description

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

---

Field Documentation

OpalStatusCallCleared OpalMessage::m_callCleared

Used by OpalIndCallCleared.

OpalParamSetUpCall OpalMessage::m_callSetUp

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

const char* OpalMessage::m_callToken

Used by OpalCmdAnswerCall/OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording/OpalCmdAlerting.

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.

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.

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

---