OpalParamGeneral Struct Reference

#include <opal.h>

List of all members.

Public Attributes

const char * m_audioRecordDevice
const char * m_audioPlayerDevice
const char * m_videoInputDevice
const char * m_videoOutputDevice
const char * m_videoPreviewDevice
const char * m_mediaOrder
const char * m_mediaMask
const char * m_autoRxMedia
const char * m_autoTxMedia
const char * m_natRouter
const char * m_stunServer
WORD m_tcpPortBase
WORD m_tcpPortMax
WORD m_udpPortBase
WORD m_udpPortMax
WORD m_rtpPortBase
WORD m_rtpPortMax
unsigned m_rtpTypeOfService
unsigned m_rtpMaxPayloadSize
unsigned m_minAudioJitter
unsigned m_maxAudioJitter


Detailed Description

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


Member Data Documentation

const char* OpalParamGeneral::m_audioRecordDevice

Audio recording device name

const char* OpalParamGeneral::m_audioPlayerDevice

Audio playback device name

const char* OpalParamGeneral::m_videoInputDevice

Video input (e.g. camera) device name

const char* OpalParamGeneral::m_videoOutputDevice

Video output (e.g. window) device name

const char* OpalParamGeneral::m_videoPreviewDevice

Video preview (e.g. window) device name

const char* OpalParamGeneral::m_mediaOrder

List of media format names to set the preference order for media. This list of names (e.g. "G.723.1") is separated by the '
' character.

const char* OpalParamGeneral::m_mediaMask

List of media format names to set media to be excluded. This list of names (e.g. "G.723.1") is separated by the '
' character.

const char* OpalParamGeneral::m_autoRxMedia

List of media types (e.g. audio, video) separated by spaces which may automatically be received automatically.

const char* OpalParamGeneral::m_autoTxMedia

List of media types (e.g. audio, video) separated by spaces which may automatically be transmitted automatically.

const char* OpalParamGeneral::m_natRouter

The host name or IP address of the Network Address Translation router which may be between the endpoint and the Internet.

const char* OpalParamGeneral::m_stunServer

The host name or IP address of the STUN server which may be used to determine the NAT router characteristics automatically.

WORD OpalParamGeneral::m_tcpPortBase

Base of range of ports to use for TCP communications. This may be required by some firewalls.

WORD OpalParamGeneral::m_tcpPortMax

Max of range of ports to use for TCP communications. This may be required by some firewalls.

WORD OpalParamGeneral::m_udpPortBase

Base of range of ports to use for UDP communications. This may be required by some firewalls.

WORD OpalParamGeneral::m_udpPortMax

Max of range of ports to use for UDP communications. This may be required by some firewalls.

WORD OpalParamGeneral::m_rtpPortBase

Base of range of ports to use for RTP/UDP communications. This may be required by some firewalls.

WORD OpalParamGeneral::m_rtpPortMax

Max of range of ports to use for RTP/UDP communications. This may be required by some firewalls.

unsigned OpalParamGeneral::m_rtpTypeOfService

Value for the Type Of Service byte with UDP/IP packets which may be used by some routers for simple Quality of Service control.

unsigned OpalParamGeneral::m_rtpMaxPayloadSize

Maximum payload size for RTP packets. This may sometimes need to be set according to the MTU or the underlying network.

unsigned OpalParamGeneral::m_minAudioJitter

Minimum jitter time in milliseconds. For audio RTP data being received this sets the minimum time of the adaptive jitter buffer which smooths out irregularities in the transmission of audio data over the Internet.

unsigned OpalParamGeneral::m_maxAudioJitter

Maximum jitter time in milliseconds. For audio RTP data being received this sets the maximum time of the adaptive jitter buffer which smooths out irregularities in the transmission of audio data over the Internet.


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