xtd::beep Class Reference

Inheritance diagram for xtd::beep:

Definition

Represent beep output manipulator class.

Header

#include <xtd/beep>

Namespace

xtd

Library

xtd.core

See also

xtd::console::beep method.

Public Constructors
	beep ()=default
	Plays the sound of a beep through the console speaker.
	beep (uint32 frequency, uint32 duration)
	Plays the sound of a beep of a specified frequency and duration through the console speaker.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

beep() [1/2]

xtd::beep::beep ( )

default

Plays the sound of a beep through the console speaker.

Remarks

By default, the beep plays at a frequency of 800 hertz for a duration of 200 milliseconds

Examples

The following example demonstrates the beep method. The example accepts a number from 1 through 9 as a command line argument, and plays the beep that number of times.

#include <xtd/xtd>
 
auto main(int argc, char* argv[]) -> int {
  int x = 0;
  //
  if ((argc == 2) && (int32_object::try_parse(argv[1], x) == true) && ((x >= 1) && (x <= 9))) {
    for (auto i = 1; i <= x; i++) {
      console::out << string::format("Beep number {}.", i) << beep() << environment::new_line;
      threading::thread::sleep(100_ms);
    }
  } else
    console::out << "Usage: Enter the number of times (between 1 and 9) to beep." << environment::new_line;
}

beep() [2/2]

xtd::beep::beep ( uint32 frequency, uint32 duration )

inline

Plays the sound of a beep of a specified frequency and duration through the console speaker.

Parameters

frequency	The frequency of the beep, ranging from 37 to 32767 hertz
duration	The duration of the beep measured in milliseconds

Examples

This example demonstrates the beep method by playing the first few notes of a song through the console speaker.

#include <xtd/xtd>
 
// Define the frequencies of notes in an octave, as well as silence (rest).
enum class tone {
  rest = 0,
  g_below_c = 196,
  a = 220,
  a_sharp = 233,
  b = 247,
  c = 262,
  c_sharp = 277,
  d = 294,
  d_sharp = 311,
  e = 330,
  f = 349,
  f_sharp = 370,
  g = 392,
  g_sharp = 415
};
 
// Define the duration of a note in units of milliseconds.
enum class duration {
  none = 0,
  whole = 1600,
  half = whole / 2,
  quarter = half / 2,
  eighth = quarter / 2,
  sixteenth = eighth / 2
};
 
// Define a note as a frequency (tone) and the amount of time (duration) the note plays.
using note = std::tuple<tone, duration>;
 
// Play the notes in a song.
auto play(auto&& tone, auto&& duration) {console::beep(as<uint32>(tone), as<uint32>(duration));}
auto play(auto&& note) {std::apply([](auto&&... args) {play(args...);}, note);}
auto play(auto&&... tune) {(play(tune), ...);}
 
auto main() -> int {
  // Declare the first few notes of the song, "Mary Had A Little Lamb" and play it
  play(note {tone::b, duration::quarter},
       note {tone::a, duration::quarter},
       note {tone::g_below_c, duration::quarter},
       note {tone::a, duration::quarter},
       note {tone::b, duration::quarter},
       note {tone::b, duration::quarter},
       note {tone::b, duration::half},
       note {tone::a, duration::quarter},
       note {tone::a, duration::quarter},
       note {tone::a, duration::half},
       note {tone::b, duration::quarter},
       note {tone::d, duration::quarter},
       note {tone::d, duration::half});
}

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/beep.hpp