upm  1.1.0
Sensor/Actuator repository for libmraa (v1.5.1)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
speaker.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2017 Intel Corporation.
4  *
5  * Based on original C++ driver by:
6  * Author: Zion Orent <sorent@ics.com>
7  * Copyright (c) 2014 Intel Corporation.
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27  */
28 #pragma once
29 
30 #include <string>
31 
32 #include "speaker.h"
33 
34 namespace upm {
35 
69  class Speaker {
70  public:
78  Speaker(int pin, bool usePWM=false);
79 
84  virtual ~Speaker();
90  void playAll();
101  void playSound(char letter, bool sharp, std::string vocalWeight);
102 
114  void emit(unsigned int freq, unsigned int emit_ms);
115 
126  void setFrequency(unsigned int freq);
127 
134  void on();
135 
141  void off();
142 
143  protected:
144  speaker_context m_speaker;
145 
146  private:
147  };
148 }
void emit(unsigned int freq, unsigned int emit_ms)
Definition: speaker.cxx:65
void playSound(char letter, bool sharp, std::string vocalWeight)
Definition: speaker.cxx:60
void setFrequency(unsigned int freq)
Definition: speaker.cxx:72
C API for the Speaker.
Speaker(int pin, bool usePWM=false)
Definition: speaker.cxx:37
virtual ~Speaker()
Definition: speaker.cxx:50
void playAll()
Definition: speaker.cxx:55
API for the Speaker.
Definition: speaker.hpp:69
Definition: speaker.h:53
void off()
Definition: speaker.cxx:84
void on()
Definition: speaker.cxx:79