OPAL  Version 3.14.3
connection.h File Reference
#include <opal_config.h>
#include <opal/mediafmt.h>
#include <opal/mediastrm.h>
#include <opal/guid.h>
#include <opal/transports.h>
#include <ptclib/dtmf.h>
#include <ptlib/safecoll.h>
#include <rtp/rtp.h>
Include dependency graph for connection.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  OpalProductInfo
 
class  OpalConnection
 
struct  OpalConnection::CallEndReason
 
class  OpalConnection::StringOptions
 
class  OpalConnection::ZeroTime
 

Macros

#define OPAL_URL_PARAM_PREFIX   "OPAL-"
 
#define OPAL_MAKE_URL_PARAM(opt)   ";" OPAL_URL_PARAM_PREFIX opt
 
#define OPAL_MAKE_URL_PARAM2(opt, val)   OPAL_MAKE_URL_PARAM(opt) "=" val
 
#define OPAL_OPT_AUTO_START   "AutoStart"
 
#define OPAL_OPT_CALL_IDENTIFIER   "Call-Identifier"
 String option to override generated call identifier. More...
 
#define OPAL_OPT_CALLING_PARTY_URL   "Calling-Party-URL"
 String option to set outgoing local URL. More...
 
#define OPAL_OPT_CALLING_PARTY_NUMBER   "Calling-Party-Number"
 String option to set outgoing local number, deprecated, same as OPAL_OPT_CALLING_PARTY_NAME. More...
 
#define OPAL_OPT_CALLING_PARTY_NAME   "Calling-Party-Name"
 String option to set outgoing local name. More...
 
#define OPAL_OPT_CALLING_PARTY_DOMAIN   "Calling-Party-Domain"
 String option to set outgoing local host/address/domain. More...
 
#define OPAL_OPT_CALLING_DISPLAY_NAME   "Calling-Display-Name"
 String option to set outgoing display name. More...
 
#define OPAL_OPT_CALLED_PARTY_NAME   "Called-Party-Name"
 String option to set outgoing party name. More...
 
#define OPAL_OPT_CALLED_DISPLAY_NAME   "Called-Display-Name"
 String option to set outgoing display name. More...
 
#define OPAL_OPT_REDIRECTING_PARTY   "Redirecting-Party"
 String option to set redirecting/refferred-by party. More...
 
#define OPAL_OPT_PRESENTATION_BLOCK   "Presentation-Block"
 String option to block outgoing calling number presentation. More...
 
#define OPAL_OPT_ORIGINATOR_ADDRESS   "Originator-Address"
 String option for originator address used by IVR. More...
 
#define OPAL_OPT_INTERFACE   "Interface"
 String option to set the interface used for outgoing call. More...
 
#define OPAL_OPT_USER_INPUT_MODE   "User-Input-Mode"
 "RFC2833", "String", "Tone", "Q.931" or "InBand" More...
 
#define OPAL_OPT_ENABLE_INBAND_DTMF   "EnableInbandDTMF"
 String option to enable in band DTMF detection. More...
 
#define OPAL_OPT_ENABLE_INBAND_DTMF   "EnableInbandDTMF"
 String option to enable in band DTMF detection. More...
 
#define OPAL_OPT_DETECT_INBAND_DTMF   "DetectInBandDTMF"
 String option to enable in band DTMF detection. More...
 
#define OPAL_OPT_SEND_INBAND_DTMF   "SendInBandDTMF"
 String option to enable in band DTMF send as fall back for other UI modes. More...
 
#define OPAL_OPT_DTMF_MULT   "dtmfmult"
 
#define OPAL_OPT_DTMF_DIV   "dtmfdiv"
 
#define OPAL_OPT_DISABLE_JITTER   "Disable-Jitter"
 String option to disable jitter buffer if "true". More...
 
#define OPAL_OPT_MAX_JITTER   "Max-Jitter"
 String option to set maximum jitter in milliseconds. More...
 
#define OPAL_OPT_MIN_JITTER   "Min-Jitter"
 String option to set minimum jitter in milliseconds. More...
 
#define OPAL_OPT_RECORD_AUDIO   "Record-Audio"
 String option to start recording to a file for call. More...
 
#define OPAL_OPT_ALERTING_TYPE   "Alerting-Type"
 String option to set the alerting type string for call. More...
 
#define OPAL_OPT_REMOVE_CODEC   "Remove-Codec"
 String option to remove codecs for this call. More...
 
#define OPAL_OPT_SILENCE_DETECT_MODE   "Silence-Detect"
 
#define OPAL_OPT_VIDUP_METHODS   "Video-Update-Picture-Method"
 
#define OPAL_OPT_VIDUP_METHOD_OOB   1
 
#define OPAL_OPT_VIDUP_METHOD_RTCP   2
 
#define OPAL_OPT_VIDUP_METHOD_PLI   4
 
#define OPAL_OPT_VIDUP_METHOD_FIR   8
 
#define OPAL_OPT_VIDUP_METHOD_DEFAULT   3
 

Macro Definition Documentation

#define OPAL_MAKE_URL_PARAM (   opt)    ";" OPAL_URL_PARAM_PREFIX opt
#define OPAL_MAKE_URL_PARAM2 (   opt,
  val 
)    OPAL_MAKE_URL_PARAM(opt) "=" val
#define OPAL_OPT_ALERTING_TYPE   "Alerting-Type"

String option to set the alerting type string for call.

#define OPAL_OPT_AUTO_START   "AutoStart"

String option for auto-started media types. This is a '
' separated list of entries of the form type:mode, type is "ausio", "video", "fax" etc. The mode is "inactive", "sendonly", "recvonly", "sendrecv" or "no". "yes" is a synonym for "sendrecv".

#define OPAL_OPT_CALL_IDENTIFIER   "Call-Identifier"

String option to override generated call identifier.

#define OPAL_OPT_CALLED_DISPLAY_NAME   "Called-Display-Name"

String option to set outgoing display name.

#define OPAL_OPT_CALLED_PARTY_NAME   "Called-Party-Name"

String option to set outgoing party name.

#define OPAL_OPT_CALLING_DISPLAY_NAME   "Calling-Display-Name"

String option to set outgoing display name.

#define OPAL_OPT_CALLING_PARTY_DOMAIN   "Calling-Party-Domain"

String option to set outgoing local host/address/domain.

#define OPAL_OPT_CALLING_PARTY_NAME   "Calling-Party-Name"

String option to set outgoing local name.

#define OPAL_OPT_CALLING_PARTY_NUMBER   "Calling-Party-Number"

String option to set outgoing local number, deprecated, same as OPAL_OPT_CALLING_PARTY_NAME.

#define OPAL_OPT_CALLING_PARTY_URL   "Calling-Party-URL"

String option to set outgoing local URL.

#define OPAL_OPT_DETECT_INBAND_DTMF   "DetectInBandDTMF"

String option to enable in band DTMF detection.

#define OPAL_OPT_DISABLE_JITTER   "Disable-Jitter"

String option to disable jitter buffer if "true".

#define OPAL_OPT_DTMF_DIV   "dtmfdiv"
#define OPAL_OPT_DTMF_MULT   "dtmfmult"
#define OPAL_OPT_ENABLE_INBAND_DTMF   "EnableInbandDTMF"

String option to enable in band DTMF detection.

String option to enable in band DTMF detection/send.

#define OPAL_OPT_ENABLE_INBAND_DTMF   "EnableInbandDTMF"

String option to enable in band DTMF detection.

String option to enable in band DTMF detection/send.

#define OPAL_OPT_INTERFACE   "Interface"

String option to set the interface used for outgoing call.

#define OPAL_OPT_MAX_JITTER   "Max-Jitter"

String option to set maximum jitter in milliseconds.

#define OPAL_OPT_MIN_JITTER   "Min-Jitter"

String option to set minimum jitter in milliseconds.

#define OPAL_OPT_ORIGINATOR_ADDRESS   "Originator-Address"

String option for originator address used by IVR.

#define OPAL_OPT_PRESENTATION_BLOCK   "Presentation-Block"

String option to block outgoing calling number presentation.

#define OPAL_OPT_RECORD_AUDIO   "Record-Audio"

String option to start recording to a file for call.

#define OPAL_OPT_REDIRECTING_PARTY   "Redirecting-Party"

String option to set redirecting/refferred-by party.

#define OPAL_OPT_REMOVE_CODEC   "Remove-Codec"

String option to remove codecs for this call.

#define OPAL_OPT_SEND_INBAND_DTMF   "SendInBandDTMF"

String option to enable in band DTMF send as fall back for other UI modes.

#define OPAL_OPT_SILENCE_DETECT_MODE   "Silence-Detect"

OpalConnection::StringOption key to an enum indicating that silence detection on the sound recording is to be executed. Default false.

#define OPAL_OPT_USER_INPUT_MODE   "User-Input-Mode"

"RFC2833", "String", "Tone", "Q.931" or "InBand"

String option to set User Input indication mode:

#define OPAL_OPT_VIDUP_METHOD_DEFAULT   3
#define OPAL_OPT_VIDUP_METHOD_FIR   8
#define OPAL_OPT_VIDUP_METHOD_OOB   1
#define OPAL_OPT_VIDUP_METHOD_PLI   4
#define OPAL_OPT_VIDUP_METHOD_RTCP   2
#define OPAL_OPT_VIDUP_METHODS   "Video-Update-Picture-Method"

OpalConnection::StringOption key to a bit mask indicating the the video update picture request method.

Bit 0 (OPAL_OPT_VIDUP_METHOD_OOB) indicates it is sent out of band, e.g. SIP INFO request or H.245 videoFastUpdate)

bit 1 (OPAL_OPT_VIDUP_METHOD_RTCP) indicates using RTCP is used as per RFC4585 and RFC5104. These are only transmitted if the capabilities have been negotiated successfully.

bit 2 (OPAL_OPT_VIDUP_METHOD_PLI) indicates the forced use of RTCP Packet Loss Indication command as per RFC4585. Capabilities are ignored.

bit 3 (OPAL_OPT_VIDUP_METHOD_FIR) indicates the forced use of RTCP Force Intra-Frame Request command as per RFC5104. Capabilities are ignored.

Default is 3 (OPAL_OPT_VIDUP_METHOD_DEFAULT) for both out of band and RTCP methods.

#define OPAL_URL_PARAM_PREFIX   "OPAL-"