com.ugrokit.api.Ugi.SpeakerTone Class Reference

Overview

A single tone, used by setFoundItemSound and setFoundLastItemSound.

Public Member Functions

int getFrequency ()
 Get the frequency for the tone. More...
 
int getDurationMsec ()
 Get the duration of the tone in milliseconds. More...
 
 SpeakerTone (int frequency, int durationMsec)
 Create a speaker tone. More...
 

Member Function Documentation

◆ getFrequency()

int com.ugrokit.api.Ugi.SpeakerTone.getFrequency ( )

Get the frequency for the tone.

Returns
frequency

◆ getDurationMsec()

int com.ugrokit.api.Ugi.SpeakerTone.getDurationMsec ( )

Get the duration of the tone in milliseconds.

Returns
duration

Constructor & Destructor Documentation

◆ SpeakerTone()

com.ugrokit.api.Ugi.SpeakerTone.SpeakerTone ( int  frequency,
int  durationMsec 
)

Create a speaker tone.

Parameters
frequencyFrequency for the tone
durationMsecDuration of the tone in milliseconds