MiNotification.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2021 SIPez LLC.  All rights reserved.
//
// $$

// Author: Keith Kyzivat <kkyzivat AT SIPez DOT com>

#ifndef _MiNotification_h_
#define _MiNotification_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsMsg.h"
#include "utl/UtlString.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class MiNotification : public OsMsg
{
   /* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   typedef enum
   {
      MI_NOTF_MESSAGE_INVALID, 

      MI_NOTF_PLAY_STARTED,
      MI_NOTF_PLAY_PAUSED,
      MI_NOTF_PLAY_RESUMED,
      MI_NOTF_PLAY_STOPPED,
      MI_NOTF_PLAY_FINISHED,
      MI_NOTF_PLAY_ERROR,
      MI_NOTF_PROGRESS,           
      MI_NOTF_RECORD_STARTED,     
      MI_NOTF_RECORD_PAUSED,      
      MI_NOTF_RECORD_RESUMED,     
      MI_NOTF_RECORD_STOPPED,     
      MI_NOTF_RECORD_FINISHED,    
      MI_NOTF_RECORD_ERROR,       
      MI_NOTF_DTMF_RECEIVED,      
      MI_NOTF_DELAY_SPEECH_STARTED,
      MI_NOTF_DELAY_NO_DELAY,
      MI_NOTF_DELAY_QUIESCENCE,
      MI_NOTF_RX_STREAM_ACTIVITY, 
      MI_NOTF_ENERGY_LEVEL,       
      MI_NOTF_VOICE_STARTED,
      MI_NOTF_VOICE_STOPPED,
      MI_NOTF_H264_SPS,
      MI_NOTF_H264_PPS,
      MI_NOTF_TONE_DETECT_ON,
      MI_NOTF_TONE_DETECT_OFF,
      MI_NOTF_RECORDER_CIRCULARBUFFER_WATERMARK_REACHED,
      MI_NOTF_INPUT_DEVICE_NOT_PRESENT,
      MI_NOTF_OUTPUT_DEVICE_NOT_PRESENT,
      MI_NOTF_INPUT_DEVICE_NOW_PRESENT,
      MI_NOTF_OUTPUT_DEVICE_NOW_PRESENT
   } NotfType;

   static const int INVALID_CONNECTION_ID;

   /* ============================ CREATORS ================================== */


   MiNotification(NotfType msgType,
                  const UtlString& sourceId,
                  int connectionId = INVALID_CONNECTION_ID,
                  int streamId = -1);

   MiNotification(const MiNotification& rNotf);

   virtual OsMsg* createCopy(void) const;

   virtual ~MiNotification();


   /* ============================ MANIPULATORS ============================== */


   MiNotification& operator=(const MiNotification& rhs);

   void setSourceId(const UtlString& sourceId);
   void setConnectionId(int connId);

   void setStreamId(int streamId);


   /* ============================ ACCESSORS ================================= */


   NotfType getType(void) const;

   UtlString getSourceId(void) const;
   int getConnectionId() const;

   int getStreamId() const;


   /* ============================ INQUIRY =================================== */



   /* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   /* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   UtlString mSourceId; 
   int mConnectionId;   
   int mStreamId;       
};

/* ============================ INLINE METHODS ============================ */

#endif  // _MiNotification_h_