/usr/include/sipxtapi/ptapi/PtPhoneSpeaker.h is in libsipxtapi-dev 3.3.0~test17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | //
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PtPhoneSpeaker_h_
#define _PtPhoneSpeaker_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ptapi/PtComponent.h"
#include "os/OsTime.h"
#include "os/OsProtectEventMgr.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class TaoClientTask;
//:The PtPhoneSpeaker class models a phone speaker.
class PtPhoneSpeaker : public PtComponent
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum VolumeLevel
{
OFF = 0,
MIDDLE = 5,
FULL = 10
};
//!enumcode: OFF - The speaker is turned off
//!enumcode: MIDDLE - The speaker volume level is set to the middle of its range
//!enumcode: FULL - The speaker volume is set to its maximum level
/* ============================ CREATORS ================================== */
PtPhoneSpeaker();
//:Default constructor
PtPhoneSpeaker(TaoClientTask *pClient);
PtPhoneSpeaker(const PtPhoneSpeaker& rPtPhoneSpeaker);
//:Copy constructor
PtPhoneSpeaker& operator=(const PtPhoneSpeaker& rhs);
//:Assignment operator
virtual
~PtPhoneSpeaker();
//:Destructor
/* ============================ MANIPULATORS ============================== */
virtual PtStatus setVolume(int volume);
//:Sets the speaker volume to a value between OFF and FULL (inclusive).
//!param: volume - The speaker volume level
//!retcode: PT_SUCCESS - Success
//!retcode: PT_INVALID_ARGUMENT - Invalid volume level
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ ACCESSORS ================================= */
virtual PtStatus getVolume(int& rVolume);
//:Sets <i>rVolume</i> to the current speaker volume level.
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
virtual PtStatus getNominalVolume(int& rVolume);
//:Sets <i>rVolume</i> to the default speaker volume level.
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
TaoClientTask *mpClient;
OsTime mTimeOut;
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
OsProtectEventMgr *mpEventMgr;
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtPhoneSpeaker_h_
|