SPIKE-RT C API Reference [English]
An RTOS-based software platform for LEGO® Education SPIKE™.
Macros | Functions
Speaker

APIs for speaker. More...

Macros

#define SOUND_MANUAL_STOP   (-1)
 
#define NOTE_C4   ( 261.63)
 
#define NOTE_CS4   ( 277.18)
 
#define NOTE_D4   ( 293.66)
 
#define NOTE_DS4   ( 311.13)
 
#define NOTE_E4   ( 329.63)
 
#define NOTE_F4   ( 349.23)
 
#define NOTE_FS4   ( 369.99)
 
#define NOTE_G4   ( 392.00)
 
#define NOTE_GS4   ( 415.30)
 
#define NOTE_A4   ( 440.00)
 
#define NOTE_AS4   ( 466.16)
 
#define NOTE_B4   ( 493.88)
 
#define NOTE_C5   ( 523.25)
 
#define NOTE_CS5   ( 554.37)
 
#define NOTE_D5   ( 587.33)
 
#define NOTE_DS5   ( 622.25)
 
#define NOTE_E5   ( 659.25)
 
#define NOTE_F5   ( 698.46)
 
#define NOTE_FS5   ( 739.99)
 
#define NOTE_G5   ( 783.99)
 
#define NOTE_GS5   ( 830.61)
 
#define NOTE_A5   ( 880.00)
 
#define NOTE_AS5   ( 932.33)
 
#define NOTE_B5   ( 987.77)
 
#define NOTE_C6   (1046.50)
 
#define NOTE_CS6   (1108.73)
 
#define NOTE_D6   (1174.66)
 
#define NOTE_DS6   (1244.51)
 
#define NOTE_E6   (1318.51)
 
#define NOTE_F6   (1396.91)
 
#define NOTE_FS6   (1479.98)
 
#define NOTE_G6   (1567.98)
 
#define NOTE_GS6   (1661.22)
 
#define NOTE_A6   (1760.00)
 
#define NOTE_AS6   (1864.66)
 
#define NOTE_B6   (1975.53)
 

Functions

void hub_speaker_set_volume (uint8_t volume)
 Set the volume level of speaker. More...
 
void hub_speaker_play_tone (uint16_t frequency, int32_t duration)
 Play a tone. More...
 
void hub_speaker_stop (void)
 Stop the sound.
 

Detailed Description

APIs for speaker.

Function Documentation

◆ hub_speaker_play_tone()

void hub_speaker_play_tone ( uint16_t  frequency,
int32_t  duration 
)

Play a tone.

Parameters
frequencyfrequency of the note in Hz.
duratonduration to play in msec or SOUND_MANUAL_STOP, which requires a call to hub_speaker_stop to stop the tone.

◆ hub_speaker_set_volume()

void hub_speaker_set_volume ( uint8_t  volume)

Set the volume level of speaker.

Parameters
volumethe percentage of max volume level, between 0 and 100.