MpSpeakerSelectBase.h

Go to the documentation of this file.

//
// Copyright (C) 2008 SIPez LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

// Author: Sergey Kostanbaev <Sergey DOT Kostanbaev AT sipez DOT com>

#ifndef _MpSpeakerSelectBase_h_
#define _MpSpeakerSelectBase_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <utl/UtlDefs.h>
#include <os/OsStatus.h>
#include <utl/UtlString.h>
#include "mp/MpTypes.h"

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

class MpSpeakerSelectBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   virtual OsStatus init(int maxParticipants, int maxActive) = 0;
   static MpSpeakerSelectBase *createInstance(const UtlString &name = "");
   virtual ~MpSpeakerSelectBase() {};


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


   virtual void reset() = 0;
   virtual OsStatus enableParticipant(int num, UtlBoolean newState) = 0;
   virtual OsStatus processFrame(MpSpeechParams* speechParams[],
                                 int frameSize) = 0;
   virtual OsStatus setParam(const char* paramName, void* value) = 0;
   static void setDefaultAlgorithm(const UtlString& name);

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



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


   virtual OsStatus isParticipantEnabled(int num, UtlBoolean &enabled) = 0;

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

   static UtlString smDefaultAlgorithm; 

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

};

#endif // _MpSpeakerSelectBase_h_