#include <lid.h>
Inheritance diagram for OpalLineInterfaceDevice:
Public Types | |
| enum | { MaxVolume = 100 } |
| enum | AECLevels { AECOff, AECLow, AECMedium, AECHigh, AECAuto, AECAGC, AECError } |
| enum | { DefaultDTMFOnTime = 180, DefaultDTMFOffTime = 120 } |
| enum | CallProgressTones { NoTone = -1, DialTone, RingTone, BusyTone, CongestionTone, ClearTone, MwiTone, CNGTone, NumTones } |
| enum | { DIAL_TONE_TIMEOUT = 10000 } |
| 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 } |
Public Member Functions | |
| 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)=0 |
| 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, PINDEX nCadence, const unsigned *pattern=NULL, unsigned frequency=400) |
| 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 | StopReading (unsigned line) |
| virtual BOOL | StopWriting (unsigned line) |
| virtual BOOL | SetReadFrameSize (unsigned line, PINDEX frameSize)=0 |
| virtual BOOL | SetWriteFrameSize (unsigned line, PINDEX frameSize)=0 |
| 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 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 CallProgressTones | DialOut (unsigned line, const PString &number, BOOL requireTones=FALSE, unsigned uiDialDelay=0) |
| virtual unsigned | GetWinkDuration (unsigned line) |
| virtual BOOL | SetWinkDuration (unsigned line, unsigned winkDuration) |
| T35CountryCodes | GetCountryCode () const |
| PString | GetCountryCodeName () const |
| virtual BOOL | SetCountryCode (T35CountryCodes country) |
| virtual BOOL | SetCountryCodeName (const PString &countryName) |
| virtual PStringList | GetCountryCodeNameList () const |
| 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) |
| int | GetErrorNumber () const |
| PString | GetErrorText () const |
| virtual void | PrintOn (ostream &strm) const |
Static Public Member Functions | |
| static PString | GetCountryCodeName (T35CountryCodes code) |
| static T35CountryCodes | GetCountryCode (const PString &name) |
| static OpalLineInterfaceDevice * | Create (const PString &type, void *parameters=NULL) |
| static PStringList | GetAllTypes () |
| static PStringList | GetAllDevices () |
Protected Member Functions | |
| 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 | 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_uiDialToneTimeout |
| std::vector< bool > | m_LineAudioEnabled |
| PString | m_callProgressTones [NumTones] |
| OpalLineInterfaceDevice::OpalLineInterfaceDevice | ( | ) |
Construct a new line interface device.
| virtual BOOL OpalLineInterfaceDevice::Open | ( | const PString & | device | ) | [pure virtual] |
Open the line interface device.
| device | Device identifier name. |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::IsOpen | ( | ) | const [virtual] |
Determine if the line interface device is open.
| virtual BOOL OpalLineInterfaceDevice::Close | ( | ) | [virtual] |
Close the line interface device.
Reimplemented in OpalPluginLID.
| virtual PString OpalLineInterfaceDevice::GetDeviceType | ( | ) | const [pure virtual] |
Get the device type identifier. This is as is used in the factory registration.
Implemented in OpalPluginLID.
| virtual PString OpalLineInterfaceDevice::GetDeviceName | ( | ) | const [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.
Implemented in OpalPluginLID.
| virtual PStringArray OpalLineInterfaceDevice::GetAllNames | ( | ) | const [pure virtual] |
Get all the possible devices that can be opened.
Implemented in OpalPluginLID.
| virtual PString OpalLineInterfaceDevice::GetDescription | ( | ) | const [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".
Implemented in OpalPluginLID.
| virtual unsigned OpalLineInterfaceDevice::GetLineCount | ( | ) | [pure virtual] |
Get the total number of lines supported by this device.
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::IsLineTerminal | ( | unsigned | line | ) | [pure 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.
| line | Number of line |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::IsLinePresent | ( | unsigned | line, | |
| BOOL | force = FALSE | |||
| ) | [virtual] |
Determine if a physical line is present on the logical line.
| line | Number of line |
| force | Force test, do not optimise |
Reimplemented in OpalPluginLID.
| 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.
| line | Number of line |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetLineOffHook | ( | unsigned | line, | |
| BOOL | newState = TRUE | |||
| ) | [pure virtual] |
Set the hook state of the line. Note that not be possible on a given line, for example a POTS line with a standard telephone handset. The hook state is determined by external hardware and cannot be changed by the software.
| line | Number of line |
| newState | New state to set |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetLineOnHook | ( | unsigned | line | ) | [inline, virtual] |
Set the hook state of the line. This is the complement of SetLineOffHook().
| line | Number of line |
| 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.
| line | Number of line |
| flashTime | Time for hook flash in milliseconds |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::HasHookFlash | ( | unsigned | line | ) | [virtual] |
Return TRUE if a hook flash has been detected
Reimplemented in OpalPluginLID.
| 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.
| line | Number of line |
| cadence | Cadence of incoming ring |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::RingLine | ( | unsigned | line, | |
| PINDEX | nCadence, | |||
| const unsigned * | pattern = NULL, |
|||
| unsigned | frequency = 400 | |||
| ) | [virtual] |
Begin ringing local phone set with specified cadence. If nCadence is zero then stops ringing.
Note that this may not be possible on a given line, for example on a PSTN line the ring state is determined by external hardware and cannot be changed by the software.
Also note that the cadence may be ignored by particular hardware driver so that only the zero or non-zero values are significant.
The ring pattern is an array of millisecond times for on and off parts of the cadence. Thus the Australian ring cadence would be represented by the array unsigned AusRing[] = { 400, 200, 400, 2000 }
If the nCadence in non-zero and the pattern parameter is NULL, then the standard ring pattern for the selected country is used.
| line | Number of line |
| nCadence | Number of entries in cadence array |
| pattern | Ring pattern times |
| frequency | Frequency of ring (if relevant) |
Reimplemented in OpalPluginLID.
| 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().
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetLineToLineDirect | ( | unsigned | line1, | |
| unsigned | line2, | |||
| BOOL | connect | |||
| ) | [virtual] |
Directly connect the two lines.
| line1 | Number of first line |
| line2 | Number of second line |
| connect | Flag for connect/disconnect |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::IsLineToLineDirect | ( | unsigned | line1, | |
| unsigned | line2 | |||
| ) | [virtual] |
Determine if the two lines are directly connected.
| line1 | Number of first line |
| line2 | Number of second line |
Reimplemented in OpalPluginLID.
| virtual OpalMediaFormatList OpalLineInterfaceDevice::GetMediaFormats | ( | ) | const [pure virtual] |
Get the media formats this device is capable of using.
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetReadFormat | ( | unsigned | line, | |
| const OpalMediaFormat & | mediaFormat | |||
| ) | [pure virtual] |
Set the media format (codec) for reading on the specified line.
| line | Number of line |
| mediaFormat | Codec type |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetWriteFormat | ( | unsigned | line, | |
| const OpalMediaFormat & | mediaFormat | |||
| ) | [pure virtual] |
Set the media format (codec) for writing on the specified line.
| line | Number of line |
| mediaFormat | Codec type |
Implemented in OpalPluginLID.
| virtual OpalMediaFormat OpalLineInterfaceDevice::GetReadFormat | ( | unsigned | line | ) | [pure virtual] |
Get the media format (codec) for reading on the specified line.
| line | Number of line |
Implemented in OpalPluginLID.
| virtual OpalMediaFormat OpalLineInterfaceDevice::GetWriteFormat | ( | unsigned | line | ) | [pure virtual] |
Get the media format (codec) for writing on the specified line.
| line | Number of line |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::StopReading | ( | unsigned | line | ) | [virtual] |
| virtual BOOL OpalLineInterfaceDevice::StopWriting | ( | unsigned | line | ) | [virtual] |
| virtual BOOL OpalLineInterfaceDevice::SetReadFrameSize | ( | unsigned | line, | |
| PINDEX | frameSize | |||
| ) | [pure virtual] |
Set the read frame size in bytes. Note that a LID may ignore this value so always use GetReadFrameSize() for I/O.
| line | Number of line |
| frameSize | New frame size |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetWriteFrameSize | ( | unsigned | line, | |
| PINDEX | frameSize | |||
| ) | [pure virtual] |
Set the write frame size in bytes. Note that a LID may ignore this value so always use GetReadFrameSize() for I/O.
| line | Number of line |
| frameSize | New frame size |
Implemented in OpalPluginLID.
| 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.
| line | Number of line |
Implemented in OpalPluginLID.
| 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.
| line | Number of line |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::ReadFrame | ( | unsigned | line, | |
| void * | buf, | |||
| PINDEX & | count | |||
| ) | [pure virtual] |
Low level read of a frame from the device.
| line | Number of line |
| buf | Pointer to a block of memory to receive data. |
| count | Number of bytes read, <= GetReadFrameSize() |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::WriteFrame | ( | unsigned | line, | |
| const void * | buf, | |||
| PINDEX | count, | |||
| PINDEX & | written | |||
| ) | [pure virtual] |
Low level write frame to the device.
| line | Number of line |
| buf | Pointer to a block of memory to write. |
| count | Number of bytes to write, <= GetWriteFrameSize() |
| written | Number of bytes written, <= GetWriteFrameSize() |
Implemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::ReadBlock | ( | unsigned | line, | |
| void * | buf, | |||
| PINDEX | count | |||
| ) | [virtual] |
High level read of audio data from the device. This version will allow non-integral number of frames to be read.
| line | Number of line |
| buf | Pointer to a block of memory to receive the read bytes. |
| count | Count of bytes to read. |
| virtual BOOL OpalLineInterfaceDevice::WriteBlock | ( | unsigned | line, | |
| const void * | buf, | |||
| PINDEX | count | |||
| ) | [virtual] |
High level write audio data to the device.
| line | Number of line |
| buf | Pointer to a block of memory to write. |
| count | Count of bytes to write. |
| virtual unsigned OpalLineInterfaceDevice::GetAverageSignalLevel | ( | unsigned | line, | |
| BOOL | playback | |||
| ) | [virtual] |
Get average signal level in last frame.
| line | Number of line |
| playback | Get average playback or record level. |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::EnableAudio | ( | unsigned | line, | |
| BOOL | enable = TRUE | |||
| ) | [virtual] |
| BOOL OpalLineInterfaceDevice::DisableAudio | ( | unsigned | line | ) | [inline] |
Disable audio for the line.
| line | Number of line |
| virtual BOOL OpalLineInterfaceDevice::IsAudioEnabled | ( | unsigned | line | ) | [virtual] |
Determine if audio for the line is enabled.
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetRecordVolume | ( | unsigned | line, | |
| unsigned | volume | |||
| ) | [virtual] |
Set 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.
| line | Number of line |
| volume | Volume level from 0 to 100% |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetPlayVolume | ( | 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.
| line | Number of line |
| volume | Volume level from 0 to 100% |
Reimplemented in OpalPluginLID.
| 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.
| line | Number of line |
| volume | Volume level from 0 to 100% |
Reimplemented in OpalPluginLID.
| 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.
| line | Number of line |
| volume | Volume level from 0 to 100% |
Reimplemented in OpalPluginLID.
| virtual AECLevels OpalLineInterfaceDevice::GetAEC | ( | unsigned | line | ) | [virtual] |
Get acoustic echo cancellation. Note, not all devices may support this function.
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetAEC | ( | unsigned | line, | |
| AECLevels | level | |||
| ) | [virtual] |
Set acoustic echo cancellation. Note, not all devices may support this function.
| line | Number of line |
| level | AEC level |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::GetVAD | ( | unsigned | line | ) | [virtual] |
Get voice activity detection. Note, not all devices, or selected codecs, may support this function.
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetVAD | ( | unsigned | line, | |
| BOOL | enable | |||
| ) | [virtual] |
Set voice activity detection. Note, not all devices, or selected codecs, may support this function.
| line | Number of line |
| enable | Flag for enabling VAD |
Reimplemented in OpalPluginLID.
| 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 ('').
| line | Number of line |
| idString | ID string returned |
| full | Get full information in idString |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetCallerID | ( | unsigned | line, | |
| const PString & | idString | |||
| ) | [virtual] |
Set Caller ID for use in next RingLine() call. The full data of the caller ID string consists of the number field, the time/date and the name field separated by tabs ('').
If the date field is missing (two consecutive tabs) then the current time and date is used. Using an empty string will clear the caller ID so that no caller ID is sent on the next RingLine() call.
| line | Number of line |
| idString | ID string to use |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SendCallerIDOnCallWaiting | ( | unsigned | line, | |
| const PString & | idString | |||
| ) | [virtual] |
Send a Caller ID on call waiting command The full data of the caller ID string consists of the number field, the time/date and the name field separated by tabs ('').
If the date field is missing (two consecutive tabs) then the current time and date is used. Using an empty string will clear the caller ID so that no caller ID is sent on the next RingLine() call.
| line | Number of line |
| idString | ID string to use |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SendVisualMessageWaitingIndicator | ( | unsigned | line, | |
| BOOL | on | |||
| ) | [virtual] |
Send a Visual Message Waiting Indicator
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::PlayDTMF | ( | unsigned | line, | |
| const char * | digits, | |||
| DWORD | onTime = DefaultDTMFOnTime, |
|||
| DWORD | offTime = DefaultDTMFOffTime | |||
| ) | [virtual] |
Play a DTMF digit. Any characters that are not in the set 0-9, A-D, * or # will be ignored.
| line | Number of line |
| digits | DTMF digits to be played |
| onTime | Number of milliseconds to play each DTMF digit |
| offTime | Number of milliseconds between digits |
Reimplemented in OpalPluginLID.
| virtual char OpalLineInterfaceDevice::ReadDTMF | ( | unsigned | line | ) | [virtual] |
Read a DTMF digit detected. This may be characters from the set 0-9, A-D, * or #. A null ('') character indicates that there are no tones in the queue. Characters E through P indicate the following tones:
E = 800 F = 1000 G = 1250 H = 950 I = 1100 J = 1400 K = 1500 L = 1600 M = 1800 N = 2100 O = 1300 P = 2450
| line | Number of line |
Reimplemented in OpalPluginLID.
| 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().
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetRemoveDTMF | ( | unsigned | line, | |
| BOOL | removeTones | |||
| ) | [virtual] |
Set DTMF removal mode. When set in this mode the DTMF tones detected are removed from the encoded data stream as returned by ReadFrame().
| line | Number of line |
| removeTones | Flag for removing DTMF tones. |
Reimplemented in OpalPluginLID.
| virtual CallProgressTones OpalLineInterfaceDevice::IsToneDetected | ( | unsigned | line | ) | [virtual] |
| virtual CallProgressTones OpalLineInterfaceDevice::WaitForToneDetect | ( | unsigned | line, | |
| unsigned | timeout = 3000 | |||
| ) | [virtual] |
See if any tone is detected.
| line | Number of line |
| timeout | Milliseconds to wait for |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::WaitForTone | ( | unsigned | line, | |
| CallProgressTones | tone, | |||
| unsigned | timeout = 3000 | |||
| ) | [virtual] |
See if a specific tone is detected.
| line | Number of line |
| tone | Tone to wait for |
| timeout | Milliseconds to wait for |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetToneFilter | ( | unsigned | line, | |
| CallProgressTones | tone, | |||
| const PString & | description | |||
| ) | [virtual] |
Set a tones filter information. The description string is of the form frequence ':' cadence where frequency is either frequency low '-' high and cadence is mintime ontime '-' offtime ontime '-' offtime '-' ontime '-' offtime examples: 300:0.25 300Hz for minimum 250ms 1100:0.4-0.4 1100Hz with cadence 400ms on, 400ms off 900-1300:1.5 900Hz to 1300Hz for minimum of 1.5 seconds 425:0.4-0.2-0.4-2 425Hz with cadence 400ms on, 200ms off, 400ms on, 2 seconds off
| line | Number of line |
| tone | Tone filter to change |
| description | Description of filter parameters |
| virtual BOOL OpalLineInterfaceDevice::SetToneFilterParameters | ( | unsigned | line, | |
| CallProgressTones | tone, | |||
| unsigned | lowFrequency, | |||
| unsigned | highFrequency, | |||
| PINDEX | numCadences, | |||
| const unsigned * | onTimes, | |||
| const unsigned * | offTimes | |||
| ) | [virtual] |
Set a tones filter information.
| line | Number of line |
| tone | Tone filter to change |
| lowFrequency | Low frequency |
| highFrequency | High frequency |
| numCadences | Number of cadence times |
| onTimes | Cadence ON times |
| offTimes | Cadence OFF times |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::PlayTone | ( | unsigned | line, | |
| CallProgressTones | tone | |||
| ) | [virtual] |
| virtual BOOL OpalLineInterfaceDevice::IsTonePlaying | ( | unsigned | line | ) | [virtual] |
Determine if a tone is still playing
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::StopTone | ( | unsigned | line | ) | [virtual] |
| 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
| 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 |
Reimplemented in OpalPluginLID.
| virtual unsigned OpalLineInterfaceDevice::GetWinkDuration | ( | unsigned | line | ) | [virtual] |
Get wink detect minimum duration. This is the signal used by telcos to end PSTN call.
| line | Number of line |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetWinkDuration | ( | unsigned | line, | |
| unsigned | winkDuration | |||
| ) | [virtual] |
Set wink detect minimum duration. This is the signal used by telcos to end PSTN call.
| line | Number of line |
| winkDuration | New minimum duration |
Reimplemented in OpalPluginLID.
| T35CountryCodes OpalLineInterfaceDevice::GetCountryCode | ( | ) | const [inline] |
Get the country code set for the device.
| PString OpalLineInterfaceDevice::GetCountryCodeName | ( | ) | const |
Get the country code set for the device as a string.
| static PString OpalLineInterfaceDevice::GetCountryCodeName | ( | T35CountryCodes | code | ) | [static] |
Get the country code set for the device as a string.
| static T35CountryCodes OpalLineInterfaceDevice::GetCountryCode | ( | const PString & | name | ) | [static] |
| virtual BOOL OpalLineInterfaceDevice::SetCountryCode | ( | T35CountryCodes | country | ) | [virtual] |
Set the country code set for the device. This may change the line analogue coefficients, ring detect, call disconnect detect and call progress tones to fit the countries telephone network.
| country | COuntry code for device |
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::SetCountryCodeName | ( | const PString & | countryName | ) | [virtual] |
Set the country code set for the device.
| countryName | COuntry code for device |
| virtual PStringList OpalLineInterfaceDevice::GetCountryCodeNameList | ( | ) | const [virtual] |
Get the list of countries actually supported by the device
Reimplemented in OpalPluginLID.
| virtual BOOL OpalLineInterfaceDevice::PlayAudio | ( | unsigned | line, | |
| const PString & | filename | |||
| ) | [virtual] |
Play a wav file
| line | Number of line |
| filename | File Name |
| virtual BOOL OpalLineInterfaceDevice::StopAudio | ( | unsigned | line | ) | [virtual] |
Stop playing the Wave File
| line | Number of line |
| virtual BOOL OpalLineInterfaceDevice::RecordAudioStart | ( | unsigned | line, | |
| const PString & | filename | |||
| ) | [virtual] |
start recording audio
| filename | line File Name |
| virtual BOOL OpalLineInterfaceDevice::RecordAudioStop | ( | unsigned | line | ) | [virtual] |
stop recording audio
| line | line |
| int OpalLineInterfaceDevice::GetErrorNumber | ( | ) | const [inline] |
Return number for last error.
| PString OpalLineInterfaceDevice::GetErrorText | ( | ) | const |
Return text for last error.
| virtual void OpalLineInterfaceDevice::PrintOn | ( | ostream & | strm | ) | const [virtual] |
| static OpalLineInterfaceDevice* OpalLineInterfaceDevice::Create | ( | const PString & | type, | |
| void * | parameters = NULL | |||
| ) | [static] |
Create a new device from the registration string
| type | Type of device to create |
| parameters | Arbitrary parameters for the LID |
| static PStringList OpalLineInterfaceDevice::GetAllTypes | ( | ) | [static] |
Return an array of all the LID types registered.
| static 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"
| int OpalLineInterfaceDevice::getOsHandle | ( | ) | const [inline, protected] |
| void OpalLineInterfaceDevice::setOsHandle | ( | int | os_handleToSet | ) | [inline, protected] |
| int OpalLineInterfaceDevice::getOsError | ( | ) | const [inline, protected] |
| void OpalLineInterfaceDevice::setOsError | ( | int | osErrorToSet | ) | [inline, protected] |
| const PBYTEArray& OpalLineInterfaceDevice::getReadDeblockingBuffer | ( | ) | [inline, protected] |
| const PBYTEArray& OpalLineInterfaceDevice::getWriteDeblockingBuffer | ( | ) | [inline, protected] |
| PINDEX OpalLineInterfaceDevice::getReadDeblockingOffset | ( | ) | const [inline, protected] |
| void OpalLineInterfaceDevice::setReadDeblockingOffset | ( | PINDEX | readDeblockingOffset | ) | [inline, protected] |
| PINDEX OpalLineInterfaceDevice::getWriteDeblockingOffset | ( | ) | const [inline, protected] |
| void OpalLineInterfaceDevice::setWriteDeblockingOffset | ( | PINDEX | writeDeblockingOffset | ) | [inline, protected] |
| unsigned int OpalLineInterfaceDevice::getDialToneTimeout | ( | ) | const [inline, protected] |
| void OpalLineInterfaceDevice::setDialToneTimeout | ( | unsigned int | uiDialToneTimeout | ) | [inline, protected] |
int OpalLineInterfaceDevice::os_handle [protected] |
int OpalLineInterfaceDevice::osError [mutable, protected] |
T35CountryCodes OpalLineInterfaceDevice::countryCode [protected] |
PBYTEArray OpalLineInterfaceDevice::m_readDeblockingBuffer [protected] |
PBYTEArray OpalLineInterfaceDevice::m_writeDeblockingBuffer [protected] |
PINDEX OpalLineInterfaceDevice::m_readDeblockingOffset [protected] |
PINDEX OpalLineInterfaceDevice::m_writeDeblockingOffset [protected] |
unsigned int OpalLineInterfaceDevice::m_uiDialToneTimeout [protected] |
std::vector<bool> OpalLineInterfaceDevice::m_LineAudioEnabled [protected] |
PString OpalLineInterfaceDevice::m_callProgressTones[NumTones] [protected] |
1.5.1