Vibrator.hpp

Go to the documentation of this file.

#ifndef __blip_Vibrator_hpp
#define __blip_Vibrator_hpp

#include <blip/Blip.hpp>
#include <blip/AudioException.hpp>

#include <commonc++/ScopedPtr.h++>

namespace blip {

class AudioContext;
class AudioEngine;

class Vibrator
{
  friend class AudioEngine;

  public:

  ~Vibrator();

  void setVibrating(bool on);

  bool isVibrating();

  void setFrequency(uint_t milliHertz);

  uint_t getFrequency();

  inline bool supportsFrequency() const
  { return(_supportsFrequency); }

  inline uint_t getMinFrequency() const
  { return(_minFrequency); }

  inline uint_t getMaxFrequency() const
  { return(_maxFrequency); }

  void setIntensity(uint_t perMille);

  uint_t getIntensity();

  inline bool supportsIntensity() const
  { return(_supportsFrequency); }

  inline uint_t getMinIntensity() const
  { return(0); }

  inline uint_t getMaxIntensity() const
  { return(1000); }

  private:

  Vibrator(AudioContext* context, uint32_t deviceID);
  void init();

  void checkResult(uint32_t result, const char* call);

  struct Private;

  ccxx::ScopedPtr<Private> _private;
  AudioContext* _context;
  uint32_t _deviceID;
  uint_t _minFrequency;
  uint_t _maxFrequency;
  bool _supportsFrequency;
  bool _supportsIntensity;

  CCXX_COPY_DECLS(Vibrator);
};

} // namespace blip

#endif // __blip_Vibrator_hpp