OpalParamProtocol Struct Reference

#include <opal.h>

List of all members.

Public Attributes

const char * m_prefix
const char * m_userName
const char * m_displayName
const char * m_vendor
const char * m_name
const char * m_version
BYTE m_t35CountryCode
BYTE m_t35Extension
WORD m_manufacturerCode
const char * m_interfaceAddresses


Detailed Description

Protocol parameters for the OpalCmdSetProtocolParameters command. This is only passed to and returned from the OpalSendMessage() function.


Member Data Documentation

const char* OpalParamProtocol::m_prefix

Protocol prefix for parameters, e.g. "h323" or "sip". If this is NULL or empty string, then the parameters are set for all protocols where they maybe set.

const char* OpalParamProtocol::m_userName

User name to identify the endpoint. This is usually the protocol specific name and may interact with the OpalCmdRegistration command. e.g. "robertj or 61295552148

const char* OpalParamProtocol::m_displayName

Display name to be used. This is the human readable form of the users name, e.g. "Robert Jongbloed".

const char* OpalParamProtocol::m_vendor

Name of the vendor or manufacturer of the application. This is used to identify the software which can be very useful for solving interoperability issues. e.g. "Vox Lucida".

const char* OpalParamProtocol::m_name

Name of the product within the vendor name space. This is used to identify the software which can be very useful for solving interoperability issues. e.g. "OpenPhone".

const char* OpalParamProtocol::m_version

Version of the product within the vendor/product name space. This is used to identify the software which can be very useful for solving interoperability issues. e.g. "2.1.4".

BYTE OpalParamProtocol::m_t35CountryCode

T.35 country code for the name space in which the vendor or manufacturer is identified. This is the part of the H.221 equivalent of the m_vendor string above and used to identify the software which can be very useful for solving interoperability issues. e.g. 9 is for Australia.

BYTE OpalParamProtocol::m_t35Extension

T.35 country extension code for the name space in which the vendor or manufacturer is identified. This is the part of the H.221 equivalent of the m_vendor string above and used to identify the software which can be very useful for solving interoperability issues. Very rarely used.

WORD OpalParamProtocol::m_manufacturerCode

Manuacturer code for the name space in which the vendor or manufacturer is identified. This is the part of the H.221 equivalent of the m_vendor string above and used to identify the software which can be very useful for solving interoperability issues. e.g. 61 is for Equivalance and was allocated by the Australian Communications Authority, Oct 2000.

const char* OpalParamProtocol::m_interfaceAddresses

A list of interfaces to start listening for incoming calls. This list is separated by the '
' character. If NULL no listeners are started or stopped. If and empty string ("") then all listeners are stopped. If a "*" then listeners are started for all interfaces in the system.


The documentation for this struct was generated from the following file:
Generated on Fri Mar 7 07:37:03 2008 for OPAL by  doxygen 1.5.1