VEX2 Functions Sound - Revision history

Bfeher at 16:10, 30 April 2012

2012-04-30T16:10:57Z

Bfeher at 16:01, 30 April 2012

2012-04-30T16:01:49Z

Bfeher: moved VEX2: Functions - Sound to VEX2 Functions Sound

2012-04-30T16:01:14Z

moved VEX2: Functions - Sound to VEX2 Functions Sound

Bfeher at 15:23, 30 April 2012

2012-04-30T15:23:00Z

Bfeher at 19:37, 13 April 2012

2012-04-13T19:37:41Z

Bfeher: /* bSoundQueueAvailable */

2012-02-15T20:54:09Z

bSoundQueueAvailable

Bfeher: Created page with "{| style="font-family:Verdana, Genega, sans-sarif; font-size:80%;color:gray;" width="100%" cellpadding="0%" cellspacing="0" border="0" |- | ''Main >> [[VEX2_Mai..."

2012-02-15T20:53:09Z

Created page with "{| style="font-family:Verdana, Genega, sans-sarif; font-size:80%;color:gray;" width="100%" cellpadding="0%" cellspacing="0" border="0" |- | ''Main >> [[VEX2_Mai..."

New page

{| style="font-family:Verdana, Genega, sans-sarif; font-size:80%;color:gray;" width="100%" cellpadding="0%" cellspacing="0" border="0"
|-
|
''[[Main_Page|Main]] >> [[VEX2_Main|CORTEX]] >> [[VEX2: Functions| Functions and Variables]] >> [[VEX2:_Functions_-_Sound|Sound]] ''
|-
|}

{| class="wikiText"
|-
|ROBOTC provides a comprehensive suite of functions for controlling an optional speaker connected to the first motor port on a VEX controller.

The ROBOTC firmware queues up to 10 sound items for playback. This allows user programs to initiate playback of a sound item and continue execution without having to wait for a sound item to finish; this mode of operation is very desirable for robots where, if you waited for the sound to complete playback, you could be delayed in updating the robot’s motors in reaction to a change in sensors.

There are several sample programs illustrating sound playback on a VEX controller. The file “songs.c” contains several complete songs that can be played as a background task while your robot continues to execute its main “mission” task.
|-
|}

{|
|-
|style="vertical-align:top"| __TOC__
|style="vertical-align:top"|
{| width="100" cellpadding="2" cellspacing="0" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!colspan="2" class="wikiHeader"|Color Key
|-
|class="wikiText" width="75%" style="border-style: solid; border-width: 1px 0px 0px 0px"|Function:
|width="25%" style="border-style: solid; border-width: 1px 0px 0px 0px;" class="colorKeyFunc"|
|-
|class="wikiText" width="75%" style="border-style: solid; border-width: 0px 0px 0px 0px"|Variable:
|width="25%" style="border-style: solid; border-width: 0px 0px 0px 0px;" class="colorKeyVar"|
|}
|-
|}

== bPlaySounds ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="variableType"| word bPlaySounds
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_word|word]]) Boolean flag. Indicates whether new sound requests should be accepted or discarded. ''Note that this is defined as a [[Data_Types#dataType_word|word]] but is treated as a [[Data_Types#dataType_bool|bool]].''
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
bPlaySounds = true; // ACCEPT new sound requests
bPlaySounds = false; // DISCARD new sound requests
</syntaxhighlight>
|-
|}
|-
|}
 

== bSoundActive ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="variableType"| const bool bSoundActive
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_bool|bool]]) Boolean flag. If true indicates sound system is actively playing sound.
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
while(bSoundActive) // while a sound is actively playing:
{
// do not continue until finished playing sound
}
</syntaxhighlight>
|-
|}
|-
|}
 

== bSoundQueueAvailable ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="variableType"| const bool bSoundQueueAvailable
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_bool|bool]]) Boolean flag. Indicates whether there is space available in the sound queue for another item.
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
if(bSoundQueueAvailable) // if there is still space in the Sound Queue:
{
PlayImmediateTone(SensorValue[lightSensor] * 80, 50); // play tone according to light sensor readings
}
else // if there is no longer any space in the Sound Queue:
{
nxtDisplayCenteredTextLine(3, "Sound Queue Full!"); // display a centered text on line 3 of the NXT LCD
}
</syntaxhighlight>
|-
|}
|-
|}
 

== ClearSounds ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void ClearSounds()
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Clears all existing and buffered sound commands.
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
ClearSounds(); // clear the sound buffer
</syntaxhighlight>
|-
|}
|-
|}
 

== MuteSound ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void MuteSound()
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Mutes all subsequent sound commands.
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
MuteSound(); // MUTE
</syntaxhighlight>
|-
|}
|-
|}
 

== nVolume ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="variableType"| word nVolume
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_word|word]]) Sound volume. Range 0 to 4 (loudest).
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
nVolume = 1; // set the volume to 1, a nice and comfortable volume for a quiet location
</syntaxhighlight>
|-
|}
|-
|}
 

== PlayImmediateTone ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void PlayImmediateTone(const int frequency, const int durationIn10MsecTicks)
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Immediately play tone at frequency & duration ahead of queued requests.
|-
|
{| class="parameterTable" cellpadding="5%" width="100%"
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
|-
| style="border-style: solid; border-width: 1px 0px 1px 0px"|''frequency''
| style="border-style: solid; border-width: 1px 0px 1px 0px"|The frequency of the tone to play
| style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_int|int]]
|-
| style="border-style: solid; border-width: 0px 0px 0px 0px"|''durationIn10MsecTicks''
| style="border-style: solid; border-width: 0px 0px 0px 0px"|How long to play the tone (measured in units of 10 milliseconds)
| style="border-style: solid; border-width: 0px 0px 0px 0px"|[[Data_Types#dataType_int|int]]
|-
|}
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
while(true)
{
PlayImmediateTone(SensorValue[lightSensor] * 80, 50); // play tone according to light sensor readings
wait1Msec(200); // wait 200 milliseconds before checking again
}
</syntaxhighlight>
|-
|}
|-
|}
 

== PlaySound ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void PlaySound(TSounds sound)
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Play one of the system predefined sounds (buzz, beep, click, ...)
|-
|
{| class="parameterTable" cellpadding="5%" width="100%"
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
|-
| style="border-style: solid; border-width: 1px 0px 0px 0px"|''sound''
| style="border-style: solid; border-width: 1px 0px 0px 0px"|A predefined system sound
| style="border-style: solid; border-width: 1px 0px 0px 0px"|[[Data_Types#dataType_TSounds|TSounds]]
|-
|}

Predefined Sounds:
*soundBlip
*soundBeepBeep
*soundDownwardTones
*soundUpwardTones
*soundLowBuzz
*soundFastUpwardTones
*soundShortBlip
*soundException
*soundLowBuzzShort
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
PlaySound(soundBeepBeep); // play the sound, 'soundBeepBeep'
</syntaxhighlight>
|-
|}
|-
|}
 

== PlaySoundFile ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void PlaySoundFile(const string &sFileName)
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Plays a sound file from the NXT file system. File must be present on the NXT. RobotC will automatically download required files with user program.
|-
|
{| class="parameterTable" cellpadding="5%" width="100%"
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
|-
| style="border-style: solid; border-width: 1px 0px 0px 0px"|''sFileName''
| style="border-style: solid; border-width: 1px 0px 0px 0px"|A sound file to play
| style="border-style: solid; border-width: 1px 0px 0px 0px"|[[Data_Types#dataType_string|string]]
|-
|}
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
PlaySoundFile("Woops.rso"); // play the sound file, 'Woops.rso'
</syntaxhighlight>
|-
|}
|-
|}
 

== PlayTone ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void PlayTone(const int frequency, const int durationIn10MsecTicks)
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Plays a constant tone at the specified frequency and duration.
|-
|
{| class="parameterTable" cellpadding="5%" width="100%"
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
|-
| style="border-style: solid; border-width: 1px 0px 1px 0px"|''frequency''
| style="border-style: solid; border-width: 1px 0px 1px 0px"|The frequency of the tone to play
| style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_int|int]]
|-
| style="border-style: solid; border-width: 0px 0px 0px 0px"|''durationIn10MsecTicks''
| style="border-style: solid; border-width: 0px 0px 0px 0px"|How long to play the tone (measured in units of 10 milliseconds)
| style="border-style: solid; border-width: 0px 0px 0px 0px"|[[Data_Types#dataType_int|int]]
|-
|}
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
PlayTone(784, 15); // play a tone at a frequency of 784 for 150 milliseconds
</syntaxhighlight>
|-
|}
|-
|}
 

== UnmuteSound ==
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
|-
| class="functionType"| void UnmuteSound()
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Restores sound playback volume.
|-
|
{|
|-
|<syntaxhighlight lang="ROBOTC">
UnmuteSound(); // UN-MUTE
</syntaxhighlight>
|-
|}
|-
|}

@@ Line 1: / Line 1: @@
-{| style="font-family:Verdana, Genega, sans-sarif; font-size:80%;color:gray;" width="100%" cellpadding="0%" cellspacing="0" border="0"
+<yambe:breadcrumb self="Sound">VEX2_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
-|-
+<br />
-−
-''[[Main_Page|Main]] &rarr; [[VEX2_Main|CORTEX]] &rarr; [[VEX2: Functions| Functions and Variables]] &rarr; [[VEX2:_Functions_-_Sound|Sound]] ''
-|-
-|}
-−
 {| class="wikiText"
@@ Line 16: / Line 11: @@
 |-
 |}
+<br />
 {|

@@ Line 13: / Line 13: @@
 <br />
-{|
+{{tl|1|1}}
-|-
+<br />
-|style="vertical-align:top"| __TOC__
-|style="vertical-align:top"|
- {| width="100" cellpadding="2" cellspacing="0" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
-!colspan="2" class="wikiHeader"|Color Key
- |-
- |class="wikiText" width="75%" style="border-style: solid; border-width: 1px 0px 0px 0px"|Function:
- |width="25%" style="border-style: solid; border-width: 1px 0px 0px 0px;" class="colorKeyFunc"|
- |-
- |class="wikiText" width="75%" style="border-style: solid; border-width: 0px 0px 0px 0px"|Variable:
- |width="25%" style="border-style: solid; border-width: 0px 0px 0px 0px;" class="colorKeyVar"|
- |}
-|-
-|}
-−
 == bPlaySounds ==

@@ Line 231: / Line 231: @@
    |<syntaxhighlight lang="ROBOTC">
 PlaySound(soundBeepBeep);  // play the sound, 'soundBeepBeep'
 </syntaxhighlight>
    |-

@@ Line 2: / Line 2: @@
 |-
+|
-''[[Main_Page|Main]] >> [[VEX2_Main|CORTEX]] >> [[VEX2: Functions| Functions and Variables]] >> [[VEX2:_Functions_-_Sound|Sound]] ''
+''[[Main_Page|Main]] &rarr; [[VEX2_Main|CORTEX]] &rarr; [[VEX2: Functions| Functions and Variables]] &rarr; [[VEX2:_Functions_-_Sound|Sound]] ''
 |-
 |}

@@ Line 91: / Line 91: @@
+{
    PlayImmediateTone(SensorValue[lightSensor] * 80, 50);  // play tone according to light sensor readings
+}
 </syntaxhighlight>