Crate actually_beep

Source
Expand description

It being a cross-platform library to provides easy to use beep functions that actually beep.

§What is it?

As mentioned above, it’s a cross-platform library that provides very basic audio tones (beeps) for whatever use you may have for that. It’s built on the AMAZING CPAL crate, which provides the low level audio support, & also provides excellent examples from which this crate stole heavily.

§Why does this Exist?

There are a variety of platform dependent crates that have a similar function, including:

None of these are cross-platform, & they are all different. This crate fixes that by providing a general beeping interface that works on all platforms.

§Quick Start

That’s the only kind of start that you can have with this library:

use actually_beep::beep_with_hz_and_millis;

let middle_e_hz = 329;
let a_bit_more_than_a_second_and_a_half_ms = 1600;

beep_with_hz_and_millis(middle_e_hz, a_bit_more_than_a_second_and_a_half_ms).unwrap();

§Futures

Currently, there is one call that blocks. There is no “beep indefinitely” call as the beep crate provides, & it doesn’t provide any way to adjust things like the audio device, host audio system, or anything else.

These things are potentially, possibly, something that may be worked on.

Enums§

Error
The actually_beep Error type

Functions§

beep_with_hz_and_millis
Beeps synchronously.

Type Aliases§

Result
The actually_beep Result type