Component: Tone Generator (Runtime Tools)

From Flowcode Help
Revision as of 12:05, 3 November 2020 by BenR (talk | contribs) (XML import)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search


Author Matrix TSL
Version 1.0 (Release)
Category Runtime Tools


Image Tone Generator component

A component to generate simple mono tone audio tones for use in alarms or other audible feedback.

Examples

No additional examples


Downloadable macro reference

This component does not contain any downloadable macros

Simulation macro reference

PlayTone

Blocking call that plays a tone for a specific period of time.

Parameters

BYTE Tone
0=Off, 1=C, 2=C#, 3=D, 4=D#, 5=E, 5=F, 6=F#, 7=G, 8=G#, 9=A, 10=A#, 11=B, 12=C
UINT Delay
delay in milliseconds


Return value

This call does not return a value


SetTone

Sets the output tone without blocking for the tone to end

To end the note the macro must be called again with the tone paramete set to 0.

Parameters

BYTE Tone
0=Off, 1=C, 2=C#, 3=D, 4=D#, 5=E, 5=F, 6=F#, 7=G, 8=G#, 9=A, 10=A#, 11=B, 12=C


Return value

This call does not return a value



Property reference

This component does not contain any properties