playTone()

Description

Plays a tone on the speaker for the specified time. Call can be either blocking (default) or non-blocking*.

For a blocking call, the call will take the amount of time that it takes to play the tone, so if you have a duration of, say, 5000 milliseconds your Circuit Playground will spend 5 seconds playing a tone and won't be doing anything else.

If you do not want the call to wait the specified amount of time and return immediately (i.e. non-blocking), specify false for the third parameter.

*NOTE: Applies to library version 1.6.4 and up.

Syntax

playTone(freq, time, wait=true);

Parameters

freq [uint16_t]: The frequency of the tone in Hertz.
time [uint16_t]: The duration of the tone in milliseconds.
wait [boolean]: Specify whether call should block or not.

Returns

Nothing