This class describes the Voicetronix line interface device

Inheritance:

Public Methods

	OpalVpbDevice () Create a new, closed, device for a VPB card
	~OpalVpbDevice () Destroy line interface device.
virtual BOOL	Open ( const PString & device ) Open the device.
virtual BOOL	Close () Close the device
virtual PString	GetName () const Get the device name
virtual unsigned	GetLineCount () Get the total number of lines supported by this device
virtual BOOL	IsLineOffHook ( unsigned line ) Determine if line is currently off hook.
virtual BOOL	SetLineOffHook ( unsigned line, BOOL newState = TRUE ) Set the state of the line.
virtual BOOL	IsLineRinging ( unsigned line, DWORD* cadence = NULL ) Determine if line is ringing.
virtual BOOL	IsLineDisconnected ( unsigned line, BOOL checkForWink = TRUE ) Determine if line has been disconnected from a call.
virtual OpalMediaFormat::List	GetMediaFormats () const Get the media formats this device is capable of using
virtual BOOL	SetReadFormat ( unsigned line, const OpalMediaFormat & mediaFormat ) Set the codec for reading.
virtual BOOL	SetWriteFormat ( unsigned line, const OpalMediaFormat & mediaFormat ) Set the codec for writing.
virtual OpalMediaFormat	GetReadFormat ( unsigned line ) Get the media format (codec) for reading on the specified line.
virtual OpalMediaFormat	GetWriteFormat ( unsigned line ) Get the media format (codec) for writing on the specified line.
virtual BOOL	StopReadCodec ( unsigned line ) Stop the read codec.
virtual BOOL	StopWriteCodec ( unsigned line ) Stop the write codec.
virtual BOOL	SetReadFrameSize ( unsigned line, PINDEX frameSize ) Set the read frame size in bytes.
virtual BOOL	SetWriteFrameSize ( unsigned line, PINDEX frameSize ) Set the write frame size in bytes.
virtual PINDEX	GetReadFrameSize ( unsigned line ) Get the read frame size in bytes.
virtual PINDEX	GetWriteFrameSize ( unsigned line ) Get the write frame size in bytes.
virtual BOOL	ReadFrame ( unsigned line, void* buf, PINDEX & count ) Low level read of a frame from the device.
virtual BOOL	WriteFrame ( unsigned line, const void* buf, PINDEX count, PINDEX & written ) Low level write frame to the device.
virtual BOOL	SetRecordVolume ( unsigned line, unsigned volume ) Set volume level for recording.
virtual BOOL	SetPlayVolume ( unsigned line, unsigned volume ) Set volume level for playing.
int	GetOSHandle ( unsigned line ) Return line handle
virtual char	ReadDTMF ( unsigned line ) Read a DTMF digit detected.
virtual BOOL	PlayDTMF ( unsigned line, const char* digits, DWORD onTime = 90, DWORD offTime = 30 ) Play a DTMF digit.
virtual unsigned	IsToneDetected ( unsigned line ) See if a tone is detected.

Inherited from OpalLineInterfaceDevice:

Public Methods

virtual BOOL IsOpen() const

virtual BOOL IsLineTerminal( unsigned line )

virtual BOOL IsLinePresent( unsigned line, BOOL force = FALSE )

virtual BOOL SetLineOnHook( unsigned line )

virtual BOOL HookFlash( unsigned line, unsigned flashTime = 200 )

virtual BOOL HasHookFlash(unsigned line)

virtual BOOL RingLine( unsigned line, DWORD cadence )

virtual BOOL RingLine( unsigned line, PINDEX nCadence, unsigned* pattern )

virtual BOOL SetLineToLineDirect( unsigned line1, unsigned line2, BOOL connect )

virtual BOOL IsLineToLineDirect( unsigned line1, unsigned line2 )

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 StopRawCodec( unsigned line )

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 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 GetRemoveDTMF( unsigned line )

virtual BOOL SetRemoveDTMF( unsigned line, BOOL removeTones )

virtual unsigned 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 CallProgressTones DialOut( unsigned line, const PString & number, BOOL requireTones = FALSE )

T35CountryCodes GetCountryCode() const

PString GetCountryCodeName() const

static PString GetCountryCodeName(T35CountryCodes code)

virtual BOOL SetCountryCode( T35CountryCodes country )

virtual BOOL SetCountryCodeName( const PString & countryName )

virtual PStringList GetCountryCodeNameList() const

int GetErrorNumber() const

PString GetErrorText() const

Documentation

This class describes the Voicetronix line interface device

OpalVpbDevice()

Create a new, closed, device for a VPB card

~OpalVpbDevice()

Destroy line interface device. This calls Close() on the device.

virtual BOOL Open( const PString & device )

Open the device.

Parameters:

device - Device identifier name.

virtual BOOL Close()

Close the device

virtual PString GetName() const

Get the device name

virtual unsigned GetLineCount()

Get the total number of lines supported by this device

virtual BOOL IsLineOffHook( unsigned line )

Determine if line is currently off hook. This returns TRUE if GetLineState() is a state that implies the line is off hook (eg OffHook or LineBusy).

Parameters:

line - Number of line

virtual BOOL SetLineOffHook( unsigned line, BOOL newState = TRUE )

Set the state of the line. Note that not be possible on a given line.

Parameters:

line - Number of line
newState - New state to set

virtual BOOL IsLineRinging( unsigned line, DWORD* cadence = NULL )

Determine if line is ringing.

Parameters:

line - Number of line
cadence - Cadence of incoming ring

virtual BOOL IsLineDisconnected( unsigned line, BOOL checkForWink = TRUE )

Determine if line has been disconnected from a call. return TRUE if a tone is detected.

Parameters:

line - Number of line

virtual OpalMediaFormat::List GetMediaFormats() const

Get the media formats this device is capable of using

virtual BOOL SetReadFormat( unsigned line, const OpalMediaFormat & mediaFormat )

Set the codec for reading.

Parameters:

line - Number of line
mediaFormat - Codec type

virtual BOOL SetWriteFormat( unsigned line, const OpalMediaFormat & mediaFormat )

Set the codec for writing.

Parameters:

line - Number of line
mediaFormat - Codec type

virtual OpalMediaFormat GetReadFormat( unsigned line )

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

Parameters:

line - Number of line

virtual OpalMediaFormat GetWriteFormat( unsigned line )

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

Parameters:

line - Number of line

virtual BOOL StopReadCodec( unsigned line )

Stop the read codec.

Parameters:

line - Number of line

virtual BOOL StopWriteCodec( unsigned line )

Stop the write codec.

Parameters:

line - Number of line

virtual BOOL SetReadFrameSize( unsigned line, PINDEX frameSize )

Set the read frame size in bytes. Note that a LID may ignore this value so always use GetReadFrameSize() for I/O.

Parameters:

line - Number of line
frameSize - New frame size

virtual BOOL SetWriteFrameSize( unsigned line, PINDEX frameSize )

Set the write frame size in bytes. Note that a LID may ignore this value so always use GetReadFrameSize() for I/O.

Parameters:

line - Number of line
frameSize - New frame size

virtual PINDEX GetReadFrameSize( unsigned line )

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

Parameters:

line - Number of line

virtual PINDEX GetWriteFrameSize( unsigned line )

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

Parameters:

line - Number of line

virtual BOOL ReadFrame( unsigned line, void* buf, PINDEX & count )

Low level read of a frame from the device.

Parameters:

line - Number of line
buf - Pointer to a block of memory to receive the read bytes.
count - Number of bytes read, <= GetReadFrameSize()

virtual BOOL WriteFrame( unsigned line, const void* buf, PINDEX count, PINDEX & written )

Low level write frame to the device.

Parameters:

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()

virtual BOOL SetRecordVolume( unsigned line, unsigned volume )

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.

Parameters:

line - Number of line
volume - Volume level from 0 to 100%

virtual BOOL SetPlayVolume( unsigned line, unsigned volume )

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%

int GetOSHandle( unsigned line )

Return line handle

Parameters:

line - Number of line

virtual char ReadDTMF( unsigned line )

Read a DTMF digit detected. This may be characters from the set 0-9, A-D, * or . A null ('\0')character indicates that there are no tones in the queue.

Parameters:

line - Number of line

virtual BOOL PlayDTMF( unsigned line, const char* digits, DWORD onTime = 90, DWORD offTime = 30 )

Play a DTMF digit. Any characters that are not in the set 0-9, A-D, * or  will be ignored.

Parameters:

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

virtual unsigned IsToneDetected( unsigned line )

See if a tone is detected.

Parameters:

line - Number of line

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java