This class describes the xJack line interface device
![]() | OpalVpbDevice () Create a new, closed, device for a VPB card |
![]() | ~OpalVpbDevice () Destroy line interface device. |
![]() | Open ( const PString & device ) Open the xJack device. |
![]() | Close () Close the xJack device |
![]() | GetName () const Get the device name |
![]() | GetLineCount () Get the total number of lines supported by this device |
![]() | IsLineOffHook ( unsigned line ) Determine if line is currently off hook. |
![]() | SetLineOffHook ( unsigned line, BOOL newState = TRUE ) Set the state of the line. |
![]() | IsLineRinging ( unsigned line, DWORD * cadence = NULL ) Determine if line is ringing. |
![]() | GetMediaFormats () const Get the media formats this device is capable of using |
![]() | SetReadFormat ( unsigned line, const OpalMediaFormat & mediaFormat ) Set the codec for reading. |
![]() | SetWriteFormat ( unsigned line, const OpalMediaFormat & mediaFormat ) Set the codec for writing. |
![]() | GetReadFormat ( unsigned line ) Get the media format (codec) for reading on the specified line. |
![]() | GetWriteFormat ( unsigned line ) Get the media format (codec) for writing on the specified line. |
![]() | StopReadCodec ( unsigned line ) Stop the read codec. |
![]() | StopWriteCodec ( unsigned line ) Stop the write codec. |
![]() | SetReadFrameSize ( unsigned line, PINDEX frameSize ) Set the read frame size in bytes. |
![]() | SetWriteFrameSize ( unsigned line, PINDEX frameSize ) Set the write frame size in bytes. |
![]() | GetReadFrameSize ( unsigned line ) Get the read frame size in bytes. |
![]() | GetWriteFrameSize ( unsigned line ) Get the write frame size in bytes. |
![]() | ReadFrame ( unsigned line, void * buf, PINDEX & count ) Low level read of a frame from the device. |
![]() | WriteFrame ( unsigned line, const void * buf, PINDEX count, PINDEX & written ) Low level write frame to the device. |
![]() | SetRecordVolume ( unsigned line, unsigned volume ) Set volume level for recording. |
![]() | SetPlayVolume ( unsigned line, unsigned volume ) Set volume level for playing. |
![]() | ReadDTMF ( unsigned line ) Read a DTMF digit detected. |
![]() | PlayDTMF ( unsigned line, const char * digits, DWORD onTime = 90, DWORD offTime = 30 ) Play a DTMF digit. |
![]() | IsToneDetected ( unsigned line ) See if a tone is detected. |
This class describes the xJack line interface device
~OpalVpbDevice()
virtual BOOL Open( const PString & device )
virtual BOOL Close()
virtual PString GetName() const
virtual unsigned GetLineCount()
virtual BOOL IsLineOffHook( unsigned line )
virtual BOOL SetLineOffHook( unsigned line, BOOL newState = TRUE )
newState - New state to setvirtual BOOL IsLineRinging( unsigned line, DWORD * cadence = NULL )
cadence - Cadence of incoming ringvirtual OpalMediaFormat::List GetMediaFormats() const
virtual BOOL SetReadFormat( unsigned line, const OpalMediaFormat & mediaFormat )
mediaFormat - Codec typevirtual BOOL SetWriteFormat( unsigned line, const OpalMediaFormat & mediaFormat )
mediaFormat - Codec typevirtual OpalMediaFormat GetReadFormat( unsigned line )
virtual OpalMediaFormat GetWriteFormat( unsigned line )
virtual BOOL StopReadCodec( unsigned line )
virtual BOOL StopWriteCodec( unsigned line )
virtual BOOL SetReadFrameSize( unsigned line, PINDEX frameSize )
frameSize - New frame sizevirtual BOOL SetWriteFrameSize( unsigned line, PINDEX frameSize )
frameSize - New frame sizevirtual PINDEX GetReadFrameSize( unsigned line )
virtual PINDEX GetWriteFrameSize( unsigned line )
virtual BOOL ReadFrame( unsigned line, void * buf, PINDEX & count )
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 )
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 )
volume - Volume level from 0 to 100%virtual BOOL SetPlayVolume( unsigned line, unsigned volume )
volume - Volume level from 0 to 100%virtual char ReadDTMF( unsigned line )
virtual BOOL PlayDTMF( unsigned line, const char * digits, DWORD onTime = 90, DWORD offTime = 30 )
digits - DTMF digits to be played
onTime - Number of milliseconds to play each DTMF digit
offTime - Number of milliseconds between digitsvirtual unsigned IsToneDetected( unsigned line )
Alphabetic index HTML hierarchy of classes or Java