Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OpalLineInterfaceDevice Class Reference

#include <lid.h>

List of all members.

Public Types

enum  { MaxVolume = 100 }
enum  AECLevels {
  AECOff, AECLow, AECMedium, AECHigh,
  AECAuto, AECAGC, AECError
}
enum  { DefaultDTMFOnTime = 180, DefaultDTMFOffTime = 120 }
enum  CallProgressTones {
  NoTone = 0x00, DialTone = 0x01, RingTone = 0x02, BusyTone = 0x04,
  FastBusyTone = 0x08, ClearTone = 0x10, CNGTone = 0x20, MwiTone = 0x40,
  AllTones = 0x4f
}
enum  T35CountryCodes {
  Japan, Albania, Algeria, AmericanSamoa,
  Germany, Anguilla, AntiguaAndBarbuda, Argentina,
  Ascension, Australia, Austria, Bahamas,
  Bahrain, Bangladesh, Barbados, Belgium,
  Belize, Benin, Bermudas, Bhutan,
  Bolivia, Botswana, Brazil, BritishAntarcticTerritory,
  BritishIndianOceanTerritory, BritishVirginIslands, BruneiDarussalam, Bulgaria,
  Myanmar, Burundi, Byelorussia, Cameroon,
  Canada, CapeVerde, CaymanIslands, CentralAfricanRepublic,
  Chad, Chile, China, Colombia,
  Comoros, Congo, CookIslands, CostaRica,
  Cuba, Cyprus, Czechoslovakia, Cambodia,
  DemocraticPeoplesRepublicOfKorea, Denmark, Djibouti, DominicanRepublic,
  Dominica, Ecuador, Egypt, ElSalvador,
  EquatorialGuinea, Ethiopia, FalklandIslands, Fiji,
  Finland, France, FrenchPolynesia, FrenchSouthernAndAntarcticLands,
  Gabon, Gambia, Germany2, Angola,
  Ghana, Gibraltar, Greece, Grenada,
  Guam, Guatemala, Guernsey, Guinea,
  GuineaBissau, Guayana, Haiti, Honduras,
  Hongkong, Hungary, Iceland, India,
  Indonesia, Iran, Iraq, Ireland,
  Israel, Italy, CotedIvoire, Jamaica,
  Afghanistan, Jersey, Jordan, Kenya,
  Kiribati, KoreaRepublic, Kuwait, Lao,
  Lebanon, Lesotho, Liberia, Libya,
  Liechtenstein, Luxemborg, Macao, Madagascar,
  Malaysia, Malawi, Maldives, Mali,
  Malta, Mauritania, Mauritius, Mexico,
  Monaco, Mongolia, Montserrat, Morocco,
  Mozambique, Nauru, Nepal, Netherlands,
  NetherlandsAntilles, NewCaledonia, NewZealand, Nicaragua,
  Niger, Nigeria, Norway, Oman,
  Pakistan, Panama, PapuaNewGuinea, Paraguay,
  Peru, Philippines, Poland, Portugal,
  PuertoRico, Qatar, Romania, Rwanda,
  SaintKittsAndNevis, SaintCroix, SaintHelenaAndAscension, SaintLucia,
  SanMarino, SaintThomas, SaoTomeAndPrincipe, SaintVicentAndTheGrenadines,
  SaudiArabia, Senegal, Seychelles, SierraLeone,
  Singapore, SolomonIslands, Somalia, SouthAfrica,
  Spain, SriLanka, Sudan, Suriname,
  Swaziland, Sweden, Switzerland, Syria,
  Tanzania, Thailand, Togo, Tonga,
  TrinidadAndTobago, Tunisia, Turkey, TurksAndCaicosIslands,
  Tuvalu, Uganda, Ukraine, UnitedArabEmirates,
  UnitedKingdom, UnitedStates, BurkinaFaso, Uruguay,
  USSR, Vanuatu, VaticanCityState, Venezuela,
  VietNam, WallisAndFutuna, WesternSamoa, Yemen,
  Yemen2, Yugoslavia, Zaire, Zambia,
  Zimbabwe, NumCountryCodes, UnknownCountry = -1
}
enum  { DIAL_TONE_TIMEOUT = 10000 }

Public Methods

 OpalLineInterfaceDevice ()
virtual BOOL Open (const PString &device)=0
virtual BOOL IsOpen () const
virtual BOOL Close ()
virtual PString GetDeviceType () const=0
virtual PString GetDeviceName () const=0
virtual PStringArray GetAllNames () const=0
virtual PString GetDescription () const=0
virtual unsigned GetLineCount ()=0
virtual BOOL IsLineTerminal (unsigned line)
virtual BOOL IsLinePresent (unsigned line, BOOL force=FALSE)
virtual BOOL IsLineOffHook (unsigned line)=0
virtual BOOL SetLineOffHook (unsigned line, BOOL newState=TRUE)=0
virtual BOOL SetLineOnHook (unsigned line)
virtual BOOL HookFlash (unsigned line, unsigned flashTime=200)
virtual BOOL HasHookFlash (unsigned line)
virtual BOOL IsLineRinging (unsigned line, DWORD *cadence=NULL)
virtual BOOL RingLine (unsigned line, DWORD cadence)
virtual BOOL RingLine (unsigned line, PINDEX nCadence, unsigned *pattern)
virtual BOOL IsLineDisconnected (unsigned line, BOOL checkForWink=TRUE)
virtual BOOL SetLineToLineDirect (unsigned line1, unsigned line2, BOOL connect)
virtual BOOL IsLineToLineDirect (unsigned line1, unsigned line2)
virtual OpalMediaFormatList GetMediaFormats () const=0
virtual BOOL SetReadFormat (unsigned line, const OpalMediaFormat &mediaFormat)=0
virtual BOOL SetWriteFormat (unsigned line, const OpalMediaFormat &mediaFormat)=0
virtual OpalMediaFormat GetReadFormat (unsigned line)=0
virtual OpalMediaFormat GetWriteFormat (unsigned line)=0
virtual BOOL SetReadCodec (unsigned line, RTP_DataFrame::PayloadTypes codec)
virtual BOOL SetWriteCodec (unsigned line, RTP_DataFrame::PayloadTypes codec)
virtual BOOL SetRawCodec (unsigned line)
virtual BOOL StopReadCodec (unsigned line)
virtual BOOL StopWriteCodec (unsigned line)
virtual BOOL StopRawCodec (unsigned line)
virtual BOOL SetReadFrameSize (unsigned line, PINDEX frameSize)
virtual BOOL SetWriteFrameSize (unsigned line, PINDEX frameSize)
virtual PINDEX GetReadFrameSize (unsigned line)=0
virtual PINDEX GetWriteFrameSize (unsigned line)=0
virtual BOOL ReadFrame (unsigned line, void *buf, PINDEX &count)=0
virtual BOOL WriteFrame (unsigned line, const void *buf, PINDEX count, PINDEX &written)=0
virtual BOOL ReadBlock (unsigned line, void *buf, PINDEX count)
virtual BOOL WriteBlock (unsigned line, const void *buf, PINDEX count)
virtual unsigned GetAverageSignalLevel (unsigned line, BOOL playback)
virtual BOOL EnableAudio (unsigned line, BOOL enable=TRUE)
BOOL DisableAudio (unsigned line)
virtual BOOL IsAudioEnabled (unsigned line)
virtual BOOL SetRecordVolume (unsigned line, unsigned volume)
virtual BOOL SetPlayVolume (unsigned line, unsigned volume)
virtual BOOL GetRecordVolume (unsigned line, unsigned &volume)
virtual BOOL GetPlayVolume (unsigned line, unsigned &volume)
virtual AECLevels GetAEC (unsigned line)
virtual BOOL SetAEC (unsigned line, AECLevels level)
virtual unsigned GetWinkDuration (unsigned line)
virtual BOOL SetWinkDuration (unsigned line, unsigned winkDuration)
virtual BOOL GetVAD (unsigned line)
virtual BOOL SetVAD (unsigned line, BOOL enable)
virtual BOOL GetCallerID (unsigned line, PString &idString, BOOL full=FALSE)
virtual BOOL SetCallerID (unsigned line, const PString &idString)
virtual BOOL SendCallerIDOnCallWaiting (unsigned line, const PString &idString)
virtual BOOL SendVisualMessageWaitingIndicator (unsigned line, BOOL on)
virtual BOOL PlayDTMF (unsigned line, const char *digits, DWORD onTime=DefaultDTMFOnTime, DWORD offTime=DefaultDTMFOffTime)
virtual char ReadDTMF (unsigned line)
virtual BOOL GetRemoveDTMF (unsigned line)
virtual BOOL SetRemoveDTMF (unsigned line, BOOL removeTones)
virtual CallProgressTones IsToneDetected (unsigned line)
virtual CallProgressTones WaitForToneDetect (unsigned line, unsigned timeout=3000)
virtual BOOL WaitForTone (unsigned line, CallProgressTones tone, unsigned timeout=3000)
virtual BOOL SetToneFilter (unsigned line, CallProgressTones tone, const PString &description)
virtual BOOL SetToneFilterParameters (unsigned line, CallProgressTones tone, unsigned lowFrequency, unsigned highFrequency, PINDEX numCadences, const unsigned *onTimes, const unsigned *offTimes)
virtual BOOL PlayTone (unsigned line, CallProgressTones tone)
virtual BOOL IsTonePlaying (unsigned line)
virtual BOOL StopTone (unsigned line)
virtual BOOL PlayAudio (unsigned line, const PString &filename)
virtual BOOL StopAudio (unsigned line)
virtual BOOL RecordAudioStart (unsigned line, const PString &filename)
virtual BOOL RecordAudioStop (unsigned line)
virtual CallProgressTones DialOut (unsigned line, const PString &number, BOOL requireTones=FALSE, unsigned uiDialDelay=0)
T35CountryCodes GetCountryCode () const
PString GetCountryCodeName () const
virtual BOOL SetCountryCode (T35CountryCodes country)
virtual BOOL SetCountryCodeName (const PString &countryName)
virtual PStringList GetCountryCodeNameList () const
int GetErrorNumber () const
PString GetErrorText () const
virtual void PrintOn (ostream &strm) const

Static Public Methods

PString GetCountryCodeName (T35CountryCodes code)
T35CountryCodes GetCountryCode (const PString &name)
OpalLineInterfaceDevice * Create (const PString &type, void *parameters=NULL)
PStringList GetAllTypes ()
PStringList GetAllDevices ()

Protected Methods

int getOsHandle () const
void setOsHandle (int os_handleToSet)
int getOsError () const
void setOsError (int osErrorToSet)
const PBYTEArray & getReadDeblockingBuffer ()
const PBYTEArray & getWriteDeblockingBuffer ()
PINDEX getReadDeblockingOffset () const
void setReadDeblockingOffset (PINDEX readDeblockingOffset)
PINDEX getWriteDeblockingOffset () const
void setWriteDeblockingOffset (PINDEX writeDeblockingOffset)
unsigned int getCardNumber () const
void setCardNumber (unsigned int uiCardNumber)
unsigned int getDialToneTimeout () const
void setDialToneTimeout (unsigned int uiDialToneTimeout)

Protected Attributes

int os_handle
int osError
T35CountryCodes countryCode
PBYTEArray m_readDeblockingBuffer
PBYTEArray m_writeDeblockingBuffer
PINDEX m_readDeblockingOffset
PINDEX m_writeDeblockingOffset
unsigned int m_uiCardNumber
unsigned int m_uiDialToneTimeout


Detailed Description

Line Interface Device abstraction. Note all functions in this device abstraction are assumed to be thread atomic.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
MaxVolume 

anonymous enum
 

Enumeration values:
DefaultDTMFOnTime 
DefaultDTMFOffTime 

anonymous enum
 

Enumeration values:
DIAL_TONE_TIMEOUT 

enum OpalLineInterfaceDevice::AECLevels
 

Enumeration values:
AECOff 
AECLow 
AECMedium 
AECHigh 
AECAuto 
AECAGC 
AECError 

enum OpalLineInterfaceDevice::CallProgressTones
 

Enumeration values:
NoTone 
DialTone 
RingTone 
BusyTone 
FastBusyTone 
ClearTone 
CNGTone 
MwiTone 
AllTones 

enum OpalLineInterfaceDevice::T35CountryCodes
 

Enumeration values:
Japan 
Albania 
Algeria 
AmericanSamoa 
Germany 
Anguilla 
AntiguaAndBarbuda 
Argentina 
Ascension 
Australia 
Austria 
Bahamas 
Bahrain 
Bangladesh 
Barbados 
Belgium 
Belize 
Benin 
Bermudas 
Bhutan 
Bolivia 
Botswana 
Brazil 
BritishAntarcticTerritory 
BritishIndianOceanTerritory 
BritishVirginIslands 
BruneiDarussalam 
Bulgaria 
Myanmar 
Burundi 
Byelorussia 
Cameroon 
Canada 
CapeVerde 
CaymanIslands 
CentralAfricanRepublic 
Chad 
Chile 
China 
Colombia 
Comoros 
Congo 
CookIslands 
CostaRica 
Cuba 
Cyprus 
Czechoslovakia 
Cambodia 
DemocraticPeoplesRepublicOfKorea 
Denmark 
Djibouti 
DominicanRepublic 
Dominica 
Ecuador 
Egypt 
ElSalvador 
EquatorialGuinea 
Ethiopia 
FalklandIslands 
Fiji 
Finland 
France 
FrenchPolynesia 
FrenchSouthernAndAntarcticLands 
Gabon 
Gambia 
Germany2 
Angola 
Ghana 
Gibraltar 
Greece 
Grenada 
Guam 
Guatemala 
Guernsey 
Guinea 
GuineaBissau 
Guayana 
Haiti 
Honduras 
Hongkong 
Hungary 
Iceland 
India 
Indonesia 
Iran 
Iraq 
Ireland 
Israel 
Italy 
CotedIvoire 
Jamaica 
Afghanistan 
Jersey 
Jordan 
Kenya 
Kiribati 
KoreaRepublic 
Kuwait 
Lao 
Lebanon 
Lesotho 
Liberia 
Libya 
Liechtenstein 
Luxemborg 
Macao 
Madagascar 
Malaysia 
Malawi 
Maldives 
Mali 
Malta 
Mauritania 
Mauritius 
Mexico 
Monaco 
Mongolia 
Montserrat 
Morocco 
Mozambique 
Nauru 
Nepal 
Netherlands 
NetherlandsAntilles 
NewCaledonia 
NewZealand 
Nicaragua 
Niger 
Nigeria 
Norway 
Oman 
Pakistan 
Panama 
PapuaNewGuinea 
Paraguay 
Peru 
Philippines 
Poland 
Portugal 
PuertoRico 
Qatar 
Romania 
Rwanda 
SaintKittsAndNevis 
SaintCroix 
SaintHelenaAndAscension 
SaintLucia 
SanMarino 
SaintThomas 
SaoTomeAndPrincipe 
SaintVicentAndTheGrenadines 
SaudiArabia 
Senegal 
Seychelles 
SierraLeone 
Singapore 
SolomonIslands 
Somalia 
SouthAfrica 
Spain 
SriLanka 
Sudan 
Suriname 
Swaziland 
Sweden 
Switzerland 
Syria 
Tanzania 
Thailand 
Togo 
Tonga 
TrinidadAndTobago 
Tunisia 
Turkey 
TurksAndCaicosIslands 
Tuvalu 
Uganda 
Ukraine 
UnitedArabEmirates 
UnitedKingdom 
UnitedStates 
BurkinaFaso 
Uruguay 
USSR 
Vanuatu 
VaticanCityState 
Venezuela 
VietNam 
WallisAndFutuna 
WesternSamoa 
Yemen 
Yemen2 
Yugoslavia 
Zaire 
Zambia 
Zimbabwe 
NumCountryCodes 
UnknownCountry 


Constructor & Destructor Documentation

OpalLineInterfaceDevice::OpalLineInterfaceDevice  
 

Construct a new line interface device.


Member Function Documentation

virtual BOOL OpalLineInterfaceDevice::Close   [virtual]
 

Close the line interface device.

OpalLineInterfaceDevice* OpalLineInterfaceDevice::Create const PString &    type,
void *    parameters = NULL
[static]
 

Create a new device from the registration string

Parameters:
type  Type of device to create
parameters  Arbitrary parameters for the LID

virtual CallProgressTones OpalLineInterfaceDevice::DialOut unsigned    line,
const PString &    number,
BOOL    requireTones = FALSE,
unsigned    uiDialDelay = 0
[virtual]
 

Dial a number on network line. The takes the line off hook, waits for dial tone, and transmits the specified number as DTMF tones.

If the requireTones flag is TRUE the call is aborted of the call progress tones are not detected. Otherwise the call proceeds with short delays while it tries to detect the call progress tones.

The return code indicates the following: DialTone No dial tone detected RingTone Dial was successful BusyTone The remote phone was busy ClearTone Dial failed (usually means rang out) NoTone There was an internal error making the call

Parameters:
line  Number of line
number  Number to dial
requireTones  Require dial/ring tone to be detected
uiDialDelay  time in msec to wait between the dial tone detection and dialing the dtmf

BOOL OpalLineInterfaceDevice::DisableAudio unsigned    line [inline]
 

Disable audio for the line.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::EnableAudio unsigned    line,
BOOL    enable = TRUE
[virtual]
 

Enable audio for the line.

Parameters:
line  Number of line

virtual AECLevels OpalLineInterfaceDevice::GetAEC unsigned    line [virtual]
 

Get acoustic echo cancellation. Note, not all devices may support this function.

Parameters:
line  Number of line

PStringList OpalLineInterfaceDevice::GetAllDevices   [static]
 

Return an array of all the LID types registered and all of the possible devices each one can open. Each string will be of the form "type: name" eg "Quicknet: 3211FFFF"

virtual PStringArray OpalLineInterfaceDevice::GetAllNames   [pure virtual]
 

Get all the possible devices that can be opened.

PStringList OpalLineInterfaceDevice::GetAllTypes   [static]
 

Return an array of all the LID types registered.

virtual unsigned OpalLineInterfaceDevice::GetAverageSignalLevel unsigned    line,
BOOL    playback
[virtual]
 

Get average signal level in last frame.

Parameters:
line  Number of line
playback  Get average playback or record level.

virtual BOOL OpalLineInterfaceDevice::GetCallerID unsigned    line,
PString &    idString,
BOOL    full = FALSE
[virtual]
 

Get Caller ID from the last incoming ring. The idString parameter is either simply the "number" field of the caller ID data, or if full is TRUE, all of the fields in the caller ID data.

The full data of the caller ID string consists of the number field, the time/date and the name field separated by tabs ('\t').

Parameters:
line  Number of line
idString  ID string returned
full  Get full information in idString

unsigned int OpalLineInterfaceDevice::getCardNumber   const [inline, protected]
 

T35CountryCodes OpalLineInterfaceDevice::GetCountryCode const PString &    name [static]
 

T35CountryCodes OpalLineInterfaceDevice::GetCountryCode   const [inline]
 

Get the country code set for the device.

PString OpalLineInterfaceDevice::GetCountryCodeName T35CountryCodes    code [static]
 

Get the country code set for the device as a string.

PString OpalLineInterfaceDevice::GetCountryCodeName  
 

Get the country code set for the device as a string.

virtual PStringList OpalLineInterfaceDevice::GetCountryCodeNameList   [virtual]
 

Get the list of countries actually supported by the device

virtual PString OpalLineInterfaceDevice::GetDescription   [pure virtual]
 

Get the description of the line interface device. This is a string indication of the card type for user interface display purposes or device specific control. The device should be as detailed as possible eg "Quicknet LineJACK".

virtual PString OpalLineInterfaceDevice::GetDeviceName   [pure virtual]
 

Get the device name, as used to open the device. Note the format of this name should be as is returned from GetAllName() and must be able to be used in a subsequent Open() call.

virtual PString OpalLineInterfaceDevice::GetDeviceType   [pure virtual]
 

Get the device type identifier. This is as is used in the factory registration.

unsigned int OpalLineInterfaceDevice::getDialToneTimeout   const [inline, protected]
 

int OpalLineInterfaceDevice::GetErrorNumber   const [inline]
 

Return number for last error.

PString OpalLineInterfaceDevice::GetErrorText  
 

Return text for last error.

virtual unsigned OpalLineInterfaceDevice::GetLineCount   [pure virtual]
 

Get the total number of lines supported by this device.

virtual OpalMediaFormatList OpalLineInterfaceDevice::GetMediaFormats   [pure virtual]
 

Get the media formats this device is capable of using.

int OpalLineInterfaceDevice::getOsError   const [inline, protected]
 

int OpalLineInterfaceDevice::getOsHandle   const [inline, protected]
 

virtual BOOL OpalLineInterfaceDevice::GetPlayVolume unsigned    line,
unsigned &    volume
[virtual]
 

Set volume level for playing. A value of 100 is the maximum volume possible for the hardware. A value of 0 is the minimum volume possible for the hardware.

Parameters:
line  Number of line
volume  Volume level from 0 to 100%

const PBYTEArray& OpalLineInterfaceDevice::getReadDeblockingBuffer   [inline, protected]
 

PINDEX OpalLineInterfaceDevice::getReadDeblockingOffset   const [inline, protected]
 

virtual OpalMediaFormat OpalLineInterfaceDevice::GetReadFormat unsigned    line [pure virtual]
 

Get the media format (codec) for reading on the specified line.

Parameters:
line  Number of line

virtual PINDEX OpalLineInterfaceDevice::GetReadFrameSize unsigned    line [pure virtual]
 

Get the read frame size in bytes. All calls to ReadFrame() will return this number of bytes.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::GetRecordVolume unsigned    line,
unsigned &    volume
[virtual]
 

Get volume level for recording. A value of 100 is the maximum volume possible for the hardware. A value of 0 is the minimum volume possible for the hardware.

Parameters:
line  Number of line
volume  Volume level from 0 to 100%

virtual BOOL OpalLineInterfaceDevice::GetRemoveDTMF unsigned    line [virtual]
 

Get DTMF removal mode. When set in this mode the DTMF tones detected are removed from the encoded data stream as returned by ReadFrame().

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::GetVAD unsigned    line [virtual]
 

Get voice activity detection. Note, not all devices, or selected codecs, may support this function.

Parameters:
line  Number of line

virtual unsigned OpalLineInterfaceDevice::GetWinkDuration unsigned    line [virtual]
 

Get wink detect minimum duration. This is the signal used by telcos to end PSTN call.

Parameters:
line  Number of line

const PBYTEArray& OpalLineInterfaceDevice::getWriteDeblockingBuffer   [inline, protected]
 

PINDEX OpalLineInterfaceDevice::getWriteDeblockingOffset   const [inline, protected]
 

virtual OpalMediaFormat OpalLineInterfaceDevice::GetWriteFormat unsigned    line [pure virtual]
 

Get the media format (codec) for writing on the specified line.

Parameters:
line  Number of line

virtual PINDEX OpalLineInterfaceDevice::GetWriteFrameSize unsigned    line [pure virtual]
 

Get the write frame size in bytes. All calls to WriteFrame() must be this number of bytes.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::HasHookFlash unsigned    line [virtual]
 

Return TRUE if a hook flash has been detected

virtual BOOL OpalLineInterfaceDevice::HookFlash unsigned    line,
unsigned    flashTime = 200
[virtual]
 

Set the hook state off then straight back on again. This will only operate if the line is currently off hook.

Parameters:
line  Number of line
flashTime  Time for hook flash in milliseconds

virtual BOOL OpalLineInterfaceDevice::IsAudioEnabled unsigned    line [virtual]
 

Determine if audio for the line is enabled.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::IsLineDisconnected unsigned    line,
BOOL    checkForWink = TRUE
[virtual]
 

Determine if line has been disconnected from a call. This uses the hardware (and country) dependent means for determining if the remote end of a PSTN connection has hung up.

For a POTS port this is equivalent to !IsLineOffHook().

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::IsLineOffHook unsigned    line [pure virtual]
 

Determine if line is currently off hook. This function implies that the state is debounced and that a return value of TRUE indicates that the phone is really off hook. That is hook flashes and winks are masked out.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::IsLinePresent unsigned    line,
BOOL    force = FALSE
[virtual]
 

Determine if a physical line is present on the logical line.

Parameters:
line  Number of line
force  Force test, do not optimise

virtual BOOL OpalLineInterfaceDevice::IsLineRinging unsigned    line,
DWORD *    cadence = NULL
[virtual]
 

Determine if line is ringing. This function implies that the state is "debounced" and that a return value of TRUE indicates that the phone is still ringing and it is not simply a pause in the ring cadence.

If cadence is not NULL then it is set with the bit pattern for the incoming ringing. Note that in this case the funtion may take a full sequence to return. If it is NULL it can be assumed that the function will return quickly.

Parameters:
line  Number of line
cadence  Cadence of incoming ring

virtual BOOL OpalLineInterfaceDevice::IsLineTerminal unsigned    line [virtual]
 

Get the type of the line. A "terminal" line is one where a call may terminate. For example a POTS line with a standard telephone handset on it would be a terminal line. The alternative is a "network" line, that is one connected to switched network eg the standard PSTN.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::IsLineToLineDirect unsigned    line1,
unsigned    line2
[virtual]
 

Determine if the two lines are directly connected.

Parameters:
line1  Number of first line
line2  Number of second line

virtual BOOL OpalLineInterfaceDevice::IsOpen   [virtual]
 

Determine if the line interface device is open.

virtual CallProgressTones OpalLineInterfaceDevice::IsToneDetected unsigned    line [virtual]
 

See if any tone is detected.

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::IsTonePlaying unsigned    line [virtual]
 

Determine if a tone is still playing

Parameters:
line  Number of line

virtual BOOL OpalLineInterfaceDevice::Open const PString &    device [pure virtual]
 

Open the line interface device.

Parameters:
device