OPAL  Version 3.18.8
OpalLineSilenceDetector Class Reference

#include <lidep.h>

Inheritance diagram for OpalLineSilenceDetector:
Collaboration diagram for OpalLineSilenceDetector:

Public Member Functions

Construction
 OpalLineSilenceDetector (OpalLine &line, const Params &newParam)
 
Overrides from OpalSilenceDetector
virtual unsigned GetAverageSignalLevel (const BYTE *buffer, PINDEX size)
 
- Public Member Functions inherited from OpalSilenceDetector
 P_DECLARE_STREAMABLE_ENUM (Modes, NoSilenceDetection, FixedSilenceDetection, AdaptiveSilenceDetection)
 
 OpalSilenceDetector (const Params &newParam)
 
const PNotifier & GetReceiveHandler () const
 
void SetParameters (const Params &params, const int clockRate=0)
 
void GetParameters (Params &params)
 
void SetClockRate (unsigned clockRate)
 
unsigned GetClockRate () const
 
Result GetResult (unsigned *currentThreshold=NULL, unsigned *currentLevel=NULL) const
 
Result Detect (const BYTE *audioPtr, PINDEX audioLen, unsigned timestamp)
 

Protected Attributes

OpalLinem_line
 
- Protected Attributes inherited from OpalSilenceDetector
PNotifier m_receiveHandler
 
Mode m_mode
 
unsigned m_signalDeadband
 
unsigned m_silenceDeadband
 
unsigned m_adaptivePeriod
 
unsigned m_clockRate
 
unsigned m_lastTimestamp
 
unsigned m_receivedTime
 
unsigned m_levelThreshold
 
unsigned m_signalMinimum
 
unsigned m_silenceMaximum
 
unsigned m_signalReceivedTime
 
unsigned m_silenceReceivedTime
 
unsigned m_lastSignalLevel
 
Result m_lastResult
 

Additional Inherited Members

- Public Types inherited from OpalSilenceDetector
typedef Modes Mode
 
enum  Result { IsSilent, VoiceActivated, VoiceActive }
 
- Static Public Member Functions inherited from OpalSilenceDetector
static unsigned GetAverageSignalLevelPCM16 (const BYTE *buffer, PINDEX size, bool asPercentage)
 
- Protected Member Functions inherited from OpalSilenceDetector
 PDECLARE_NOTIFIER (RTP_DataFrame, OpalSilenceDetector, ReceivedPacket)
 
 PDECLARE_MUTEX (m_inUse)
 

Constructor & Destructor Documentation

OpalLineSilenceDetector::OpalLineSilenceDetector ( OpalLine line,
const Params newParam 
)

Create a new silence detector for a LID.

Parameters
lineLine to detect silence on
newParamNew parameters for silence detector

Member Function Documentation

virtual unsigned OpalLineSilenceDetector::GetAverageSignalLevel ( const BYTE *  buffer,
PINDEX  size 
)
virtual

Get the average signal level in the stream. This is called from within the silence detection algorithm to calculate the average signal level of the last data frame read from the stream.

The default behaviour returns UINT_MAX which indicates that the average signal has no meaning for the stream.

Parameters
bufferRTP payload being detected
sizeSize of payload buffer

Implements OpalSilenceDetector.

Field Documentation

OpalLine& OpalLineSilenceDetector::m_line
protected

The documentation for this class was generated from the following file: