jaus++/2.0/include/jaus/extras/audio/audiosensor.h

Go to the documentation of this file.

#ifndef __JAUS_EXTRAS_AUDIO_AUDIO_SENSOR__H
#define __JAUS_EXTRAS_AUDIO_AUDIO_SENSOR__H

#include "jaus/core/events/events.h"
#include "jaus/core/sensor.h"
#include "jaus/extras/audio/reportaudio.h"
#include "jaus/extras/audio/queryaudio.h"

namespace JAUS
{
    typedef ReportAudio Audio;

    class JAUS_EXTRAS_DLL AudioSensor : public Sensor, public Events::Child
    {
    public:
        const static std::string Name; 
        // Constructor.
        AudioSensor();
        // Destructor.
        ~AudioSensor();
        // Set a sample of audio data from a device.
        virtual bool SetAudioSample(const Byte deviceID,
                                    const Audio::Format format,
                                    const int frequency,
                                    const Packet& audioBuffer,
                                    const Time& timestamp = Time(true));
        Audio GetAudioSample(const int deviceID = -1) const;
        // Method called when an Event has been signaled, generates an Event message.
        virtual bool GenerateEvent(const Events::Subscription& info) const;
        // Method called to determine if an Event is supported by the service.
        virtual bool IsEventSupported(const Events::Type type,
                                      const double requestedPeriodicRate,
                                      const Message* queryMessage,
                                      double& confirmedPeriodicRate,
                                      std::string& errorMessage) const;
        // Audio Sensor is always discoverable.
        virtual bool IsDiscoverable() const { return true; }
        // Processes messages associated with the Audio Sensor Services.
        virtual void Receive(const Message* message);
        // Creates messages associated with the Audio Sensor Service.
        virtual Message* CreateMessage(const UShort messageCode) const;
    private:
        virtual void CheckServiceSynchronization(const unsigned int timeSinceLastCheckMs);
        Mutex mAudioSensorMutex;                
        std::map<Byte, Audio> mAudioData;       
    };
}

#endif
/*  End of File */