Play an audio alert on the device. More...

#include <types.h>

Data Fields
struct infuse_rpc_req_header	header
	Common RPC request header.
uint16_t	frequency_hz
	Audio frequency of the first burst (Hz)
uint32_t	duration_ms
	Total duration of the alert (milliseconds)
uint16_t	burst_length_ms
	Length of each audio burst, up to burst_period_ms (milliseconds)
uint16_t	burst_period_ms
	Period between the start of each audio burst (milliseconds)
int16_t	burst_frequency_shift_hz
	Frequency change applied to each subsequent burst (Hz)
uint16_t	loop_after
	Reset the frequency to frequency_hz after this many bursts (0 = never)
uint8_t	volume_percent
	Audio volume (1 to 100 %), remains set after the alert.
uint8_t	wait
	Respond once the alert has completed instead of immediately, duration_ms must be 10000 or less (0 = respond immediately)

Detailed Description

Play an audio alert on the device.

Field Documentation

int16_t rpc_audio_alert_request::burst_frequency_shift_hz

Frequency change applied to each subsequent burst (Hz)

uint16_t rpc_audio_alert_request::burst_length_ms

Length of each audio burst, up to burst_period_ms (milliseconds)

uint16_t rpc_audio_alert_request::burst_period_ms

Period between the start of each audio burst (milliseconds)

uint32_t rpc_audio_alert_request::duration_ms

Total duration of the alert (milliseconds)

uint16_t rpc_audio_alert_request::frequency_hz

Audio frequency of the first burst (Hz)

struct infuse_rpc_req_header rpc_audio_alert_request::header

Common RPC request header.

uint16_t rpc_audio_alert_request::loop_after

Reset the frequency to frequency_hz after this many bursts (0 = never)

uint8_t rpc_audio_alert_request::volume_percent

Audio volume (1 to 100 %), remains set after the alert.

uint8_t rpc_audio_alert_request::wait

Respond once the alert has completed instead of immediately, duration_ms must be 10000 or less (0 = respond immediately)

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